diff --git a/404.html b/404.html index 7c2463c3a..b6ff86220 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/02e5f5c4.2b72627a.js b/assets/js/02e5f5c4.2b72627a.js new file mode 100644 index 000000000..72014c583 --- /dev/null +++ b/assets/js/02e5f5c4.2b72627a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>f,contentTitle:()=>b,default:()=>x,frontMatter:()=>y,metadata:()=>a,toc:()=>q});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":"eJzNV19vJDUM/yomL3DVdHdb7kDME+V0HIXqrqJFleitqsyMdybXTBISz25Xq5XugW/AE698tPskyMnO/ms5KCDES9V1bMf+2Y5/sxAk6yDya/G11RV6Mc5EhaH0ypGyRuTiskF47lESQlKBk/NTkFrbWYC57YAslOl8Es8HIhPWoZfs4LQSuUjH6VRkwuNPHQb6ylZzkS/2rjv3dqoqhAK1nYGTXrZI6O/dIjJRWkNoiH1I57Qq443Dt4EdLUQoG2wl/8cXKo8Vp5msjWyRU6W5Q5ELW7zFkkQmnOfISWFgu6T7inXzRa8byCtTi0xMrG8lbUvwTrZOs5LBWR/nMhNOejSU0GNAHudLLJeZIEXxR3J6UzB2Sz7Y5Ea+wygIzpqQMjgeje5DnHys4KwgdGWJIUw6recfPQbWD4OXxI9P1zVHRXN3/NYxcv+PCnx7bGR4dqvOkX2tcDuhh9xsjI5Hx58eHo0OR59fHn2WP/0if/bZYDQa/Sgycddqto1NmItKUvTbl7j/3bnqP7hnua+WQKuQpNJB3Gs97rplJp4+1FgXtkVqlKlhhoZg5q2pM3AaZUAgPwdZS2VAS0L/L3Yaem/9h0F6XGTbA6eMVgZv+qm6eToa3RytQXh2H4RTM5VaVfGVvLS3aP7bTLevp3T9/RqrpBTPxU6y2/KUZMCy84rmIr9eiLtD6dRhOs+vx8txJhhYy6+8syFGLKkRuRjuPfoB/RR9iF46r0UuGiIX8uEwSFMV9m5gHZqgaqNlEQalbYfSqeH0aHAkltm+jXTuUfrYHT7WJJCslan/zG68QeiCq5gKtYPTulzSqe9wLrK+DNtamVDcPQ3KNGSZ4Ob4frMqX/Ql3t1L2w/d/XdOcHWVmdgYxarKrx2aC1Wb2CMxi/2df4W6tC3y0qUGoTd4//Nv0aayZdeiodjE0cNHb8wb87rz4OwM/aTTIE0FE413qtAYjbCNZ2vOEFC2GkPQc1CGsPa82ytVK5IaGGye1lI6WSiteABYzbK1h60ZCgO4apAa9Hz0sUeQUOEUNc8NyI5sK4ld9UHDzPrbCbOXDCQUXVAGQwA0jTQlK/blzMB6kAbQEHrnVUAI5DlqlWKzhrwsCVppZI3sO9uBqkKtuOfB26ILBMHqLoYM/LZajxX0CRnEKgwYxBd3jo+ApaVtnceGe2+KUHeqwpBBaSuEEJuBUzAVFBgIHMeiSgzstDPalrexeLzXwVl+fpTUYCc7MbI5eWkC778US1+DNWDOWyYImAI8OPghIFf4TJnbkB8cvDGHcL3uqSssgiIcf9LP0Ww2uzc/T3ZtXir6pivge3Q2KLJ+vrGuFTVdEWdu28n6R/L0Eg3G/tmaqI2Pypbh/gizdNigdsMLJO6QMDw5P40v9hN4/+4XOEPpDTR2lrq17DzqOdT9VYxcqnyCbf3gwsTGxmsY8TI134ry9gheNZLev/s1wCucgUojlIA8ODjvCq1KuMTW8ToKBwd5z7+plwE1kqCUBgqE0EhupamSIMEla63M7QBOzBy6gB5miprYDCyPdjtpMC7rcgcoZMAKrIkW/Z2DTUQsbwPqKQb2ZSxxGFgpZpPUeNvV6bbtYFbJeZworeFKVTVSzO2kqsCtxLMkZsC3wsEJDwQ1OAfpEQIaGsD5nkk86ZyznqNQKfiJ5c8ULgCaylllKORQeTmhjf9s0+hxZSlrHhAlCOUajmzlZl2SNImrjNfSwRt+2fe2we5b63GCni+MaW/q4tSqna77tgTu1n/S1pG9WkOyjEwEW6l0Wktf7vuJrAB9G15PLtBPVYmr1fgHEz2MykORCa1KNAG32MbJy/MzmH46GIlsa8f+heEenp0+f/Hq4gUHww9pAuxoMBqMIqm3gVpptm7a+U7d32qLDQv7ex+1qy1OeEdDp6WK1CkmtFixnuvdT91xJhomRfm1WCx4qn7werlk8U8demZU40xMpVey4MV8PV5mPQFgmnSLc84pBX14ybezuu4Sl9ijkcxgksVJWaKjD+pu87bz1xeXIhPF6nO8tRXbeDnjT3U5YxLBH/Rxc8WvaZYthJam7mTNuskncxZ+9nYJz20kPKt/OKv+yMy3ItxlQikN/stJPWiwWCQytVyu9dPRH1qsgO21uXrj5XL5O0f/8v8=","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 l=r(74848),s=r(28453),o=r(33617),n=r.n(o),d=r(17543),i=r.n(d),p=r(86013),c=r.n(p),m=r(63723),u=r.n(m),g=(r(18766),r(79329),r(9303));const y={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:"eJzNV19vJDUM/yomL3DVdHdb7kDME+V0HIXqrqJFleitqsyMdybXTBISz25Xq5XugW/AE698tPskyMnO/ms5KCDES9V1bMf+2Y5/sxAk6yDya/G11RV6Mc5EhaH0ypGyRuTiskF47lESQlKBk/NTkFrbWYC57YAslOl8Es8HIhPWoZfs4LQSuUjH6VRkwuNPHQb6ylZzkS/2rjv3dqoqhAK1nYGTXrZI6O/dIjJRWkNoiH1I57Qq443Dt4EdLUQoG2wl/8cXKo8Vp5msjWyRU6W5Q5ELW7zFkkQmnOfISWFgu6T7inXzRa8byCtTi0xMrG8lbUvwTrZOs5LBWR/nMhNOejSU0GNAHudLLJeZIEXxR3J6UzB2Sz7Y5Ea+wygIzpqQMjgeje5DnHys4KwgdGWJIUw6recfPQbWD4OXxI9P1zVHRXN3/NYxcv+PCnx7bGR4dqvOkX2tcDuhh9xsjI5Hx58eHo0OR59fHn2WP/0if/bZYDQa/Sgycddqto1NmItKUvTbl7j/3bnqP7hnua+WQKuQpNJB3Gs97rplJp4+1FgXtkVqlKlhhoZg5q2pM3AaZUAgPwdZS2VAS0L/L3Yaem/9h0F6XGTbA6eMVgZv+qm6eToa3RytQXh2H4RTM5VaVfGVvLS3aP7bTLevp3T9/RqrpBTPxU6y2/KUZMCy84rmIr9eiLtD6dRhOs+vx8txJhhYy6+8syFGLKkRuRjuPfoB/RR9iF46r0UuGiIX8uEwSFMV9m5gHZqgaqNlEQalbYfSqeH0aHAkltm+jXTuUfrYHT7WJJCslan/zG68QeiCq5gKtYPTulzSqe9wLrK+DNtamVDcPQ3KNGSZ4Ob4frMqX/Ql3t1L2w/d/XdOcHWVmdgYxarKrx2aC1Wb2CMxi/2df4W6tC3y0qUGoTd4//Nv0aayZdeiodjE0cNHb8wb87rz4OwM/aTTIE0FE413qtAYjbCNZ2vOEFC2GkPQc1CGsPa82ytVK5IaGGye1lI6WSiteABYzbK1h60ZCgO4apAa9Hz0sUeQUOEUNc8NyI5sK4ld9UHDzPrbCbOXDCQUXVAGQwA0jTQlK/blzMB6kAbQEHrnVUAI5DlqlWKzhrwsCVppZI3sO9uBqkKtuOfB26ILBMHqLoYM/LZajxX0CRnEKgwYxBd3jo+ApaVtnceGe2+KUHeqwpBBaSuEEJuBUzAVFBgIHMeiSgzstDPalrexeLzXwVl+fpTUYCc7MbI5eWkC778US1+DNWDOWyYImAI8OPghIFf4TJnbkB8cvDGHcL3uqSssgiIcf9LP0Ww2uzc/T3ZtXir6pivge3Q2KLJ+vrGuFTVdEWdu28n6R/L0Eg3G/tmaqI2Pypbh/gizdNigdsMLJO6QMDw5P40v9hN4/+4XOEPpDTR2lrq17DzqOdT9VYxcqnyCbf3gwsTGxmsY8TI134ry9gheNZLev/s1wCucgUojlIA8ODjvCq1KuMTW8ToKBwd5z7+plwE1kqCUBgqE0EhupamSIMEla63M7QBOzBy6gB5miprYDCyPdjtpMC7rcgcoZMAKrIkW/Z2DTUQsbwPqKQb2ZSxxGFgpZpPUeNvV6bbtYFbJeZworeFKVTVSzO2kqsCtxLMkZsC3wsEJDwQ1OAfpEQIaGsD5nkk86ZyznqNQKfiJ5c8ULgCaylllKORQeTmhjf9s0+hxZSlrHhAlCOUajmzlZl2SNImrjNfSwRt+2fe2we5b63GCni+MaW/q4tSqna77tgTu1n/S1pG9WkOyjEwEW6l0Wktf7vuJrAB9G15PLtBPVYmr1fgHEz2MykORCa1KNAG32MbJy/MzmH46GIlsa8f+heEenp0+f/Hq4gUHww9pAuxoMBqMIqm3gVpptm7a+U7d32qLDQv7ex+1qy1OeEdDp6WK1CkmtFixnuvdT91xJhomRfm1WCx4qn7werlk8U8demZU40xMpVey4MV8PV5mPQFgmnSLc84pBX14ybezuu4Sl9ijkcxgksVJWaKjD+pu87bz1xeXIhPF6nO8tRXbeDnjT3U5YxLBH/Rxc8WvaZYthJam7mTNuskncxZ+9nYJz20kPKt/OKv+yMy3ItxlQikN/stJPWiwWCQytVyu9dPRH1qsgO21uXrj5XL5O0f/8v8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,f={},q=[];function I(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:"Create Folder"}),"\n",(0,l.jsx)(n(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(i(),{parameters:void 0}),"\n",(0,l.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,l.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/02e5f5c4.d17e846d.js b/assets/js/02e5f5c4.d17e846d.js deleted file mode 100644 index bf0f1a4b5..000000000 --- a/assets/js/02e5f5c4.d17e846d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5373],{69772:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>F,contentTitle:()=>I,default:()=>x,frontMatter:()=>w,metadata:()=>o,toc:()=>y});const o=JSON.parse('{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/v1.1/createfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createfolder","permalink":"/docs/API-docs/v1.1/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV+tuFDcUfpWD/7Sgye4mBarOr6aIQtqIRCQIqSFCZ2bOzph4bGN79qLVSv3RN+gb9NF4kurYO3sL0KatUP+sduxz/c7VCxGw9iK/Ej8aVZET15moyJdO2iCNFrm4bAieOMJAkEjg+PwEUCkz9TA3HQQDZbofx/uByISx5JAFnFQiF+k63YpMOHrfkQ8/mGou8sWeunNnJrIiKEiZKVh02FIgd0uLyERpdCAdWAZaq2QZNQ7feRa0EL5sqEX+xwqlo4rdTNwaW2JXw9ySyIUp3lEZRCasY8uDJM98ifYF0+aLntYHJ3UtMjE2rsWwfUIzbK1iIk3T3s5lJiw60iGhx4DcTZZYLjMRZIgfSejbgrFb8sXGt+A6igfeGu2TB0ej0W2Ik4wVnBX4rizJ+3Gn1PzeXWD9PHjp+O7u2uawaGZH7ywj9/+IwE9HGv2jG3lOLGuF23H4mJgN09Ho6JuDw9HB6NvLw8f5w+/yR48Ho9HoF5GJWauYNyZhLioMUW4f4v67s9UX0LPcJ0ugVRRQKi9upR5n3TITDz+WWBempdBIXcOUdICpM7rOwCpCTxDcHLBGqUFhIPcfZho5Z9znQbqbZdsFJ7WSmt72VfX24Wj09nANwqPbIJzoCSpZxS55aW5If1lPt9WHpP52jGUiivdix9nt8+Skp7JzMsxFfrUQswO08iDd51fXy+tMMLCGu7w1PlqMoRG5GO41fU9uQs5HKZ1TIhdNCNbnw6FHXRVmNjCWtJe1Vlj4QWnaIVo5nBwODsUy2+dBa+9ET93BXVl8wFrq+q/4rjcIXXAUU6B2cFqHC638meYi68OwTZUJydnTEKYiywQnx8vNqHzah3h3Lm03utt9TnB0pR6baMUqymeW9IWsdcyR6MX+zH9NqjQt8dANDUHP8OG3PyJPZcquJR1iEkcJ997oN/qsc2DNlNy4U4C6grGimSwURSZq4916Z/CErSLv1RykDlQ7nu2VrGVABQw2V2uJFgupJBcAkxnmdrBVQ34ArxsKDTm++soRIFQ0IcV1A9gF02JgUb3RMDXuZszbSwYIReelJu+BdIO6ZMI+nBkYB6iBdCBnnfQEPji2WibbjA4OywAtaqyJZWc7UFWkJOc8OFN0PoA3qosmA/dW46iC3iFNVPkBg/h0ZvkK+LQ0rXXUcO5NCOpOVuQzKE1F4GMysAu6goJ8AMu2yJI8C+20MuVNDB7PdbCG249EBWa8YyOzB4fa8/xLtvQxWANmneEFgZKBDx688sQRPpX6xucPHrzRB3C1zqnXVHgZ6Prrvo6m0+mt+rm/y/NMhuddAS/JGi+DcfMNdy1D0xWx5raFrD+SpGekKebPVkVtZFSm9LdLmE+HDSk7vKDAGeKHx+cnsWPfhw+//g6nhE5DY6YpW8vOkZpD3ati5FLkE2zrhgtjExOvYcTLlHyrlXeNYBztIFPxrDA87wolSwjUWp5DORyD3T2CEjUUtN7c2ATfICfSRCIgKKlvBnCs59B5cjCVoYk5wOeRebVCR0ZGHjdRHjvTggwDeG6mNCGXRRme2bQJQJUMUdbaGBk8qfEgmu5oLJWCqaxqCvnetwd0BNQWVFVUsddbagsac7rLANKD5xNOX9Y8gMuG5pEXJygVcieROiW14fcHI0u6skbq4HOoHI7DWrLPNkqi29LojxwlkHDtVrYS03+vSmwvEn4Ab7hn7/X53S7qaEyONcaS3CSOlatEueoTDjgP/03Cxr3U6IBl3DGoRanSwPl+X06c9+Rafza+IDeRJa2G3idqdRiJhyITSpakPW3tEcfPzk9hAt8MRiLbGp9/o26HpydPnr64eMrWcI9MiB0ORoNR3NeNDy3qLVU7T9D9gbXYLFj/7L26GtCBZmFoFcq4FUWHFquF5mr3FXudiYb3nfxKLBYFenrl1HLJx+87crwsXWdigk5y1sZVKetnO29ANzRnn5LRB5esnclVl9aEvQ2Rl5PEcVyWZMNnabdXsvOzi0uRiWL10m5NxTwOp/wKxynvB/xWj0MpPpT5bCEU6rrDmmmTTF5HuKPt7jI3cZdZ/WGv+is937Jwd8lJbvAvO/VRhsUi7UnL5Zo+XX2SYwVsT83Ru14ul38C7ULjuA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/v1.1/getfolder"}}');var a=r(74848),n=r(28453),i=r(33617),s=r.n(i),d=r(17543),l=r.n(d),c=r(86013),p=r.n(c),u=r(63723),m=r.n(u),f=(r(18766),r(79329),r(9303));const w={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:"eJzNV+tuFDcUfpWD/7Sgye4mBarOr6aIQtqIRCQIqSFCZ2bOzph4bGN79qLVSv3RN+gb9NF4kurYO3sL0KatUP+sduxz/c7VCxGw9iK/Ej8aVZET15moyJdO2iCNFrm4bAieOMJAkEjg+PwEUCkz9TA3HQQDZbofx/uByISx5JAFnFQiF+k63YpMOHrfkQ8/mGou8sWeunNnJrIiKEiZKVh02FIgd0uLyERpdCAdWAZaq2QZNQ7feRa0EL5sqEX+xwqlo4rdTNwaW2JXw9ySyIUp3lEZRCasY8uDJM98ifYF0+aLntYHJ3UtMjE2rsWwfUIzbK1iIk3T3s5lJiw60iGhx4DcTZZYLjMRZIgfSejbgrFb8sXGt+A6igfeGu2TB0ej0W2Ik4wVnBX4rizJ+3Gn1PzeXWD9PHjp+O7u2uawaGZH7ywj9/+IwE9HGv2jG3lOLGuF23H4mJgN09Ho6JuDw9HB6NvLw8f5w+/yR48Ho9HoF5GJWauYNyZhLioMUW4f4v67s9UX0LPcJ0ugVRRQKi9upR5n3TITDz+WWBempdBIXcOUdICpM7rOwCpCTxDcHLBGqUFhIPcfZho5Z9znQbqbZdsFJ7WSmt72VfX24Wj09nANwqPbIJzoCSpZxS55aW5If1lPt9WHpP52jGUiivdix9nt8+Skp7JzMsxFfrUQswO08iDd51fXy+tMMLCGu7w1PlqMoRG5GO41fU9uQs5HKZ1TIhdNCNbnw6FHXRVmNjCWtJe1Vlj4QWnaIVo5nBwODsUy2+dBa+9ET93BXVl8wFrq+q/4rjcIXXAUU6B2cFqHC638meYi68OwTZUJydnTEKYiywQnx8vNqHzah3h3Lm03utt9TnB0pR6baMUqymeW9IWsdcyR6MX+zH9NqjQt8dANDUHP8OG3PyJPZcquJR1iEkcJ997oN/qsc2DNlNy4U4C6grGimSwURSZq4916Z/CErSLv1RykDlQ7nu2VrGVABQw2V2uJFgupJBcAkxnmdrBVQ34ArxsKDTm++soRIFQ0IcV1A9gF02JgUb3RMDXuZszbSwYIReelJu+BdIO6ZMI+nBkYB6iBdCBnnfQEPji2WibbjA4OywAtaqyJZWc7UFWkJOc8OFN0PoA3qosmA/dW46iC3iFNVPkBg/h0ZvkK+LQ0rXXUcO5NCOpOVuQzKE1F4GMysAu6goJ8AMu2yJI8C+20MuVNDB7PdbCG249EBWa8YyOzB4fa8/xLtvQxWANmneEFgZKBDx688sQRPpX6xucPHrzRB3C1zqnXVHgZ6Prrvo6m0+mt+rm/y/NMhuddAS/JGi+DcfMNdy1D0xWx5raFrD+SpGekKebPVkVtZFSm9LdLmE+HDSk7vKDAGeKHx+cnsWPfhw+//g6nhE5DY6YpW8vOkZpD3ati5FLkE2zrhgtjExOvYcTLlHyrlXeNYBztIFPxrDA87wolSwjUWp5DORyD3T2CEjUUtN7c2ATfICfSRCIgKKlvBnCs59B5cjCVoYk5wOeRebVCR0ZGHjdRHjvTggwDeG6mNCGXRRme2bQJQJUMUdbaGBk8qfEgmu5oLJWCqaxqCvnetwd0BNQWVFVUsddbagsac7rLANKD5xNOX9Y8gMuG5pEXJygVcieROiW14fcHI0u6skbq4HOoHI7DWrLPNkqi29LojxwlkHDtVrYS03+vSmwvEn4Ab7hn7/X53S7qaEyONcaS3CSOlatEueoTDjgP/03Cxr3U6IBl3DGoRanSwPl+X06c9+Rafza+IDeRJa2G3idqdRiJhyITSpakPW3tEcfPzk9hAt8MRiLbGp9/o26HpydPnr64eMrWcI9MiB0ORoNR3NeNDy3qLVU7T9D9gbXYLFj/7L26GtCBZmFoFcq4FUWHFquF5mr3FXudiYb3nfxKLBYFenrl1HLJx+87crwsXWdigk5y1sZVKetnO29ANzRnn5LRB5esnclVl9aEvQ2Rl5PEcVyWZMNnabdXsvOzi0uRiWL10m5NxTwOp/wKxynvB/xWj0MpPpT5bCEU6rrDmmmTTF5HuKPt7jI3cZdZ/WGv+is937Jwd8lJbvAvO/VRhsUi7UnL5Zo+XX2SYwVsT83Ru14ul38C7ULjuA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},I=void 0,F={},y=[];function N(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,a.jsx)(s(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(l(),{parameters:void 0}),"\n",(0,a.jsx)(p(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,a.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/03e06346.0d5f551b.js b/assets/js/03e06346.0d5f551b.js new file mode 100644 index 000000000..29fc1e634 --- /dev/null +++ b/assets/js/03e06346.0d5f551b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>b,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>y});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":"eJztPF1zGzeSfwU7dVWJeUOKpCRb0dbVnZL4Et96bZUtX+pO0irgTJMDawaYABhRjIpV+7D/YJ/udX9afslVN4DhDD8k2VYS+Y55cMTBV3ejG+hudPdNZPnERIen0QkUZc4tmOg8jlIwiRalFUpGh9FJBuy4GuUiYaEXOzp+wXieq6lhlQFtmFUs0YBNNszEbMYtM6CvgHHDRnkFpRbSGjZWmk1AguZWyAlLVVIVgA1TYTNWakhhLCSkzFhdJbbSYHrshwwk4/X0TBhmqiQBY8ZVns/88mnMbObg02ArLQ3jrJLipwpYpxMGX4i002FcpoyzTqck5C4qnXc6PYbotr/hUu53PmOclhSjHGh8wWdsBMxkXEPq4OdyRkSJGUg+yhFDm0GBJPJIu6FGTGQD9xE3kDIlCf4AaI99r6ZwhZM1PzNhDeRjlnAplUUACpWKsYCU2UyrapIxmwnD3r15+UcmLPZjSuYEaoXL4A6EpR3lhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/77YphVDL+ddjrfwqiasHcvOp3zLzNrS3O4s8PLsqdKkDhfzkeml6hiJ8WOZTp+ErNpBhpwVgIOuBFI3BRpmE7AGkJYskSVM5YopVMhkaliVvIJMFkVI9AmdnugNDCBzKGBp7OuVd3KAPuPt69fIaIFtz12nFcmrpdLhYbEItPg9EjZgNUXbiOe7iHvCTmJWcEvcQuFZT9VIrlEtA3IFP/vOY1o1em8rcpSaQsp+8GhcNjpYMvXkKsp4xqof6KKQklWcs0LsCQ6KCbYrOGnSizYKM8DLQ7PZBe5d1bCYafDXshUJF7CgOFXpsa+b891RSJh17clJMgXrmuDdMho00wkGdFkyt1+ljlPHJgaTAmJFVfQnvg6ZjOc+FuQKkCQKS1+VtLynLbjCrQVCc+b24YAYldjuSaZL5WQNnz1K7D/8tuDu0eb4vkKQUuRWIWQ1GKAXfG8AuOhmsYsQ6jeQKnBkDj5eUkeU5aBmGQb1+Pp+8rY1sSsMl5wayj8WmGXiLxAZBvz3AAT4xYtC34JjdWYovOU5z329YylMOZVbmMmkOOsrqDHXinLeFnmIuF4uqCIovBwPP+6tMueHTwgkhe0x8daXYkU8KBLxXgMGoUTG2kKPyZAh3xW0gBEjyTHZnQ6LG10onKlV1mIPrfpyBIlLUjbY0dXXOQEvEPWMCGTvEqBjXKeXMZ0B8RM4ymNuzIDvEJix+/UBS8KR3OiDzOQIxcqifBL5ZfHo99DleKBjedzkCdsDKSmRYRpUtVL7VjhykiCIGIMCi7ymAgXs/dqxKywOcQosCWXs5il3ELMLFzbkbqOWZJBckl/aZ4KxUaVtUo6xFKtylRNpaflWElrxM9rJDK0fDhFhzHbi9nTmB3EbNCP2WAYs8FezAZPYzY4iNmwH7PhMGbDvZgNnzqwhgee1rwmcBOAwdBR2X4+1MVz96UwJNl4YJr6DJ62zuBBj3U6tTThtx9//PFM3pxJxs4iFK6z6JCdRXWXsyh2bXhmYtvA/77GH7vDZ/7nDH8+HR74n1PqOtjzPzP8ORycyblf8EwOCRLLi/IWKLD5QSHwvzwT4TdaFL+F8ww/4kEUhwbcqxY82DBv4rKLuAgprOC52YxO6PGIMFqAtILUHiJF7LoZI2p+ROg04cEWOiZdEx2rjaYg8ATFcAX7/Z6/WTYj75Z9NLg3wPk01J8i6ng0neDRtBn/+vR6RERYhunTKPGsRwoAncyb6eA7PCIqtCH6NBocIA3wUtpMAGx9RNg3wMEGf8O7tv5ed7DfHfaHey0KoG3kOhRFN027s9nsIaiHOo9fHlWeoKE6zQ7N17FWxRrzg6yDRS+vE9HfQWX/Myrqo6DDQop2HxkWQWOpLb6mlm1VymdfGDdVGForZ9h/oZrNGmBSE8JB1m+SKZF44LFPUMlGaOD1kAZdouROmu40KIkf07RbFN2lj/izS4RvfCyKXpr2lnqu7I77WLA0jdnq57Xf05QVRbHhs/ve+rxTFKtY9IrCw0bK11c9cqqQzrZZTnyH30pUFhLRXvhWMULPAXpIsIHMufVytHTZZEL6Bs9UbKmDhkmVcw3XaJcaoaTr/fAyFkRsodmTHUsmoPMcESnYl6+99v7Esz+i0J4Av9w9bgUznOSIJZWxqmAaJnDNSm4taEmTXfFcpM7N1KUPcM2LEk2Anb+cnaX//E875IBAG986X1UqJgL9QDt/OT3q/vf5mh5VWYJOuAGWA65kYgY26bHTDPJy4YqaTqe96a5JMqVy54d6bzSM3b8XavT+gsAte9yUT9Zh6lijYfAj6yzb+wZsi2LcsDByjclPPEYyNOjTbevtnVuuW9/jEd04SyBho/OeYPPpWVRwUkiQlWHxt7IZ6LPovB7jjHxI7xh7fg9hzUQKOR9Bvtp0b0GrP+d8piov38Gp1UbVc3SDbthQCFn7LQidftxo5NdLja5tvka+HUGa0hmunCCeYQdYLkzw3LTJ2RztXVvkcJQA5MNE57UfwEY1l36yFNSA3U8M3Enk9+6OJbAfo461WzGsdscKrY1pEgbnKIQURVXU/tFxPWsgWeF1jya9cCQ6+8MKzd1dWYFf37ECOiM3L3AmB+THCP6PWzRT3+MRnRVLIN0uxh9zirTu6Qe6YO8WwIBWUwDXXMvY1V3ItfCZzdLXY6/xekOfrBuEXrYkgdKiR+5TRbMG+d43FPmsmn64zZzX7PWIuG8NWL8yB/p+D337fBSTNrH/jBi1Bfa9mdU5JQs+ucVyp+ZHxJ4enhUnRKdzrGEs8rzxpMjCp/Cyg086kEPhn738YyJedeQIF9IqNAvCs+0IxvReaukZpflu7e4Zt6XNN1H3QKw0y7hx+jcp/LhV+GCLj9tLrvgA2sIdL2SAG3dl8HB24/CrfnOfBk/3W/u032/tU3/TPt1iNuIOmlJJU/vaYNHUkGva4vB99WpZFtswKW7pc4lvK8F6cMKgqjxlubikV5VUmDLnM9zVIKUeyuXnum8ypcyih38x+9IjfNh+iVMaH+Oe9OqHifs4vJY2o7EXg2e7ja3YPzhoS0xLYO5jvy/WW92F/t7OYH/HebTWO7QWbpjNh/AtmgBj99kv8hPda7+o52LDtm6nj3U7PQy77z6k1T14NmxdFrv9j70sHty4bkrNHWb1QxjPD2bFNsXtnvbrb2ZHfjr37f0aGvXg2W6TC58NHsCFukFx/lROXNGPH4z32EMpx+sY8B7a8a0q8SczaBPYX51J9x9Gkx70WxraVy0F7athkyn39+/FlM1FlzjrLBL/+fXrN9P+n76bqKOjo6NXb99lz99Njo6OCvzd6/XWGlHrdpuWQc3VRwT6e5nu+A2r9Ho9JGHKLT+k4TulnPzRjY83j+n51+dfybOz/xCPKWscOJ9+CtRdfz9vza8n558qgVEcqZKCpJV8kUaHkQtCDkHAUUymJRj7tUpn0eFN5MPG8E8flIVDd94bjOO+iUySQcHxr2CSYuT3WOQ4FUY+gTZRHFEcAYaBI9dFh5EavYfERjG+cZXoiACDc9C4w5vQy4XLRrFXwqPDyHF9FEf+paf+xEAmCt9uy3QczcOCt01Vf1lMZeiPOiIa58GI1I+chobOlyLfP2qm5gzzBVkXk3Gt+SxaDrIPoajhHdGNq2Pt8lm4HIRFV0gdH0ndojgSFormKhs2TasPp3QCCjGhGKMPHUvbwosPXhPHlZmSHzXQex/W0PyeVHKtqwu3t+wIgxwhDVppdxGtGzOKmOvdxTGhP2HLJ8013RvByponm6K4G8GjJiNTlJclcN2jYOqPjtOnvA6eJxVlHdTHYguzGtQas8E8jq7vRuaaJaobQsTZlzmMrXvSZYnSEvSTZpzIo0FuuLc3j6PZ3ejNPkv0nuHmTe/G7geKrV/kHfwesO4ezOMouxvW7+vo/98R2L2n88VdF7lspTofaaTS2UU4t+Z3dQyXCvbDXJQX8rVOQTcIMVIqBy5XKPFi7Lzrin2BFscXsQukoKBtoU24UNgUHcwaEsAEEIqvCmcV8zqHi+hmPpAWnfLP8QOpSaYaGewlw3zGTTgCZrWYTAB9zr4HDfZh6cCTDJNrfHgHHwcvW6nhSqjKBPDQEY3BfjlYSnkCoevEpZZV1KAOububuPeau4Nf8JLDjC14fXJ8D1qSydZ1iVbunnZYujnY65NjTIURY6+G9dg7U1MikJa3ujBUi9iV4CFcvj7bZ+7xGZzfUbncsaaPvueTULpsFaBUmLUQxS6FD+P06yS+lYkXuVK4Raqy6PMXPgPAWChNi44ERU3IE1XdhyvvoCRnk4pi/SyKbMiLoXCfRSqLkC5ZkPT9tNIhe8ezBfbExL0FnQJVsFNjfszaM244Z2NuLObeVVIg5XWF2n09JVyXoAXIBNaSQIMjHSYR3q1NtPNC3r156TPkAg5BKEcogW5iSFlVEteQJNT5SmHnllFfUZRQOkBfbFLQVlUPyiryrogStFESzRWlJ1yKnx0Lk0aC1s4IMp67rv6oQJc1woMS3gYmnLW//O0fDbg2apyrgLkVeJpiMNodEJJJ5xgeNW4NJZ6Aqg0Rzgf635YvAYSOhObCJVw6QTL35/FjCl8z9bno39Dq9ztTJRkq+PV5a+JwxhqvVhqyEcmQpEe4EvGFa2FsI+MmxMWung9vAOmYNGAgNQSlGnlezpoCvnhXVEvTUV6QaGdr1dfgiizwyqoLDYWQ97unml4xq+qDoLKq4FYkLExleu0cPPf0EuS6YF8G0JAbr4TSTzaIKk53oWQCF0JeYMLtPRS8V3UcT8pnyNx2CiCbsAUiuetskSc1pVzmJk0atxNlAzah3EfzwD2errNdbjckAz+4q4RybYsRPuK7Z2AUNTo41MKWbBtDn4s15d9Dt7bUZ2RsDPr9/8u21G7/87Gl9vqfkS11gMB69+ndB9Am/Wbt2RHcwbcPeK/IaUOO3Nt7opd1HtfO63UEXojDcO7+W5h/4dy/wyR0NuPCrevNmYAMkWHY7+P/lg7BUFHCl89o1dT4QxTf36d8xyWwqLxxO72Org6Oi1IWSUYneV2G4/ZRTWbzX4nP3HhkvX8NEIj0X9prFGBM+8JYs4AvgGJvJ1dzl4TMhYSLsAUXS857t8176/bkrSrAZqTMoRo/1QrrUJQ5YKaD1TPGJ1xIhtPoB9wi0PouZv4wyG6jxl6/fzGoibC/SoQXkuLrqZLLiboE+dti2lzeuuUR1OsiX5wokXCdqD1qIdv87pA0kFRa2Fl0eHoTXXd5Kbqu/fD0fH6OXGgzRY88yhDE3GbRYbSz8uZDBXXwReH0JiK5qJnfcJli8MLKactLsXM16A2iebw8Zu3pfEt/qLofOsRYPhFycte48wWN3uI+uq1qUWqhgZbiT4AqqN+IZq84Esg/GXA0NZD0yB5vFi9lz8Mmhzesdc9Si81cfmgK70ytp6PlW3LNY1DjLeg0PMTQ20r9tBItEIrq5w/8s1bBTxcsW78dBHV3QHricG+PFKpnA9I8dg/oUt97Oj93BG44CykWtenxcmEXLdeN/9R2ZUTRkuugZb8vm+8bTekNlrRfcslirAFZZ6jtt+yjNdQK93ubVhiYgLTa7ROt9vpEq4N+S7XwGC5mWCgIpAXUSgDd9M2LHm/zc+Q/IceKmNdz1OsS5Fv0s+HhQsy/ohBCnqiirqcRBvzyt3/QmGCFO38GzvAHjNd4XWlWqinoceWKc4xzuKZKVTgICmoz9IpIUda8yMEYfFqUFiZUl4py7tCx511HCS/5SOQCT04XSUwhiY3D11Xmwld+bPpCuxTEK8jxwK0t9kaVLzZV+nKMpcNixtkI6+ygzwZkxmXi3EPuFCA3B9qr6HortTBYPkgj1MLBpqTVPLGs4JJPyE8Rt0iVQi7wqGRajdB7alReOf+g5SJX2gWQEUL0wk9BL8+vS2wijRYdaxoy5Nsr7yQ0sXPSOgH3BahG6A8vERaRAPlKKpkrrBWFfvUqz1mprPN1o+LchBGHW82lQW3XwRL2oCaY99+B8VHW7wzgDr8U8tLVN+my05qnfoCRERba2Y/LsvekPeY7Yb+vRlg9SRlhlZ4tRk+EzaoRHdXNSeofbqbvQl2zxkG8mCNViVljAqjE7GCi5s5bsMghZufo+AVd9U/YL3/9O3sJXEuWqanj1qTSkM/aJdTczjuy1Tc1eYh5heXDLDGpnIRHi0DBHzJuf/nr/xj2CqboKUMRcoTsdJZK3ZlO55B9s7a0XcjWcjH06Lbnvk4cy4W87LEjXwnOvW4gM+B3GvcRleBOGqtDYSC/AtOoAAepsK36b9ACxiPXTidA3I7SlJVLKQXoRluA4zxF9ArBncsIC6qtyUJohfu3CwGBTKnklzlkqeZju5g/Xi1Et+ZTSFEI5Ij9NPWWOEks22q6cVE0S0pE+6zVMAYqhmfaFfpK4dnpNLAla6cVfzhbO5NRWp6QChsuSF6KtY5mLHhmXo/fgr4SSbByNkj0DnXeieIoFwl4+9XfXUffHb9kV7u9fhQ3VLN7CPfOyxffPH/19jkCgwepI9ig1+/1yThTxhZcNlZakp3le60RobStKrmtKrmtKrmtKrmtKrmtKrmtKrmtKvmoqLutKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKvlYzoptVcnHUqxvW1Xyt+DAbVXJbVXJbVXJbVXJbVXJbVXJbVXJbVXJD3ZebatKbqtKbqtKbqtKbqtKbqtKbqtK/j+tKtnIitopcy4oedHn2Lq8w9PlWpPncZRhYuLhaXRzg5z3TufzOX7+qaIcrNPzOLriWmDEFuU0xiEFD/OwLmEWHUbfuAC07gmuH7uNpvj3pVROzCF0I44I91v7NnMnj1+/PYniaOTrYRYqpRRsPsW8LT51qWuN5C76dhPlXE4qSgyL3JxzV7Ika6ccXlLKof+jkV3G5awBYTsX0aGB/yJSawfc3Lh0xvm87u+aNo7whA29cf/O5/P5/wKDceTJ","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPF1zGzeSfwU7dVWJeUOKpCRb0dbVnZL4Et96bZUtX+pO0irgTJMDawaYABhRjIpV+7D/YJ/udX9afslVN4DhDD8k2VYS+Y55cMTBV3ejG+hudPdNZPnERIen0QkUZc4tmOg8jlIwiRalFUpGh9FJBuy4GuUiYaEXOzp+wXieq6lhlQFtmFUs0YBNNszEbMYtM6CvgHHDRnkFpRbSGjZWmk1AguZWyAlLVVIVgA1TYTNWakhhLCSkzFhdJbbSYHrshwwk4/X0TBhmqiQBY8ZVns/88mnMbObg02ArLQ3jrJLipwpYpxMGX4i002FcpoyzTqck5C4qnXc6PYbotr/hUu53PmOclhSjHGh8wWdsBMxkXEPq4OdyRkSJGUg+yhFDm0GBJPJIu6FGTGQD9xE3kDIlCf4AaI99r6ZwhZM1PzNhDeRjlnAplUUACpWKsYCU2UyrapIxmwnD3r15+UcmLPZjSuYEaoXL4A6EpR3lhJI1VEJOemfyTJ6I8pC9K3PFUzZTlWbH3/77YphVDL+ddjrfwqiasHcvOp3zLzNrS3O4s8PLsqdKkDhfzkeml6hiJ8WOZTp+ErNpBhpwVgIOuBFI3BRpmE7AGkJYskSVM5YopVMhkaliVvIJMFkVI9AmdnugNDCBzKGBp7OuVd3KAPuPt69fIaIFtz12nFcmrpdLhYbEItPg9EjZgNUXbiOe7iHvCTmJWcEvcQuFZT9VIrlEtA3IFP/vOY1o1em8rcpSaQsp+8GhcNjpYMvXkKsp4xqof6KKQklWcs0LsCQ6KCbYrOGnSizYKM8DLQ7PZBe5d1bCYafDXshUJF7CgOFXpsa+b891RSJh17clJMgXrmuDdMho00wkGdFkyt1+ljlPHJgaTAmJFVfQnvg6ZjOc+FuQKkCQKS1+VtLynLbjCrQVCc+b24YAYldjuSaZL5WQNnz1K7D/8tuDu0eb4vkKQUuRWIWQ1GKAXfG8AuOhmsYsQ6jeQKnBkDj5eUkeU5aBmGQb1+Pp+8rY1sSsMl5wayj8WmGXiLxAZBvz3AAT4xYtC34JjdWYovOU5z329YylMOZVbmMmkOOsrqDHXinLeFnmIuF4uqCIovBwPP+6tMueHTwgkhe0x8daXYkU8KBLxXgMGoUTG2kKPyZAh3xW0gBEjyTHZnQ6LG10onKlV1mIPrfpyBIlLUjbY0dXXOQEvEPWMCGTvEqBjXKeXMZ0B8RM4ymNuzIDvEJix+/UBS8KR3OiDzOQIxcqifBL5ZfHo99DleKBjedzkCdsDKSmRYRpUtVL7VjhykiCIGIMCi7ymAgXs/dqxKywOcQosCWXs5il3ELMLFzbkbqOWZJBckl/aZ4KxUaVtUo6xFKtylRNpaflWElrxM9rJDK0fDhFhzHbi9nTmB3EbNCP2WAYs8FezAZPYzY4iNmwH7PhMGbDvZgNnzqwhgee1rwmcBOAwdBR2X4+1MVz96UwJNl4YJr6DJ62zuBBj3U6tTThtx9//PFM3pxJxs4iFK6z6JCdRXWXsyh2bXhmYtvA/77GH7vDZ/7nDH8+HR74n1PqOtjzPzP8ORycyblf8EwOCRLLi/IWKLD5QSHwvzwT4TdaFL+F8ww/4kEUhwbcqxY82DBv4rKLuAgprOC52YxO6PGIMFqAtILUHiJF7LoZI2p+ROg04cEWOiZdEx2rjaYg8ATFcAX7/Z6/WTYj75Z9NLg3wPk01J8i6ng0neDRtBn/+vR6RERYhunTKPGsRwoAncyb6eA7PCIqtCH6NBocIA3wUtpMAGx9RNg3wMEGf8O7tv5ed7DfHfaHey0KoG3kOhRFN027s9nsIaiHOo9fHlWeoKE6zQ7N17FWxRrzg6yDRS+vE9HfQWX/Myrqo6DDQop2HxkWQWOpLb6mlm1VymdfGDdVGForZ9h/oZrNGmBSE8JB1m+SKZF44LFPUMlGaOD1kAZdouROmu40KIkf07RbFN2lj/izS4RvfCyKXpr2lnqu7I77WLA0jdnq57Xf05QVRbHhs/ve+rxTFKtY9IrCw0bK11c9cqqQzrZZTnyH30pUFhLRXvhWMULPAXpIsIHMufVytHTZZEL6Bs9UbKmDhkmVcw3XaJcaoaTr/fAyFkRsodmTHUsmoPMcESnYl6+99v7Esz+i0J4Av9w9bgUznOSIJZWxqmAaJnDNSm4taEmTXfFcpM7N1KUPcM2LEk2Anb+cnaX//E875IBAG986X1UqJgL9QDt/OT3q/vf5mh5VWYJOuAGWA65kYgY26bHTDPJy4YqaTqe96a5JMqVy54d6bzSM3b8XavT+gsAte9yUT9Zh6lijYfAj6yzb+wZsi2LcsDByjclPPEYyNOjTbevtnVuuW9/jEd04SyBho/OeYPPpWVRwUkiQlWHxt7IZ6LPovB7jjHxI7xh7fg9hzUQKOR9Bvtp0b0GrP+d8piov38Gp1UbVc3SDbthQCFn7LQidftxo5NdLja5tvka+HUGa0hmunCCeYQdYLkzw3LTJ2RztXVvkcJQA5MNE57UfwEY1l36yFNSA3U8M3Enk9+6OJbAfo461WzGsdscKrY1pEgbnKIQURVXU/tFxPWsgWeF1jya9cCQ6+8MKzd1dWYFf37ECOiM3L3AmB+THCP6PWzRT3+MRnRVLIN0uxh9zirTu6Qe6YO8WwIBWUwDXXMvY1V3ItfCZzdLXY6/xekOfrBuEXrYkgdKiR+5TRbMG+d43FPmsmn64zZzX7PWIuG8NWL8yB/p+D337fBSTNrH/jBi1Bfa9mdU5JQs+ucVyp+ZHxJ4enhUnRKdzrGEs8rzxpMjCp/Cyg086kEPhn738YyJedeQIF9IqNAvCs+0IxvReaukZpflu7e4Zt6XNN1H3QKw0y7hx+jcp/LhV+GCLj9tLrvgA2sIdL2SAG3dl8HB24/CrfnOfBk/3W/u032/tU3/TPt1iNuIOmlJJU/vaYNHUkGva4vB99WpZFtswKW7pc4lvK8F6cMKgqjxlubikV5VUmDLnM9zVIKUeyuXnum8ypcyih38x+9IjfNh+iVMaH+Oe9OqHifs4vJY2o7EXg2e7ja3YPzhoS0xLYO5jvy/WW92F/t7OYH/HebTWO7QWbpjNh/AtmgBj99kv8hPda7+o52LDtm6nj3U7PQy77z6k1T14NmxdFrv9j70sHty4bkrNHWb1QxjPD2bFNsXtnvbrb2ZHfjr37f0aGvXg2W6TC58NHsCFukFx/lROXNGPH4z32EMpx+sY8B7a8a0q8SczaBPYX51J9x9Gkx70WxraVy0F7athkyn39+/FlM1FlzjrLBL/+fXrN9P+n76bqKOjo6NXb99lz99Njo6OCvzd6/XWGlHrdpuWQc3VRwT6e5nu+A2r9Ho9JGHKLT+k4TulnPzRjY83j+n51+dfybOz/xCPKWscOJ9+CtRdfz9vza8n558qgVEcqZKCpJV8kUaHkQtCDkHAUUymJRj7tUpn0eFN5MPG8E8flIVDd94bjOO+iUySQcHxr2CSYuT3WOQ4FUY+gTZRHFEcAYaBI9dFh5EavYfERjG+cZXoiACDc9C4w5vQy4XLRrFXwqPDyHF9FEf+paf+xEAmCt9uy3QczcOCt01Vf1lMZeiPOiIa58GI1I+chobOlyLfP2qm5gzzBVkXk3Gt+SxaDrIPoajhHdGNq2Pt8lm4HIRFV0gdH0ndojgSFormKhs2TasPp3QCCjGhGKMPHUvbwosPXhPHlZmSHzXQex/W0PyeVHKtqwu3t+wIgxwhDVppdxGtGzOKmOvdxTGhP2HLJ8013RvByponm6K4G8GjJiNTlJclcN2jYOqPjtOnvA6eJxVlHdTHYguzGtQas8E8jq7vRuaaJaobQsTZlzmMrXvSZYnSEvSTZpzIo0FuuLc3j6PZ3ejNPkv0nuHmTe/G7geKrV/kHfwesO4ezOMouxvW7+vo/98R2L2n88VdF7lspTofaaTS2UU4t+Z3dQyXCvbDXJQX8rVOQTcIMVIqBy5XKPFi7Lzrin2BFscXsQukoKBtoU24UNgUHcwaEsAEEIqvCmcV8zqHi+hmPpAWnfLP8QOpSaYaGewlw3zGTTgCZrWYTAB9zr4HDfZh6cCTDJNrfHgHHwcvW6nhSqjKBPDQEY3BfjlYSnkCoevEpZZV1KAOububuPeau4Nf8JLDjC14fXJ8D1qSydZ1iVbunnZYujnY65NjTIURY6+G9dg7U1MikJa3ujBUi9iV4CFcvj7bZ+7xGZzfUbncsaaPvueTULpsFaBUmLUQxS6FD+P06yS+lYkXuVK4Raqy6PMXPgPAWChNi44ERU3IE1XdhyvvoCRnk4pi/SyKbMiLoXCfRSqLkC5ZkPT9tNIhe8ezBfbExL0FnQJVsFNjfszaM244Z2NuLObeVVIg5XWF2n09JVyXoAXIBNaSQIMjHSYR3q1NtPNC3r156TPkAg5BKEcogW5iSFlVEteQJNT5SmHnllFfUZRQOkBfbFLQVlUPyiryrogStFESzRWlJ1yKnx0Lk0aC1s4IMp67rv6oQJc1woMS3gYmnLW//O0fDbg2apyrgLkVeJpiMNodEJJJ5xgeNW4NJZ6Aqg0Rzgf635YvAYSOhObCJVw6QTL35/FjCl8z9bno39Dq9ztTJRkq+PV5a+JwxhqvVhqyEcmQpEe4EvGFa2FsI+MmxMWung9vAOmYNGAgNQSlGnlezpoCvnhXVEvTUV6QaGdr1dfgiizwyqoLDYWQ97unml4xq+qDoLKq4FYkLExleu0cPPf0EuS6YF8G0JAbr4TSTzaIKk53oWQCF0JeYMLtPRS8V3UcT8pnyNx2CiCbsAUiuetskSc1pVzmJk0atxNlAzah3EfzwD2errNdbjckAz+4q4RybYsRPuK7Z2AUNTo41MKWbBtDn4s15d9Dt7bUZ2RsDPr9/8u21G7/87Gl9vqfkS11gMB69+ndB9Am/Wbt2RHcwbcPeK/IaUOO3Nt7opd1HtfO63UEXojDcO7+W5h/4dy/wyR0NuPCrevNmYAMkWHY7+P/lg7BUFHCl89o1dT4QxTf36d8xyWwqLxxO72Org6Oi1IWSUYneV2G4/ZRTWbzX4nP3HhkvX8NEIj0X9prFGBM+8JYs4AvgGJvJ1dzl4TMhYSLsAUXS857t8176/bkrSrAZqTMoRo/1QrrUJQ5YKaD1TPGJ1xIhtPoB9wi0PouZv4wyG6jxl6/fzGoibC/SoQXkuLrqZLLiboE+dti2lzeuuUR1OsiX5wokXCdqD1qIdv87pA0kFRa2Fl0eHoTXXd5Kbqu/fD0fH6OXGgzRY88yhDE3GbRYbSz8uZDBXXwReH0JiK5qJnfcJli8MLKactLsXM16A2iebw8Zu3pfEt/qLofOsRYPhFycte48wWN3uI+uq1qUWqhgZbiT4AqqN+IZq84Esg/GXA0NZD0yB5vFi9lz8Mmhzesdc9Si81cfmgK70ytp6PlW3LNY1DjLeg0PMTQ20r9tBItEIrq5w/8s1bBTxcsW78dBHV3QHricG+PFKpnA9I8dg/oUt97Oj93BG44CykWtenxcmEXLdeN/9R2ZUTRkuugZb8vm+8bTekNlrRfcslirAFZZ6jtt+yjNdQK93ubVhiYgLTa7ROt9vpEq4N+S7XwGC5mWCgIpAXUSgDd9M2LHm/zc+Q/IceKmNdz1OsS5Fv0s+HhQsy/ohBCnqiirqcRBvzyt3/QmGCFO38GzvAHjNd4XWlWqinoceWKc4xzuKZKVTgICmoz9IpIUda8yMEYfFqUFiZUl4py7tCx511HCS/5SOQCT04XSUwhiY3D11Xmwld+bPpCuxTEK8jxwK0t9kaVLzZV+nKMpcNixtkI6+ygzwZkxmXi3EPuFCA3B9qr6HortTBYPkgj1MLBpqTVPLGs4JJPyE8Rt0iVQi7wqGRajdB7alReOf+g5SJX2gWQEUL0wk9BL8+vS2wijRYdaxoy5Nsr7yQ0sXPSOgH3BahG6A8vERaRAPlKKpkrrBWFfvUqz1mprPN1o+LchBGHW82lQW3XwRL2oCaY99+B8VHW7wzgDr8U8tLVN+my05qnfoCRERba2Y/LsvekPeY7Yb+vRlg9SRlhlZ4tRk+EzaoRHdXNSeofbqbvQl2zxkG8mCNViVljAqjE7GCi5s5bsMghZufo+AVd9U/YL3/9O3sJXEuWqanj1qTSkM/aJdTczjuy1Tc1eYh5heXDLDGpnIRHi0DBHzJuf/nr/xj2CqboKUMRcoTsdJZK3ZlO55B9s7a0XcjWcjH06Lbnvk4cy4W87LEjXwnOvW4gM+B3GvcRleBOGqtDYSC/AtOoAAepsK36b9ACxiPXTidA3I7SlJVLKQXoRluA4zxF9ArBncsIC6qtyUJohfu3CwGBTKnklzlkqeZju5g/Xi1Et+ZTSFEI5Ij9NPWWOEks22q6cVE0S0pE+6zVMAYqhmfaFfpK4dnpNLAla6cVfzhbO5NRWp6QChsuSF6KtY5mLHhmXo/fgr4SSbByNkj0DnXeieIoFwl4+9XfXUffHb9kV7u9fhQ3VLN7CPfOyxffPH/19jkCgwepI9ig1+/1yThTxhZcNlZakp3le60RobStKrmtKrmtKrmtKrmtKrmtKrmtKrmtKvmoqLutKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKrmtKvlYzoptVcnHUqxvW1Xyt+DAbVXJbVXJbVXJbVXJbVXJbVXJbVXJbVXJD3ZebatKbqtKbqtKbqtKbqtKbqtKbqtK/j+tKtnIitopcy4oedHn2Lq8w9PlWpPncZRhYuLhaXRzg5z3TufzOX7+qaIcrNPzOLriWmDEFuU0xiEFD/OwLmEWHUbfuAC07gmuH7uNpvj3pVROzCF0I44I91v7NnMnj1+/PYniaOTrYRYqpRRsPsW8LT51qWuN5C76dhPlXE4qSgyL3JxzV7Ika6ccXlLKof+jkV3G5awBYTsX0aGB/yJSawfc3Lh0xvm87u+aNo7whA29cf/O5/P5/wKDceTJ",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,g={},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,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:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/03e06346.93c9778f.js b/assets/js/03e06346.93c9778f.js deleted file mode 100644 index a18cb3d34..000000000 --- a/assets/js/03e06346.93c9778f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3404],{48329:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,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":"eJztPO1yIzdyr4KbSpW9ypAiKWlX5lUqke2NvbmNpVrtxpVIOhmcaXKwmgHGAEYUrWJVftwb5A3u0fwkqW4Awxl+SNpd2dYm9I+1OPhq9AfQ3eju28jyiYmGZ9FbKMqcWzDRRRylYBItSiuUjIbR2wzYSTXKRcJCL3Z08orxPFdTwyoD2jCrWKIBm2yYidmMW2ZAXwPjho3yCkotpDVsrDSbgATNrZATlqqkKgAbpsJmrNSQwlhISJmxukpspcF02Y8ZSMbr6ZkwzFRJAsaMqzyf+eXTmNnMwafBVloaxlklxc8VsJ2dMPhSpDs7jMuUcbazU9LmLiud7+x0GW63/Q2Xcr/zGeO0pBjlQOMLPmMjYCbjGlIHP5czQkrMQPJRjju0GRSIIr9pN9SIiWzsfcQNpExJgj8A2mXfqylc42TNz0xYA/mYJVxKZRGAQqViLCBlNtOqmmTMZsKwd29e/5kJi/2YkjmBWuEySIGwtMOcULKGSshJ91yey7eiHLJ3Za54ymaq0uzk239dDLOK4beznZ1vYVRN2LtXOzsXX2bWlma4u8vLsqtKkDhfzkemm6hiN8WOZTp+FrNpBhpwVgIOuBGI3BRxmE7AGtqwZIkqZyxRSqdCIlPFrOQTYLIqRqBN7GigNDCBzKGBp7OOVZ3KAPu30+MfcKMFt112klcmrpdLhYbEItPg9IjZsKsvHCGe7yPvCTmJWcGvkITCsp8rkVzhtg3IFP/vOY1wtbNzWpWl0hZS9qPbwnBnB1u+hlxNGddA/RNVFEqykmtegCXRQTHBZg0/V2LBRnkecDE8lx3k3lkJw50d9kqmIvESBgy/MjX2fbuuKyIJu56WkCBfuK4N1CGjTTORZISTKXf0LHOeODA1mBISK66hPfFNzGY48bcgVYAgU1r8oqTlOZHjGrQVCc+bZEMAsauxXJPMl0pIG776Fdh/evIg9Ygonq8QtBSRVQhJLQbYNc8rMB6qacwyhOoNlBoMiZOfl+QxZRmISbZxPZ6+r4xtTcwq4wW3hsKvFahE6AVC25jnBpgYt3BZ8CtorMYUnac877KvZyyFMa9yGzOBHGd1BV32g7KMl2UuEo6nC4ooCg/H869DVPbs4AGRvCAan2h1LVLAgy4V4zFoFE5spCn8mAAd8llJA3B7JDk2o9NhidCJypVeZSH63MYjS5S0IG2XHV1zkRPwbrOGCZnkVQpslPPkKqY7IGYaT2mkygzwCokdv1MXvCgczgk/zECOXKgkwi+VXx6Pfg9Vigc2ns9BnrAxoJoWEaaJVS+1Y4UrIwqCiDEouMhjQlzM3qsRs8LmEKPAllzOYpZyCzGzcGNH6iZmSQbJFf2leSoUG1XWKuk2lmpVpmoqPS7HSlojflkjkaHlwzE6iNl+zJ7H7DBm/V7M+oOY9fdj1n8es/5hzAa9mA0GMRvsx2zw3IE1OPS45jWCmwD0Bw7L9vPBLp67r4UhycYD09Rn8LR1Bve7bGenlib89tNPP53L23PJ2HmEwnUeDdl5VHc5j2LXhmcmtvX97xv8sTd44X/O8OfzwaH/OaWu/X3/M8Ofg/65nPsFz+WAILG8KO+AApsfFQL/yzMRfqNF8Vs4z/AjHkRxaEBateDBhnlzL3u4FyGFFTw3m7cTejyhHS1AWtnUPm6K2HXzjqj5CW2nCQ+20DHpmuhYbTQFgScoBiu7P+j6m2Xz5t2yT2bvDXA+bevPcet4NL3Fo2nz/uvT6wkhYRmmT8PEiy4pAHQyb8aD7/CEsNCG6NNwcIg4wEtpMwKw9QntvgEONvgb3rX19jv9g86gN9hvYQBtI9ehKDpp2pnNZo+BPdR5/PKo8gQN1Wl2aL6OtSrWmB9kHSx6eZ2I/g4q+7+joj4KOiykaPeRYRE0ltria2rZVqV89oVxU4WhtXKG/Req2awBJjUhHGT9JpkSiQce+wSVbIQGXhdx0CFM7qbpbgOT+DFNO0XRWfqIPzuE+MbHouimaXep5wp13MeCpWnMVj+v/Z6mrCiKDZ/d99bn3aJY3UW3KDxspHx91SWnCulsm+XEd/i9RGUhEe2F7xQj9ByghwQbyJxbL0dLl00mpG/wTMWWOmiYVDnXcIN2qRFKut6PL2NBxBaaPdmxZAI6zxGhgn157LX3Z579cQvtCfDL/eNWdoaTHLGkMlYVTMMEbljJrQUtabJrnovUuZk69AFueFGiCbD71/Pz9B//YZccEGjjW+erSsVEoB9o969nR53/uljToypL0Ak3wHLAlUzMwCZddpZBXi5cUdPptDvdM0mmVO78UO+NhrH791KN3l8SuGWXm/LZup061mgY/Mg6y/a+AdvCGDcsjFxj8hOPkQz1e3TbenvnjuvW93hCN84SSNjovCfYfHYeFZwUEmRlWPytbAb6PLqoxzgjH9J7xl48QFgzkULOR5CvNj1Y0OrPOZ+pyst3cGq1t+o5uoE3bCiErP0WtJ1e3GjkN0uNrm2+Rr4dQprSGa6cIJ6BAiwXJnhu2uhsjvauLXI4SgDyYaLz2g9go5pLP1kKasAeJgbuJPK0u2cJ7MeoY+1WDKvds0KLME3E4ByFkKKoito/Oq5nDSgrvO7RxBeORGd/WKFJ3ZUV+M09K6AzcvMC57JPfozg/7hDM/U9ntBZsQTS3WL8MadI655+pAv2fgEM22oK4JprGbu6C7kWPrNZ+rrsGK839Mm6QehlSxIoLXrkPlU0a5AffEORz6rph9vMec1eT4j71oD1G3Og7/fYt89HMWlz958Ro7bAfjCzOqdkwSd3WO7U/ITY08Oz4oTY2TnRMBZ53nhSZOFTeNnBJx3IofDPXv4xEa86coQLaRWaBeHZdgRjei+19IzSfLd294wjafNN1D0QK80ybpz+TQo/kgofbPFxe8kVH0BbuOOFDHAjVfqPZzcOvuo16dR/ftCi00GvRafeJjrdYTYiBU2ppKl9bbBoasg1kTh8X71alsU2TIokfSnxbSVYD04YVJWnLBdX9KqSClPmfIZUDVLqoVx+rvsmU8osevgXsy/9hoftlzil8THuWbd+mHiIw2uJGA1a9F/sNUhxcHjYlpiWwDzEfl+st0qF3v5u/2DXebTWO7QWbpjNh/AdmgBjD6EX+YkeRC/quSDY1u30sW6nx2H3vce0uvsvBq3LYq/3sZfFoxvXTam5x6x+DOP50azYprg90H793ezIT+e+/d9Co+6/2Gty4Yv+I7hQNyjOn8qJK/rxo/EeeyzleB0DPkA7vlMl/mQGbQL7mzPpweNo0v1eS0P7qqWgfTVoMuXBwYOYsrnoEmedR+I/vj5+M+395buJOjo6Ovrh9F328t3k6OiowN/dbnetEbWO2rQMaq4+ItDfy3THb1il2+0iClNu+ZCG75Zy8mc3Pt48putfn38jz87BYzymrHHgfPopUHf947w1v52cf6oERnGkSgqSVvJVGg0jF4QcgoCjmExLMPZrlc6i4W3kw8bwTx+UhUN33xuM476NTJJBwfGvYJJi5PdY5DgVRj6BNlEcURwBhoEj10XDSI3eQ2KjGN+4SnREgME5aNzwNvRy4bJR7JXwaBg5ro/iyL/01J8YyETh222ZjqN5WPCuqeovi6kM/VFHROM8GJH6kdPQ0PlS5PtHzdScYb5A62IyrjWfRctB9iEUNbwjunF1rF0+C5eDsOgKqeMjqVsUR8JC0VxlA9G0+nBMJ6BwJxRj9KFjiSy8+OA1cVyZKflRA733YQ3OH4gl17q6cJtkRxjkCGnQSjuLaN2YUcRc9z6OCf1pt3zSXNO9Eays+XZTFHcjeNRkZIrysgSuuxRM/dFx+pTXwfOkoqyD+lhs7awGtd5Zfx5HN/dv5oYlqhNCxNmXOYyte9JlidIS9LNmnMiT2dxgf38eR7P7tzf7LLf3Aok3vX93P1Js/SLv4I+Ade9wHkfZ/bB+X0f//4HA7j+fL+66yGUr1flII5XOLsO5Nb+vY7hUsB/morySxzoF3UDESKkcuFzBxKux864r9gVaHF/ELpCCgraFNuFCYVN0MGtIABNAKL4qnFXM6xwuopv5QFp0yr/ED6QmmWpksJcM8xk34QiY1WIyAfQ5+x402IelA08yTK7x4R18HLxspYZroSoTwENHNAb75WAp5QmErhOXWlZRAzvk7m7uvdukDn7BSw4ztuD47ckDcEkmW8clWrl72u3SzcGO355gKowYezWsy96ZGhMBtbzVhaFaxK4FD+Hy9dk+c4/P4PyOyuWONX30XZ+E0mGrAKXCrIUodil8GKdfJ/GtTLzIlUISqcqiz1/4DABjoTQtPBIUNSLfquohXHkPJjmbVBTrZ1FkQ14MhfssUlmEdMmCpO+nlQ7ZO54tsCcm7i3wFLCCnRrzY9aeccM5G3NjMfeukgIxryvU7usp4aYELUAmsBYFGhzqMInwfm2inRfy7s1rnyEX9hCEcoQS6CaGlFUlcQ1JQp2vFCi3vPUVRQmlA/TlJgVtVfWgrCLviihBGyXRXFF6wqX4xbEwaSRo7Ywg47nr6o8KdFkjPCjhbWDCWfvr3/7egGujxrkKmFuBpykGo90DIZl0juFR49ZQ4gmo2hDhfKD/ZfkSQOhIaC5dwqUTJPNwHj+h8DVTn4v+Da1+vzNVkqGCX5+3Jg5nrPFqpSEbkQxJeoQrcb9wI4xtZNyEuNjV8+ENIB6TBgykhqBUI8/LWVPAF++Kamk6ygsS7Wyt+hpckQVeWXWpoRDyYfdU0ytmVX0QVFYV3IqEhalMt52D555eglwX7MsAGnLjtVD62QZRxekulUzgUshLTLh9gIL3Qx3Hk/IZMredAsgmbAFJ7jpb5ElNKZe5iZPG7UTZgE0oD9A8cI+n62yXuw3JwA/uKqFc22KEj/juGRhFjQ4OtbAl28bQ52JN+ffQrS31GRkb/V7v/7Ittdf7fGyp/d5nZEsdIrDefXr/AbRJv1l7dgR38N0D3ity2pAj9+6e6GWdx7Xzeh2CF+IwmLv/FuZfOPfvMQmdzbhw63pzJmyG0DDo9fB/S4dgqCjhy2e0amr8KYof7lO+5xJYVN64G19H14cnRSmLJKOTvC7DcfeoJrP5r8Rnbjyy3j8HCET6T+01CjCmfWGsWcAXQLF3o6tJJSFzIeEykOByyXnvyLy/jianqgCbkTKHavxUK6xDUeaAmQ5WzxifcCEZTqMfkUSg9X3M/GGQ3YWN/V7vsl8j4WAVCa8kxddTJZe36grk77vT5vLWLY+g3hT54kSJhOtE7VFrs83vbpMGkkoLO4uGZ7fRTYeXouPah2cX8wvkQpspeuRRhiDmNouG0e7Kmw8V1MEXhbPbiOSiZn7DZYrBCyunLS/F7nW/24/m8fKYtafzHf2h6nzoEGP5RMjJfeMuFjg6RTo6UrUwtdBAS/EXQBXUE6LZK44E8k8GHE0NRD2yx5vFS9nLQOTwhrXuWWpBzOWHpvDO1Ho6Wr4l1zwGNd6CzsJDDL2t1E8r0WJDUf38gX/WKvjZgmXrt4Og7vZJTxzs75NC9aJPmsfeIV3q+8/nFw7BDWchxaI2PV4u7KLluvGf2q6MKFpyHbTs92XzfaMpvcGS9ksuWYw1IOsMtYOWfbQGW+F+b+MKAxMQV3s9wtV+j3B12GupFn6HixkWCgJpAbUSQDd986LH2/wC+U/IsSLm9Rx1XII8RT8bHi7E/CsKIeSJKup6GmHAr3/7O40JVrjzZ+AMf8J4jeNKs1JNQY8rV5xjnMMNVarCQVBQm6FXRIqy5kUOxuDTorQwobpUlHOHjj3vOkp4yUciF3hyukhiCklsHL6uMhe+8mPTF9qlIF5DjgdubbE3qnyxqdJXYywdFjPORlhnB302IDMuE+cecqcAuTnQXkXXW6mFwfJBGqEWDjYlreaJZQWXfEJ+iriFqhRygUcl02qE3lOj8sr5By0XudIugIw2RC/8FPTy8qbEJtJo0bGmIUO+vfZOQhM7J60TcF+AaoT+8BJhEQmQr6SSucJaUehXr/Kclco6Xzcqzk0YcbjVXBrUdh0sgQY1wrz/DoyPsn5nACn8WsgrV9+kw85qnvoRRkZYaGc/Lsves/aY74T9vhph9SRlhFV6thg9ETarRnRUNyepf7iZvgt1zRoH8WKOVCVmjQmgErOLiZq7p2CRQ8zu0ckruuqfsV//+3/Ya+BaskxNHbcmlYZ81i6h5ijv0Fbf1OQh5hWWD7PEpHISHi1qDJYUaCuc8HgcLql4Q3bkq741tD6XnxWUP6qX5iLo0WnPWS7kVZcd+QJw7lEDeQC/02BfI68u/9aIyycDVthGxbfaR4kleSAVIb+0VQOOYk3aKQHD9SkC6PbxGfMb0wF8XTdamUrhzWgsr8sQebfiosIPyJRqeZkhSzUf20VFu3i1wtyaTyH3IGwr9tPUZQSdiC1RwnQZxccsqQftU1TDGKjMnWnX3iuFZ5SzwHCsnTD84QzrjEFpeULKabj6eCnWupCxlJk5Hp+CvhZJsF82yOoudd6N4igXCXjL1N9KR9+dvGbXbK/bi+KG1vUAud19/eqblz+cvkRo8Ix0GOt3e90e2V3K2ILLxlJLFSCXr6xG8NG2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOSTwu62YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YORTOSu2BSOfSh2+bcHI34MDtwUjtwUjtwUjtwUjtwUjtwUjtwUjtwUjP9h5tS0YuS0YuS0YuS0YuS0YuS0YuS0Y+f+0YGQj4Wm3zLmgvESfPutSCs+Wy0hexFGGOYfDs+j2Fjnvnc7nc/z8c0XpVWcXcXTNtcCILUpXjEN2HaZYXcEsGkbfuAC0zltcP3aEpgD4pSxNTA90I45o73f2baZFnhyfvo3iaORLXRYqpexqPsWULD51WWmNvC36dhvlXE4qyvmK3JxzV40ka2cTXlE2of+jkTjG5awBYTvN0G0D/8VNrR1we+syFefzur9r2jjCIzb0RvpdzOfz/wUKzNWC","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"}}');var i=t(74848),r=t(28453),l=t(33617),o=t.n(l),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"publictemplate",title:"Public Template",description:"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.",sidebar_label:"Public Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPO1yIzdyr4KbSpW9ypAiKWlX5lUqke2NvbmNpVrtxpVIOhmcaXKwmgHGAEYUrWJVftwb5A3u0fwkqW4Awxl+SNpd2dYm9I+1OPhq9AfQ3eju28jyiYmGZ9FbKMqcWzDRRRylYBItSiuUjIbR2wzYSTXKRcJCL3Z08orxPFdTwyoD2jCrWKIBm2yYidmMW2ZAXwPjho3yCkotpDVsrDSbgATNrZATlqqkKgAbpsJmrNSQwlhISJmxukpspcF02Y8ZSMbr6ZkwzFRJAsaMqzyf+eXTmNnMwafBVloaxlklxc8VsJ2dMPhSpDs7jMuUcbazU9LmLiud7+x0GW63/Q2Xcr/zGeO0pBjlQOMLPmMjYCbjGlIHP5czQkrMQPJRjju0GRSIIr9pN9SIiWzsfcQNpExJgj8A2mXfqylc42TNz0xYA/mYJVxKZRGAQqViLCBlNtOqmmTMZsKwd29e/5kJi/2YkjmBWuEySIGwtMOcULKGSshJ91yey7eiHLJ3Za54ymaq0uzk239dDLOK4beznZ1vYVRN2LtXOzsXX2bWlma4u8vLsqtKkDhfzkemm6hiN8WOZTp+FrNpBhpwVgIOuBGI3BRxmE7AGtqwZIkqZyxRSqdCIlPFrOQTYLIqRqBN7GigNDCBzKGBp7OOVZ3KAPu30+MfcKMFt112klcmrpdLhYbEItPg9IjZsKsvHCGe7yPvCTmJWcGvkITCsp8rkVzhtg3IFP/vOY1wtbNzWpWl0hZS9qPbwnBnB1u+hlxNGddA/RNVFEqykmtegCXRQTHBZg0/V2LBRnkecDE8lx3k3lkJw50d9kqmIvESBgy/MjX2fbuuKyIJu56WkCBfuK4N1CGjTTORZISTKXf0LHOeODA1mBISK66hPfFNzGY48bcgVYAgU1r8oqTlOZHjGrQVCc+bZEMAsauxXJPMl0pIG776Fdh/evIg9Ygonq8QtBSRVQhJLQbYNc8rMB6qacwyhOoNlBoMiZOfl+QxZRmISbZxPZ6+r4xtTcwq4wW3hsKvFahE6AVC25jnBpgYt3BZ8CtorMYUnac877KvZyyFMa9yGzOBHGd1BV32g7KMl2UuEo6nC4ooCg/H869DVPbs4AGRvCAan2h1LVLAgy4V4zFoFE5spCn8mAAd8llJA3B7JDk2o9NhidCJypVeZSH63MYjS5S0IG2XHV1zkRPwbrOGCZnkVQpslPPkKqY7IGYaT2mkygzwCokdv1MXvCgczgk/zECOXKgkwi+VXx6Pfg9Vigc2ns9BnrAxoJoWEaaJVS+1Y4UrIwqCiDEouMhjQlzM3qsRs8LmEKPAllzOYpZyCzGzcGNH6iZmSQbJFf2leSoUG1XWKuk2lmpVpmoqPS7HSlojflkjkaHlwzE6iNl+zJ7H7DBm/V7M+oOY9fdj1n8es/5hzAa9mA0GMRvsx2zw3IE1OPS45jWCmwD0Bw7L9vPBLp67r4UhycYD09Rn8LR1Bve7bGenlib89tNPP53L23PJ2HmEwnUeDdl5VHc5j2LXhmcmtvX97xv8sTd44X/O8OfzwaH/OaWu/X3/M8Ofg/65nPsFz+WAILG8KO+AApsfFQL/yzMRfqNF8Vs4z/AjHkRxaEBateDBhnlzL3u4FyGFFTw3m7cTejyhHS1AWtnUPm6K2HXzjqj5CW2nCQ+20DHpmuhYbTQFgScoBiu7P+j6m2Xz5t2yT2bvDXA+bevPcet4NL3Fo2nz/uvT6wkhYRmmT8PEiy4pAHQyb8aD7/CEsNCG6NNwcIg4wEtpMwKw9QntvgEONvgb3rX19jv9g86gN9hvYQBtI9ehKDpp2pnNZo+BPdR5/PKo8gQN1Wl2aL6OtSrWmB9kHSx6eZ2I/g4q+7+joj4KOiykaPeRYRE0ltria2rZVqV89oVxU4WhtXKG/Req2awBJjUhHGT9JpkSiQce+wSVbIQGXhdx0CFM7qbpbgOT+DFNO0XRWfqIPzuE+MbHouimaXep5wp13MeCpWnMVj+v/Z6mrCiKDZ/d99bn3aJY3UW3KDxspHx91SWnCulsm+XEd/i9RGUhEe2F7xQj9ByghwQbyJxbL0dLl00mpG/wTMWWOmiYVDnXcIN2qRFKut6PL2NBxBaaPdmxZAI6zxGhgn157LX3Z579cQvtCfDL/eNWdoaTHLGkMlYVTMMEbljJrQUtabJrnovUuZk69AFueFGiCbD71/Pz9B//YZccEGjjW+erSsVEoB9o969nR53/uljToypL0Ak3wHLAlUzMwCZddpZBXi5cUdPptDvdM0mmVO78UO+NhrH791KN3l8SuGWXm/LZup061mgY/Mg6y/a+AdvCGDcsjFxj8hOPkQz1e3TbenvnjuvW93hCN84SSNjovCfYfHYeFZwUEmRlWPytbAb6PLqoxzgjH9J7xl48QFgzkULOR5CvNj1Y0OrPOZ+pyst3cGq1t+o5uoE3bCiErP0WtJ1e3GjkN0uNrm2+Rr4dQprSGa6cIJ6BAiwXJnhu2uhsjvauLXI4SgDyYaLz2g9go5pLP1kKasAeJgbuJPK0u2cJ7MeoY+1WDKvds0KLME3E4ByFkKKoito/Oq5nDSgrvO7RxBeORGd/WKFJ3ZUV+M09K6AzcvMC57JPfozg/7hDM/U9ntBZsQTS3WL8MadI655+pAv2fgEM22oK4JprGbu6C7kWPrNZ+rrsGK839Mm6QehlSxIoLXrkPlU0a5AffEORz6rph9vMec1eT4j71oD1G3Og7/fYt89HMWlz958Ro7bAfjCzOqdkwSd3WO7U/ITY08Oz4oTY2TnRMBZ53nhSZOFTeNnBJx3IofDPXv4xEa86coQLaRWaBeHZdgRjei+19IzSfLd294wjafNN1D0QK80ybpz+TQo/kgofbPFxe8kVH0BbuOOFDHAjVfqPZzcOvuo16dR/ftCi00GvRafeJjrdYTYiBU2ppKl9bbBoasg1kTh8X71alsU2TIokfSnxbSVYD04YVJWnLBdX9KqSClPmfIZUDVLqoVx+rvsmU8osevgXsy/9hoftlzil8THuWbd+mHiIw2uJGA1a9F/sNUhxcHjYlpiWwDzEfl+st0qF3v5u/2DXebTWO7QWbpjNh/AdmgBjD6EX+YkeRC/quSDY1u30sW6nx2H3vce0uvsvBq3LYq/3sZfFoxvXTam5x6x+DOP50azYprg90H793ezIT+e+/d9Co+6/2Gty4Yv+I7hQNyjOn8qJK/rxo/EeeyzleB0DPkA7vlMl/mQGbQL7mzPpweNo0v1eS0P7qqWgfTVoMuXBwYOYsrnoEmedR+I/vj5+M+395buJOjo6Ovrh9F328t3k6OiowN/dbnetEbWO2rQMaq4+ItDfy3THb1il2+0iClNu+ZCG75Zy8mc3Pt48putfn38jz87BYzymrHHgfPopUHf947w1v52cf6oERnGkSgqSVvJVGg0jF4QcgoCjmExLMPZrlc6i4W3kw8bwTx+UhUN33xuM476NTJJBwfGvYJJi5PdY5DgVRj6BNlEcURwBhoEj10XDSI3eQ2KjGN+4SnREgME5aNzwNvRy4bJR7JXwaBg5ro/iyL/01J8YyETh222ZjqN5WPCuqeovi6kM/VFHROM8GJH6kdPQ0PlS5PtHzdScYb5A62IyrjWfRctB9iEUNbwjunF1rF0+C5eDsOgKqeMjqVsUR8JC0VxlA9G0+nBMJ6BwJxRj9KFjiSy8+OA1cVyZKflRA733YQ3OH4gl17q6cJtkRxjkCGnQSjuLaN2YUcRc9z6OCf1pt3zSXNO9Eays+XZTFHcjeNRkZIrysgSuuxRM/dFx+pTXwfOkoqyD+lhs7awGtd5Zfx5HN/dv5oYlqhNCxNmXOYyte9JlidIS9LNmnMiT2dxgf38eR7P7tzf7LLf3Aok3vX93P1Js/SLv4I+Ade9wHkfZ/bB+X0f//4HA7j+fL+66yGUr1flII5XOLsO5Nb+vY7hUsB/morySxzoF3UDESKkcuFzBxKux864r9gVaHF/ELpCCgraFNuFCYVN0MGtIABNAKL4qnFXM6xwuopv5QFp0yr/ED6QmmWpksJcM8xk34QiY1WIyAfQ5+x402IelA08yTK7x4R18HLxspYZroSoTwENHNAb75WAp5QmErhOXWlZRAzvk7m7uvdukDn7BSw4ztuD47ckDcEkmW8clWrl72u3SzcGO355gKowYezWsy96ZGhMBtbzVhaFaxK4FD+Hy9dk+c4/P4PyOyuWONX30XZ+E0mGrAKXCrIUodil8GKdfJ/GtTLzIlUISqcqiz1/4DABjoTQtPBIUNSLfquohXHkPJjmbVBTrZ1FkQ14MhfssUlmEdMmCpO+nlQ7ZO54tsCcm7i3wFLCCnRrzY9aeccM5G3NjMfeukgIxryvU7usp4aYELUAmsBYFGhzqMInwfm2inRfy7s1rnyEX9hCEcoQS6CaGlFUlcQ1JQp2vFCi3vPUVRQmlA/TlJgVtVfWgrCLviihBGyXRXFF6wqX4xbEwaSRo7Ywg47nr6o8KdFkjPCjhbWDCWfvr3/7egGujxrkKmFuBpykGo90DIZl0juFR49ZQ4gmo2hDhfKD/ZfkSQOhIaC5dwqUTJPNwHj+h8DVTn4v+Da1+vzNVkqGCX5+3Jg5nrPFqpSEbkQxJeoQrcb9wI4xtZNyEuNjV8+ENIB6TBgykhqBUI8/LWVPAF++Kamk6ygsS7Wyt+hpckQVeWXWpoRDyYfdU0ytmVX0QVFYV3IqEhalMt52D555eglwX7MsAGnLjtVD62QZRxekulUzgUshLTLh9gIL3Qx3Hk/IZMredAsgmbAFJ7jpb5ElNKZe5iZPG7UTZgE0oD9A8cI+n62yXuw3JwA/uKqFc22KEj/juGRhFjQ4OtbAl28bQ52JN+ffQrS31GRkb/V7v/7Ittdf7fGyp/d5nZEsdIrDefXr/AbRJv1l7dgR38N0D3ity2pAj9+6e6GWdx7Xzeh2CF+IwmLv/FuZfOPfvMQmdzbhw63pzJmyG0DDo9fB/S4dgqCjhy2e0amr8KYof7lO+5xJYVN64G19H14cnRSmLJKOTvC7DcfeoJrP5r8Rnbjyy3j8HCET6T+01CjCmfWGsWcAXQLF3o6tJJSFzIeEykOByyXnvyLy/jianqgCbkTKHavxUK6xDUeaAmQ5WzxifcCEZTqMfkUSg9X3M/GGQ3YWN/V7vsl8j4WAVCa8kxddTJZe36grk77vT5vLWLY+g3hT54kSJhOtE7VFrs83vbpMGkkoLO4uGZ7fRTYeXouPah2cX8wvkQpspeuRRhiDmNouG0e7Kmw8V1MEXhbPbiOSiZn7DZYrBCyunLS/F7nW/24/m8fKYtafzHf2h6nzoEGP5RMjJfeMuFjg6RTo6UrUwtdBAS/EXQBXUE6LZK44E8k8GHE0NRD2yx5vFS9nLQOTwhrXuWWpBzOWHpvDO1Ho6Wr4l1zwGNd6CzsJDDL2t1E8r0WJDUf38gX/WKvjZgmXrt4Og7vZJTxzs75NC9aJPmsfeIV3q+8/nFw7BDWchxaI2PV4u7KLluvGf2q6MKFpyHbTs92XzfaMpvcGS9ksuWYw1IOsMtYOWfbQGW+F+b+MKAxMQV3s9wtV+j3B12GupFn6HixkWCgJpAbUSQDd986LH2/wC+U/IsSLm9Rx1XII8RT8bHi7E/CsKIeSJKup6GmHAr3/7O40JVrjzZ+AMf8J4jeNKs1JNQY8rV5xjnMMNVarCQVBQm6FXRIqy5kUOxuDTorQwobpUlHOHjj3vOkp4yUciF3hyukhiCklsHL6uMhe+8mPTF9qlIF5DjgdubbE3qnyxqdJXYywdFjPORlhnB302IDMuE+cecqcAuTnQXkXXW6mFwfJBGqEWDjYlreaJZQWXfEJ+iriFqhRygUcl02qE3lOj8sr5By0XudIugIw2RC/8FPTy8qbEJtJo0bGmIUO+vfZOQhM7J60TcF+AaoT+8BJhEQmQr6SSucJaUehXr/Kclco6Xzcqzk0YcbjVXBrUdh0sgQY1wrz/DoyPsn5nACn8WsgrV9+kw85qnvoRRkZYaGc/Lsves/aY74T9vhph9SRlhFV6thg9ETarRnRUNyepf7iZvgt1zRoH8WKOVCVmjQmgErOLiZq7p2CRQ8zu0ckruuqfsV//+3/Ya+BaskxNHbcmlYZ81i6h5ijv0Fbf1OQh5hWWD7PEpHISHi1qDJYUaCuc8HgcLql4Q3bkq741tD6XnxWUP6qX5iLo0WnPWS7kVZcd+QJw7lEDeQC/02BfI68u/9aIyycDVthGxbfaR4kleSAVIb+0VQOOYk3aKQHD9SkC6PbxGfMb0wF8XTdamUrhzWgsr8sQebfiosIPyJRqeZkhSzUf20VFu3i1wtyaTyH3IGwr9tPUZQSdiC1RwnQZxccsqQftU1TDGKjMnWnX3iuFZ5SzwHCsnTD84QzrjEFpeULKabj6eCnWupCxlJk5Hp+CvhZJsF82yOoudd6N4igXCXjL1N9KR9+dvGbXbK/bi+KG1vUAud19/eqblz+cvkRo8Ix0GOt3e90e2V3K2ILLxlJLFSCXr6xG8NG2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOSTwu62YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YOS2YORTOSu2BSOfSh2+bcHI34MDtwUjtwUjtwUjtwUjtwUjtwUjtwUjtwUjP9h5tS0YuS0YuS0YuS0YuS0YuS0YuS0Y+f+0YGQj4Wm3zLmgvESfPutSCs+Wy0hexFGGOYfDs+j2Fjnvnc7nc/z8c0XpVWcXcXTNtcCILUpXjEN2HaZYXcEsGkbfuAC0zltcP3aEpgD4pSxNTA90I45o73f2baZFnhyfvo3iaORLXRYqpexqPsWULD51WWmNvC36dhvlXE4qyvmK3JxzV40ka2cTXlE2of+jkTjG5awBYTvN0G0D/8VNrR1we+syFefzur9r2jjCIzb0RvpdzOfz/wUKzNWC",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"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:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{template_id:{type:"string",example:"Av8Pmpnmch"},public_url:{type:"string",example:"https://app.example.com/publicsign?templateid=Av8Pmpnmch"},message:{type:"string",example:"Public template created successfully!"}},title:"inline_response_publictemplate"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.9f7fe758.js b/assets/js/138cee78.9f7fe758.js new file mode 100644 index 000000000..dd2e94156 --- /dev/null +++ b/assets/js/138cee78.9f7fe758.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>T,metadata:()=>n,toc:()=>h});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":"eJzVWM1u3EYSfpVKX7IRqPmRnAThKVrD8Apr2EKkQEDkgVEka8i2mt2d7ub8YDBADnmDnHLdR/OTLKpJznBGshNhAwcLGMaouqq6/utrbkTA0ov0Tjw3OmAevJgloiCfO2mDNFqk4qYieO4IA0HHBBdXl4BKmaWHtWkgGKD53LigyHu1hrzl1rSEvFMLocIAOWpgefTgZanJeZgbxzocyNoaF1AHKEze1KSDH4lEGEsO2ZLLQqSi1dwpFYlw9HNDPvzTFGuRbo4Mv3JmIQuCjJRZgkWHNQVybG5n4V4R/yIdWAlaq2Qe7xy/96xpI3xeUY38i2+UjgqOGdUolUiExpo4bmFtSaTCZO8pKrWOrQ+SPEtGrnTTc/ngpC5FIubG1RiGFFphbRUzvTdsPolt0l32dPmM6PuOMMpNzapsZfSTTZmenZ9Nz6fnZ1Ox3SYiyBDJBxl5l3Eitny+j1NwDUWCt0b7NhZnk8nDfPXV1aoswDd5Tt7PG6XWXzwlR5/OQ0vmcnpaAGw1zarV2XvLIfw/T+az6fn0LP5jFV3AL8JjavZCZ5Oz89Pp5HTy7c30m/TZd+nX34wmk8lPIhGrWu1LXBQYopd9jfR/N7b4DPdsj9m64iwooFR+KND3/zaW7LPHivLa1BQqqUtYkg6wdEaXCVhF6AmCWwOWKDUoDOT+wiIl54z7dJieZtmwZ6VWUtO7viPfPZtM3k13QZh+vDNROcJiDbSSPvjP6+7HbPi0Y9OBY18/dOxSL1DJIi60G3NP+vP6NLw+tNc/LF/ZMsVzceDskN466SlvnAxrkd5txOoUrTxtz9O72XaWCK4Yw4vUGh8txlCJVIyP96ontyDno5rGKZGKKgTr0/HYoy4ysxoZS5p3uMLM8ygao5XjxXTEA+VYBq19Ej81p08V8QFLqcs/kpvtQ3TNaWwzdRCoXb7Qyn/Tul/v6QFXIiSXT0VYkIs54+r4YY9GXvQ53qWxn/674f/YPN+N84N1y7fNTTSty/0bS/paljpWTnTtGLXdkspNTQx2QkXQC3z49T9RpsdYsbSjhi/e6rf6TePAmiW5eaMAdQFzRSuZKYpCVMezHejzhHUH+aQOVDrGVIUsZUAVAR4PpxwtZlJJbgtmMy3cG3SWH8FtRaGiiAS/dAQIBS1IcTcBNsHUGFhVbzQsjbufM/xMACFrvNTkPZCuUOfM2Oc4AeMANZAO5KyTnsAHx1bL1jajg+OhUqPGklh3chCqgpTkRgBnssYH8EY10WTgXWIcFdA7pIkKP+IgvlhZPgKm5qa2jiouyAVB2ciCfAK5KQh8TDu7oAvIyAewbIvMybPSRiuT38fkMQICa3goSVRg5gc2snhwqD0v/NaWPge7gFlnGEpRa+DJyY+eOMOvpL736cnJW30Kd7uauqXMy0Czf/TNtVwuHzTVV4cyL2X4V5PBD2SNl8G49V66lKFqstiIQyW7P1pNL0lTrJ9Bm+11FCb3D/uaqeOKlB1fU+AK8eOLq8s4x7+CD7/8Bq8InYbKLNtqzRtHag1lfxVHrs18G7bdGI6vEmxCxRHP2+Lrnhp9BG8rDB9++d3Da1qCbFuoDeTJyVWTKZnDDdWWt68/OUn7F1ToafsHUUbgK+RSWkgEBNtKK6nvR3Ch19B4crCUoYrFwPQod+AGx2X/cIIMPRVgdJTo7xztLWJ67UktyLMubQKbQYVk3B0qZ5qyvW1oTOeco7lUCm5lUVKIvl0UBdiOvGzJHPCBOTTnhggVrQEdgScdRnB1JBJPGsvPQCo4prH2Db8zOQGkC2ukDj6FwuF88E5M9oUeF5k0+hFSG0LchSPp1OxS0nZi5/GOOnrL4/5oRRzOWkdzcnxhdHufFyu7crrryxK4Wv+Xso5wvVvTjDG6VYJWfn+sJ2IFcrV/M78mt5A5dfvyIx09jsxjkQglc9J+uLwuXl69gsX5aCKSweL9E809fnX5/MXr6xdsDA/SNmDT0WQ0iY8X40ONenDT4ZeG47W22YOzv/m7RAcSAq3C2CqUEZrF0Gw6VHV39LViloiKUVd6JzYbbtAfndpumfxzQ44h2ywRC3QSM97xd7Nt0gMMhmH3tO5QMOlwesPXM7tqWqxyhFMZIbUSF3lONnySdwgMr95c34hEZN0XldoULONwyV9bcClSET/KxCUYv4cwbSMU6rLBMgKdqJMxEU/QQ0B1HwFV94O96o/0emDhIdJq3eD/2alHBTabFqxttzv+9uijEl1ge25O32y73f4XoAGnxg==","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 account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var o=a(74848),s=a(28453),r=a(33617),c=a.n(r),i=a(17543),l=a.n(i),p=a(86013),d=a.n(p),m=a(63723),g=a.n(m),u=(a(18766),a(79329),a(9303));const T={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:"eJzVWM1u3EYSfpVKX7IRqPmRnAThKVrD8Apr2EKkQEDkgVEka8i2mt2d7ub8YDBADnmDnHLdR/OTLKpJznBGshNhAwcLGMaouqq6/utrbkTA0ov0Tjw3OmAevJgloiCfO2mDNFqk4qYieO4IA0HHBBdXl4BKmaWHtWkgGKD53LigyHu1hrzl1rSEvFMLocIAOWpgefTgZanJeZgbxzocyNoaF1AHKEze1KSDH4lEGEsO2ZLLQqSi1dwpFYlw9HNDPvzTFGuRbo4Mv3JmIQuCjJRZgkWHNQVybG5n4V4R/yIdWAlaq2Qe7xy/96xpI3xeUY38i2+UjgqOGdUolUiExpo4bmFtSaTCZO8pKrWOrQ+SPEtGrnTTc/ngpC5FIubG1RiGFFphbRUzvTdsPolt0l32dPmM6PuOMMpNzapsZfSTTZmenZ9Nz6fnZ1Ox3SYiyBDJBxl5l3Eitny+j1NwDUWCt0b7NhZnk8nDfPXV1aoswDd5Tt7PG6XWXzwlR5/OQ0vmcnpaAGw1zarV2XvLIfw/T+az6fn0LP5jFV3AL8JjavZCZ5Oz89Pp5HTy7c30m/TZd+nX34wmk8lPIhGrWu1LXBQYopd9jfR/N7b4DPdsj9m64iwooFR+KND3/zaW7LPHivLa1BQqqUtYkg6wdEaXCVhF6AmCWwOWKDUoDOT+wiIl54z7dJieZtmwZ6VWUtO7viPfPZtM3k13QZh+vDNROcJiDbSSPvjP6+7HbPi0Y9OBY18/dOxSL1DJIi60G3NP+vP6NLw+tNc/LF/ZMsVzceDskN466SlvnAxrkd5txOoUrTxtz9O72XaWCK4Yw4vUGh8txlCJVIyP96ontyDno5rGKZGKKgTr0/HYoy4ysxoZS5p3uMLM8ygao5XjxXTEA+VYBq19Ej81p08V8QFLqcs/kpvtQ3TNaWwzdRCoXb7Qyn/Tul/v6QFXIiSXT0VYkIs54+r4YY9GXvQ53qWxn/674f/YPN+N84N1y7fNTTSty/0bS/paljpWTnTtGLXdkspNTQx2QkXQC3z49T9RpsdYsbSjhi/e6rf6TePAmiW5eaMAdQFzRSuZKYpCVMezHejzhHUH+aQOVDrGVIUsZUAVAR4PpxwtZlJJbgtmMy3cG3SWH8FtRaGiiAS/dAQIBS1IcTcBNsHUGFhVbzQsjbufM/xMACFrvNTkPZCuUOfM2Oc4AeMANZAO5KyTnsAHx1bL1jajg+OhUqPGklh3chCqgpTkRgBnssYH8EY10WTgXWIcFdA7pIkKP+IgvlhZPgKm5qa2jiouyAVB2ciCfAK5KQh8TDu7oAvIyAewbIvMybPSRiuT38fkMQICa3goSVRg5gc2snhwqD0v/NaWPge7gFlnGEpRa+DJyY+eOMOvpL736cnJW30Kd7uauqXMy0Czf/TNtVwuHzTVV4cyL2X4V5PBD2SNl8G49V66lKFqstiIQyW7P1pNL0lTrJ9Bm+11FCb3D/uaqeOKlB1fU+AK8eOLq8s4x7+CD7/8Bq8InYbKLNtqzRtHag1lfxVHrs18G7bdGI6vEmxCxRHP2+Lrnhp9BG8rDB9++d3Da1qCbFuoDeTJyVWTKZnDDdWWt68/OUn7F1ToafsHUUbgK+RSWkgEBNtKK6nvR3Ch19B4crCUoYrFwPQod+AGx2X/cIIMPRVgdJTo7xztLWJ67UktyLMubQKbQYVk3B0qZ5qyvW1oTOeco7lUCm5lUVKIvl0UBdiOvGzJHPCBOTTnhggVrQEdgScdRnB1JBJPGsvPQCo4prH2Db8zOQGkC2ukDj6FwuF88E5M9oUeF5k0+hFSG0LchSPp1OxS0nZi5/GOOnrL4/5oRRzOWkdzcnxhdHufFyu7crrryxK4Wv+Xso5wvVvTjDG6VYJWfn+sJ2IFcrV/M78mt5A5dfvyIx09jsxjkQglc9J+uLwuXl69gsX5aCKSweL9E809fnX5/MXr6xdsDA/SNmDT0WQ0iY8X40ONenDT4ZeG47W22YOzv/m7RAcSAq3C2CqUEZrF0Gw6VHV39LViloiKUVd6JzYbbtAfndpumfxzQ44h2ywRC3QSM97xd7Nt0gMMhmH3tO5QMOlwesPXM7tqWqxyhFMZIbUSF3lONnySdwgMr95c34hEZN0XldoULONwyV9bcClSET/KxCUYv4cwbSMU6rLBMgKdqJMxEU/QQ0B1HwFV94O96o/0emDhIdJq3eD/2alHBTabFqxttzv+9uijEl1ge25O32y73f4XoAGnxg==",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={},h=[];function v(t){const e={p:"p",...(0,s.R)(),...t.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)(c(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.jsx)(e.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,o.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{title:"Body",body:{description:"Provide below parameter to create contact",content:{"application/json":{schema:{required:["email","name"],type:"object",properties:{name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"1232131321"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,o.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(v,{...t})}):v(t)}}}]); \ No newline at end of file diff --git a/assets/js/138cee78.d0313598.js b/assets/js/138cee78.d0313598.js deleted file mode 100644 index bbb0f5661..000000000 --- a/assets/js/138cee78.d0313598.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1679],{92338:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>G,contentTitle:()=>u,default:()=>P,frontMatter:()=>g,metadata:()=>n,toc:()=>b});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":"eJzVWGtuHLkRvkot/yRrtOYheTdI/1rFMLxCjLWw0sJAZMGo7q6ZpsUmuWT1PDAYID9yg9wgR9uTBMXunpdkJ0ICBwEEYZqsKta7PnKjGOdR5XfqlbOMJUd1n6mKYhm0Z+2sytVtTfAqEDJBTwSX11eAxrhlhLVrgR3QbOYCG4rRrKHsqC0toezFAtfIUKIF4ccIUc8thQgzF0RGAN14FxgtQ+XKtiHLcaQy5TwFFE2uKpWrTnIvVGUq0K8tRf6Tq9Yq35wofh3cQlcEBRm3BI8BG2IKom6v4V6Q/CLLIgS9N7pMZ44/RZG0UbGsqUH5JSfqQJX4jBrURmXKYkPiN157UrlyxSdKQn0Q7VlTFM5ElW8GqshB27nK1MyFBvlwhVbYeCNEn5yoT2qb9Yc9n78g+qFfGJWuEVG+dvbZqkzPL86nF9OL86nabjPFmtPyUUQ+FhKIrezv/cShpbQQvbOx88X5ZPI4XkN2dSIriG1ZUoyz1pj1N8+J0Zfj0C1LOj3PAb6eFvXq/JMXF/6fB/Pl9GJ6nv5ERO/wS35KzJ7pfHJ+cTadnE3+cDv9Pn/5x/y770eTyeQvKlOrxuxTXFXIycohR4bv1ldf4ZztKVmfnBUxahMPGYb636aUfflUUt64hrjWdg5LsgzL4Ow8A28IIwGHNeActQWDTOG/mKQUggtfdtPzNDusWW2NtvRxqMiPLyeTj9OdE6afr0w0gbBaA6105Ph1zf2cDl82bHpg2HePDbuyCzS6SgPt1j2Q/bo2HR7P3fGP01d3RGlfHRl7uN4ZGalsg+a1yu82anWGXp91+/nd/fY+U5IxTgapdzFpjFyrXI1P52qksKAQk5g2GJWrmtnHfDyOaKvCrUbOk5UZbrCI0orG6PV4MR1JQznlQe+fRU/t2XNZIuNc2/m/4rvfu+hGwthF6shRu3ih13+m9TDe8yOqTGlJn5qwopBiJtnx8x6NvB5ivAvj0P13zf+pfr5r50fjVk6buaRaH/t3nuyNntuUOcm0U9T2nkzpGhKwwzXBwPDb3/6ReAaMlVI7Sfjmg/1g37UBvFtSmLUG0FYwM7TShaHERE3a24G+SNj0kE9bpnkQTFXpuWY0CeBJcyrRY6GNlrIQMtfBvYPKiiN4XxPXlJDg7wIBQkULMlJNgC27BllEDUrD0oWHmcDPDBCKNmpLMQLZGm0phEOMM3AB0AJZpuCDjgSRg2itO92c5SBNpUGLcxLZ2ZGrKjJaCgGCK9rIEJ1pk8ogs8QFqmAwyBJVcSROfL3ysgWyWrrGB6olIRcE81ZXFDMoXUUQU9jFBFtBQZHBiy66pChCW2tc+ZCCJwgIvJOmpNGAmx3pKOwc0EYZ+J0uQwx2DvPBCZSiTsEXL36JJBF+q+1DzF+8+GDP4G6XU++piJrp/vdDcS2Xy0dF9e0xzxvNP7YF/EzeRc0urPfcc811W6RCPBSy++gkvSFLKX8Oymwvo3JlfFzXsjquyfjxDbFkSBxfXl+lPv4t/PbXv8NbwmChdssuW8s2kFnDfDhKPNdFvnPbrg2nWwm2XIvHyy75+qvGzoMJy4Duiqf34XVbGF0CU+Nl7OZwCf54KV2BCtphXFEh1iiJtNAICEbbhxFc2jW0kQIsNdcpB2Q9MfdXl8Qonsd9lGfBNaB5BD+6JS0oZElGFDbrGKjSnGTtlNEcycxGSfVAM20MLHU1J85PviNgIKCmoKqiSqw+OLagmaS7ZtARoqxI+srJI7itaZ14cYHaoHQSbbukdnKBFM+SrbzTlmMOVcDZwQUw2x+SzNbOPrHUOQl3ZmW9mOG7L7GTSMQRfJBGftL8j7tooBkFOTGV5D5xvO4T5W5IOJA8/E8SNgHxfgALeuiHBHr9w6mchAIoNPHd7IbCQpfUT8LP1Oo4EY9VpowuycbDsXT55votLOBiNFHZwUz9N+p2/Pbq1eufbl6LNtIjO49NR5PRJN1LXOQG7cFRx48IpxNrs8dd/+Mnh37+M6147A3qhLqSazY9YLo7eYi4z1QtgCq/U5tNgZF+CWa7leVfWwqCxu4ztcCgpQASFssG7CAI64HWPcAly2e3cryQm7aDIScQVMBPx3FZluT5i7SHmO/63c2tylTRP5Y0rhKegEt5SMGlylV6b0nzLT11yNpGGbTzFucJwySZAnekOR5jpYeElfofYtWwZdcHGh6DqM4M+S9GPcmw2XQ4bLvd0Xdbn+XoHTtQS/jut9vtPwHQpJh/","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 account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"}}');var o=a(74848),c=a(28453),r=a(33617),s=a.n(r),i=a(17543),l=a.n(i),p=a(86013),d=a.n(p),m=a(63723),f=a.n(m),y=(a(18766),a(79329),a(9303));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:"eJzVWGtuHLkRvkot/yRrtOYheTdI/1rFMLxCjLWw0sJAZMGo7q6ZpsUmuWT1PDAYID9yg9wgR9uTBMXunpdkJ0ICBwEEYZqsKta7PnKjGOdR5XfqlbOMJUd1n6mKYhm0Z+2sytVtTfAqEDJBTwSX11eAxrhlhLVrgR3QbOYCG4rRrKHsqC0toezFAtfIUKIF4ccIUc8thQgzF0RGAN14FxgtQ+XKtiHLcaQy5TwFFE2uKpWrTnIvVGUq0K8tRf6Tq9Yq35wofh3cQlcEBRm3BI8BG2IKom6v4V6Q/CLLIgS9N7pMZ44/RZG0UbGsqUH5JSfqQJX4jBrURmXKYkPiN157UrlyxSdKQn0Q7VlTFM5ElW8GqshB27nK1MyFBvlwhVbYeCNEn5yoT2qb9Yc9n78g+qFfGJWuEVG+dvbZqkzPL86nF9OL86nabjPFmtPyUUQ+FhKIrezv/cShpbQQvbOx88X5ZPI4XkN2dSIriG1ZUoyz1pj1N8+J0Zfj0C1LOj3PAb6eFvXq/JMXF/6fB/Pl9GJ6nv5ERO/wS35KzJ7pfHJ+cTadnE3+cDv9Pn/5x/y770eTyeQvKlOrxuxTXFXIycohR4bv1ldf4ZztKVmfnBUxahMPGYb636aUfflUUt64hrjWdg5LsgzL4Ow8A28IIwGHNeActQWDTOG/mKQUggtfdtPzNDusWW2NtvRxqMiPLyeTj9OdE6afr0w0gbBaA6105Ph1zf2cDl82bHpg2HePDbuyCzS6SgPt1j2Q/bo2HR7P3fGP01d3RGlfHRl7uN4ZGalsg+a1yu82anWGXp91+/nd/fY+U5IxTgapdzFpjFyrXI1P52qksKAQk5g2GJWrmtnHfDyOaKvCrUbOk5UZbrCI0orG6PV4MR1JQznlQe+fRU/t2XNZIuNc2/m/4rvfu+hGwthF6shRu3ih13+m9TDe8yOqTGlJn5qwopBiJtnx8x6NvB5ivAvj0P13zf+pfr5r50fjVk6buaRaH/t3nuyNntuUOcm0U9T2nkzpGhKwwzXBwPDb3/6ReAaMlVI7Sfjmg/1g37UBvFtSmLUG0FYwM7TShaHERE3a24G+SNj0kE9bpnkQTFXpuWY0CeBJcyrRY6GNlrIQMtfBvYPKiiN4XxPXlJDg7wIBQkULMlJNgC27BllEDUrD0oWHmcDPDBCKNmpLMQLZGm0phEOMM3AB0AJZpuCDjgSRg2itO92c5SBNpUGLcxLZ2ZGrKjJaCgGCK9rIEJ1pk8ogs8QFqmAwyBJVcSROfL3ysgWyWrrGB6olIRcE81ZXFDMoXUUQU9jFBFtBQZHBiy66pChCW2tc+ZCCJwgIvJOmpNGAmx3pKOwc0EYZ+J0uQwx2DvPBCZSiTsEXL36JJBF+q+1DzF+8+GDP4G6XU++piJrp/vdDcS2Xy0dF9e0xzxvNP7YF/EzeRc0urPfcc811W6RCPBSy++gkvSFLKX8Oymwvo3JlfFzXsjquyfjxDbFkSBxfXl+lPv4t/PbXv8NbwmChdssuW8s2kFnDfDhKPNdFvnPbrg2nWwm2XIvHyy75+qvGzoMJy4Duiqf34XVbGF0CU+Nl7OZwCf54KV2BCtphXFEh1iiJtNAICEbbhxFc2jW0kQIsNdcpB2Q9MfdXl8Qonsd9lGfBNaB5BD+6JS0oZElGFDbrGKjSnGTtlNEcycxGSfVAM20MLHU1J85PviNgIKCmoKqiSqw+OLagmaS7ZtARoqxI+srJI7itaZ14cYHaoHQSbbukdnKBFM+SrbzTlmMOVcDZwQUw2x+SzNbOPrHUOQl3ZmW9mOG7L7GTSMQRfJBGftL8j7tooBkFOTGV5D5xvO4T5W5IOJA8/E8SNgHxfgALeuiHBHr9w6mchAIoNPHd7IbCQpfUT8LP1Oo4EY9VpowuycbDsXT55votLOBiNFHZwUz9N+p2/Pbq1eufbl6LNtIjO49NR5PRJN1LXOQG7cFRx48IpxNrs8dd/+Mnh37+M6147A3qhLqSazY9YLo7eYi4z1QtgCq/U5tNgZF+CWa7leVfWwqCxu4ztcCgpQASFssG7CAI64HWPcAly2e3cryQm7aDIScQVMBPx3FZluT5i7SHmO/63c2tylTRP5Y0rhKegEt5SMGlylV6b0nzLT11yNpGGbTzFucJwySZAnekOR5jpYeElfofYtWwZdcHGh6DqM4M+S9GPcmw2XQ4bLvd0Xdbn+XoHTtQS/jut9vtPwHQpJh/",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,G={},b=[];function h(t){const e={p:"p",...(0,c.R)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(s(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.jsx)(e.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,o.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{title:"Body",body:{description:"Provide below parameter to create contact",content:{"application/json":{schema:{required:["email","name"],type:"object",properties:{name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"1232131321"}},title:"createcontact_body"}}},required:!0}}),"\n",(0,o.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function P(t={}){const{wrapper:e}={...(0,c.R)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(h,{...t})}):h(t)}}}]); \ No newline at end of file diff --git a/assets/js/18b84479.23ffef42.js b/assets/js/18b84479.23ffef42.js new file mode 100644 index 000000000..4ffb922f0 --- /dev/null +++ b/assets/js/18b84479.23ffef42.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>h,default:()=>v,frontMatter:()=>f,metadata:()=>o,toc:()=>A});const o=JSON.parse('{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.1/deletedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletedocument","permalink":"/docs/API-docs/v1.1/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81u3DYQfpUJL20MeXftuCmqU93GSIwajVE7MFBnYVDiSGJNkQxJ7XqxENBD36CnXvtoeZJiKGlXaztpg7a52Kvh/H4znBmuWeClZ+k1e2HypkYdPJsnTKDPnbRBGs1SdlkhvECFAUH0XHB8fgpcKbP0sDINBAMOa7NA8BZzWch8y1o4UxOT25D8hCXMWHScLJwKljIR9Q8MLGGWO15jQEferZnmNRJbz3AjBUuYJO8sDxW77/K5MwspEEz2C+bhVIAptg4FA505ljCH7xrpULA0uAYT5sNKkSEva6uIAe+sMgJZWnDliSGvsOYsXbOwspEzOKlLlrDCuJqHMQXveNSSMlsdZtUh94K17Zysemu0R096Dmcz+rcbwJCO3lMBvslz9L5olFo9YQnLjQ6EVLpm3Fol84jl9BdP4uuHbnZIELCOkA+yMz4A9FhAW/e/uyPn7Sv7jLXJkKvj8HGhw9nhs/2D2f7s68uD5+nRN+lXzyez2exnlrC7WpHskFQekPQGGdT2u33A1uVszNhTWmI+egzGC1NjqKQuYUlgLp3RZQJWIfcIwa2Al1xqUDyg+w9RReeM+zg6n+ZZO4paaiU13gw1dHM0m90cbEA4+kgtaROgMI0WnzfUx+x/PKCjm2ebgL56GNCpXnAlRWxCl+YW9eeNZ2w+dOYfVqvsmOI52wl2TO+C9Jg3ToZV7HR3+9zK/e48vZ5Tu6BKMdsuGbtjqFjKpkNPm65HnbFlpNItht7ZOMVSVoVgfTqdeq5FZu4mxqL2stSKZ36Sm3rKrZwuDiYHrE3uy3BrP4kfm/1PFfGBl1KXfyc336J1QRntkraD2SZ13MofcMWSISVjrn54VMgFupg+qQsThftEvbaoL2SpY5qj8ftD5gpVbmqkeRIqhEHg/W9/RpkhI7EOo4Ynb/Vb/bpxYM0SXdEo4FpAofBOZgqjENbxbDNVPfJaofdqBVIHLB2nKSxLGbgCwog6SM4tz6SSVMPEZrpxO7oGfgJXFYYKHR194RA4CFygotIH3gRT80CqNkNyadxtQfM9AQ5Z46VG7wF1xXVOjEMWEjAOuAbUAZ110iP44Mhr2flmdHA8D1BzzUsk3ckOVAKVpFIFZ7LGB/BGNdFlCFwq41DAEJBGFH5CIJ7QVHYIRM1NbR1WVDILhLKRAn0CuREIPl5ZCkELyNAHsOSLzNGT0kYrk9/G5NFcBWuog0iuaF0Y+0jiwXHtacb3u0yfgw1g1hka0Ng5uLf3xiNl+EzqW5/u7b3V+3C9qakrzLwMOP9yKP/lcvmg7J/uyryU4VWTwU9ojZfBuNVWupSharJ4VcZKNh+dppeoMdbP6CJsdQiT+4c3j6jTCpWdXmCgCvHT4/PT2HSfwvtff4cz5E5DZZZdteaNQ7WCcjBFyHWZ72Db9EwoTCy8ihDPu+KjZQx9GBC8qnh4/+sfHn7EJcjuCnVA7u2dN5mSOVxibWlE+r29FL53SCbDQINQ8QA515Ah+IpTKS0kBw62k1ZS307gWK+g8ehgKUMVi4HoUW4nDMJlu8JCxj0KMDpKDDYnW4+IXntUC/Ski2ZfhoBC0jYXKmeasrM2dqYPzmEhlYIrKUoMMbZjIcD25GVHjnvs1h0s6EKEClfAHYJHHSZwfk8knjTWGkdeyM75wtAiTwlALayROvgUhONF2OpPtoWeE8zS6EdIHYR8A0fSq9mkpLuJfcQb6uQtNeR7TXy31zosMD4gYtjbvFjZl9P1UJZA1fpvypqmNXUtnsdlAmsuVTdNvr2vJw52dLV/XVygW8gc+4n2gRs9jcxTljAlc9QeRwvD8cvzM1g8m8xYMhqN/+ByT89Ovz/58eKEnKFG2gF2MJlNZkSyxoea65Gl/i33YvvY2sF6vV2l/qenXz+fA96FqVVcxgUpxrzuN5trNnoKpuNX3zxhlfGBWNZruoNvnGpbIr9r0NEKNU/YgjvJMxrj12smpKffYvOE+2C0X/7Uvwafwj9+QD4ay7CAaNo+Flw19MUSdoure4/Ydt4mwxZCznYcx3mONoxkH2y0O2vhi5Ozk8sTljDqp7sL0G1cgPofZOBR13Y3o84H+ktr2qMC63W3XLXthr87+qBEH+PATTjN27b9C8Xtzug=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"}}');var s=n(74848),l=n(28453),d=n(33617),c=n.n(d),i=n(17543),p=n.n(i),r=n(86013),u=n.n(r),a=n(63723),m=n.n(a),g=(n(18766),n(79329),n(9303));const f={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u3DYQfpUJL20MeXftuCmqU93GSIwajVE7MFBnYVDiSGJNkQxJ7XqxENBD36CnXvtoeZJiKGlXaztpg7a52Kvh/H4znBmuWeClZ+k1e2HypkYdPJsnTKDPnbRBGs1SdlkhvECFAUH0XHB8fgpcKbP0sDINBAMOa7NA8BZzWch8y1o4UxOT25D8hCXMWHScLJwKljIR9Q8MLGGWO15jQEferZnmNRJbz3AjBUuYJO8sDxW77/K5MwspEEz2C+bhVIAptg4FA505ljCH7xrpULA0uAYT5sNKkSEva6uIAe+sMgJZWnDliSGvsOYsXbOwspEzOKlLlrDCuJqHMQXveNSSMlsdZtUh94K17Zysemu0R096Dmcz+rcbwJCO3lMBvslz9L5olFo9YQnLjQ6EVLpm3Fol84jl9BdP4uuHbnZIELCOkA+yMz4A9FhAW/e/uyPn7Sv7jLXJkKvj8HGhw9nhs/2D2f7s68uD5+nRN+lXzyez2exnlrC7WpHskFQekPQGGdT2u33A1uVszNhTWmI+egzGC1NjqKQuYUlgLp3RZQJWIfcIwa2Al1xqUDyg+w9RReeM+zg6n+ZZO4paaiU13gw1dHM0m90cbEA4+kgtaROgMI0WnzfUx+x/PKCjm2ebgL56GNCpXnAlRWxCl+YW9eeNZ2w+dOYfVqvsmOI52wl2TO+C9Jg3ToZV7HR3+9zK/e48vZ5Tu6BKMdsuGbtjqFjKpkNPm65HnbFlpNItht7ZOMVSVoVgfTqdeq5FZu4mxqL2stSKZ36Sm3rKrZwuDiYHrE3uy3BrP4kfm/1PFfGBl1KXfyc336J1QRntkraD2SZ13MofcMWSISVjrn54VMgFupg+qQsThftEvbaoL2SpY5qj8ftD5gpVbmqkeRIqhEHg/W9/RpkhI7EOo4Ynb/Vb/bpxYM0SXdEo4FpAofBOZgqjENbxbDNVPfJaofdqBVIHLB2nKSxLGbgCwog6SM4tz6SSVMPEZrpxO7oGfgJXFYYKHR194RA4CFygotIH3gRT80CqNkNyadxtQfM9AQ5Z46VG7wF1xXVOjEMWEjAOuAbUAZ110iP44Mhr2flmdHA8D1BzzUsk3ckOVAKVpFIFZ7LGB/BGNdFlCFwq41DAEJBGFH5CIJ7QVHYIRM1NbR1WVDILhLKRAn0CuREIPl5ZCkELyNAHsOSLzNGT0kYrk9/G5NFcBWuog0iuaF0Y+0jiwXHtacb3u0yfgw1g1hka0Ng5uLf3xiNl+EzqW5/u7b3V+3C9qakrzLwMOP9yKP/lcvmg7J/uyryU4VWTwU9ojZfBuNVWupSharJ4VcZKNh+dppeoMdbP6CJsdQiT+4c3j6jTCpWdXmCgCvHT4/PT2HSfwvtff4cz5E5DZZZdteaNQ7WCcjBFyHWZ72Db9EwoTCy8ihDPu+KjZQx9GBC8qnh4/+sfHn7EJcjuCnVA7u2dN5mSOVxibWlE+r29FL53SCbDQINQ8QA515Ah+IpTKS0kBw62k1ZS307gWK+g8ehgKUMVi4HoUW4nDMJlu8JCxj0KMDpKDDYnW4+IXntUC/Ski2ZfhoBC0jYXKmeasrM2dqYPzmEhlYIrKUoMMbZjIcD25GVHjnvs1h0s6EKEClfAHYJHHSZwfk8knjTWGkdeyM75wtAiTwlALayROvgUhONF2OpPtoWeE8zS6EdIHYR8A0fSq9mkpLuJfcQb6uQtNeR7TXy31zosMD4gYtjbvFjZl9P1UJZA1fpvypqmNXUtnsdlAmsuVTdNvr2vJw52dLV/XVygW8gc+4n2gRs9jcxTljAlc9QeRwvD8cvzM1g8m8xYMhqN/+ByT89Ovz/58eKEnKFG2gF2MJlNZkSyxoea65Gl/i33YvvY2sF6vV2l/qenXz+fA96FqVVcxgUpxrzuN5trNnoKpuNX3zxhlfGBWNZruoNvnGpbIr9r0NEKNU/YgjvJMxrj12smpKffYvOE+2C0X/7Uvwafwj9+QD4ay7CAaNo+Flw19MUSdoure4/Ydt4mwxZCznYcx3mONoxkH2y0O2vhi5Ozk8sTljDqp7sL0G1cgPofZOBR13Y3o84H+ktr2qMC63W3XLXthr87+qBEH+PATTjN27b9C8Xtzug=",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,j={},A=[];function N(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/18b84479.ef1d6397.js b/assets/js/18b84479.ef1d6397.js deleted file mode 100644 index 88867bbad..000000000 --- a/assets/js/18b84479.ef1d6397.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1706],{18140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>k,contentTitle:()=>v,default:()=>y,frontMatter:()=>I,metadata:()=>o,toc:()=>j});const o=JSON.parse('{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1.1/deletedocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletedocument","permalink":"/docs/API-docs/v1.1/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V+9u20YSf5XpfmkT0JLsOC2On85tjMSo0Ri1gwDnCMaSHIpTL3e3u0vJgkCgH+4N7g36aHmSYpakRMlOrsFd+yUxV/P3N7+dmd2IIBdepLfilcmbGnXwYp6IAn3uyAYyWqTipkJ4hQoDQtFLwdnVBUilzMrD2jQQDDiszRLBW8yppHwnWjpTs5DbHvmJSISx6CR7uChEKopofxAQibDSyRoDOo5uI7SskcV6gTsqRCKIo7MyVOIw5CtnllQgmOwXzMNFAabcBRQMdO5EIhz+2pDDQqTBNZgIH9aKHXmqrWIBfLDKFCjSUirPAnmFtRTpRoS1jZLBkV6IRJTG1TKMT/BBRiupsNVJVp1IX4i2nbNXb4326NnOyWzG/+0nMJSjj7QA3+Q5el82Sq2/EonIjQ6MVLoR0lpFecRy+otn9c3jMDskGFjHyAfqnA8APZXQLvzvHzh4+8a+EG0y1OosfF7pZHby4uh4djT77ub42/T0H+nLbyez2exfIhEPtWLdoagyINsNFNTuu30k1tVsLNiftCx8+hSM16bGUJFewIrBXDmjFwlYhdIjBLcGuZCkQcmA7v+IKjpn3OfR+bLI2lHWpBVpvBs4dHc6m90db0E4/QyXtAlQmkYXf2+qT/n/fEKndy+2Cb18nNCFXkpFRWxCN+Ye9d+bz9h96Nw/Zit1QvF3sZfs+LxL0mPeOArr2OkejqSlo+739HbO7YKZYnZdMnbHUIlUTIeeNt2MOmMr2KRbDr2zcUqkogrB+nQ69VIXmXmYGIva00IrmflJbuqptDRdHk+ORZsc6khrv0gem6MvVfFBLkgv/pvefIfWNVe0K9oeZtvSSUs/4lokQ0nGUv3wqFAW6GL5SJcmKveFemtRX9NCxzJH54dD5j2q3NTI8yRUCIPCx3//HnWGikQeRgtffdAf9NvGgTUrdGWjQOoCSoUPlCmMSljH37ZT1aOsFXqv1kA64MJJnsK0oCAVMEbcQXJpZUaKmMMsZrpxO7oGfgLvKwwVOv7pa4cgocAlKqY+yCaYWgY2tR2SK+PuS57vCUjIGk8avQfUldQ5Cw5VSMA4kBpQB3TWkUfwwXHU1MVmdHAyD1BLLRfItpM9qApUxFQFZ7LGB/BGNTFkCJKUcVjAkJBGLPyEQTznqewQ+DQ3tXVYMWWWCIuGCvQJ5KZA8PHKcgq6gAx9AMuxUI6ejTZamfw+Fo/nKljDHYSk4nVhHCOrBye15xnf7zJ9DbaAWWd4QGMX4PPn7zxyhS9J3/v0+fMP+ghut5x6j5mngPNvBvqvVqtHtH+2r/Oawpsmg5/RGk/BuPVOe0GharJ4VcZGth+dpdeoMfJndBF2NgqT+8c3j0+nFSo7vcbADPHTs6uL2HSfwcff/gOXKJ2Gyqw6tuaNQ7WGxeCKkesq38G27ZlQmki8ihHPO/LxMoY+bBG0vAkAdZenx/CqyRTlELC2PBtTOAO7fwS51JAh5A4lb04cgq8kE2lJEiQo0vcTONNraDw6WFGoIgf4PCp3mp0iIy8PllkKE3hjVrhEl0QbntV4umFBIdraBkPBoyonMXSHJSkFKyoWGNKDbw/SIWCdYVFgwVmP3GZYMt0pAHnw/RIbPU/gpsJ11JVLSUpyJyHdkdrwhs7Ioi6sIR18CoWTZdit4snOSUybjH7iqANJbtNKejPDd3/FDirhJ/CBW+1Be97vog5LjE+DeCV3xLHUE+V2IBwwD/8XwvIc5n4k87gmYC1JdXPin4d24shGV/u35TW6JeXYz6pP3NVpFJ6KRCjKUXscrQJnr68uYQkvJjORjKben7i308uLH85/uj7naLhHdogdT2aTGR9Z40Mt9chV/0x7tXtH7YG92W1Jf9Grrh+9AR/C1CpJcfeJOW/6peVWjF556fhBN09EZXxgkc0mkx7fOdW2fPxrg463o3kiltIRczxuNgV5/rvYvs4+me03P/cPvWfwp9+GT+Yy7BaaF4ulVA1/iUTc4/rgfdrO22RYMDjYTuIsz9GGke6jZXVv43t1fnl+cy4Swa1yf7e5j7tN/wc7eDK0/aWni4H/5Q3sSYXNptub2nYr3/30SY0+x0GacZq3bfsHJMG/oQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"}}');var s=n(74848),d=n(28453),i=n(33617),c=n.n(i),p=n(17543),l=n.n(p),r=n(86013),a=n.n(r),m=n(63723),u=n.n(m),f=(n(18766),n(79329),n(9303));const I={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9u20YSf5XpfmkT0JLsOC2On85tjMSo0Ri1gwDnCMaSHIpTL3e3u0vJgkCgH+4N7g36aHmSYpakRMlOrsFd+yUxV/P3N7+dmd2IIBdepLfilcmbGnXwYp6IAn3uyAYyWqTipkJ4hQoDQtFLwdnVBUilzMrD2jQQDDiszRLBW8yppHwnWjpTs5DbHvmJSISx6CR7uChEKopofxAQibDSyRoDOo5uI7SskcV6gTsqRCKIo7MyVOIw5CtnllQgmOwXzMNFAabcBRQMdO5EIhz+2pDDQqTBNZgIH9aKHXmqrWIBfLDKFCjSUirPAnmFtRTpRoS1jZLBkV6IRJTG1TKMT/BBRiupsNVJVp1IX4i2nbNXb4326NnOyWzG/+0nMJSjj7QA3+Q5el82Sq2/EonIjQ6MVLoR0lpFecRy+otn9c3jMDskGFjHyAfqnA8APZXQLvzvHzh4+8a+EG0y1OosfF7pZHby4uh4djT77ub42/T0H+nLbyez2exfIhEPtWLdoagyINsNFNTuu30k1tVsLNiftCx8+hSM16bGUJFewIrBXDmjFwlYhdIjBLcGuZCkQcmA7v+IKjpn3OfR+bLI2lHWpBVpvBs4dHc6m90db0E4/QyXtAlQmkYXf2+qT/n/fEKndy+2Cb18nNCFXkpFRWxCN+Ye9d+bz9h96Nw/Zit1QvF3sZfs+LxL0mPeOArr2OkejqSlo+739HbO7YKZYnZdMnbHUIlUTIeeNt2MOmMr2KRbDr2zcUqkogrB+nQ69VIXmXmYGIva00IrmflJbuqptDRdHk+ORZsc6khrv0gem6MvVfFBLkgv/pvefIfWNVe0K9oeZtvSSUs/4lokQ0nGUv3wqFAW6GL5SJcmKveFemtRX9NCxzJH54dD5j2q3NTI8yRUCIPCx3//HnWGikQeRgtffdAf9NvGgTUrdGWjQOoCSoUPlCmMSljH37ZT1aOsFXqv1kA64MJJnsK0oCAVMEbcQXJpZUaKmMMsZrpxO7oGfgLvKwwVOv7pa4cgocAlKqY+yCaYWgY2tR2SK+PuS57vCUjIGk8avQfUldQ5Cw5VSMA4kBpQB3TWkUfwwXHU1MVmdHAyD1BLLRfItpM9qApUxFQFZ7LGB/BGNTFkCJKUcVjAkJBGLPyEQTznqewQ+DQ3tXVYMWWWCIuGCvQJ5KZA8PHKcgq6gAx9AMuxUI6ejTZamfw+Fo/nKljDHYSk4nVhHCOrBye15xnf7zJ9DbaAWWd4QGMX4PPn7zxyhS9J3/v0+fMP+ghut5x6j5mngPNvBvqvVqtHtH+2r/Oawpsmg5/RGk/BuPVOe0GharJ4VcZGth+dpdeoMfJndBF2NgqT+8c3j0+nFSo7vcbADPHTs6uL2HSfwcff/gOXKJ2Gyqw6tuaNQ7WGxeCKkesq38G27ZlQmki8ihHPO/LxMoY+bBG0vAkAdZenx/CqyRTlELC2PBtTOAO7fwS51JAh5A4lb04cgq8kE2lJEiQo0vcTONNraDw6WFGoIgf4PCp3mp0iIy8PllkKE3hjVrhEl0QbntV4umFBIdraBkPBoyonMXSHJSkFKyoWGNKDbw/SIWCdYVFgwVmP3GZYMt0pAHnw/RIbPU/gpsJ11JVLSUpyJyHdkdrwhs7Ioi6sIR18CoWTZdit4snOSUybjH7iqANJbtNKejPDd3/FDirhJ/CBW+1Be97vog5LjE+DeCV3xLHUE+V2IBwwD/8XwvIc5n4k87gmYC1JdXPin4d24shGV/u35TW6JeXYz6pP3NVpFJ6KRCjKUXscrQJnr68uYQkvJjORjKben7i308uLH85/uj7naLhHdogdT2aTGR9Z40Mt9chV/0x7tXtH7YG92W1Jf9Grrh+9AR/C1CpJcfeJOW/6peVWjF556fhBN09EZXxgkc0mkx7fOdW2fPxrg463o3kiltIRczxuNgV5/rvYvs4+me03P/cPvWfwp9+GT+Yy7BaaF4ulVA1/iUTc4/rgfdrO22RYMDjYTuIsz9GGke6jZXVv43t1fnl+cy4Swa1yf7e5j7tN/wc7eDK0/aWni4H/5Q3sSYXNptub2nYr3/30SY0+x0GacZq3bfsHJMG/oQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,k={},j=[];function g(e){const t={p:"p",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(a(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.9ff4fd96.js b/assets/js/19e5ad2a.9ff4fd96.js deleted file mode 100644 index 725bf22a8..000000000 --- a/assets/js/19e5ad2a.9ff4fd96.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(t,e,i)=>{i.r(e),i.d(e,{assets:()=>g,contentTitle:()=>y,default:()=>G,frontMatter:()=>v,metadata:()=>a,toc:()=>k});const a=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":"eJzNV+tu4zYWfpVT/ul2oPiSuRTVrwbFIA022Bk0KQZoJhhQ0rF1xhTJkkd2DMPA/tg36Bv00fokxaFkW04ybbM7KBYIkog89+vHjWI9jyq/Ud85y7rkqG4zVWEsA3kmZ1WurmuE/hYuKTKcvb0AbLxbYYiwdi2wg4AcCJcIGozQuBmUvcQMfHBLqsjOQUPpGh+wRhtpibAkXAmtNgb0UpPRhcE9J5AV+WF3UDi3GKlMOY9Bi3UXlcpVfylqVaa8DrpBxiBebZTVDapcGWpIbkkc+rnFsFaZCvhzSwErlc+0iZipyGsj1DMXGpUpvPPGVahyDq3cljU2WuUb1eg7atpG5S8nk0zx2guTbZsCg9oKn268CJpOttnehLgg/9ks+LTOyfZW5EbvbMQotKeTifw5TmpsyxJjnLUG9tFUWYolWhZ67b2hMl2MP0Zh2jw0wBUfsUxhDyKGqVMZMLaGB3Q6BC0OE2MT/5y/O5bs7ikjB7JzlaXQaB6e7H1Xvp4W9d3pRy8h6eL+NAEfHUKBmCLaaDL/BX+B+G1/MCpdI6J87eyTTXkxfT49TT8iogyoGaszfkzMgel0cvr8ZDo5mXx9PX2Vv/gmf/lqNJlMflKZumuSN301VpqTl0xsht+tr/4GPdv7ZH0PV8iaTBwy9Ddqux0ckjVk8cOuzD9IiW8TxYvHiv3KNci1zJ8VWoZVcHaegTeoIwKHNei5JgtGM4YvPl8XYAgu/HEcn2bZH4XgxWTyYboPwsuHQbiwS22oStP72i3Q/r2eDtVzp/5hGVBHlO7VkbPD887JiGUbiNdpzN+daE8n3X1+cyszUALrZD/MsdsLXKtcjY+3RcSw3K2KNhiVq5rZx3w8jtpWhbsbOS+ram6NLqL081h7Gi+nI+nK+zza+yfRY3vyVJbIek52/md8t4f4XEkOuzQdRekwmz39E2U490kYUvX7qkZdyZ7ZyvfMJeY+NW882iua25TYpPw+fniHpnQNCkrgGmHH8Nt/fk08lSvbBi2nyksSvnhv39s3bYAEMWRFaVvBzOAdCTp4DH5E1I3BGM0ayDLOg2aEiubE2oDESFqs1F4XZEiqVshcBy4GhR9H8K5GrjHI1ZdB4EyFSzRS7KBbdo1mEbUzGlYuLGbGrWIGGoo2ksUYAW2tbSmEuyxk4AJoC2gZgw8UESIHsZo625zlIAir0VbPUWRnR6Gq0JCUKgRXtJEhOtMmk0FGpgtYwc4hi1jFkQTxteCHgNBhqCHwmrdUYcygdBVCTE0qLtgKCowMXmyhEqMIba1x5SIlb9YaA97JzCBtBLkNbRR2DtpG2WudLbsc7APmgxPggZ2Bz579GFEyfEl2EfNnz97bE7jZ19Q7LCIx3v5jV/6r1epB2X91zHNO/H1bwA/oXSR2YX3gnhPXbZFaZShk/9FJOkeLqX4GjXCQUbkyPuw8OR3XaPz4ClkqJI7P3l6kMfsV/PbvX+ASdbBQu1VXrWUb0KxhvlMlkesy34VtPyVh5lLh1RLxsis+QY0YeR/BtLIFK0vz9DF82xaGSmBsvCyPHM7AHx9BqS0UCD2ySCbEWkshLUknHG8XIziza2gjBlgR16kG5Dwxd5wdo0ReH7I8C64B4hF871a4xJAlGVHYrGPAijjJ2htDHNHMRsn0gDMyBlZUzZHze98RdEDApsCqwkq8HqgtcCblTgwUIcqJlK9oHsF1jevEe3hnkO2K2hnjVhJZtJV3ZDnmUAU9473kmB2UJLfJ2UeOuiDpvVtZL2b33bfYvUzEEbyXUXtvPB9P0YAzDKIxteShcDz1hXKzKziQOvxfCjbhzR52yXLvgLDsiW/vy0lLGkMT38yuMCypxH5XfaJXx4l4rDJlqEQbcbD8z87fXsISno8mKhtsvb/Qt+PLi+9e/+vqtVgjM7KL2HQ0GU0S/HaRG20Hqs6R90/aHgkcRXtzAEb/h8/ffm8z3vHYG00JKqWAbXqYc3P0KL7NVO0iy/FmU+iIPwaz3cpx9w4V8FNRFN2Hl+gC14N381KbVnQmRPIJ2v6BeyC9lY9AQptAWbbDEaKw4zkrS/RDBQ9Q6BGUO399rTIl4/AYvywSfun/Eem7K7seyD4GNp0B8lt8epRhs+mw0Xa7p++uPsnRO7ijltTcbrfb3wGgsBEI","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),n=i(33617),l=i.n(n),c=i(17543),r=i.n(c),p=i(86013),b=i.n(p),d=i(63723),h=i.n(d),m=(i(18766),i(79329),i(9303));const v={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV+tu4zYWfpVT/ul2oPiSuRTVrwbFIA022Bk0KQZoJhhQ0rF1xhTJkkd2DMPA/tg36Bv00fokxaFkW04ybbM7KBYIkog89+vHjWI9jyq/Ud85y7rkqG4zVWEsA3kmZ1WurmuE/hYuKTKcvb0AbLxbYYiwdi2wg4AcCJcIGozQuBmUvcQMfHBLqsjOQUPpGh+wRhtpibAkXAmtNgb0UpPRhcE9J5AV+WF3UDi3GKlMOY9Bi3UXlcpVfylqVaa8DrpBxiBebZTVDapcGWpIbkkc+rnFsFaZCvhzSwErlc+0iZipyGsj1DMXGpUpvPPGVahyDq3cljU2WuUb1eg7atpG5S8nk0zx2guTbZsCg9oKn268CJpOttnehLgg/9ks+LTOyfZW5EbvbMQotKeTifw5TmpsyxJjnLUG9tFUWYolWhZ67b2hMl2MP0Zh2jw0wBUfsUxhDyKGqVMZMLaGB3Q6BC0OE2MT/5y/O5bs7ikjB7JzlaXQaB6e7H1Xvp4W9d3pRy8h6eL+NAEfHUKBmCLaaDL/BX+B+G1/MCpdI6J87eyTTXkxfT49TT8iogyoGaszfkzMgel0cvr8ZDo5mXx9PX2Vv/gmf/lqNJlMflKZumuSN301VpqTl0xsht+tr/4GPdv7ZH0PV8iaTBwy9Ddqux0ckjVk8cOuzD9IiW8TxYvHiv3KNci1zJ8VWoZVcHaegTeoIwKHNei5JgtGM4YvPl8XYAgu/HEcn2bZH4XgxWTyYboPwsuHQbiwS22oStP72i3Q/r2eDtVzp/5hGVBHlO7VkbPD887JiGUbiNdpzN+daE8n3X1+cyszUALrZD/MsdsLXKtcjY+3RcSw3K2KNhiVq5rZx3w8jtpWhbsbOS+ram6NLqL081h7Gi+nI+nK+zza+yfRY3vyVJbIek52/md8t4f4XEkOuzQdRekwmz39E2U490kYUvX7qkZdyZ7ZyvfMJeY+NW882iua25TYpPw+fniHpnQNCkrgGmHH8Nt/fk08lSvbBi2nyksSvnhv39s3bYAEMWRFaVvBzOAdCTp4DH5E1I3BGM0ayDLOg2aEiubE2oDESFqs1F4XZEiqVshcBy4GhR9H8K5GrjHI1ZdB4EyFSzRS7KBbdo1mEbUzGlYuLGbGrWIGGoo2ksUYAW2tbSmEuyxk4AJoC2gZgw8UESIHsZo625zlIAir0VbPUWRnR6Gq0JCUKgRXtJEhOtMmk0FGpgtYwc4hi1jFkQTxteCHgNBhqCHwmrdUYcygdBVCTE0qLtgKCowMXmyhEqMIba1x5SIlb9YaA97JzCBtBLkNbRR2DtpG2WudLbsc7APmgxPggZ2Bz579GFEyfEl2EfNnz97bE7jZ19Q7LCIx3v5jV/6r1epB2X91zHNO/H1bwA/oXSR2YX3gnhPXbZFaZShk/9FJOkeLqX4GjXCQUbkyPuw8OR3XaPz4ClkqJI7P3l6kMfsV/PbvX+ASdbBQu1VXrWUb0KxhvlMlkesy34VtPyVh5lLh1RLxsis+QY0YeR/BtLIFK0vz9DF82xaGSmBsvCyPHM7AHx9BqS0UCD2ySCbEWkshLUknHG8XIziza2gjBlgR16kG5Dwxd5wdo0ReH7I8C64B4hF871a4xJAlGVHYrGPAijjJ2htDHNHMRsn0gDMyBlZUzZHze98RdEDApsCqwkq8HqgtcCblTgwUIcqJlK9oHsF1jevEe3hnkO2K2hnjVhJZtJV3ZDnmUAU9473kmB2UJLfJ2UeOuiDpvVtZL2b33bfYvUzEEbyXUXtvPB9P0YAzDKIxteShcDz1hXKzKziQOvxfCjbhzR52yXLvgLDsiW/vy0lLGkMT38yuMCypxH5XfaJXx4l4rDJlqEQbcbD8z87fXsISno8mKhtsvb/Qt+PLi+9e/+vqtVgjM7KL2HQ0GU0S/HaRG20Hqs6R90/aHgkcRXtzAEb/h8/ffm8z3vHYG00JKqWAbXqYc3P0KL7NVO0iy/FmU+iIPwaz3cpx9w4V8FNRFN2Hl+gC14N381KbVnQmRPIJ2v6BeyC9lY9AQptAWbbDEaKw4zkrS/RDBQ9Q6BGUO399rTIl4/AYvywSfun/Eem7K7seyD4GNp0B8lt8epRhs+mw0Xa7p++uPsnRO7ijltTcbrfb3wGgsBEI",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={},k=[];function u(t){const e={p:"p",...(0,o.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,s.jsx)(e.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(r(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(b(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function G(t={}){const{wrapper:e}={...(0,o.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(u,{...t})}):u(t)}}}]); \ No newline at end of file diff --git a/assets/js/19e5ad2a.f6c81f16.js b/assets/js/19e5ad2a.f6c81f16.js new file mode 100644 index 000000000..b842f2f3b --- /dev/null +++ b/assets/js/19e5ad2a.f6c81f16.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1651],{82850:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>h,default:()=>P,frontMatter:()=>u,metadata:()=>o,toc:()=>y});const o=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":"eJzNV91u4zYWfpVT3nQbKLacmWmxumowGKRBg07QpAjQTDCgpGOJY4pkySM7hmFgLvYN9qq3fbR5kuJQki0nmXazWxQLBEl0eP7/+HEjSFZBZLfitTUkCwriLhElhsIrR8oakYnrGqE/hQsVCE4vzwEbZ1foA6xtC2TBI3mFSwQJmnnsHIpeYwLO26UqlalAQmEb57FGE9QSYalwxbxSa5BLqbTMNe4kQRnW7wdCbu1iIhJhHXrJ3p2XIhP9IZsViXDSywYJPUe1EUY2KDKhVaP4VHFAv7To1yIRHn9plcdSZHOpAyYi0Foz99z6RiQC7522JYqMfMunRY2NFNlGNPJeNW0jsldpmghaOxYybZOjF1uWk41jRbN0m+xcCAvl/jIPPm8z3d6x3uCsCRiY9yRN+c9hUUNbFBjCvNWwy6ZIYi7REPNL57Qq4sH0Q2ChzWMHbP4Bi5h2z2pIdSY9hlbTiE96LzlgRdiEP5fvyFzdHWcgr0wlkpgaSWPKLnbh6lle3598cJySLu/PU/DBIuSIMaONVPq/kM8Rv+0Jk8I2rMrV1jzblZezF7OT+MMqCo+SsDylp9TshU7SkxfHs/Q4/eZ69nX28p/Zq68naZr+LBJx38Ro+m4sJcUoSZEef7eu/BvsbB+y9TNcIkmlw1igPxHb7YiojFYG3w9t/p5bfBs5Xj7V7Fe2Qap5/6zQEKy8NVUCTqMMCOTXICupDGhJ6L/466YAvbf+j/P4PM/+KAUv0/T9bJeEV4+TcG6WUqsybu9ru0Dz90Y6Nk+d+cdtoDqmeC4Ogh3TuyADFq1XtI5r/v5YOnXcnWe3d7wDObGW74cKu3uBapGJ6eFtEdAvh6ui9VpkoiZyIZtOgzRlbu8n1vFVVRkt88DzPJVOTZezCU/lQxnp3LP4sT1+rkggWSlT/Znc3T4/V1zDrkwHWdrvZqe+R17OfRHGXP19VaMs+Z7Z8vfcRuG+NG8dmitVmVjYaPwhfrhBXdgGGSVQjTAIfPrXb1GmtEXboKHYeVHDF+/MO/O29RAhBl9R0pQw13ivGB08BT8CykZjCHoNyhBWXhJCqSpFUgPniEeskE7mSivuWmazHbgYNX6YwE2NVKPnoy89w5kSl6i52UG2ZBtJrGpwGlbWL+barkICEvI2KIMhAJpamoIZhyokYD1IA2gIvfMqIATy7LXqfLOGPCOsRhpZIetODlJVolbcquBt3gaCYHUbXQZemdZjCUNABrEME07iG8YPHqHDUGPgVbWqxJBAYUuEEIeUQzAl5BgIHPuiCgystDXaFotYvHmrNTjLO0NJzcht7COLk5cm8L3W+TLUYJcw5y0DD+wcPDr6KSBX+EKZRciOjt6ZY7jd9dQN5kER3v1jaP/VavWo7b86lDlT9F2bw4/obFBk/XovXSmq2zyOyljJ7qPTdIYGY/+MBmGvo7RFeDx5TJ3WqN30Cok7JExPL8/jmv0KPn38N1yg9AZqu+q6tWg96jVUgynOXFf5Lm27LQlzGxuv5owXXfMxasRAQwZvakmfPv4a4AdcMWLmEeoSeXR02eZaFXCNjeM7JBwdZfA6QgmggQZUS4JCGsgRQi25lZZKggTXSWtlFhM4NWtoA3pYKapjMzA9yh2EwXnZlTtALgOWYE2UGGxO9h4xvQmolxhYl7HEbmCpiDu69ratOmtjZ/rgPM6V1nCjygopxnZaluB68qojc8JH7uCcB4JqXIP0CAENTeDygUg8aZ2znr1QnfNzq7VdcQHQlM4qQyGD0ss57fUn+0aPiE1Z8wSpS6HcpSPp1exK0k1iH/GOOnnHC/nBEj/ctR7n6NlgDHtfF6f6drod2hK4W/+Xto6otAdnDAE6uMy3ybcP9cSrHH0T3s6v0C9Vgf2N9pmJnkbmqUiEVgWagCOIcHp2eQHLF5NUJKOr8T8Y7unF+es3P1y9YWd4kXYJm03SSRoxug3USDOydIa0e/f2cOEg2Zs9evo/fCP3lzvhPU2dliriqZiwTY+Fbg9ezneJqG0gJm82PLQ/eb3dMrl7rDJCKlVg2/vn6gLXo8f1UuqWbUbY8hne/hW8Z73jD6+YNyK3ZAAbbLCTOS0KdGMDj6DqAd47e3MtEsE78xDkLCLI6f9h7cORWY90H6KfzgH+zTE9KbDZdABqu93xd0eflegDHLi5NHfb7fZ3wWkgTw==","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 i=n(74848),a=n(28453),s=n(33617),l=n.n(s),c=n(17543),r=n.n(c),p=n(86013),d=n.n(p),m=n(63723),g=n.n(m),b=(n(18766),n(79329),n(9303));const u={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV91u4zYWfpVT3nQbKLacmWmxumowGKRBg07QpAjQTDCgpGOJY4pkySM7hmFgLvYN9qq3fbR5kuJQki0nmXazWxQLBEl0eP7/+HEjSFZBZLfitTUkCwriLhElhsIrR8oakYnrGqE/hQsVCE4vzwEbZ1foA6xtC2TBI3mFSwQJmnnsHIpeYwLO26UqlalAQmEb57FGE9QSYalwxbxSa5BLqbTMNe4kQRnW7wdCbu1iIhJhHXrJ3p2XIhP9IZsViXDSywYJPUe1EUY2KDKhVaP4VHFAv7To1yIRHn9plcdSZHOpAyYi0Foz99z6RiQC7522JYqMfMunRY2NFNlGNPJeNW0jsldpmghaOxYybZOjF1uWk41jRbN0m+xcCAvl/jIPPm8z3d6x3uCsCRiY9yRN+c9hUUNbFBjCvNWwy6ZIYi7REPNL57Qq4sH0Q2ChzWMHbP4Bi5h2z2pIdSY9hlbTiE96LzlgRdiEP5fvyFzdHWcgr0wlkpgaSWPKLnbh6lle3598cJySLu/PU/DBIuSIMaONVPq/kM8Rv+0Jk8I2rMrV1jzblZezF7OT+MMqCo+SsDylp9TshU7SkxfHs/Q4/eZ69nX28p/Zq68naZr+LBJx38Ro+m4sJcUoSZEef7eu/BvsbB+y9TNcIkmlw1igPxHb7YiojFYG3w9t/p5bfBs5Xj7V7Fe2Qap5/6zQEKy8NVUCTqMMCOTXICupDGhJ6L/466YAvbf+j/P4PM/+KAUv0/T9bJeEV4+TcG6WUqsybu9ru0Dz90Y6Nk+d+cdtoDqmeC4Ogh3TuyADFq1XtI5r/v5YOnXcnWe3d7wDObGW74cKu3uBapGJ6eFtEdAvh6ui9VpkoiZyIZtOgzRlbu8n1vFVVRkt88DzPJVOTZezCU/lQxnp3LP4sT1+rkggWSlT/Znc3T4/V1zDrkwHWdrvZqe+R17OfRHGXP19VaMs+Z7Z8vfcRuG+NG8dmitVmVjYaPwhfrhBXdgGGSVQjTAIfPrXb1GmtEXboKHYeVHDF+/MO/O29RAhBl9R0pQw13ivGB08BT8CykZjCHoNyhBWXhJCqSpFUgPniEeskE7mSivuWmazHbgYNX6YwE2NVKPnoy89w5kSl6i52UG2ZBtJrGpwGlbWL+barkICEvI2KIMhAJpamoIZhyokYD1IA2gIvfMqIATy7LXqfLOGPCOsRhpZIetODlJVolbcquBt3gaCYHUbXQZemdZjCUNABrEME07iG8YPHqHDUGPgVbWqxJBAYUuEEIeUQzAl5BgIHPuiCgystDXaFotYvHmrNTjLO0NJzcht7COLk5cm8L3W+TLUYJcw5y0DD+wcPDr6KSBX+EKZRciOjt6ZY7jd9dQN5kER3v1jaP/VavWo7b86lDlT9F2bw4/obFBk/XovXSmq2zyOyljJ7qPTdIYGY/+MBmGvo7RFeDx5TJ3WqN30Cok7JExPL8/jmv0KPn38N1yg9AZqu+q6tWg96jVUgynOXFf5Lm27LQlzGxuv5owXXfMxasRAQwZvakmfPv4a4AdcMWLmEeoSeXR02eZaFXCNjeM7JBwdZfA6QgmggQZUS4JCGsgRQi25lZZKggTXSWtlFhM4NWtoA3pYKapjMzA9yh2EwXnZlTtALgOWYE2UGGxO9h4xvQmolxhYl7HEbmCpiDu69ratOmtjZ/rgPM6V1nCjygopxnZaluB68qojc8JH7uCcB4JqXIP0CAENTeDygUg8aZ2znr1QnfNzq7VdcQHQlM4qQyGD0ss57fUn+0aPiE1Z8wSpS6HcpSPp1exK0k1iH/GOOnnHC/nBEj/ctR7n6NlgDHtfF6f6drod2hK4W/+Xto6otAdnDAE6uMy3ybcP9cSrHH0T3s6v0C9Vgf2N9pmJnkbmqUiEVgWagCOIcHp2eQHLF5NUJKOr8T8Y7unF+es3P1y9YWd4kXYJm03SSRoxug3USDOydIa0e/f2cOEg2Zs9evo/fCP3lzvhPU2dliriqZiwTY+Fbg9ezneJqG0gJm82PLQ/eb3dMrl7rDJCKlVg2/vn6gLXo8f1UuqWbUbY8hne/hW8Z73jD6+YNyK3ZAAbbLCTOS0KdGMDj6DqAd47e3MtEsE78xDkLCLI6f9h7cORWY90H6KfzgH+zTE9KbDZdABqu93xd0eflegDHLi5NHfb7fZ3wWkgTw==",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={},y=[];function f(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,i.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}},title:"inline_response_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/1c57a399.c9e66b6d.js b/assets/js/1c57a399.ef3d0d2a.js similarity index 51% rename from assets/js/1c57a399.c9e66b6d.js rename to assets/js/1c57a399.ef3d0d2a.js index b2a1659d5..320670071 100644 --- a/assets/js/1c57a399.c9e66b6d.js +++ b/assets/js/1c57a399.ef3d0d2a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8901],{45740:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>h,contentTitle:()=>p,default:()=>g,frontMatter:()=>d,metadata:()=>t,toc:()=>m});const t=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the OpenSign\u2122 API documentation v1.1!","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 documentation v1.1!","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 s=i(74848),r=i(28453),a=(i(64624),i(9303)),o=i(12990),l=i.n(o),c=i(79329);i(25383);const d={id:"opensign-api-v-1-1",title:"OpenSign API v1.1",description:"Welcome to the OpenSign\u2122 API documentation v1.1!",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,h={},m=[];function u(e){const n={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,s.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.1"}),"\n",(0,s.jsx)(n.p,{children:"Welcome to the OpenSign\u2122 API documentation v1.1!"}),"\n",(0,s.jsx)(n.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,s.jsx)(n.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Useful Links:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Update in v1.1:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Public template: A public template can be created and shared via a link. Any user with the link can create and sign a document from it. However, users cannot edit the template itself."}),"\n",(0,s.jsx)(n.li,{children:"Prefill widget: Prefill widgets are embedded in a document before it is sent to users. They are available in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates."}),"\n"]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,s.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,s.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,s.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,s.jsx)("div",{children:(0,s.jsx)("table",{children:(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(n.p,{children:"Security Scheme Type:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(n.p,{children:"apiKey"})})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(n.p,{children:"Header parameter name:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(n.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"Contact"})}),(0,s.jsx)("span",{children:(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"Terms of Service"})}),(0,s.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"License"})}),(0,s.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,s.jsx)(n.p,{children:"AGPL v 3.0"})})]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8901],{45740:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>h,contentTitle:()=>p,default:()=>g,frontMatter:()=>d,metadata:()=>t,toc:()=>m});const t=JSON.parse('{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the OpenSign\u2122 API documentation v1.1!","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 documentation v1.1!","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 s=i(74848),r=i(28453),o=(i(64624),i(9303)),a=i(12990),l=i.n(a),c=i(79329);i(25383);const d={id:"opensign-api-v-1-1",title:"OpenSign API v1.1",description:"Welcome to the OpenSign\u2122 API documentation v1.1!",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,h={},m=[];function u(e){const n={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,s.jsx)(o.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1.1"}),"\n",(0,s.jsx)(n.p,{children:"Welcome to the OpenSign\u2122 API documentation v1.1!"}),"\n",(0,s.jsx)(n.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,s.jsx)(n.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Useful Links:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"What\u2019s New in v1.1"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.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,s.jsxs)(n.li,{children:[(0,s.jsx)(n.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,s.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,s.jsx)(o.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,s.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,s.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,s.jsx)("div",{children:(0,s.jsx)("table",{children:(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(n.p,{children:"Security Scheme Type:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(n.p,{children:"apiKey"})})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(n.p,{children:"Header parameter name:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(n.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"Contact"})}),(0,s.jsx)("span",{children:(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"Terms of Service"})}),(0,s.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(n.p,{children:"License"})}),(0,s.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,s.jsx)(n.p,{children:"AGPL v3.0"})})]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/23f866da.8525544f.js b/assets/js/23f866da.8525544f.js deleted file mode 100644 index 86c1c3899..000000000 --- a/assets/js/23f866da.8525544f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>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":"eJztO11zG0eOfwU7dVWOdUNSpGXHp/K5Volzie58sSqSy7UnaZXmDMhpa6Z70t0jklGxKg/7D/Z172V/mn/JFdA9wxmKkuw4tdHd0Q8ypz/QABqNBtDAdeTE1Eb7p9ErnVQFKmej8zhK0SZGlk5qFe1HJxmCxXxi5VTBwdEhTFGhEQ4tCHj7w2twmXCASoxztDAxiNYtcgQaL9UU9AQEpAF+H/6kK0iEApFbDVIleZUiaF5M5FAa7KU4kQpTmMl0is7GMMtkkoHLPEw0PB9T6UAbwHkpVApVqRUICwoxxbQPJ5m0UBp9JVNGtMYG5yUaiSohYIXMhQGnGfaHX/52TCT+SVeG6P3wy3/DJNczkIr735SoeIAoy/6ZOlMnstyHt2WuRQoLXRk4evVvDaEEldpOd3Ze4biawtvDnZ3zLzLnSrs/GBAMXaIitHIxtv1EF4OUBpbp5DGRjAYJqqdVWJkvQKQtprgMFSS6XECitUmloh2JoRRTBFUVYzQ2BuJMoQ0SDQIMinTRc7pXWYR/P37zPUy0KYTrw1Fe2bhZLpUGE5cvPHiivabqkYWxsPhsD6wzUk1jKMQlsVU6+KmSySWRbVGlNVMPjg6ZVzs7x1VZauMwhXeehP2dHer5ConHwiCPT3RRaAWlMKJAh8Z66aJugz9V0rBcuAxEnte82D9TPdjZcYsS93d24FClMmHxJIDUSiLox/b9UGISDT0uMZETGYa2WAdaBakjnsyE388yF4lH06AtMXHyCruA5zEsCPArVLrGINNG/qyVEzlvxxUaJxORt7eNEGTxdsI4YmeppXJ1a1ihOTm0e7wpQa4ItZSYVUjFPRbhSuQV2oDVLIaMsPoBS4OWTnkNlxipUshQTrNb1xPp+8q6DmCoLKHZxiKsVe8SsxeZbRORWwQ56fCyEJfYWq3RAH34agEpTkSVuxgkSZwzFfbhe+3o5OUyIUVDkstnWrjKYI93OYhDQESJgvf4aKUDUjmZoKHDSZ0MIsypsSM580qDyOOT4zKhQKu1jU50rs1NEeLmLh8h0cqx5ju4EjJn5D2xtlF/41wklzGM8wpjMJj6g7vAPNez2Ms7DyEF53nO/CG1TFKoFeGvdFheWrABq0YR1ueJOhtlS4tI2+ZqOLUTTSsTC+ojBlgImcfMuBje6zE46XKM6cCWQi1iSIXDGBzO3VjPY0gyTC7Heh74NdHKWfnzhlNX93w610Yx7MXwLIbnMQx3YxiOYhjuxTB8FsPweQyj3RhGoxhGezGMnnmejp4HfoqGiW0EhiPPSfewOEj687W0fEJJ8dlGl846unTYh52d5lRQ248//nimrs8UwFlEh+Qs2oezqBlyFsW+j3Qf9Q3D95w+noy+DJ8L+nw2eh4+Zzx0uBc+M/ocDc/UMix4pkaMiRNFeQcW1P2bYhC+gqBQGy9KbbVeokZSKHHdQfvRwYc6lm1anhAtUkknRW5vJ6ce8YAoWqF0g6g9IopF8naKuPsBkdPGh3pY3fkuVo+trvpQMxajG9Q/7Ycb4nbi/bIPhvYWOp9H+jMindTPCamf2+lvNNQDYsI6Tp/HiS/7fJGz9r2dD2HAA+JCF6PP48Fz4gFdPLczgHofEPUtdKgj3OK+b3evN3zaG+2O9jocIB/HDyiKXpr2FovFb8E9smvC8mTW1Jamt9CEQ5gYXWxwI9jKX40Kdg//rk3v/ySDe1zbopjWPmhjlTSeW9tadjoVi0fWg6qnNgYYjV+ZX4sWmtxFeLAXm2RaJgF5GlObXWNy1PrEgx5zcpCmgxYnqTFNe0XRW2ukzx4zvtVYFP007a+NvLE7vrGANI3hZvPG9jSFoihuafbtneZBUdykol8UATem90z9Cx2TYJndflLCgH/UYVmdie7Cdx4kigFolfPa7JhtPklr100mVegIYgVrAwxOq1wYnJOHaaVWfvRvf8rqQ7ay39kjZWeO/X3PCvjiTbDRH4cDQCR0AVDL/fNuUEZADiCprNMFGJziHErhHBrFwK5ELlPBTlmPG3AuipIM/cGfz87Sf/6nAYcSyFt3QDsBqZxKiugM/nx60Puv8w0jqrJEkwiLkCOtZGNAl/ThNMO8XAWVZrNZf/bEJpnWuY8ovbcGJ/7vhR6/v2B0y76w5eNNlHrRaLnuJDrrnrtF1+GYsFDP3OC8s4yxCzPc5fs2eDV3XLhhxAO6c9ZQok4fB6Hu07OoEGySkCjj6rd2GZqz6LyZ4911TO+Ze/4RhzWTKeZijPnNro8+aE1zLha6Cue7Dk91SQ0S3eIbdRRSNREIJmc3bnWK+Vqn71tuON+eIe3TWV869fGsdwByaesYTJed7dkhSMWhQwoIk9iOEeoJMG6k9LNPQYPYxx0Dr4nC3t2zBI0DHtgECJuYwN0rdDamzRiCUUgli6poIp2TBmrNsiJYH21+0czKoqlXaO/ujRXE/J4VKKx4+wJnasiRDFmI6R2GKXc/IC0R8FmT7yiOdEnvJVKrwzTaj+q3lChmoGjdVzpdRPvXUYh50c8QUaJJg/eW3mGuI5tkWAj6VSNDLzcTmWMUR/5lxEZxxA4SPeMQp6L9SI/fY+KimK7ukk43WoLB8/av61E+nh/FwVyO9iMf6I/iKFxgTROgSjQZpWU6iZb1gneBalpWoCz/aB4WCA6FzH8lmO9p6nLt5epXQXrVgsC0FXiiv9bU5/CVWNgWXC/f0fqDGc2h85uEWZCKhaUwYWW9KkpEnlQ5md44L6VZNH4A298NS1r4Nis1+A6fLutNb2F0y14b/ekblKAmBnDM5VPnvtc4RvxjaCBLhPdXFJ+MxXuNMEbe2zLT6pPnD0dPhqPhk+GIIIRgaQuGMEYsojiSDgt7Px99700Muvt/QKFfTOtbqLd6p4iBY4z9+0SxHs9kiyneL3Mnt71ftULqNtNVnlKwGoXp8zPSr36h7IoxLcLU9u8R2mUcze8nZg6J7tWPY/BFjhPnTWBItFFoHrc96wdD3GhvbxlHi/vJW/yvJO9L2rzZ/dS941fF1Yvr74Hrk+fLOMrux/W75t3zd0R279lydYlGiUHh0GFREpCLsU4XF7XeWrYH1mZEfV34oeFGWNKKeYqGLI6b+mqlamgkvddfrOv5sdY5CrVB0XQewwTpOstmKxnFIbQ0y5B8n5U1y9BtY4YHE9qbLPTAhmvevLRk6ZkKz6I+HE5WvPSG8Pp7XD2W3+OUhke83oWtWI0/GoRv4tCjdm4BPfeuQmo1CjwY6i2wMJN5TnjT9d2H5h+bdg0nCYH6uqwXvv+q+NpHEXjBMKn7sg3BROzD10I1L5/dF0a4vm6EgKVjuYTra9pVNBd06S6X8aqB1uo08L3qWwwmKK86s5omXE1s2lpTvSVzQZaMbwhR6jYCPgXnojIBDhl8y2W/I5BriEPGfhXzANNGzigN5ybVjb3CO/3R3L/B7CABBOT/Dd9flC+/kxtQeTEoX74oX76jPJYS/dnz7JlIlfqTP8M878ML64xW05drLHgxCO2bt9LglcQZH1ze1RWUdd42gPoBJ0rUam2etJCYKpEi5/CZ0QnWyUK0bwrnDqzD0pKrLp3PCOM0BDa7xdQgcuYW4SIqx3k77IHVC74QkBmc/OujNZ4+esl5YZSy9WIgXobRh96bz8QVglALYMI5qKGNj0pMKsNqMsmFkZPg7sVQ5kihPvIGReKjDJ6jNR4nmVCXNn4xNi9PUBRNZtqHv/ydRvAx4HS8E12Zj9DpHHzo+b31vq/XeR4ICJhW/AjhiE+1euIo5CpXRirrTOXjAZBWpk4PqvPueD+s7YdsoB6k0vqEiQzb8GNAZf10ARNhHZoYKiWVQ2OqkiTnZipfR5R5gSU51z6Pjfbofl3QTUqhtEafgtfKOqzvgRowhqzD4Oc1CVF1BuA66Rsv3nBO7keQLklOWwqhoBKN1YpkSZupUEFUveGvLXlNmcj9UH9eJT3hED50/3aRqU2aD3/5ewuvW12/m4j5FUSaUoz8Hgw5AESRHsthIINlvgCnuxgRPDR/XLe1onstIG8krQIk4V6mhD2trHfjRru79F+XjDoDFrwFloKtEtq2SZXniz9E8cdHZ+72IX3zZrvsLqcwey9HP8+Tq9ERbdEtMn0ngGDDVianHFDiXK9Jy13nrVS5VHhRs+1itLt7MSTeLuNobxP7jnWBLuOEJ2LijDR1o8qcWYCYCqmALCrzG3ITjdHmbhP30zC7iwl7HSY8vcmEQ8Wxcs6SPtGXqP6xlLaXd355QnVesKx4NRNJP4j7ow6x7XZPpMWkMtItov3T62jeE6Xs+f790/PleRwRYzXFNEttGWPhsmg/GrRCnBbNFcUlCQILbSOHVqiUQtk3/ClRysHVsD+MlvH6nI3+1x3jsep96hTrxFSq6X3zzlfcOaYd9JvU4dEqylTK/0AKM4UtaI+KI0mSk6FIyW9bxhEJxg+rwPA39fbWIdtNUdiWUlyLq9Zh1U6kdF2Fb4h9bg59Dp+2g44+rMiRwiZQuCn21xBeR/OaYF4rPtcKz52uhLyJhNWBsCFHkEZ7exxq+XLIMYknz9nd33u2PO94vlHU9W45cL/uo32ey9H1OLZm9P8hM7prRftH1jWrshawxorrmFLrltTtVg1pgYlmlRHOcVNtQsqcVc6NQBvmiS6ajOMW9jyn3ndvdBGEP9DL2pvKQKlnaCaVT1+e5DiXZIjTJCy4bxXQQVHkaG2+ALLAp1T24/MVRN7Yt4koxVjmkm4qGqaDJKwuO9uHd6uQ0CPj0zeuMKcLjoREF4Lt58Z2nmlzScU3VMMCY6o2IMMSVSZU4m1Yr3tjkgKqkCH/oDTSUhGFIaylx00rZ2j7C6HElAUz7rAqxZzOqQWjx/TsaXVeefFyQuba+BcbJoiEzfLz5Dfzkro4UkjWv8GMdvQqeDKWkrpTBK9WQxnOmAILJeEiE+RQWKVyTRUzFFSo8hxKTXYCHTw96eBI050RypJ5Fx6Jwh40DAtOBtqQLv7WIu3wa6kufXZ4D04bmXqHYysddjNH1qXycXfOt9J9V42phkRb6bRZrGZPpcuqMV+QbSDNh4f0bSgbg9b1t4KR6sRuCK3qxA4oyWVwjI4kxA4Ojg7ZtHoMH375K7xGYRRkeualNakM5oumQs3XP/HOe7Y1lhG7saSdiOOJF76gVBsOlvwsJ/3hCTw8qsa5TJrg4D4cQNltqt+2azeCVXImSJCupAABuVSXfThQC3aCVpqV2nmyn7nS5avqOf8wIF0fvtMzvGLXuHakqGiBa+J8bk5ARjqyxfjR/sjgRDZVU/tr3z4YisUY05Bv2Fp2jBMuInNcWxLCt7wyB28XPFc0hRohWXEVKUOVckWT3YfUiIlrINt4tQiTzZr7RlNdslGTFQcwTYzWH7G1nbB9H6NdM8q6WtTgBPnNlY/kSnBKGQTltBY46CZbfbrAkpoPtxEb9OFSEKXceCNQQZd9MzlGcyWT2oG75awOePAgiqNcJqgstgz+g2+PXsMVPOnvRnHL1v2Iczt4ffj1N98ff0PYkI70HBv2d/u7/DKprSuEai11jPkEjr3hv/YU33hB23rSbT3ptp50W0+6rSfd1pNu60m39aTbetJtPem2nnRbT7qtJ/3dqlu29aTbetJtPem2nnRbT7qtJ93Wk27rSbf1pNt60m096e+uJW6tJw3JMaQwB2UupGplBPoUrNNVlel5HGWUnbV/Gl1fU7D9LeVaUPNPFRpK7TqPoythJIWbOLErrrORKBHnEimt5WsfPeud0MqxV1b8dLWWz0bpVH7GQZJg6e4c204gO3pzfBLFUZ23X+iU5hgxoypZMfOZFoGPnHokuBQpF2pacV5Q5GFSAhU963azry45+yr8aKUXCbVoYdhNy/Jk0F8iauOE62uf2cVpQH6877p1RmBsPZp27ny5XP4POXm7lA==","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(33617),l=t.n(o),a=t(17543),d=t.n(a),p=t(86013),c=t.n(p),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11zG0eOfwU7dVWOdUNSpGXHp/K5Volzie58sSqSy7UnaZXmDMhpa6Z70t0jklGxKg/7D/Z172V/mn/JFdA9wxmKkuw4tdHd0Q8ypz/QABqNBtDAdeTE1Eb7p9ErnVQFKmej8zhK0SZGlk5qFe1HJxmCxXxi5VTBwdEhTFGhEQ4tCHj7w2twmXCASoxztDAxiNYtcgQaL9UU9AQEpAF+H/6kK0iEApFbDVIleZUiaF5M5FAa7KU4kQpTmMl0is7GMMtkkoHLPEw0PB9T6UAbwHkpVApVqRUICwoxxbQPJ5m0UBp9JVNGtMYG5yUaiSohYIXMhQGnGfaHX/52TCT+SVeG6P3wy3/DJNczkIr735SoeIAoy/6ZOlMnstyHt2WuRQoLXRk4evVvDaEEldpOd3Ze4biawtvDnZ3zLzLnSrs/GBAMXaIitHIxtv1EF4OUBpbp5DGRjAYJqqdVWJkvQKQtprgMFSS6XECitUmloh2JoRRTBFUVYzQ2BuJMoQ0SDQIMinTRc7pXWYR/P37zPUy0KYTrw1Fe2bhZLpUGE5cvPHiivabqkYWxsPhsD6wzUk1jKMQlsVU6+KmSySWRbVGlNVMPjg6ZVzs7x1VZauMwhXeehP2dHer5ConHwiCPT3RRaAWlMKJAh8Z66aJugz9V0rBcuAxEnte82D9TPdjZcYsS93d24FClMmHxJIDUSiLox/b9UGISDT0uMZETGYa2WAdaBakjnsyE388yF4lH06AtMXHyCruA5zEsCPArVLrGINNG/qyVEzlvxxUaJxORt7eNEGTxdsI4YmeppXJ1a1ihOTm0e7wpQa4ItZSYVUjFPRbhSuQV2oDVLIaMsPoBS4OWTnkNlxipUshQTrNb1xPp+8q6DmCoLKHZxiKsVe8SsxeZbRORWwQ56fCyEJfYWq3RAH34agEpTkSVuxgkSZwzFfbhe+3o5OUyIUVDkstnWrjKYI93OYhDQESJgvf4aKUDUjmZoKHDSZ0MIsypsSM580qDyOOT4zKhQKu1jU50rs1NEeLmLh8h0cqx5ju4EjJn5D2xtlF/41wklzGM8wpjMJj6g7vAPNez2Ms7DyEF53nO/CG1TFKoFeGvdFheWrABq0YR1ueJOhtlS4tI2+ZqOLUTTSsTC+ojBlgImcfMuBje6zE46XKM6cCWQi1iSIXDGBzO3VjPY0gyTC7Heh74NdHKWfnzhlNX93w610Yx7MXwLIbnMQx3YxiOYhjuxTB8FsPweQyj3RhGoxhGezGMnnmejp4HfoqGiW0EhiPPSfewOEj687W0fEJJ8dlGl846unTYh52d5lRQ248//nimrs8UwFlEh+Qs2oezqBlyFsW+j3Qf9Q3D95w+noy+DJ8L+nw2eh4+Zzx0uBc+M/ocDc/UMix4pkaMiRNFeQcW1P2bYhC+gqBQGy9KbbVeokZSKHHdQfvRwYc6lm1anhAtUkknRW5vJ6ce8YAoWqF0g6g9IopF8naKuPsBkdPGh3pY3fkuVo+trvpQMxajG9Q/7Ycb4nbi/bIPhvYWOp9H+jMindTPCamf2+lvNNQDYsI6Tp/HiS/7fJGz9r2dD2HAA+JCF6PP48Fz4gFdPLczgHofEPUtdKgj3OK+b3evN3zaG+2O9jocIB/HDyiKXpr2FovFb8E9smvC8mTW1Jamt9CEQ5gYXWxwI9jKX40Kdg//rk3v/ySDe1zbopjWPmhjlTSeW9tadjoVi0fWg6qnNgYYjV+ZX4sWmtxFeLAXm2RaJgF5GlObXWNy1PrEgx5zcpCmgxYnqTFNe0XRW2ukzx4zvtVYFP007a+NvLE7vrGANI3hZvPG9jSFoihuafbtneZBUdykol8UATem90z9Cx2TYJndflLCgH/UYVmdie7Cdx4kigFolfPa7JhtPklr100mVegIYgVrAwxOq1wYnJOHaaVWfvRvf8rqQ7ay39kjZWeO/X3PCvjiTbDRH4cDQCR0AVDL/fNuUEZADiCprNMFGJziHErhHBrFwK5ELlPBTlmPG3AuipIM/cGfz87Sf/6nAYcSyFt3QDsBqZxKiugM/nx60Puv8w0jqrJEkwiLkCOtZGNAl/ThNMO8XAWVZrNZf/bEJpnWuY8ovbcGJ/7vhR6/v2B0y76w5eNNlHrRaLnuJDrrnrtF1+GYsFDP3OC8s4yxCzPc5fs2eDV3XLhhxAO6c9ZQok4fB6Hu07OoEGySkCjj6rd2GZqz6LyZ4911TO+Ze/4RhzWTKeZijPnNro8+aE1zLha6Cue7Dk91SQ0S3eIbdRRSNREIJmc3bnWK+Vqn71tuON+eIe3TWV869fGsdwByaesYTJed7dkhSMWhQwoIk9iOEeoJMG6k9LNPQYPYxx0Dr4nC3t2zBI0DHtgECJuYwN0rdDamzRiCUUgli6poIp2TBmrNsiJYH21+0czKoqlXaO/ujRXE/J4VKKx4+wJnasiRDFmI6R2GKXc/IC0R8FmT7yiOdEnvJVKrwzTaj+q3lChmoGjdVzpdRPvXUYh50c8QUaJJg/eW3mGuI5tkWAj6VSNDLzcTmWMUR/5lxEZxxA4SPeMQp6L9SI/fY+KimK7ukk43WoLB8/av61E+nh/FwVyO9iMf6I/iKFxgTROgSjQZpWU6iZb1gneBalpWoCz/aB4WCA6FzH8lmO9p6nLt5epXQXrVgsC0FXiiv9bU5/CVWNgWXC/f0fqDGc2h85uEWZCKhaUwYWW9KkpEnlQ5md44L6VZNH4A298NS1r4Nis1+A6fLutNb2F0y14b/ekblKAmBnDM5VPnvtc4RvxjaCBLhPdXFJ+MxXuNMEbe2zLT6pPnD0dPhqPhk+GIIIRgaQuGMEYsojiSDgt7Px99700Muvt/QKFfTOtbqLd6p4iBY4z9+0SxHs9kiyneL3Mnt71ftULqNtNVnlKwGoXp8zPSr36h7IoxLcLU9u8R2mUcze8nZg6J7tWPY/BFjhPnTWBItFFoHrc96wdD3GhvbxlHi/vJW/yvJO9L2rzZ/dS941fF1Yvr74Hrk+fLOMrux/W75t3zd0R279lydYlGiUHh0GFREpCLsU4XF7XeWrYH1mZEfV34oeFGWNKKeYqGLI6b+mqlamgkvddfrOv5sdY5CrVB0XQewwTpOstmKxnFIbQ0y5B8n5U1y9BtY4YHE9qbLPTAhmvevLRk6ZkKz6I+HE5WvPSG8Pp7XD2W3+OUhke83oWtWI0/GoRv4tCjdm4BPfeuQmo1CjwY6i2wMJN5TnjT9d2H5h+bdg0nCYH6uqwXvv+q+NpHEXjBMKn7sg3BROzD10I1L5/dF0a4vm6EgKVjuYTra9pVNBd06S6X8aqB1uo08L3qWwwmKK86s5omXE1s2lpTvSVzQZaMbwhR6jYCPgXnojIBDhl8y2W/I5BriEPGfhXzANNGzigN5ybVjb3CO/3R3L/B7CABBOT/Dd9flC+/kxtQeTEoX74oX76jPJYS/dnz7JlIlfqTP8M878ML64xW05drLHgxCO2bt9LglcQZH1ze1RWUdd42gPoBJ0rUam2etJCYKpEi5/CZ0QnWyUK0bwrnDqzD0pKrLp3PCOM0BDa7xdQgcuYW4SIqx3k77IHVC74QkBmc/OujNZ4+esl5YZSy9WIgXobRh96bz8QVglALYMI5qKGNj0pMKsNqMsmFkZPg7sVQ5kihPvIGReKjDJ6jNR4nmVCXNn4xNi9PUBRNZtqHv/ydRvAx4HS8E12Zj9DpHHzo+b31vq/XeR4ICJhW/AjhiE+1euIo5CpXRirrTOXjAZBWpk4PqvPueD+s7YdsoB6k0vqEiQzb8GNAZf10ARNhHZoYKiWVQ2OqkiTnZipfR5R5gSU51z6Pjfbofl3QTUqhtEafgtfKOqzvgRowhqzD4Oc1CVF1BuA66Rsv3nBO7keQLklOWwqhoBKN1YpkSZupUEFUveGvLXlNmcj9UH9eJT3hED50/3aRqU2aD3/5ewuvW12/m4j5FUSaUoz8Hgw5AESRHsthIINlvgCnuxgRPDR/XLe1onstIG8krQIk4V6mhD2trHfjRru79F+XjDoDFrwFloKtEtq2SZXniz9E8cdHZ+72IX3zZrvsLqcwey9HP8+Tq9ERbdEtMn0ngGDDVianHFDiXK9Jy13nrVS5VHhRs+1itLt7MSTeLuNobxP7jnWBLuOEJ2LijDR1o8qcWYCYCqmALCrzG3ITjdHmbhP30zC7iwl7HSY8vcmEQ8Wxcs6SPtGXqP6xlLaXd355QnVesKx4NRNJP4j7ow6x7XZPpMWkMtItov3T62jeE6Xs+f790/PleRwRYzXFNEttGWPhsmg/GrRCnBbNFcUlCQILbSOHVqiUQtk3/ClRysHVsD+MlvH6nI3+1x3jsep96hTrxFSq6X3zzlfcOaYd9JvU4dEqylTK/0AKM4UtaI+KI0mSk6FIyW9bxhEJxg+rwPA39fbWIdtNUdiWUlyLq9Zh1U6kdF2Fb4h9bg59Dp+2g44+rMiRwiZQuCn21xBeR/OaYF4rPtcKz52uhLyJhNWBsCFHkEZ7exxq+XLIMYknz9nd33u2PO94vlHU9W45cL/uo32ey9H1OLZm9P8hM7prRftH1jWrshawxorrmFLrltTtVg1pgYlmlRHOcVNtQsqcVc6NQBvmiS6ajOMW9jyn3ndvdBGEP9DL2pvKQKlnaCaVT1+e5DiXZIjTJCy4bxXQQVHkaG2+ALLAp1T24/MVRN7Yt4koxVjmkm4qGqaDJKwuO9uHd6uQ0CPj0zeuMKcLjoREF4Lt58Z2nmlzScU3VMMCY6o2IMMSVSZU4m1Yr3tjkgKqkCH/oDTSUhGFIaylx00rZ2j7C6HElAUz7rAqxZzOqQWjx/TsaXVeefFyQuba+BcbJoiEzfLz5Dfzkro4UkjWv8GMdvQqeDKWkrpTBK9WQxnOmAILJeEiE+RQWKVyTRUzFFSo8hxKTXYCHTw96eBI050RypJ5Fx6Jwh40DAtOBtqQLv7WIu3wa6kufXZ4D04bmXqHYysddjNH1qXycXfOt9J9V42phkRb6bRZrGZPpcuqMV+QbSDNh4f0bSgbg9b1t4KR6sRuCK3qxA4oyWVwjI4kxA4Ojg7ZtHoMH375K7xGYRRkeualNakM5oumQs3XP/HOe7Y1lhG7saSdiOOJF76gVBsOlvwsJ/3hCTw8qsa5TJrg4D4cQNltqt+2azeCVXImSJCupAABuVSXfThQC3aCVpqV2nmyn7nS5avqOf8wIF0fvtMzvGLXuHakqGiBa+J8bk5ARjqyxfjR/sjgRDZVU/tr3z4YisUY05Bv2Fp2jBMuInNcWxLCt7wyB28XPFc0hRohWXEVKUOVckWT3YfUiIlrINt4tQiTzZr7RlNdslGTFQcwTYzWH7G1nbB9H6NdM8q6WtTgBPnNlY/kSnBKGQTltBY46CZbfbrAkpoPtxEb9OFSEKXceCNQQZd9MzlGcyWT2oG75awOePAgiqNcJqgstgz+g2+PXsMVPOnvRnHL1v2Iczt4ffj1N98ff0PYkI70HBv2d/u7/DKprSuEai11jPkEjr3hv/YU33hB23rSbT3ptp50W0+6rSfd1pNu60m39aTbetJtPem2nnRbT7qtJ/3dqlu29aTbetJtPem2nnRbT7qtJ93Wk27rSbf1pNt60m096e+uJW6tJw3JMaQwB2UupGplBPoUrNNVlel5HGWUnbV/Gl1fU7D9LeVaUPNPFRpK7TqPoythJIWbOLErrrORKBHnEimt5WsfPeud0MqxV1b8dLWWz0bpVH7GQZJg6e4c204gO3pzfBLFUZ23X+iU5hgxoypZMfOZFoGPnHokuBQpF2pacV5Q5GFSAhU963azry45+yr8aKUXCbVoYdhNy/Jk0F8iauOE62uf2cVpQH6877p1RmBsPZp27ny5XP4POXm7lA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},x=void 0,f={},j=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/23f866da.89427f12.js b/assets/js/23f866da.89427f12.js new file mode 100644 index 000000000..bc6ce6a3c --- /dev/null +++ b/assets/js/23f866da.89427f12.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[285],{64658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>f});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":"eJztO11vG0lyf6VuEMBrZUiKtOx1BMc4rb23q8SxhZUM4yLptM2ZIqetme7Z7h6RXIHAPtw/yFOA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ0x/VVdXV1VXVVdeRE1Mb7Z9GL3VSFaicjc7jKEWbGFk6qVW0H51kCBbziZVTBQdHhzBFhUY4tCDg7Q+vwGXCASoxztHCxCBat8gRaLxUU9ATEJAG+H34s64gEQpEbjVIleRViqB5MZFDabCX4kQqTGEm0yk6G8Msk0kGLvMw0fB8TKUDbQDnpVApVKVWICwoxBTTPpxk0kJp9JVMGdEaG5yXaCSqhIAVMhcGnGbYH375r2Mi8c+6MkTvh1/+Gya5noFU3P+mRMUDRFn2z9SZOpHlPrwtcy1SWOjKwNHLPzWEElRqO93ZeYnjagpvD3d2zr/KnCvt/mBAMHSJitDKxdj2E10MUhpYppOHRDIaJKieVmFlvgCRtpjiMlSQ6HIBidYmlYp2JIZSTBFUVYzR2BiIM4U2SDQIMCjSRc/pXmUR/uX4zWuYaFMI14ejvLJxs1wqDSYuX3jwRHtN1QMLY2HxyR5YZ6SaxlCIS2KrdPBTJZNLItuiSmumHhwdMq92do6rstTGYQrvPAn7OzvU8w0Sj4VBHp/ootAKSmFEgQ6N9dJF3QZ/qqRhuXAZiDyvebF/pnqws+MWJe7v7MChSmXC4kkAqZVE0I/t+6HEJBp6XGIiJzIMbbEOtApSRzyZCb+fZS4Sj6ZBW2Li5BV2Ac9jWBDgl6h0jUGmjfxZKydy3o4rNE4mIm9vGyHI4u2EccTOUkvl6tawQnNyaPd4U4JcEWopMauQinsswpXIK7QBq1kMGWH1A5YGLZ3yGi4xUqWQoZxmt64n0veVdR3AUFlCs41FWKveJWYvMtsmIrcIctLhZSEusbVaowH68M0CUpyIKncxSJI4Zyrsw2vt6OTlMiFFQ5LLZ1q4ymCPdzmIQ0BEiYL3+GilA1I5maChw0mdDCLMqbEjOfNKg8jjk+MyoUCrtY1OdK7NTRHi5i4fIdHKseY7uBIyZ+Q9sbZRf+NcJJcxjPMKYzCY+oO7wDzXs9jLOw8hBed5zvwhtUxSqBXhr3RYXlqwAatGEdbniTobZUuLSNvmaji1E00rEwvqIwZYCJnHzLgY3usxOOlyjOnAlkItYkiFwxgczt1Yz2NIMkwux3oe+DXRyln584ZTV/d8OtdGMezF8CSGpzEMd2MYjmIY7sUwfBLD8GkMo90YRqMYRnsxjJ54no6eBn6KholtBIYjz0n3ZXGQ9OcrafmEkuKzjS6ddXTpsA87O82poLYff/zxTF2fKYCziA7JWbQPZ1Ez5CyKfR/pPuobhu85fTwafR0+F/T5ZPQ0fM546HAvfGb0ORqeqWVY8EyNGBMnivIOLKj7N8UgfAVBoTZelNpqvUSNpFDiuoP2o4MPdSzbtDwiWqSSTorc3k5OPeILomiF0g2i9ogoFsnbKeLuL4icNj7Uw+rOd7F6bHXVh5qxGN2g/nE/3BC3E++X/WJob6HzeaQ/IdJJ/ZyQ+rmd/kZDfUFMWMfp8zjxdZ8vcta+t/MhDPiCuNDF6PN48JR4QBfP7Qyg3i+I+hY61BFucd+3u9cbPu6Ndkd7HQ6Qj+MHFEUvTXuLxeK34B7ZNWF5MmtqS9NbaMIhTIwuNrgRbOWvRgW7h3/Xpve/kcE9rm1RTGsftLFKGs+tbS07nYrFA+tB1VMbA4zGr8yvRQtN7iI82ItNMi2TgDyNqc2uMTlqfeJBjzk5SNNBi5PUmKa9ouitNdJnjxnfaiyKfpr210be2B3fWECaxnCzeWN7mkJRFLc0+/ZO86AoblLRL4qAG9N7pv6JjkmwzG4/KWHA3+uwrM5Ed+E7DxLFALTKeW12zDafpLXrJpMqdASxgrUBBqdVLgzOycO0Uis/+rc/ZfUhW9nv7JGyM8f+vmcFfPUm2OgPwwEgEroAqOX+eTcoIyAHkFTW6QIMTnEOpXAOjWJgVyKXqWCnrMcNOBdFSYb+4C9nZ+k//sOAQwnkrTugnYBUTiVFdAZ/OT3o/fv5hhFVWaJJhEXIkVayMaBL+nCaYV6ugkqz2aw/e2STTOvcR5TeW4MT//dCj99fMLplX9jy4SZKvWi0XHcSnXXP3aLrcExYqGducN5ZxtiFGe7yfRu8mjsu3DDiC7pz1lCiTh8Hoe7Ts6gQbJKQKOPqt3YZmrPovJnj3XVM75l7/hGHNZMp5mKM+c2ujz5oTXMuFroK57sOT3VJDRLd4ht1FFI1EQgmZzdudYr5WqfvW244354h7dNZXzr18ax3AHJp6xhMl53t2SFIxaFDCgiT2I4R6gkwbqT0s09Bg9jHHQOvicLe3bMEjQMe2AQIm5jA3St0NqbNGIJRSCWLqmginZMGas2yIlgfbX7RzMqiqVdo7+6NFcT8nhUorHj7AmdqyJEMWYjpHYYpd39BWiLgsybfURzpkt5LpFaHabQf1W8pUcxA0bpvdLqI9q+jEPOinyGiRJMG7y29w1xHNsmwEPSrRoZebiYyxyiO/MuIjeKIHSR6xiFORfuRHr/HxEUxXd0lnW60BIPn7V/Xo3w8P4qDuRztRz7QH8VRuMCaJkCVaDJKy3QSLesF7wLVtKxAWf7RPCwQHAqZ/0owr2nqcu3l6ldBetmCwLQVeKJfaOpz+FIsbAuul+9o/cGM5tD5TcIsSMXCUpiwsl4VJSJPqpxMb5yX0iwaP4Dt74YlLXyblRp8h4+X9aa3MLplr43+9A1KUBMDOObyqXPfaxwj/jE0kCXC+yuKT8bivUYYI+9tmWn1yfOHo0fD0fDRcEQQQrC0BUMYIxZRHEmHhb2fj773Jgbd/T+g0C+m9S3UW71TxMAxxv59oliPZ7LFFO+XuZPb3q9aIXWb6SpPKViNwvT5GelXv1B2xZgWYWr79wjtMo7m9xMzh0T36scx+CrHifMmMCTaKDQP2571F0PcaG9vGUeL+8lb/K8k72vavNn91L3jV8XVi+vvgeujp8s4yu7H9fvm3fN3RHbvyXJ1iUaJQeHQYVESkIuxThcXtd5atgfWZkR9Xfih4UZY0op5ioYsjpv6aqVqaCS911+s6/mx1jkKtUHRdB7DBOk6y2YrGcUhtDTLkHyflTXL0G1jhgcT2pss9MCGa968tGTpmQrPoj4cTla89Ibw+ntcPZbf45SGB7zeha1YjT8YhG/i0IN2bgE9965CajUKPBjqLbAwk3lOeNP13YfmH5t2DScJgfq6rBe+/6p44aMIvGCY1H3ZhmAi9uGFUM3LZ/eFEa6vGyFg6Vgu4fqadhXNBV26y2W8aqC1Og18r/oWgwnKq86spglXE5u21lRvyVyQJeMbQpS6jYBPwbmoTIBDBt9y2e8I5BrikLFfxTzAtJEzSsO5SXVjr/BOfzT3bzA7SAAB+X/D92fl8+/lBlSeDcrnz8rn7yiPpUR/9jx7JlKl/uTPMM/78Mw6o9X0+RoLng1C++atNHglccYHl3d1BWWdtw2gfsCJErVamyctJKZKpMg5fGZ0gnWyEO2bwrkD67C05KpL5zPCOA2BzW4xNYicuUW4iMpx3g57YPWCzwRkBif//GCNpw+ec14YpWw9G4jnYfSh9+YzcYUg1AKYcA5qaOOjEpPKsJpMcmHkJLh7MZQ5UqiPvEGR+CiD52iNx0km1KWNn43N8xMURZOZ9uGvf6MRfAw4He9EV+YjdDoHH3p+b73v63WeBwICphU/QjjiU62eOAq5ypWRyjpT+XgApJWp04PqvDveD2v7IRuoB6m0PmEiwzb8GFBZP13ARFiHJoZKSeXQmKokybmZytcRZV5gSc61z2OjPbpfF3STUiit0afgtbIO63ugBowh6zD4eU1CVJ0BuE76xos3nJP7EaRLktOWQiioRGO1IlnSZipUEFVv+GtLXlMmcj/Un1dJTziED92/XWRqk+bDX//WwutW1+8mYn4FkaYUI78HQw4AUaTHchjIYJkvwOkuRgQPzR/Xba3oXgvIG0mrAEm4lylhTyvr3bjR7i791yWjzoAFb4GlYKuEtm1S5fniD1H88dGZu31I37zZLrvLKczey9HP8+RqdERbdItM3wkg2LCVySkHlDjXa9Jy13krVS4VXtRsuxjt7l4MibfLONrbxL5jXaDLOOGJmDgjTd2oMmcWIKZCKiCLyvyG3ERjtLnbxP00zO5iwl6HCY9vMuFQcaycs6RP9CWqvy+l7eWdX55QnRcsK17NRNIP4v6oQ2y73RNpMamMdIto//Q6mvdEKXu+f//0fHkeR8RYTTHNUlvGWLgs2o8GrRCnRXNFcUmCwELbyKEVKqVQ9g1/SpRycDXsD6NlvD5no/91x3isep86xToxlWp637zzFXeOaQf9JnV4tIoylfJfkcJMYQvao+JIkuRkKFLy25ZxRILxwyow/G29vXXIdlMUtqUU1+KqdVi1EyldV+EbYp+bQ5/Dx+2gow8rcqSwCRRuiv01hNfRvCaY14rPtcJzpyshbyJhdSBsyBGk0d4eh1q+HnJM4tFTdvf3nizPO55vFHW9Ww7cr/ton+dydD2OrRn9f8iM7lrR/pF1zaqsBayx4jqm1LoldbtVQ1pgolllhHPcVJuQMmeVcyPQhnmiiybjuIU9z6n33RtdBOEP9LL2pjJQ6hmaSeXTlyc5ziUZ4jQJC+5bBXRQFDlamy+ALPAplf34fAWRN/ZtIkoxlrmkm4qG6SAJq8vO9uHdKiT0wPj0jSvM6YIjIdGFYPu5sZ1n2lxS8Q3VsMCYqg3IsESVCZV4G9br3pikgCpkyD8ojbRURGEIa+lx08oZ2v5CKDFlwYw7rEoxp3NqwegxPXtanVdevJyQuTb+xYYJImGz/Dz57bykLo4UkvVvMKMdvQqejKWk7hTBq9VQhjOmwEJJuMgEORRWqVxTxQwFFao8h1KTnUAHT086ONJ0Z4SyZN6FR6KwBw3DgpOBNqSLv7VIO/xKqkufHd6D00am3uHYSofdzJF1qXzYnfOddN9XY6oh0VY6bRar2VPpsmrMF2QbSPPhIX0Xysagdf2tYKQ6sRtCqzqxA0pyGRyjIwmxg4OjQzatHsKHX/4DXqEwCjI989KaVAbzRVOh5uufeOc92xrLiN1Y0k7E8cQLX1CqNQffZcJ9+OU/LbxGrgGjI+QZubNzVI1zmcBJHSPc2dmHF+w3tOKGnZfuTJAoXUkBAko/O5fqsg8HasHe0ErFUjvP65DBar3ebl+GlYJWIRXHr9lfYUTthcX8CtnNopKGMXLRHEl0ZnQ19au1kQnEGZyQqxvqtIi2gzSl0jxurktmqOpohQ5OfLEMLnxUlWs3jtamcE9TuxByGlcBNVQpFz7ZfUiNmLgV/Hgl6OyesYK/0VRXdtTsiAOYZkv8SQwUN619juSumW5dXWtwgvwyy2Sv9qWUQZxOa7GEbkrWp4s1XQbhzmKzP1wdopQb7w0q+7JvJsdormRSu3m3nOgBDx5EcZTLBJXFlltw8N3RK7h61N+N4pZB/BGHe/Dq8MW3r4+/JWRIkXqGDfu7/V1+vtTWFUK1VjrGfALH3jtYe69vXKVt0em26HRbdLotOt0WnW6LTrdFp9ui023R6bbodFt0ui063Rad/m4lMNui023R6bbodFt0ui063RadbotOt0Wn26LTbdHptuj0d9cStxadhgwaUpiDMhdStdIGfZ7W6aoU9TyOMkrh2j+Nrq8p2P6WEjKo+acKDeV/ncfRlTCSwk2c/RXXKUuUrXOJlPvywkfPeie0cuyVFb9crSW9Uc6Vn3GQJFi6O8e2s8yO3hyfRHFUJ/cXOqU5RsyolFbMfDpG4CPnJwmuV8qFmlacPBR5mJRlRW+/3RStS07RCj9aOUhCLVoYdnO3PBn0l4jaOOH62qd/ca6QH++7bp0RGFuPpp07Xy6X/wNHVMrb","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"}}');var s=t(74848),o=t(28453),r=t(33617),a=t.n(r),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const g={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztO11vG0lyf6VuEMBrZUiKtOx1BMc4rb23q8SxhZUM4yLptM2ZIqetme7Z7h6RXIHAPtw/yFOA5OV+mn9JUNU9wxmKkuz14tZJ6AeZ0x/VVdXV1VXVVdeRE1Mb7Z9GL3VSFaicjc7jKEWbGFk6qVW0H51kCBbziZVTBQdHhzBFhUY4tCDg7Q+vwGXCASoxztHCxCBat8gRaLxUU9ATEJAG+H34s64gEQpEbjVIleRViqB5MZFDabCX4kQqTGEm0yk6G8Msk0kGLvMw0fB8TKUDbQDnpVApVKVWICwoxBTTPpxk0kJp9JVMGdEaG5yXaCSqhIAVMhcGnGbYH375r2Mi8c+6MkTvh1/+Gya5noFU3P+mRMUDRFn2z9SZOpHlPrwtcy1SWOjKwNHLPzWEElRqO93ZeYnjagpvD3d2zr/KnCvt/mBAMHSJitDKxdj2E10MUhpYppOHRDIaJKieVmFlvgCRtpjiMlSQ6HIBidYmlYp2JIZSTBFUVYzR2BiIM4U2SDQIMCjSRc/pXmUR/uX4zWuYaFMI14ejvLJxs1wqDSYuX3jwRHtN1QMLY2HxyR5YZ6SaxlCIS2KrdPBTJZNLItuiSmumHhwdMq92do6rstTGYQrvPAn7OzvU8w0Sj4VBHp/ootAKSmFEgQ6N9dJF3QZ/qqRhuXAZiDyvebF/pnqws+MWJe7v7MChSmXC4kkAqZVE0I/t+6HEJBp6XGIiJzIMbbEOtApSRzyZCb+fZS4Sj6ZBW2Li5BV2Ac9jWBDgl6h0jUGmjfxZKydy3o4rNE4mIm9vGyHI4u2EccTOUkvl6tawQnNyaPd4U4JcEWopMauQinsswpXIK7QBq1kMGWH1A5YGLZ3yGi4xUqWQoZxmt64n0veVdR3AUFlCs41FWKveJWYvMtsmIrcIctLhZSEusbVaowH68M0CUpyIKncxSJI4Zyrsw2vt6OTlMiFFQ5LLZ1q4ymCPdzmIQ0BEiYL3+GilA1I5maChw0mdDCLMqbEjOfNKg8jjk+MyoUCrtY1OdK7NTRHi5i4fIdHKseY7uBIyZ+Q9sbZRf+NcJJcxjPMKYzCY+oO7wDzXs9jLOw8hBed5zvwhtUxSqBXhr3RYXlqwAatGEdbniTobZUuLSNvmaji1E00rEwvqIwZYCJnHzLgY3usxOOlyjOnAlkItYkiFwxgczt1Yz2NIMkwux3oe+DXRyln584ZTV/d8OtdGMezF8CSGpzEMd2MYjmIY7sUwfBLD8GkMo90YRqMYRnsxjJ54no6eBn6KholtBIYjz0n3ZXGQ9OcrafmEkuKzjS6ddXTpsA87O82poLYff/zxTF2fKYCziA7JWbQPZ1Ez5CyKfR/pPuobhu85fTwafR0+F/T5ZPQ0fM546HAvfGb0ORqeqWVY8EyNGBMnivIOLKj7N8UgfAVBoTZelNpqvUSNpFDiuoP2o4MPdSzbtDwiWqSSTorc3k5OPeILomiF0g2i9ogoFsnbKeLuL4icNj7Uw+rOd7F6bHXVh5qxGN2g/nE/3BC3E++X/WJob6HzeaQ/IdJJ/ZyQ+rmd/kZDfUFMWMfp8zjxdZ8vcta+t/MhDPiCuNDF6PN48JR4QBfP7Qyg3i+I+hY61BFucd+3u9cbPu6Ndkd7HQ6Qj+MHFEUvTXuLxeK34B7ZNWF5MmtqS9NbaMIhTIwuNrgRbOWvRgW7h3/Xpve/kcE9rm1RTGsftLFKGs+tbS07nYrFA+tB1VMbA4zGr8yvRQtN7iI82ItNMi2TgDyNqc2uMTlqfeJBjzk5SNNBi5PUmKa9ouitNdJnjxnfaiyKfpr210be2B3fWECaxnCzeWN7mkJRFLc0+/ZO86AoblLRL4qAG9N7pv6JjkmwzG4/KWHA3+uwrM5Ed+E7DxLFALTKeW12zDafpLXrJpMqdASxgrUBBqdVLgzOycO0Uis/+rc/ZfUhW9nv7JGyM8f+vmcFfPUm2OgPwwEgEroAqOX+eTcoIyAHkFTW6QIMTnEOpXAOjWJgVyKXqWCnrMcNOBdFSYb+4C9nZ+k//sOAQwnkrTugnYBUTiVFdAZ/OT3o/fv5hhFVWaJJhEXIkVayMaBL+nCaYV6ugkqz2aw/e2STTOvcR5TeW4MT//dCj99fMLplX9jy4SZKvWi0XHcSnXXP3aLrcExYqGducN5ZxtiFGe7yfRu8mjsu3DDiC7pz1lCiTh8Hoe7Ts6gQbJKQKOPqt3YZmrPovJnj3XVM75l7/hGHNZMp5mKM+c2ujz5oTXMuFroK57sOT3VJDRLd4ht1FFI1EQgmZzdudYr5WqfvW244354h7dNZXzr18ax3AHJp6xhMl53t2SFIxaFDCgiT2I4R6gkwbqT0s09Bg9jHHQOvicLe3bMEjQMe2AQIm5jA3St0NqbNGIJRSCWLqmginZMGas2yIlgfbX7RzMqiqVdo7+6NFcT8nhUorHj7AmdqyJEMWYjpHYYpd39BWiLgsybfURzpkt5LpFaHabQf1W8pUcxA0bpvdLqI9q+jEPOinyGiRJMG7y29w1xHNsmwEPSrRoZebiYyxyiO/MuIjeKIHSR6xiFORfuRHr/HxEUxXd0lnW60BIPn7V/Xo3w8P4qDuRztRz7QH8VRuMCaJkCVaDJKy3QSLesF7wLVtKxAWf7RPCwQHAqZ/0owr2nqcu3l6ldBetmCwLQVeKJfaOpz+FIsbAuul+9o/cGM5tD5TcIsSMXCUpiwsl4VJSJPqpxMb5yX0iwaP4Dt74YlLXyblRp8h4+X9aa3MLplr43+9A1KUBMDOObyqXPfaxwj/jE0kCXC+yuKT8bivUYYI+9tmWn1yfOHo0fD0fDRcEQQQrC0BUMYIxZRHEmHhb2fj773Jgbd/T+g0C+m9S3UW71TxMAxxv59oliPZ7LFFO+XuZPb3q9aIXWb6SpPKViNwvT5GelXv1B2xZgWYWr79wjtMo7m9xMzh0T36scx+CrHifMmMCTaKDQP2571F0PcaG9vGUeL+8lb/K8k72vavNn91L3jV8XVi+vvgeujp8s4yu7H9fvm3fN3RHbvyXJ1iUaJQeHQYVESkIuxThcXtd5atgfWZkR9Xfih4UZY0op5ioYsjpv6aqVqaCS911+s6/mx1jkKtUHRdB7DBOk6y2YrGcUhtDTLkHyflTXL0G1jhgcT2pss9MCGa968tGTpmQrPoj4cTla89Ibw+ntcPZbf45SGB7zeha1YjT8YhG/i0IN2bgE9965CajUKPBjqLbAwk3lOeNP13YfmH5t2DScJgfq6rBe+/6p44aMIvGCY1H3ZhmAi9uGFUM3LZ/eFEa6vGyFg6Vgu4fqadhXNBV26y2W8aqC1Og18r/oWgwnKq86spglXE5u21lRvyVyQJeMbQpS6jYBPwbmoTIBDBt9y2e8I5BrikLFfxTzAtJEzSsO5SXVjr/BOfzT3bzA7SAAB+X/D92fl8+/lBlSeDcrnz8rn7yiPpUR/9jx7JlKl/uTPMM/78Mw6o9X0+RoLng1C++atNHglccYHl3d1BWWdtw2gfsCJErVamyctJKZKpMg5fGZ0gnWyEO2bwrkD67C05KpL5zPCOA2BzW4xNYicuUW4iMpx3g57YPWCzwRkBif//GCNpw+ec14YpWw9G4jnYfSh9+YzcYUg1AKYcA5qaOOjEpPKsJpMcmHkJLh7MZQ5UqiPvEGR+CiD52iNx0km1KWNn43N8xMURZOZ9uGvf6MRfAw4He9EV+YjdDoHH3p+b73v63WeBwICphU/QjjiU62eOAq5ypWRyjpT+XgApJWp04PqvDveD2v7IRuoB6m0PmEiwzb8GFBZP13ARFiHJoZKSeXQmKokybmZytcRZV5gSc61z2OjPbpfF3STUiit0afgtbIO63ugBowh6zD4eU1CVJ0BuE76xos3nJP7EaRLktOWQiioRGO1IlnSZipUEFVv+GtLXlMmcj/Un1dJTziED92/XWRqk+bDX//WwutW1+8mYn4FkaYUI78HQw4AUaTHchjIYJkvwOkuRgQPzR/Xba3oXgvIG0mrAEm4lylhTyvr3bjR7i791yWjzoAFb4GlYKuEtm1S5fniD1H88dGZu31I37zZLrvLKczey9HP8+RqdERbdItM3wkg2LCVySkHlDjXa9Jy13krVS4VXtRsuxjt7l4MibfLONrbxL5jXaDLOOGJmDgjTd2oMmcWIKZCKiCLyvyG3ERjtLnbxP00zO5iwl6HCY9vMuFQcaycs6RP9CWqvy+l7eWdX55QnRcsK17NRNIP4v6oQ2y73RNpMamMdIto//Q6mvdEKXu+f//0fHkeR8RYTTHNUlvGWLgs2o8GrRCnRXNFcUmCwELbyKEVKqVQ9g1/SpRycDXsD6NlvD5no/91x3isep86xToxlWp637zzFXeOaQf9JnV4tIoylfJfkcJMYQvao+JIkuRkKFLy25ZxRILxwyow/G29vXXIdlMUtqUU1+KqdVi1EyldV+EbYp+bQ5/Dx+2gow8rcqSwCRRuiv01hNfRvCaY14rPtcJzpyshbyJhdSBsyBGk0d4eh1q+HnJM4tFTdvf3nizPO55vFHW9Ww7cr/ton+dydD2OrRn9f8iM7lrR/pF1zaqsBayx4jqm1LoldbtVQ1pgolllhHPcVJuQMmeVcyPQhnmiiybjuIU9z6n33RtdBOEP9LL2pjJQ6hmaSeXTlyc5ziUZ4jQJC+5bBXRQFDlamy+ALPAplf34fAWRN/ZtIkoxlrmkm4qG6SAJq8vO9uHdKiT0wPj0jSvM6YIjIdGFYPu5sZ1n2lxS8Q3VsMCYqg3IsESVCZV4G9br3pikgCpkyD8ojbRURGEIa+lx08oZ2v5CKDFlwYw7rEoxp3NqwegxPXtanVdevJyQuTb+xYYJImGz/Dz57bykLo4UkvVvMKMdvQqejKWk7hTBq9VQhjOmwEJJuMgEORRWqVxTxQwFFao8h1KTnUAHT086ONJ0Z4SyZN6FR6KwBw3DgpOBNqSLv7VIO/xKqkufHd6D00am3uHYSofdzJF1qXzYnfOddN9XY6oh0VY6bRar2VPpsmrMF2QbSPPhIX0Xysagdf2tYKQ6sRtCqzqxA0pyGRyjIwmxg4OjQzatHsKHX/4DXqEwCjI989KaVAbzRVOh5uufeOc92xrLiN1Y0k7E8cQLX1CqNQffZcJ9+OU/LbxGrgGjI+QZubNzVI1zmcBJHSPc2dmHF+w3tOKGnZfuTJAoXUkBAko/O5fqsg8HasHe0ErFUjvP65DBar3ebl+GlYJWIRXHr9lfYUTthcX8CtnNopKGMXLRHEl0ZnQ19au1kQnEGZyQqxvqtIi2gzSl0jxurktmqOpohQ5OfLEMLnxUlWs3jtamcE9TuxByGlcBNVQpFz7ZfUiNmLgV/Hgl6OyesYK/0VRXdtTsiAOYZkv8SQwUN619juSumW5dXWtwgvwyy2Sv9qWUQZxOa7GEbkrWp4s1XQbhzmKzP1wdopQb7w0q+7JvJsdormRSu3m3nOgBDx5EcZTLBJXFlltw8N3RK7h61N+N4pZB/BGHe/Dq8MW3r4+/JWRIkXqGDfu7/V1+vtTWFUK1VjrGfALH3jtYe69vXKVt0em26HRbdLotOt0WnW6LTrdFp9ui023R6bbodFt0ui063Rad/m4lMNui023R6bbodFt0ui063RadbotOt0Wn26LTbdHptuj0d9cStxadhgwaUpiDMhdStdIGfZ7W6aoU9TyOMkrh2j+Nrq8p2P6WEjKo+acKDeV/ncfRlTCSwk2c/RXXKUuUrXOJlPvywkfPeie0cuyVFb9crSW9Uc6Vn3GQJFi6O8e2s8yO3hyfRHFUJ/cXOqU5RsyolFbMfDpG4CPnJwmuV8qFmlacPBR5mJRlRW+/3RStS07RCj9aOUhCLVoYdnO3PBn0l4jaOOH62qd/ca6QH++7bp0RGFuPpp07Xy6X/wNHVMrb",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={},f=[];function j(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)(u.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.90f34d82.js b/assets/js/34593b53.90f34d82.js deleted file mode 100644 index e009ff08e..000000000 --- a/assets/js/34593b53.90f34d82.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/v1.1/createdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocument","permalink":"/docs/API-docs/v1.1/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7WgthkWtY5bU0Oiq7G6IVUAZQLHZZnTEPswf7B/Mp/lLNjIB1NEHm5JoDzXbfpDZKByJvJDITOR1ZPnYRIen0QuVlDlIa6L3cZSCSbQorFAyOoxOJsCea+AWWOjFjo5fMZ5lampYaUAbZhUbgwSNvSRMWRrmY8MZK7S6FKmQY5Zyy9lU2AkbcgOP9hnIRKWQspHIoHMmz+SJKA7ZuyJTPGUzVWp2/OJP1Wy4DLad7uy8gGE5Zu9e7ey8/2pibWEOu11eFB1VgDRiLDM+NJ1E5d0UOxbp6GHMphPQgLOyhEsG3IhsxniasqlIx2BNzOwEJEtUMWOJUjoVklswMSv4GJgs8yFoEzMuU5YrDUxIxpkGns52rdotDbD/ePvmezZSOue2w46z0sTVcqnQkNhs5qa3E6h29cAEbBirhRzHLOcXiC1h2c+lSC5w2wZkiv/HgUfHrwhXOztvy6JQ2kLKfnRbONzZwS/fQKamjGug/onKcyVZwTXPwRK5JtzSZw0/l0JD6ojCsyzg4vBM7rKdHTsr4HBnh72SqUgQGTQhtjI18n07risiCbu+LSARI+G7NlDHlGTTiUgmhJMpd/QsMp44MDWYAhIrLqE98VXMZjjxC5AqQDBRWvyipOUZkeMStBUJz5pkQwCxq7FcW0RnoYS0odWvwP7iyYPUI6J4vkLQUkRWLiR9McAueVaC8VBNYzZBqH6AQoMhVvfzIiJlyiYgxpO16/H0Q2lsa2JWGgSzCYVfK1CJ0AuEthHPDDAxauEy5xfQWI0pkmGeddg3M5bCiJeZjZlAjrO6hA77XlnGiyITCR9mgJzLUHi4LTXsEpU9O3hAJM+Jxsck0WAYZ6kYjUCjcOJHmsKPCdAhn9UqgCTHTrhkSi4QOlGZ0sssRM1tPLJESQvSdtjRJRcZAe82a5iQSVamwIYZTy5iNsxKiJmG1AnuDFBtxV4JYRfGjcc54YcZyJALlUT4pfLLC8OMhyrtsJOJMLU84ceAalpEmCZWvdSOFK6MKAgixiDnIosJcTH7oIbMCptBjAJbcDmLUV9CzCxc2aG6ilkygeSC/tI8FYoNS2uVdBtLtSpSNZUelyMlrRG/rJDI8OXjMTqI2X7MHsXsScz6vZj1BzHr78es/yhm/ScxG/RiNhjEbLAfs8EjB9bgicc1rxDcBKA/cFi2Xw52Ue++FoYkGxWmqXTwtKWD+x22s1NJE7b99NNPZ/L6TDJ2FqFwnUWH7CyqupxFsfuGOhO/9f3vK/yxN3jsf87w56PBE/9zSl37+/7nBH8O+mdy7hc8kwOCxPK8uAEK/HynEPhfnomwjRbFtqDPsBEVURw+IK1a8OCHeXMve7gXIYUVPDPrtxN63KMd1SAtbWofN0Xsun5H9PkebacJD34hNek+kVptfAoCT1AMlnZ/0PEny/rNu2Xvzd4b4Hze1h/h1lE1naBqWr//SnvdIyQswvR5mHjcIQOANPN6PPgO9wgLbYg+DwdPEAd4KK1HAH69R7tvgIMf/AnvvvX2d/sHu4PeYL+FAbwbuQ55vpumu7PZ7C6whzaPXx5NnmChOssOb6UjrfIV1w+6HdS9vE1EfweT/T/RUB8GGxZSvPfRxSJYLNWNr2llW5Xy2QPjpgpDK+MM+9em2awBJn1COOj2m0yUSDzw2CeYZEO84HUQB7uEyW6adhuYxMY03c3z3YVG/LlLiG805nknTTsLPZeo4xpzlqYxW25e2Z6mLM/zNc2uvdXczfPlXXTy3MNGxtfXKCTeZlsvJ77D7yUqtUS0F75RjNBzoGRGa9N1brUcLRw2EyH9B89UbKGDhnGZcQ1XeC81QknX++5lLIhYbdnTPZaugOQlcKhgX73x1vtDz/64hfYE2LJ53NLOcJIjlpTGqpxpGMMVK7i1oCVNdskzkXK6yu1SA1zxvMArQPevZ2fpv/5LlxwQeMe3DCnBUjEW6Afq/vX0aPe/36/oURYF6IQbYBngSiZmYJMOO51AVtSuqOl02pnumWSiVOb8UB+MhpH791wNP5wTuEWHm+Lhqp061mhc+JF1Fu/7BmwLY9ywMHLFlZ94jGSo36PT1t93bjhufY97dOIsgIQfnfcEP5+eRTkngwRZGeq/lZ2APoveV2PcJR/SDWPf30JYJyKFjA8hW/50a0GrmjM+U6WX7+DUam/Vc3QDb/ghF7LyW9B2enHjI79a+Oi+zVfIt0NIUzrDkRPEM1CAZcIEz00bnc3R3rVFDkcJQD7MIbAwAN3DQXt8rhRUgN1ODJwm8rTbsAT2Y9SxciuG1Tas0CJMEzE4Ry6kyMu88o+OqlkDynJvezTxhSPR6x5WaFJ3aQV+tWEFdEauX+BM9smPEfwfN1imvsc90hULIN0sxp+iRVrn9B0dsJsFMGyrKYArjmXs6g7kSvjMeunrsDd4vKFP1g1CL1uSQGHRI/e5olmBfOsTinxWTT/ces5r9rpH3LcCrN+YA32/uz59PolJm7v/ghi1BfatmdU5JXM+vuHmTp/vEXt6eJacEDs7xxpGIssaIUUWmkJkB0M6kEHuw14+mIhHHTnChbQKrwUhbDuEEcVLLYVRJrwOOLpzxpG0GRNlCUaclWYTbpz9TQY/kgoDtnYC+YIrPoBWu+OFDHAjVfp3d28cfN1r0qn/6KBFp4Nei069dXS64dqIFDSFkqbytUH9qSHXROLQvny0LIptmBRJ+lJibCXcHpwwqDJLWSYuKKqSClNkfIZUDVLqoVwM1z2fKGXqHj5i9pXf8GE7Eqc0BuMedqrAxG0cXgvEaNCi/3ivQYqDJ0/aEtMSmNvc3+v1lqnQ2+/2D7rOo7XaoVW7YdYr4RssAcZuQy/yE92KXtSzJtjW7fSpbqe7Yfe9u7x19x8PWofFXu9TD4s7v1w3pWbDtfouLs93dottitst76+/2z3y87lv/7ewqPuP95pc+Lh/By7UNYbz53Likn18Z7zH7so4XsWAt7CObzSJP5tBm8D+5kx6cDeWdL/XstC+bhloXw+aTHlwcCumbC66wFlnkfivb978MO39+duxOjo6Ovr+7bvJy3fjo6OjHH93Op2Vl6hV1KZl0HL1GYH+XKYzfs0qnU4HUYiplYc0vFvI8b+58fH6MZ0zGcWRKjBnUyj5Ko0OIzK6IdjgUUz3CDD2G5XOosPryOcI4Z8+AweHdj8YTBS9jkwygZzjX+H+gamlmNoZxZTmAtpEcURBY8wzRZJGh5EafoAEVys0gmMFGJyDxh1eh14uNzKKvcUVHUZui1Ecebd+1VRllRbpKJqHBW+aqmqppzL0R3UhwXkw/fATp/keh84XUms/aaYXjRlobzmcqOcKv1l4wWemMa/z+kWLGb04BoU98aNYymcGlUZp3AGX8CwpM7QL4aoQelbFRsk4bPBHBW+1UgVv/2BeE70GiWvNZ1EcCQt5s30NE2j18ZRLQCFmKEHlY8d+UDAE+KNvwMANEZ7nHw3FBwVsCET0YqLkR4/vD/b6g/5ef4Az+Mvtp+PRfV2GoM0YR5hDB2kwenbrZNCYUUJWZxOPhv60bT6Gzcx4si5JuJGbaCZ00+FFAVx3KFf3k9PA2/xdna6dDdw8j6OrzZu5YonaDRnI7KsMRtZFDFmitAT9sJmGcG82N9jfn8fRbPP2Zl/k9h4j8aabd/cjpW7Xae3/CFj3nszjaLIZ1u+q5PJ/ILD7j+b16bpgPJwPVTo7D3prvqljOCiw30hlKWg0SJb1Va1qUMPgo4jzRT0/VCoDLlcomlZWsX++gsYv+n+9Q2Q6AbxD1DYxzV4b3N5b7KDFTGVYSH4QBm1VXcJZ1GGvRg3znczpxcTm0JeSjKViD2i9c1OSGn/Q9b8RRw+aDzjQ3VrnHwUQqDOzkBcZvYCYos92SMG8tMOq/8jyqzCJAITjMiy8+ah47pIuaEE/qP18gHnbscOec1mlkLdTtdn1dcUGxB3zObu+RqqCPsdDdz6P6wZcq9VA56pr0ZCAuGyNqpqgHli1NYY6E+ccTRzX4FP6mgCIsRRyfF5qPw9agvN5p8WQC4CT59rjANKKz8RYrth1Za8QpW+N/SVkew7ASf7f4P1p8ew7sQKUp93i2dPi2Y/4WKgAJ3sOPSMhUyf5U8iyDntqrFZy/GwBBU+7vn01KTVcCpiS4BJV61kWcVtN1PEw/QUVdU08YViiy0TwjLKNtEogBEiQbhJv0MZCYTAiJSyNdO85yB7nYw0UiiFYeGnpcRRdzcKCTzmbaBj9+4MFnD549hZBx3dxT7v8me/9yvkEJvwSGJczRhsnB4bSzgk2KjWpySTjWoz8PTBmRQaYGYXXRJ64gJrDaIDjZMLlhYmfDvWzE+A5e1OARAh+/dvfsUfQ6a/kG52CvoVSfzVyoTvFHqAeexC7LC1id6GN9araaULPIQ6uNaLjs/Qx4veyUv2mHBrsJcN8tWq1WozHgAEt34MG+zcvwJOJOzQIKj4KLvwCmUeVJoCHDBZuYxTdEo4/hBy3XS4N7FAsrbn3ziqtLvGRzJuT41vgkvxBu05QnDPE7dLNwd6cHOM7u4rcHfbOVJgIqOWtLgyv4exS8PAWp7LsZy6zBVxQw+vFZgCw41+47bJlgFJhVkIUu0MdNVz1KnVp4vohJpJIlRYDisI/LyIpa+GRoKgQeaLK23DlBkxyNi4pkdii+IZTk3IJ63dyQhqrS5fVw9JSh6eBni2cmjCmxlPACnZqzB8zkMYN52zEjQUds1IKxLwu0UVYTQlXBWgBMoGVKNDgUIeqY/MR1X509u6H1/75bdhDEMohSqCbGFJWFsQ1JAnVY8hAucWtr7QHvfreDCDabvRk0fs5C9BGSVRxSo+59BrU3UfRmTmECc9cV68qMB6G8KCEt4EJlvavf/t7A661HollwNwKPE0x03UDhOQXdgyPyVwaCtSAqg0Rzgf6j4tXAISOhOY8V2klSOb2PH5MubGm0os+QF8lB5gymeCxVelbEwcda7xTwZALmPzEFOEvcL9wJYxtPOcLSffL+uEHQDwmDRjoEopSjTwvZ00Br5MW1MJ0dD0Q7aeg1SVoSRZ4adW5hlzI251TTZe7VZUiKK3KuRUJC1OZTvuBr4vrBrnO2VcBNOTGS6H0wzWiitOdK5nAuZDncAn6Ftf776skQXIIDsFOAWQTtoAkd5zVjzCn+G6+hZPG6URPjZtQomewcJkZqzxXbaDCg+mQ7R74wR0l9JA/H2KGkMsxQVEjxRFuaUuusC/Fl+aTLbaetC/I1dTv9f6ZPWl7vS/Hk7bf+4I8aU8QWB+A3KyA1tk3K3VHiDLePOCDIpc9xWlv7olRPXLSuTD4KgTX4jCYu/9q51/Q+xscgs5jWIcR/XUmbIbQMOj18H9tcr5oJRCicVsmaCyOyiyb/SGKbx/DvJkGrnm1k/ImrT75IAa/XCWXg+PIx8fa1vRHnkWfFOTCMYshrjU2/Y1b8QJR6gzr3+Bedit7iqZt0FjITEg4DwQ8T1VyHnaP/XIwpn3K3QqGitx0y27TesPykWPM/VVc9FblYCdkfuK8U/TeVO4Nq2eMj7mQDGVc3yFTgdabxO/jILsJBfu93nm/QsLBMhJeSXpuRMWeTtQFyN93p83lrVseQb3Ks1oHRsJ1ou9Ra7PNdrdJA0mphZ1Fh6fX0dUuL8Su+354+n7+HlnQThSmQRTKEMTcTqLDqLuUFWFAX1JU+/TayU0lCobLFHO5ls4HXojuZb/Tj+bx4piV58kN/aHc/dghxvKxkONN497XOHqLdHSkamGq1lOF+DOgovKEaPaKI4H8MwGOlyNEPbLHD3UuyctA5JDlsSpxoybmYipGyMRoJVcsnusr0iVWZ0v0Dxp5Cqch5YCyCKokglV5AdXWQ6S/CvQ3YveN0P1pzexVlDyY9n2yiQf7+2Q8Pu6TlbX3hAyY/UdzYs86LBZF7dAXZfgvBnA+Lx7RDkdsfez/RD72BRe7Z57aT+wyIVsOT9/UdgAGLqwcbi2v16LTa60Dao3/yS+54GepAFnl3jhoeRVWyF2wittSh7mCKHV7PZK6/R5J3ZNeyyD3O6xnqM1qsp0r05ns46Z5jDbwe9SBQo4UKVCv1QJd6IAjBbx0jYIsUXlV4qpBSBoTRMB5AXGGP2AK5ZtSs0JNQY9KVy9rlMGVQC8NDoKcvtWBb+B5BsZk+HDAwpgqONIzeHSHe4drwgs+FJnA09s97nFCURsApsN+rEPnD7SrCnAJGR76lZ8LK0AGg22q9MUIQ/Ax42yIpe/Q0wlywmXinKruJCLnIHp50GFdaGGwop9GqIWDTUmrURJyLvmYZDRuoSqFDFWWYVoNMeZgVFY6SbNcZEq7lDfaECXXUh7qy6sCP9E9EN3RGibIt5fetW5iF9pwh4yvCTnEKFKBsIgEyMNYykxh+UaMRpVZxgplXYQIr5tNGHG41VwatHV9lp2nQYUw7/UG4x8+vTOAFH4t5IUrObbLTiue+hGGRlhoFyRYlL2H7THfCvtdOcSChsoIq/SsHj0WdlIOyVxoTlL9cDN9GyqANoyBeo5UJWbFxVklpou1E7pvwSKHmO7R8SsyNx+yX//nf9lr4FqyiZo6bk1KDdmsLjZKxTiJ8g5tlbVIcRVU1IjxxDGfP18qDBaU1yic8HgcHpfDTCRVEsUhO2JFuyk8mQ43TDqd3KM2DHVxlgl50WFHckZe+fqQwXYa7EbWx1rjqRy5fYTtsO/UFPVaXHv2sUoepCKUfPDACGsgG1ECdvuV3uHqV3voLPVFbNa+0PNpLrQyJbnMaCyvKgN6Z3ydUQAypfKa5pClmo9sXQA2XnjTR4fYUlN4Dhi2FftpqlwWJ2ILlDAdl8uyYKK2taiGEVDSartKLS+EZ5TTwHCsXcPj4xnWuVDoYG5cztFWXhl4weqi5s3oLehLkYQb9RpZ7VLnbhRHmUjA+3P8qXT07fFrdsn2Or0oblj+t5Db7utXz19+//YlQoM60mGs3+l1euR3VsbmXDaWWigEvHhkNVLEt3WDt3WDt3WDt3WDt3WDv5jKttu6wdu6wdu6wdu6wdu6wdu6wb8dErZ1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g++PrtjWDb4v5Vi3dYN/Dw7c1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g1eUze48aKiW2RcyMYbUvdu7nSxmvD7OJrgw7rD0+j6Gpd5h69jsPnnkt5vnL6Po0uuBabn0Ju8ODwhwzccF4APkZ67bKPdE1w/drJNGbYLTxHxDZwbcUQMfWPf5tu/4zdvT6I4CmXYcpXSo2c+xTcffOqevTQehlDbdZRxOS7pUUnk5py7IiGT9pO5C3oy5/9ovEzhctaAsP2Wzm0D/8VNrRxwfe2e49HDLdfffVo7wiM29Eb6vZ/P5/8HON/q/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":"Draft Document","permalink":"/docs/API-docs/v1.1/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"}}');var i=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7WgthkWtY5bU0Oiq7G6IVUAZQLHZZnTEPswf7B/Mp/lLNjIB1NEHm5JoDzXbfpDZKByJvJDITOR1ZPnYRIen0QuVlDlIa6L3cZSCSbQorFAyOoxOJsCea+AWWOjFjo5fMZ5lampYaUAbZhUbgwSNvSRMWRrmY8MZK7S6FKmQY5Zyy9lU2AkbcgOP9hnIRKWQspHIoHMmz+SJKA7ZuyJTPGUzVWp2/OJP1Wy4DLad7uy8gGE5Zu9e7ey8/2pibWEOu11eFB1VgDRiLDM+NJ1E5d0UOxbp6GHMphPQgLOyhEsG3IhsxniasqlIx2BNzOwEJEtUMWOJUjoVklswMSv4GJgs8yFoEzMuU5YrDUxIxpkGns52rdotDbD/ePvmezZSOue2w46z0sTVcqnQkNhs5qa3E6h29cAEbBirhRzHLOcXiC1h2c+lSC5w2wZkiv/HgUfHrwhXOztvy6JQ2kLKfnRbONzZwS/fQKamjGug/onKcyVZwTXPwRK5JtzSZw0/l0JD6ojCsyzg4vBM7rKdHTsr4HBnh72SqUgQGTQhtjI18n07risiCbu+LSARI+G7NlDHlGTTiUgmhJMpd/QsMp44MDWYAhIrLqE98VXMZjjxC5AqQDBRWvyipOUZkeMStBUJz5pkQwCxq7FcW0RnoYS0odWvwP7iyYPUI6J4vkLQUkRWLiR9McAueVaC8VBNYzZBqH6AQoMhVvfzIiJlyiYgxpO16/H0Q2lsa2JWGgSzCYVfK1CJ0AuEthHPDDAxauEy5xfQWI0pkmGeddg3M5bCiJeZjZlAjrO6hA77XlnGiyITCR9mgJzLUHi4LTXsEpU9O3hAJM+Jxsck0WAYZ6kYjUCjcOJHmsKPCdAhn9UqgCTHTrhkSi4QOlGZ0sssRM1tPLJESQvSdtjRJRcZAe82a5iQSVamwIYZTy5iNsxKiJmG1AnuDFBtxV4JYRfGjcc54YcZyJALlUT4pfLLC8OMhyrtsJOJMLU84ceAalpEmCZWvdSOFK6MKAgixiDnIosJcTH7oIbMCptBjAJbcDmLUV9CzCxc2aG6ilkygeSC/tI8FYoNS2uVdBtLtSpSNZUelyMlrRG/rJDI8OXjMTqI2X7MHsXsScz6vZj1BzHr78es/yhm/ScxG/RiNhjEbLAfs8EjB9bgicc1rxDcBKA/cFi2Xw52Ue++FoYkGxWmqXTwtKWD+x22s1NJE7b99NNPZ/L6TDJ2FqFwnUWH7CyqupxFsfuGOhO/9f3vK/yxN3jsf87w56PBE/9zSl37+/7nBH8O+mdy7hc8kwOCxPK8uAEK/HynEPhfnomwjRbFtqDPsBEVURw+IK1a8OCHeXMve7gXIYUVPDPrtxN63KMd1SAtbWofN0Xsun5H9PkebacJD34hNek+kVptfAoCT1AMlnZ/0PEny/rNu2Xvzd4b4Hze1h/h1lE1naBqWr//SnvdIyQswvR5mHjcIQOANPN6PPgO9wgLbYg+DwdPEAd4KK1HAH69R7tvgIMf/AnvvvX2d/sHu4PeYL+FAbwbuQ55vpumu7PZ7C6whzaPXx5NnmChOssOb6UjrfIV1w+6HdS9vE1EfweT/T/RUB8GGxZSvPfRxSJYLNWNr2llW5Xy2QPjpgpDK+MM+9em2awBJn1COOj2m0yUSDzw2CeYZEO84HUQB7uEyW6adhuYxMY03c3z3YVG/LlLiG805nknTTsLPZeo4xpzlqYxW25e2Z6mLM/zNc2uvdXczfPlXXTy3MNGxtfXKCTeZlsvJ77D7yUqtUS0F75RjNBzoGRGa9N1brUcLRw2EyH9B89UbKGDhnGZcQ1XeC81QknX++5lLIhYbdnTPZaugOQlcKhgX73x1vtDz/64hfYE2LJ53NLOcJIjlpTGqpxpGMMVK7i1oCVNdskzkXK6yu1SA1zxvMArQPevZ2fpv/5LlxwQeMe3DCnBUjEW6Afq/vX0aPe/36/oURYF6IQbYBngSiZmYJMOO51AVtSuqOl02pnumWSiVOb8UB+MhpH791wNP5wTuEWHm+Lhqp061mhc+JF1Fu/7BmwLY9ywMHLFlZ94jGSo36PT1t93bjhufY97dOIsgIQfnfcEP5+eRTkngwRZGeq/lZ2APoveV2PcJR/SDWPf30JYJyKFjA8hW/50a0GrmjM+U6WX7+DUam/Vc3QDb/ghF7LyW9B2enHjI79a+Oi+zVfIt0NIUzrDkRPEM1CAZcIEz00bnc3R3rVFDkcJQD7MIbAwAN3DQXt8rhRUgN1ODJwm8rTbsAT2Y9SxciuG1Tas0CJMEzE4Ry6kyMu88o+OqlkDynJvezTxhSPR6x5WaFJ3aQV+tWEFdEauX+BM9smPEfwfN1imvsc90hULIN0sxp+iRVrn9B0dsJsFMGyrKYArjmXs6g7kSvjMeunrsDd4vKFP1g1CL1uSQGHRI/e5olmBfOsTinxWTT/ces5r9rpH3LcCrN+YA32/uz59PolJm7v/ghi1BfatmdU5JXM+vuHmTp/vEXt6eJacEDs7xxpGIssaIUUWmkJkB0M6kEHuw14+mIhHHTnChbQKrwUhbDuEEcVLLYVRJrwOOLpzxpG0GRNlCUaclWYTbpz9TQY/kgoDtnYC+YIrPoBWu+OFDHAjVfp3d28cfN1r0qn/6KBFp4Nei069dXS64dqIFDSFkqbytUH9qSHXROLQvny0LIptmBRJ+lJibCXcHpwwqDJLWSYuKKqSClNkfIZUDVLqoVwM1z2fKGXqHj5i9pXf8GE7Eqc0BuMedqrAxG0cXgvEaNCi/3ivQYqDJ0/aEtMSmNvc3+v1lqnQ2+/2D7rOo7XaoVW7YdYr4RssAcZuQy/yE92KXtSzJtjW7fSpbqe7Yfe9u7x19x8PWofFXu9TD4s7v1w3pWbDtfouLs93dottitst76+/2z3y87lv/7ewqPuP95pc+Lh/By7UNYbz53Likn18Z7zH7so4XsWAt7CObzSJP5tBm8D+5kx6cDeWdL/XstC+bhloXw+aTHlwcCumbC66wFlnkfivb978MO39+duxOjo6Ovr+7bvJy3fjo6OjHH93Op2Vl6hV1KZl0HL1GYH+XKYzfs0qnU4HUYiplYc0vFvI8b+58fH6MZ0zGcWRKjBnUyj5Ko0OIzK6IdjgUUz3CDD2G5XOosPryOcI4Z8+AweHdj8YTBS9jkwygZzjX+H+gamlmNoZxZTmAtpEcURBY8wzRZJGh5EafoAEVys0gmMFGJyDxh1eh14uNzKKvcUVHUZui1Ecebd+1VRllRbpKJqHBW+aqmqppzL0R3UhwXkw/fATp/keh84XUms/aaYXjRlobzmcqOcKv1l4wWemMa/z+kWLGb04BoU98aNYymcGlUZp3AGX8CwpM7QL4aoQelbFRsk4bPBHBW+1UgVv/2BeE70GiWvNZ1EcCQt5s30NE2j18ZRLQCFmKEHlY8d+UDAE+KNvwMANEZ7nHw3FBwVsCET0YqLkR4/vD/b6g/5ef4Az+Mvtp+PRfV2GoM0YR5hDB2kwenbrZNCYUUJWZxOPhv60bT6Gzcx4si5JuJGbaCZ00+FFAVx3KFf3k9PA2/xdna6dDdw8j6OrzZu5YonaDRnI7KsMRtZFDFmitAT9sJmGcG82N9jfn8fRbPP2Zl/k9h4j8aabd/cjpW7Xae3/CFj3nszjaLIZ1u+q5PJ/ILD7j+b16bpgPJwPVTo7D3prvqljOCiw30hlKWg0SJb1Va1qUMPgo4jzRT0/VCoDLlcomlZWsX++gsYv+n+9Q2Q6AbxD1DYxzV4b3N5b7KDFTGVYSH4QBm1VXcJZ1GGvRg3znczpxcTm0JeSjKViD2i9c1OSGn/Q9b8RRw+aDzjQ3VrnHwUQqDOzkBcZvYCYos92SMG8tMOq/8jyqzCJAITjMiy8+ah47pIuaEE/qP18gHnbscOec1mlkLdTtdn1dcUGxB3zObu+RqqCPsdDdz6P6wZcq9VA56pr0ZCAuGyNqpqgHli1NYY6E+ccTRzX4FP6mgCIsRRyfF5qPw9agvN5p8WQC4CT59rjANKKz8RYrth1Za8QpW+N/SVkew7ASf7f4P1p8ew7sQKUp93i2dPi2Y/4WKgAJ3sOPSMhUyf5U8iyDntqrFZy/GwBBU+7vn01KTVcCpiS4BJV61kWcVtN1PEw/QUVdU08YViiy0TwjLKNtEogBEiQbhJv0MZCYTAiJSyNdO85yB7nYw0UiiFYeGnpcRRdzcKCTzmbaBj9+4MFnD549hZBx3dxT7v8me/9yvkEJvwSGJczRhsnB4bSzgk2KjWpySTjWoz8PTBmRQaYGYXXRJ64gJrDaIDjZMLlhYmfDvWzE+A5e1OARAh+/dvfsUfQ6a/kG52CvoVSfzVyoTvFHqAeexC7LC1id6GN9araaULPIQ6uNaLjs/Qx4veyUv2mHBrsJcN8tWq1WozHgAEt34MG+zcvwJOJOzQIKj4KLvwCmUeVJoCHDBZuYxTdEo4/hBy3XS4N7FAsrbn3ziqtLvGRzJuT41vgkvxBu05QnDPE7dLNwd6cHOM7u4rcHfbOVJgIqOWtLgyv4exS8PAWp7LsZy6zBVxQw+vFZgCw41+47bJlgFJhVkIUu0MdNVz1KnVp4vohJpJIlRYDisI/LyIpa+GRoKgQeaLK23DlBkxyNi4pkdii+IZTk3IJ63dyQhqrS5fVw9JSh6eBni2cmjCmxlPACnZqzB8zkMYN52zEjQUds1IKxLwu0UVYTQlXBWgBMoGVKNDgUIeqY/MR1X509u6H1/75bdhDEMohSqCbGFJWFsQ1JAnVY8hAucWtr7QHvfreDCDabvRk0fs5C9BGSVRxSo+59BrU3UfRmTmECc9cV68qMB6G8KCEt4EJlvavf/t7A661HollwNwKPE0x03UDhOQXdgyPyVwaCtSAqg0Rzgf6j4tXAISOhOY8V2klSOb2PH5MubGm0os+QF8lB5gymeCxVelbEwcda7xTwZALmPzEFOEvcL9wJYxtPOcLSffL+uEHQDwmDRjoEopSjTwvZ00Br5MW1MJ0dD0Q7aeg1SVoSRZ4adW5hlzI251TTZe7VZUiKK3KuRUJC1OZTvuBr4vrBrnO2VcBNOTGS6H0wzWiitOdK5nAuZDncAn6Ftf776skQXIIDsFOAWQTtoAkd5zVjzCn+G6+hZPG6URPjZtQomewcJkZqzxXbaDCg+mQ7R74wR0l9JA/H2KGkMsxQVEjxRFuaUuusC/Fl+aTLbaetC/I1dTv9f6ZPWl7vS/Hk7bf+4I8aU8QWB+A3KyA1tk3K3VHiDLePOCDIpc9xWlv7olRPXLSuTD4KgTX4jCYu/9q51/Q+xscgs5jWIcR/XUmbIbQMOj18H9tcr5oJRCicVsmaCyOyiyb/SGKbx/DvJkGrnm1k/ImrT75IAa/XCWXg+PIx8fa1vRHnkWfFOTCMYshrjU2/Y1b8QJR6gzr3+Bedit7iqZt0FjITEg4DwQ8T1VyHnaP/XIwpn3K3QqGitx0y27TesPykWPM/VVc9FblYCdkfuK8U/TeVO4Nq2eMj7mQDGVc3yFTgdabxO/jILsJBfu93nm/QsLBMhJeSXpuRMWeTtQFyN93p83lrVseQb3Ks1oHRsJ1ou9Ra7PNdrdJA0mphZ1Fh6fX0dUuL8Su+354+n7+HlnQThSmQRTKEMTcTqLDqLuUFWFAX1JU+/TayU0lCobLFHO5ls4HXojuZb/Tj+bx4piV58kN/aHc/dghxvKxkONN497XOHqLdHSkamGq1lOF+DOgovKEaPaKI4H8MwGOlyNEPbLHD3UuyctA5JDlsSpxoybmYipGyMRoJVcsnusr0iVWZ0v0Dxp5Cqch5YCyCKokglV5AdXWQ6S/CvQ3YveN0P1pzexVlDyY9n2yiQf7+2Q8Pu6TlbX3hAyY/UdzYs86LBZF7dAXZfgvBnA+Lx7RDkdsfez/RD72BRe7Z57aT+wyIVsOT9/UdgAGLqwcbi2v16LTa60Dao3/yS+54GepAFnl3jhoeRVWyF2wittSh7mCKHV7PZK6/R5J3ZNeyyD3O6xnqM1qsp0r05ns46Z5jDbwe9SBQo4UKVCv1QJd6IAjBbx0jYIsUXlV4qpBSBoTRMB5AXGGP2AK5ZtSs0JNQY9KVy9rlMGVQC8NDoKcvtWBb+B5BsZk+HDAwpgqONIzeHSHe4drwgs+FJnA09s97nFCURsApsN+rEPnD7SrCnAJGR76lZ8LK0AGg22q9MUIQ/Ax42yIpe/Q0wlywmXinKruJCLnIHp50GFdaGGwop9GqIWDTUmrURJyLvmYZDRuoSqFDFWWYVoNMeZgVFY6SbNcZEq7lDfaECXXUh7qy6sCP9E9EN3RGibIt5fetW5iF9pwh4yvCTnEKFKBsIgEyMNYykxh+UaMRpVZxgplXYQIr5tNGHG41VwatHV9lp2nQYUw7/UG4x8+vTOAFH4t5IUrObbLTiue+hGGRlhoFyRYlL2H7THfCvtdOcSChsoIq/SsHj0WdlIOyVxoTlL9cDN9GyqANoyBeo5UJWbFxVklpou1E7pvwSKHmO7R8SsyNx+yX//nf9lr4FqyiZo6bk1KDdmsLjZKxTiJ8g5tlbVIcRVU1IjxxDGfP18qDBaU1yic8HgcHpfDTCRVEsUhO2JFuyk8mQ43TDqd3KM2DHVxlgl50WFHckZe+fqQwXYa7EbWx1rjqRy5fYTtsO/UFPVaXHv2sUoepCKUfPDACGsgG1ECdvuV3uHqV3voLPVFbNa+0PNpLrQyJbnMaCyvKgN6Z3ydUQAypfKa5pClmo9sXQA2XnjTR4fYUlN4Dhi2FftpqlwWJ2ILlDAdl8uyYKK2taiGEVDSartKLS+EZ5TTwHCsXcPj4xnWuVDoYG5cztFWXhl4weqi5s3oLehLkYQb9RpZ7VLnbhRHmUjA+3P8qXT07fFrdsn2Or0oblj+t5Db7utXz19+//YlQoM60mGs3+l1euR3VsbmXDaWWigEvHhkNVLEt3WDt3WDt3WDt3WDt3WDv5jKttu6wdu6wdu6wdu6wdu6wdu6wb8dErZ1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g7d1g++PrtjWDb4v5Vi3dYN/Dw7c1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g3e1g1eUze48aKiW2RcyMYbUvdu7nSxmvD7OJrgw7rD0+j6Gpd5h69jsPnnkt5vnL6Po0uuBabn0Ju8ODwhwzccF4APkZ67bKPdE1w/drJNGbYLTxHxDZwbcUQMfWPf5tu/4zdvT6I4CmXYcpXSo2c+xTcffOqevTQehlDbdZRxOS7pUUnk5py7IiGT9pO5C3oy5/9ovEzhctaAsP2Wzm0D/8VNrRxwfe2e49HDLdfffVo7wiM29Eb6vZ/P5/8HON/q/Q==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},b=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/34593b53.9a97a9b7.js b/assets/js/34593b53.9a97a9b7.js new file mode 100644 index 000000000..7c5df0e21 --- /dev/null +++ b/assets/js/34593b53.9a97a9b7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9099],{85203:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>b,frontMatter:()=>x,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":"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7XglhkWtY5bUcNBV2V0Qq4AygGKzzWDEPMwf7NO+zqf5SzYyAdTRB0lJtIeabT/IbBSORF5IZCbyMrJ8aqL94+iFSqoCpDXR+zhKwSRalFYoGe1HRxmw5xq4BRZ6sYPDV4znuZoZVhnQhlnFpiBBYy8JM5aG+dh4zkqtzkUq5JSl3HI2EzZjY27g0S4DmagUUjYROfRO5Ik8EuU+e1fmiqdsrirNDl/8oZ4Nl8G2462tFzCupuzdq62t919l1pZmv9/nZdlTJUgjpjLnY9NLVNFPsWOZTh7GbJaBBpyVJVwy4Ebkc8bTlM1EOgVrYmYzkCxR5ZwlSulUSG7BxKzkU2CyKsagTcy4TFmhNDAhGWcaeDrftmq7MsD+4+2b12yidMFtjx3mlYnr5VKhIbH53E1vM6h39cAEbBirhZzGrOBniC1h2U+VSM5w2wZkiv/HgQeHrwhXW1tvq7JU2kLKfnRb2N/awi/fQK5mjGug/okqCiVZyTUvwBK5Mm7ps4afKqEhdUTheR5wsX8it9nWlp2XsL+1xV7JVCSIDJoQW5ma+L491xWRhF3flpCIifBdW6hjSrJZJpKMcDLjjp5lzhMHpgZTQmLFOXQnvojZHCd+AVIFCDKlxc9KWp4TOc5BW5HwvE02BBC7Gsu1RXSWSkgbWv0K7E+ePEg9IornKwQtRWQVQtIXA+yc5xUYD9UsZhlC9QOUGgyxup8XESlTloGYZmvX4+mHytjOxKwyCGYbCr9WoBKhFwhtE54bYGLSwWXBz6C1GlMkwzzvsW/mLIUJr3IbM4EcZ3UFPfZaWcbLMhcJH+eAnMtQeLitNGwTlT07eEAkL4jGhyTRYBhnqZhMQKNw4keawo8J0CGfNSqAJMdmXDIlFwidqFzpZRai5i4eWaKkBWl77OCci5yAd5s1TMgkr1Jg45wnZzEb5xXETEPqBHcOqLZir4SwC+PG45zwwwzkyIVKIvxS+eWFYcZDlfbYUSZMI0/4MaCaFhGmjVUvtROFKyMKgogxKLjIY0JczD6oMbPC5hCjwJZczmPUlxAzCxd2rC5ilmSQnNFfmqdCsXFlrZJuY6lWZapm0uNyoqQ14ucVEhm+fDxGRzHbjdmjmD2J2XAQs+EoZsPdmA0fxWz4JGajQcxGo5iNdmM2euTAGj3xuOY1gtsADEcOy/bLwS7q3e+FIclGhWlqHTzr6OBhj21t1dKEbX/5y19O5OWJZOwkQuE6ifbZSVR3OYli9w11Jn4b+t8X+GNn9Nj/nOPPR6Mn/ueMug53/c8Mf46GJ/LKL3giRwSJ5UV5DRT4+U4h8L88E2EbLYptQZ9hIyqiOHxAWnXgwQ9X7b3s4F6EFFbw3KzfTuhxj3bUgLS0qV3cFLHr+h3R53u0nTY8+IXUpPtEarX1KQg8QTFa2v1ez58s6zfvlr03e2+B83lbf4RbR9V0hKpp/f5r7XWPkLAI0+dh4nGPDADSzOvx4DvcIyx0Ifo8HDxBHOChtB4B+PUe7b4FDn7wJ7z7NtjdHu5tjwaj3Q4G8G7kOhTFdppuz+fzu8Ae2jx+eTR5goXqLDu8lU60KlZcP+h20PTyNhH9HUz2/0RDfRxsWEjx3kcXi2Cx1De+tpVtVcrnD4ybKgytjTPs35hm8xaY9AnhoNtvkimReOCxTzDJxnjB6yEOtgmT/TTttzCJjWm6XRTbC434c5sQ32osil6a9hZ6LlHHNRYsTWO23LyyPU1ZURRrml17p7lfFMu76BWFh42Mr69RSLzNtl5OfIffSlQaiegufK0YoedAyZzWpuvcajlaOGwyIf0Hz1RsoYOGaZVzDRd4LzVCSdf77mUsiFhj2dM9lq6A5CVwqGBfvfHW+0PP/riF7gTYcvO4pZ3hJAcsqYxVBdMwhQtWcmtBS5rsnOci5XSV26YGuOBFiVeA/p9PTtJ//Zc+OSDwjm8ZUoKlYirQD9T/8/HB9n+/X9GjKkvQCTfAcsCVTMzAJj12nEFeNq6o2WzWm+2YJFMqd36oD0bDxP17qsYfTgncssdN+XDVTh1rtC78yDqL930DtoMxblgYueLKTzxGMjQc0Gnr7zvXHLe+xz06cRZAwo/Oe4Kfj0+igpNBgqwMzd/KZqBPovf1GHfJh/SGse9vIayZSCHnY8iXP91a0OrmnM9V5eU7OLW6W/Uc3cIbfiiErP0WtJ1B3PrILxY+um9XK+TbIaQtneHICeIZKMByYYLnpovO9mjv2iKHowQgH+YYWBiA7uGgPT5XCmrAbicGThN52t2wBPZj1LF2K4bVblihQ5g2YnCOQkhRVEXtH53UswaUFd72aOMLR6LXPazQpu7SCvzihhXQGbl+gRM5JD9G8H9cY5n6HvdIVyyAdL0Yf4oW6ZzTd3TA3iyAYVttAVxxLGNXdyDXwmfWS1+PvcHjDX2ybhB62ZIESoseuc8VzRrkW59Q5LNq++HWc1671z3ivhVg/coc6Pvd9enzSUza3v0XxKgdsG/NrM4pWfDpNTd3+nyP2NPDs+SE2No61DARed4KKbLQFCI7GNKBHAof9vLBRDzqyBEupFV4LQhh2zFMKF5qKYyS8Sbg6M4ZR9J2TJQlGHFWmmXcOPubDH4kFQZsbQbFgis+gNa444UMcCNVhnd3bxx9PWjTafhor0OnvUGHToN1dLrm2ogUNKWSpva1QfOpJddE4tC+fLQsim2YFEn6UmJsJdwenDCoKk9ZLs4oqpIKU+Z8jlQNUuqhXAzXPc+UMk0PHzH7ym94vxuJUxqDcQ97dWDiNg6vBWK0aDF8vNMixd6TJ12J6QjMbe7vzXrLVBjs9od7fefRWu3Qatww65XwNZYAY7ehF/mJbkUv6tkQbON2+lS3092w+85d3rqHj0edw2Jn8KmHxZ1frttSc8O1+i4uz3d2i22L2y3vr7/ZPfLzuW/317Coh4932lz4eHgHLtQ1hvPncuKSfXxnvMfuyjhexYC3sI6vNYk/m0HbwP7qTLp3N5b0cNCx0L7uGGhfj9pMubd3K6ZsL7rAWSeR+K9v3vwwG/zx26k6ODg4eP32Xfby3fTg4KDA371eb+UlahW1aRm0XH1GoD+X6Yxfs0qv10MUYmrlPg3vl3L6b258vH5M70RGcaRKzNkUSr5Ko/2IjG4INngU0z0CjP1GpfNo/zLyOUL4p8/AwaH9DwYTRS8jk2RQcPwr3D8wtRRTO6OY0lxAmyiOKGiMeaZI0mg/UuMPkOBqpUZwrACDc9C4/cvQy+VGRrG3uKL9yG0xiiPv1q+b6qzSMp1EV2HB66aqW5qpDP1RX0hwHkw//MRpXuPQq4XU2k+a6UVrBtpbAUfqucJvFl7wuWnN67x+0WJGL45BYU/8KJbyuUGlURl3wCU8T6oc7UK4KIWe17FRMg5b/FHDW69Uwzvcu2qI3oDEtebzKI6EhaLdvoYJtPp4yiWgEDOUoPKxYz8oGAP83jdg4IYIz4uPhuKDAjYGInqZKfnR44ejneFouDMc4Qz+cvvpeHRflyHoMsYB5tBBGoye7SYZNGaUkNW7iUdDf9o2n8LNzHi0Lkm4lZtoMrrp8LIErnuUq/vJaeBd/q5P194N3HwVRxc3b+aCJWo7ZCCzr3KYWBcxZInSEvTDdhrCvdncaHf3Ko7mN29v/kVu7zESb3bz7n6k1O0mrf0fAevOk6s4ym6G9bs6ufwfCOzuo6vmdF0wHk7HKp2fBr11dVPHcFBgv4nKU9BokCzrq0bVoIbBRxGni3p+rFQOXK5QNJ2sYv98BY1f9P96h8gsA7xDNDYxzd4Y3N5b7KDFTGVYSH4QBm1VXcFJ1GOvJi3znczpxcTm0JeSjKViD2i9U1ORGn/Q978RRw/aDzjQ3drkHwUQqDOzUJQ5vYCYoc92TMG8tMfq/8jyqzGJAITjMix881Hx3CVd0IJ+UPf5APO2Y48957JOIe+marPLy5oNiDuurtjlJVIV9CkeuldXcdOAa3Ua6Fx1LRoSEOedUXUTNAPrttZQZ+KcoonjGnxKXxsAMZVCTk8r7edBS/DqqtdhyAXAyXPtcQBpzWdiKlfsurZXiNK3xv4Ssj0H4CT/b/D+tHz2nVgBytN++exp+exHfCxUgpM9h56JkKmT/BnkeY89NVYrOX22gIKnfd++mpQazgXMSHCJqs0si7itJ+p5mP6EirohnjAs0VUieE7ZRlolEAIkSDeJN2hjoTQYkRKWRrr3HGSP86kGCsUQLLyy9DiKrmZhwaecZRom//5gAacPnr1F0PFd3NM+f+Z7v3I+gYyfA+Nyzmjj5MBQ2jnBJpUmNZnkXIuJvwfGrMwBM6PwmsgTF1BzGA1wHGVcnpn46Vg/OwJesDclSITgl7/9HXsEnf5KvtEp6Fso9VcTF7pT7AHqsQexy9IidhfaWK+qnSb0HOLgWiM6PksfI34va9VvqrHBXjLM16hWq8V0ChjQ8j1osH/zAjzJ3KFBUPFJcOGXyDyqMgE8ZLBwG6PolnD8IeS063JpYYdiae2991ZpdYmPZN4cHd4Cl+QP2naC4pwhbpduDvbm6BDf2dXk7rF3psZEQC3vdGF4DWfngoe3OLVlP3eZLeCCGl4vtgOAPf/CbZstA5QKsxKi2B3qqOHqV6lLEzcPMZFEqrIYUBT+eRFJWQePBEWNyCNV3YYrb8AkZ9OKEoktim84NSmXsHknJ6SxunJZPSytdHga6NnCqQljGjwFrGCn1vwxA2nccM4m3FjQMaukQMzrCl2E9ZRwUYIWIBNYiQINDnWoOm4+orqPzt798L1/fhv2EIRyjBLoJoaUVSVxDUlC/RgyUG5x6yvtQa++bwYQbTd6suj9nCVooySqOKWnXHoN6u6j6MwcQ8Zz19WrCoyHITwo4V1ggqX9y9/+3oJrrUdiGTC3Ak9TzHS9AULyCzuGx2QuDSVqQNWFCOcD/fvFKwBCR0JzWqi0FiRzex4/pNxYU+tFH6CvkwNMlWR4bNX61sRBxxrvVDDkAiY/MUX4S9wvXAhjW8/5QtL9sn74ARCPSQsGuoSiVCPPy3lbwJukBbUwHV0PRPcpaH0JWpIFXll1qqEQ8nbnVNvlblWtCCqrCm5FwsJUptd94OviukGuC/ZVAA258Vwo/XCNqOJ0p0omcCrkKZyDvsX1/nWdJEgOwTHYGYBswxaQ5I6z5hHmDN/Nd3DSOp3oqXEbSvQMli4zY5XnqgtUeDAdst0DP7ijhB7yF2PMEHI5JihqpDjCLW3JFfal+NJ8ssXGk/YFuZqGg8E/sydtZ/DleNJ2B1+QJ+0JAusDkDcroHX2zUrdEaKM1w/4oMhlT3Ha63tiVI+cdC4MvgrBjTiMrtx/jfMv6P0bHILOY9iEEf11JmyG0DAaDPB/XXK+6CQQonFbJWgsTqo8n/8uim8fw7yeBq55tZPyOq2efRCjny+S89Fh5ONjXWv6I8+iTwpy4ZjFENcam/7arXiBqHSO9W9wL9u1PUXTtmgsZC4knAYCnqYqOQ27x34FGNM95W4FQ01uumV3aX3D8pFjzN1VXPRWFWAzMj9x3hl6b2r3htVzxqdcSIYyru+QqUDrm8Tv4yC7DgW7g8HpsEbC3jISXkl6bkTFno7UGcjfdqft5a1bHkG9KPJGB0bCdaLvUWez7Xa3SQNJpYWdR/vHl9HFNi/Ftvu+f/z+6j2yoM0UpkGUyhDE3GbRftRfyoowoM8pqn186eSmFgXDZYq5XEvnAy9F/3zYG0ZX8eKYlefJNf2h2v7YIcbyqZDTm8a9b3D0FunoSNXBVKOnSvFHQEXlCdHuFUcC+ScDjpcjRD2yxw9NLsnLQOSQ5bEqcaMh5mIqRsjE6CRXLJ7rK9IlVmdLDPdaeQrHIeWAsgjqJIJVeQH11kOkvw70t2L3rdD9ccPsdZQ8mPZDsolHu7tkPD4ekpW184QMmN1HV8SeTVgsirqhL8rwXwzgfF48ohuO2PjY/4l87Asuds88jZ/YZUJ2HJ6+qesADFxYO9w6Xq9Fp9daB9Qa/5NfcsHPUgOyyr2x1/EqrJC7YBV3pQ5zBVHqdgYkdbsDkrong45B7nfYzNCY1WQ716Yz2cdt8xht4PeoA4WcKFKgXqsFutABRwp46RoFeaKKusRVi5A0JoiA8wLiDL/DFMo3lWalmoGeVK5e1iSHC4FeGhwEBX1rAt/AixyMyfHhgIUpVXCkZ/DoDvcO14SXfCxygae3e9zjhKIxAEyP/diEzh9oVxXgHHI89Gs/F1aADAbbTOmzCYbgY8bZGEvfoacTZMZl4pyq7iQi5yB6edBhXWphsKKfRqiFg01Jq1ESCi75lGQ07qAqhRxVlmFajTHmYFReOUmzXORKu5Q32hAl11Ie6suLEj/RPRDd0Roy5Ntz71o3sQttuEPG14QcYxSpRFhEAuRhrGSusHwjRqOqPGelsi5ChNfNNow43GouDdq6PsvO06BGmPd6g/EPn94ZQAp/L+SZKzm2zY5rnvoRxkZY6BYkWJS9h90x3wr7XTXGgobKCKv0vBk9FTarxmQutCepf7iZvg0VQFvGQDNHqhKz4uKsEtPH2gn9t2CRQ0z/4PAVmZsP2S9//R/2PXAtWaZmjluTSkM+b4qNUjFOorxDW20tUlwFFTViPHHM58+XgMEfM25/+ev/GvYaZuhfRhFyiNzaOqzGuUjYUcil2NraD1VQm/yKzgNq96wNg12clW50LuRZjx3IObnnm9MG22lcZxt0wrUKp3LMxlTSZ1G7NXsNROQQNpCfA/n9sYbeGBikwoUQtaqmbrU2MH5z3Rd+uLeDNGXlwis/dD434Dj/KsXuuHO0Yo3TFQ8DOy/wuokHIFOqwmn2War5xDbzxwtP/+isW2oKrwYDOmI/TU0SJ4l+x3Wry3VeMGS7ulbDBCi1tVvLlpfCs9NxYEvWrfTx8WztHC10fLeu8GhRrwzPYA1S82byFvS5SMK9e41E96lzP4qjXCTgvT7+7Dr49vB7dr7TG0Rx63pwC+Huf//q+cvXb18iMKhIHcKGvUFvQM5pZWzBZWulhWrBi+daK498U1x4U1x4U1x4U1x4U1z4iyl/uykuvCkuvCkuvCkuvCkuvCku/OshYVNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNc+P7oik1x4ftSs3VTXPi34MBNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceE1xYVbzy76Zc6FbD00dY/rjhdLDr+Powxf3+0fR5eXuMw7fEKDzT9V9Mjj+H0cnXMtMD2HHu7F4Z0ZPvQ4A3yt9NxlG20f4fqxk21KsF14r4gP5dyIA2Loa/u2Hwgevnl7FMVRqNVWqJReRvMZPgzhM/c2pvV6hNouo5zLaUUvTyI355WrJJJ139Wd0bs6/0fr+QqX8xaE3Qd3bhv4L25q5YDLS/dmj153uf7u09oRHrGhN9Lv/dXV1f8Beqn6RA==","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(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7XglhkWtY5bUcNBV2V0Qq4AygGKzzWDEPMwf7NO+zqf5SzYyAdTRB0lJtIeabT/IbBSORF5IZCbyMrJ8aqL94+iFSqoCpDXR+zhKwSRalFYoGe1HRxmw5xq4BRZ6sYPDV4znuZoZVhnQhlnFpiBBYy8JM5aG+dh4zkqtzkUq5JSl3HI2EzZjY27g0S4DmagUUjYROfRO5Ik8EuU+e1fmiqdsrirNDl/8oZ4Nl8G2462tFzCupuzdq62t919l1pZmv9/nZdlTJUgjpjLnY9NLVNFPsWOZTh7GbJaBBpyVJVwy4Ebkc8bTlM1EOgVrYmYzkCxR5ZwlSulUSG7BxKzkU2CyKsagTcy4TFmhNDAhGWcaeDrftmq7MsD+4+2b12yidMFtjx3mlYnr5VKhIbH53E1vM6h39cAEbBirhZzGrOBniC1h2U+VSM5w2wZkiv/HgQeHrwhXW1tvq7JU2kLKfnRb2N/awi/fQK5mjGug/okqCiVZyTUvwBK5Mm7ps4afKqEhdUTheR5wsX8it9nWlp2XsL+1xV7JVCSIDJoQW5ma+L491xWRhF3flpCIifBdW6hjSrJZJpKMcDLjjp5lzhMHpgZTQmLFOXQnvojZHCd+AVIFCDKlxc9KWp4TOc5BW5HwvE02BBC7Gsu1RXSWSkgbWv0K7E+ePEg9IornKwQtRWQVQtIXA+yc5xUYD9UsZhlC9QOUGgyxup8XESlTloGYZmvX4+mHytjOxKwyCGYbCr9WoBKhFwhtE54bYGLSwWXBz6C1GlMkwzzvsW/mLIUJr3IbM4EcZ3UFPfZaWcbLMhcJH+eAnMtQeLitNGwTlT07eEAkL4jGhyTRYBhnqZhMQKNw4keawo8J0CGfNSqAJMdmXDIlFwidqFzpZRai5i4eWaKkBWl77OCci5yAd5s1TMgkr1Jg45wnZzEb5xXETEPqBHcOqLZir4SwC+PG45zwwwzkyIVKIvxS+eWFYcZDlfbYUSZMI0/4MaCaFhGmjVUvtROFKyMKgogxKLjIY0JczD6oMbPC5hCjwJZczmPUlxAzCxd2rC5ilmSQnNFfmqdCsXFlrZJuY6lWZapm0uNyoqQ14ucVEhm+fDxGRzHbjdmjmD2J2XAQs+EoZsPdmA0fxWz4JGajQcxGo5iNdmM2euTAGj3xuOY1gtsADEcOy/bLwS7q3e+FIclGhWlqHTzr6OBhj21t1dKEbX/5y19O5OWJZOwkQuE6ifbZSVR3OYli9w11Jn4b+t8X+GNn9Nj/nOPPR6Mn/ueMug53/c8Mf46GJ/LKL3giRwSJ5UV5DRT4+U4h8L88E2EbLYptQZ9hIyqiOHxAWnXgwQ9X7b3s4F6EFFbw3KzfTuhxj3bUgLS0qV3cFLHr+h3R53u0nTY8+IXUpPtEarX1KQg8QTFa2v1ez58s6zfvlr03e2+B83lbf4RbR9V0hKpp/f5r7XWPkLAI0+dh4nGPDADSzOvx4DvcIyx0Ifo8HDxBHOChtB4B+PUe7b4FDn7wJ7z7NtjdHu5tjwaj3Q4G8G7kOhTFdppuz+fzu8Ae2jx+eTR5goXqLDu8lU60KlZcP+h20PTyNhH9HUz2/0RDfRxsWEjx3kcXi2Cx1De+tpVtVcrnD4ybKgytjTPs35hm8xaY9AnhoNtvkimReOCxTzDJxnjB6yEOtgmT/TTttzCJjWm6XRTbC434c5sQ32osil6a9hZ6LlHHNRYsTWO23LyyPU1ZURRrml17p7lfFMu76BWFh42Mr69RSLzNtl5OfIffSlQaiegufK0YoedAyZzWpuvcajlaOGwyIf0Hz1RsoYOGaZVzDRd4LzVCSdf77mUsiFhj2dM9lq6A5CVwqGBfvfHW+0PP/riF7gTYcvO4pZ3hJAcsqYxVBdMwhQtWcmtBS5rsnOci5XSV26YGuOBFiVeA/p9PTtJ//Zc+OSDwjm8ZUoKlYirQD9T/8/HB9n+/X9GjKkvQCTfAcsCVTMzAJj12nEFeNq6o2WzWm+2YJFMqd36oD0bDxP17qsYfTgncssdN+XDVTh1rtC78yDqL930DtoMxblgYueLKTzxGMjQc0Gnr7zvXHLe+xz06cRZAwo/Oe4Kfj0+igpNBgqwMzd/KZqBPovf1GHfJh/SGse9vIayZSCHnY8iXP91a0OrmnM9V5eU7OLW6W/Uc3cIbfiiErP0WtJ1B3PrILxY+um9XK+TbIaQtneHICeIZKMByYYLnpovO9mjv2iKHowQgH+YYWBiA7uGgPT5XCmrAbicGThN52t2wBPZj1LF2K4bVblihQ5g2YnCOQkhRVEXtH53UswaUFd72aOMLR6LXPazQpu7SCvzihhXQGbl+gRM5JD9G8H9cY5n6HvdIVyyAdL0Yf4oW6ZzTd3TA3iyAYVttAVxxLGNXdyDXwmfWS1+PvcHjDX2ybhB62ZIESoseuc8VzRrkW59Q5LNq++HWc1671z3ivhVg/coc6Pvd9enzSUza3v0XxKgdsG/NrM4pWfDpNTd3+nyP2NPDs+SE2No61DARed4KKbLQFCI7GNKBHAof9vLBRDzqyBEupFV4LQhh2zFMKF5qKYyS8Sbg6M4ZR9J2TJQlGHFWmmXcOPubDH4kFQZsbQbFgis+gNa444UMcCNVhnd3bxx9PWjTafhor0OnvUGHToN1dLrm2ogUNKWSpva1QfOpJddE4tC+fLQsim2YFEn6UmJsJdwenDCoKk9ZLs4oqpIKU+Z8jlQNUuqhXAzXPc+UMk0PHzH7ym94vxuJUxqDcQ97dWDiNg6vBWK0aDF8vNMixd6TJ12J6QjMbe7vzXrLVBjs9od7fefRWu3Qatww65XwNZYAY7ehF/mJbkUv6tkQbON2+lS3092w+85d3rqHj0edw2Jn8KmHxZ1frttSc8O1+i4uz3d2i22L2y3vr7/ZPfLzuW/317Coh4932lz4eHgHLtQ1hvPncuKSfXxnvMfuyjhexYC3sI6vNYk/m0HbwP7qTLp3N5b0cNCx0L7uGGhfj9pMubd3K6ZsL7rAWSeR+K9v3vwwG/zx26k6ODg4eP32Xfby3fTg4KDA371eb+UlahW1aRm0XH1GoD+X6Yxfs0qv10MUYmrlPg3vl3L6b258vH5M70RGcaRKzNkUSr5Ko/2IjG4INngU0z0CjP1GpfNo/zLyOUL4p8/AwaH9DwYTRS8jk2RQcPwr3D8wtRRTO6OY0lxAmyiOKGiMeaZI0mg/UuMPkOBqpUZwrACDc9C4/cvQy+VGRrG3uKL9yG0xiiPv1q+b6qzSMp1EV2HB66aqW5qpDP1RX0hwHkw//MRpXuPQq4XU2k+a6UVrBtpbAUfqucJvFl7wuWnN67x+0WJGL45BYU/8KJbyuUGlURl3wCU8T6oc7UK4KIWe17FRMg5b/FHDW69Uwzvcu2qI3oDEtebzKI6EhaLdvoYJtPp4yiWgEDOUoPKxYz8oGAP83jdg4IYIz4uPhuKDAjYGInqZKfnR44ejneFouDMc4Qz+cvvpeHRflyHoMsYB5tBBGoye7SYZNGaUkNW7iUdDf9o2n8LNzHi0Lkm4lZtoMrrp8LIErnuUq/vJaeBd/q5P194N3HwVRxc3b+aCJWo7ZCCzr3KYWBcxZInSEvTDdhrCvdncaHf3Ko7mN29v/kVu7zESb3bz7n6k1O0mrf0fAevOk6s4ym6G9bs6ufwfCOzuo6vmdF0wHk7HKp2fBr11dVPHcFBgv4nKU9BokCzrq0bVoIbBRxGni3p+rFQOXK5QNJ2sYv98BY1f9P96h8gsA7xDNDYxzd4Y3N5b7KDFTGVYSH4QBm1VXcFJ1GOvJi3znczpxcTm0JeSjKViD2i9U1ORGn/Q978RRw/aDzjQ3drkHwUQqDOzUJQ5vYCYoc92TMG8tMfq/8jyqzGJAITjMix881Hx3CVd0IJ+UPf5APO2Y48957JOIe+marPLy5oNiDuurtjlJVIV9CkeuldXcdOAa3Ua6Fx1LRoSEOedUXUTNAPrttZQZ+KcoonjGnxKXxsAMZVCTk8r7edBS/DqqtdhyAXAyXPtcQBpzWdiKlfsurZXiNK3xv4Ssj0H4CT/b/D+tHz2nVgBytN++exp+exHfCxUgpM9h56JkKmT/BnkeY89NVYrOX22gIKnfd++mpQazgXMSHCJqs0si7itJ+p5mP6EirohnjAs0VUieE7ZRlolEAIkSDeJN2hjoTQYkRKWRrr3HGSP86kGCsUQLLyy9DiKrmZhwaecZRom//5gAacPnr1F0PFd3NM+f+Z7v3I+gYyfA+Nyzmjj5MBQ2jnBJpUmNZnkXIuJvwfGrMwBM6PwmsgTF1BzGA1wHGVcnpn46Vg/OwJesDclSITgl7/9HXsEnf5KvtEp6Fso9VcTF7pT7AHqsQexy9IidhfaWK+qnSb0HOLgWiM6PksfI34va9VvqrHBXjLM16hWq8V0ChjQ8j1osH/zAjzJ3KFBUPFJcOGXyDyqMgE8ZLBwG6PolnD8IeS063JpYYdiae2991ZpdYmPZN4cHd4Cl+QP2naC4pwhbpduDvbm6BDf2dXk7rF3psZEQC3vdGF4DWfngoe3OLVlP3eZLeCCGl4vtgOAPf/CbZstA5QKsxKi2B3qqOHqV6lLEzcPMZFEqrIYUBT+eRFJWQePBEWNyCNV3YYrb8AkZ9OKEoktim84NSmXsHknJ6SxunJZPSytdHga6NnCqQljGjwFrGCn1vwxA2nccM4m3FjQMaukQMzrCl2E9ZRwUYIWIBNYiQINDnWoOm4+orqPzt798L1/fhv2EIRyjBLoJoaUVSVxDUlC/RgyUG5x6yvtQa++bwYQbTd6suj9nCVooySqOKWnXHoN6u6j6MwcQ8Zz19WrCoyHITwo4V1ggqX9y9/+3oJrrUdiGTC3Ak9TzHS9AULyCzuGx2QuDSVqQNWFCOcD/fvFKwBCR0JzWqi0FiRzex4/pNxYU+tFH6CvkwNMlWR4bNX61sRBxxrvVDDkAiY/MUX4S9wvXAhjW8/5QtL9sn74ARCPSQsGuoSiVCPPy3lbwJukBbUwHV0PRPcpaH0JWpIFXll1qqEQ8nbnVNvlblWtCCqrCm5FwsJUptd94OviukGuC/ZVAA258Vwo/XCNqOJ0p0omcCrkKZyDvsX1/nWdJEgOwTHYGYBswxaQ5I6z5hHmDN/Nd3DSOp3oqXEbSvQMli4zY5XnqgtUeDAdst0DP7ijhB7yF2PMEHI5JihqpDjCLW3JFfal+NJ8ssXGk/YFuZqGg8E/sydtZ/DleNJ2B1+QJ+0JAusDkDcroHX2zUrdEaKM1w/4oMhlT3Ha63tiVI+cdC4MvgrBjTiMrtx/jfMv6P0bHILOY9iEEf11JmyG0DAaDPB/XXK+6CQQonFbJWgsTqo8n/8uim8fw7yeBq55tZPyOq2efRCjny+S89Fh5ONjXWv6I8+iTwpy4ZjFENcam/7arXiBqHSO9W9wL9u1PUXTtmgsZC4knAYCnqYqOQ27x34FGNM95W4FQ01uumV3aX3D8pFjzN1VXPRWFWAzMj9x3hl6b2r3htVzxqdcSIYyru+QqUDrm8Tv4yC7DgW7g8HpsEbC3jISXkl6bkTFno7UGcjfdqft5a1bHkG9KPJGB0bCdaLvUWez7Xa3SQNJpYWdR/vHl9HFNi/Ftvu+f/z+6j2yoM0UpkGUyhDE3GbRftRfyoowoM8pqn186eSmFgXDZYq5XEvnAy9F/3zYG0ZX8eKYlefJNf2h2v7YIcbyqZDTm8a9b3D0FunoSNXBVKOnSvFHQEXlCdHuFUcC+ScDjpcjRD2yxw9NLsnLQOSQ5bEqcaMh5mIqRsjE6CRXLJ7rK9IlVmdLDPdaeQrHIeWAsgjqJIJVeQH11kOkvw70t2L3rdD9ccPsdZQ8mPZDsolHu7tkPD4ekpW184QMmN1HV8SeTVgsirqhL8rwXwzgfF48ohuO2PjY/4l87Asuds88jZ/YZUJ2HJ6+qesADFxYO9w6Xq9Fp9daB9Qa/5NfcsHPUgOyyr2x1/EqrJC7YBV3pQ5zBVHqdgYkdbsDkrong45B7nfYzNCY1WQ716Yz2cdt8xht4PeoA4WcKFKgXqsFutABRwp46RoFeaKKusRVi5A0JoiA8wLiDL/DFMo3lWalmoGeVK5e1iSHC4FeGhwEBX1rAt/AixyMyfHhgIUpVXCkZ/DoDvcO14SXfCxygae3e9zjhKIxAEyP/diEzh9oVxXgHHI89Gs/F1aADAbbTOmzCYbgY8bZGEvfoacTZMZl4pyq7iQi5yB6edBhXWphsKKfRqiFg01Jq1ESCi75lGQ07qAqhRxVlmFajTHmYFReOUmzXORKu5Q32hAl11Ie6suLEj/RPRDd0Roy5Ntz71o3sQttuEPG14QcYxSpRFhEAuRhrGSusHwjRqOqPGelsi5ChNfNNow43GouDdq6PsvO06BGmPd6g/EPn94ZQAp/L+SZKzm2zY5rnvoRxkZY6BYkWJS9h90x3wr7XTXGgobKCKv0vBk9FTarxmQutCepf7iZvg0VQFvGQDNHqhKz4uKsEtPH2gn9t2CRQ0z/4PAVmZsP2S9//R/2PXAtWaZmjluTSkM+b4qNUjFOorxDW20tUlwFFTViPHHM58+XgMEfM25/+ev/GvYaZuhfRhFyiNzaOqzGuUjYUcil2NraD1VQm/yKzgNq96wNg12clW50LuRZjx3IObnnm9MG22lcZxt0wrUKp3LMxlTSZ1G7NXsNROQQNpCfA/n9sYbeGBikwoUQtaqmbrU2MH5z3Rd+uLeDNGXlwis/dD434Dj/KsXuuHO0Yo3TFQ8DOy/wuokHIFOqwmn2War5xDbzxwtP/+isW2oKrwYDOmI/TU0SJ4l+x3Wry3VeMGS7ulbDBCi1tVvLlpfCs9NxYEvWrfTx8WztHC10fLeu8GhRrwzPYA1S82byFvS5SMK9e41E96lzP4qjXCTgvT7+7Dr49vB7dr7TG0Rx63pwC+Huf//q+cvXb18iMKhIHcKGvUFvQM5pZWzBZWulhWrBi+daK498U1x4U1x4U1x4U1x4U1z4iyl/uykuvCkuvCkuvCkuvCkuvCku/OshYVNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNc+P7oik1x4ftSs3VTXPi34MBNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceFNceE1xYVbzy76Zc6FbD00dY/rjhdLDr+Powxf3+0fR5eXuMw7fEKDzT9V9Mjj+H0cnXMtMD2HHu7F4Z0ZPvQ4A3yt9NxlG20f4fqxk21KsF14r4gP5dyIA2Loa/u2Hwgevnl7FMVRqNVWqJReRvMZPgzhM/c2pvV6hNouo5zLaUUvTyI355WrJJJ139Wd0bs6/0fr+QqX8xaE3Qd3bhv4L25q5YDLS/dmj153uf7u09oRHrGhN9Lv/dXV1f8Beqn6RA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},f=[];function j(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.34e886ef.js b/assets/js/4227e71a.34e886ef.js new file mode 100644 index 000000000..7a954af99 --- /dev/null +++ b/assets/js/4227e71a.34e886ef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5342],{30649:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>x,contentTitle:()=>h,default:()=>k,frontMatter:()=>f,metadata:()=>p,toc:()=>w});const p=JSON.parse('{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/v1.1/get-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-template","permalink":"/docs/API-docs/v1.1/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWM1u3DgSfpUaXnZiyN1tx3Fm+zTGbJAxNpgYYw8MrGM0KKlaYkyRHJLqHzQEzGHfYE973UfLkyyKlNRqu+MfzCLAXhI3VR9ZVaxifVUb5nnh2PSGXWFlJPfo2G3CcnSZFcYLrdiUXZUI79FDJwJnF+fApdRLB2tdg9dg0VuBC4QcPRfSAU917YGDM5iJucjAt+BRv40Dh3aBwB2kskZjhfIO5tpCZpF7oQrIdVZXSMtL4UswFnOcC4U5OG/rzNcW3YglTBu0nLQ9z9mUFei7M1jCDLe8Qo+WzNwwxStkU9apMxM5S5ggMw33Jbtv+/nfQM975cGX3INCzB1ZnSLM0Wcl0h4Wf6+FxZxNva0xYc6vJZ3kRGUkKYIrI3WObDrn0pFAVmLF2XTD/NoESW+FKljC5tpW3McVVbCmuaXtndHKoSPA8WRC/+2q6uosQ+fmtYTeHyxhmVYelSd5bowUWfgw/uwItHmohU4/Y+bJcZa28SIeGZfJv4/rG1dwxYPVU7Y6+jlVlTu+KFiTMC88rT7cYgtw4Y/e5YRS2j8B6i8oiDakkszRfiuzYlA9pmDUB4Jgs3XENg5bhUl18ZSLSu+Nm47HHbh2aEeZrgitl2rH7secFfJMd1olzIlChTzp0dxavqYE8Vi5p71p9VOqZ6if57DPGiHFoBZWXMgnpVPEH9uFzhem1OqJY07enB4fvf7h7RHJL0VeoP8T9sevL4skjyuf6lXQlxdDuKqrFO0Q3q/08KMmYasXYo5PTpqErV+IektHLV8Iev1Dk7DyhaCTU4rj8Kw9w+dfC6Vn+bzZm4uXMQ9mXTw8KhXS2aHKz9VHu/vmpFpL5Gp4NNWGJmEh8zA/849H5/Hk+PXh0eRw8vbq6HR68tfpm9PRZDL5B0vYqpJb61nevpSdkt3v2uTf5BxUPJV4pevnmW8xFxYzP6vt3sR+7O7ouEA+ZpXOiVrw+4Gy59xQcglYez2zWAn15E11kCg90yrDmVAzXKDdmzo9cEIBseu2YTG7H0dtEJ7sK+mXukJfEhNaovKwtFoVCRiJ3CF4uwZecKGAtrHf/e9qPVqrn6ghL9NsmD9CSaFw1vGZ2clkMjvqnXDy0AlXg9oOc12r/Nuauu/8xw06mZ32Br15aNC5WnAp8kCjr/Qdqm9rz/B4H49/GLEiCoXvbMfY4Xo00mFWW+HXgV+vDrkRh/H79OaWqCtFim6JeSDkvmRT1rOX8WZAxhtG+9lFR9fDA9ETHsdVnurVSBtURFYkTx0V+zE3Yrw4GlEVv4/hxrxIHuvDl0Kc54VQxVO4262rLuk6443tOGxLPIz4OxLzaO9jKNX2KyXywBgb+j3XAdze0keDispTuONw+P2+5hplpiukLsaXCB3gyz//EzBd4xWCMOzw3Sf1SX2sLRi9REtNBlc5zCWuRCpjS4hV+NY3hQ55JdE5uQahPBaWkigXhfBcAvmIno+MG54KKSiASUwT2sIgB9wIrkv0JVr69BeLwCHHBUqKe6AXvdrtFmGp7d2c2tMEOKS1EwqdA1QlVxkJdreQgLbAFaDyaI0VDqmvJK1F1E0rb3nmoeKKF0h7JzuuylEKClWwOq2dB6dlHVQG6oK1xRw6g0LTOCInvqM+0CLQaqYrY7GkkFkgFLXI0SWQ6Rwh9kFkgsohRefBkC4iw9B71krq7C5c3ryWEoym50NwSf3qUEeCe8uVo6IadenuoHeYsZpaR4wKHhz85pBu+INQd256cPBJHcJNH1PXmDrh8fb7LvyXy+WDsH+1i3kv/M91Cr+i0U54bddbdCF8WachVYab9D/iTu9RYYifQSJs98h15h5mHq2OS5RmfImeIsSNzy7Ow4v7Cr788S/4gNwqKPUyRmtWW5RrKLqjyHPx5qPb+gczDCl47UvyeBaDj9p/dL7z4HXJ/Zc//u3gF1yCiCkUHXlwcFGnUmTbOcjBwRR+CoSw73pdnDRkXNGQwZWcQmkhOHAwES2FuhvBmVoDdX9xPkLBQOsBt2MG+WUwTUm5wxy0Coh9kxlfYuVQLtDRXlT4UgTMhaeILq2ui3jaUJnWOItzISVcR+5Mtp3lOY1uwnJLqcnhA3VwTgnhS1wDtwgOlR/BxT1I+FIboy1pIaLyc01UkC4AVW40jZCmkFs+99v9k22gx8mSVnuWogt5746k3aa/kpiJrcX96ugTPcj3HvHdt9biHC0dGMze3osRbTjddGEJFK1/JqypVNOrxbPAJNrOmarJj/f3CVUdbeU+zi/RLkTWTRa+ktHjIDxmCZMiQ+VwwBbO3l98gMXr0YQlg9L4jOQefzj/6d0vl+9IGXpIo8OORpPRJDTE2vmKq8FJwznk/aK22ZKo/4OZZVvoqRUdG8lFoFltPxQp0s22R0jYdDixvE1YqZ0nkc2Gkvk3K5uGln+vQ3tyc5uwBbeCurLAo3Lh6O+8nz5+1XPf/9oOMl/B84efe43pqIwiHrPgsg7tW8LucH1vAtvc0pgg8hnSNkqcZRkaP8A+IMY77PL9uysWOrxyl0fdBR7V/kG779Vrl2BFBehfYnt7AZtN5GhN08vHT19FtAZ20uSk26Zp/guv8jML","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 r=a(74848),n=a(28453),i=a(33617),l=a.n(i),o=a(17543),s=a.n(o),m=a(86013),d=a.n(m),c=a(63723),u=a.n(c),g=(a(18766),a(79329),a(9303));const f={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWM1u3DgSfpUaXnZiyN1tx3Fm+zTGbJAxNpgYYw8MrGM0KKlaYkyRHJLqHzQEzGHfYE973UfLkyyKlNRqu+MfzCLAXhI3VR9ZVaxifVUb5nnh2PSGXWFlJPfo2G3CcnSZFcYLrdiUXZUI79FDJwJnF+fApdRLB2tdg9dg0VuBC4QcPRfSAU917YGDM5iJucjAt+BRv40Dh3aBwB2kskZjhfIO5tpCZpF7oQrIdVZXSMtL4UswFnOcC4U5OG/rzNcW3YglTBu0nLQ9z9mUFei7M1jCDLe8Qo+WzNwwxStkU9apMxM5S5ggMw33Jbtv+/nfQM975cGX3INCzB1ZnSLM0Wcl0h4Wf6+FxZxNva0xYc6vJZ3kRGUkKYIrI3WObDrn0pFAVmLF2XTD/NoESW+FKljC5tpW3McVVbCmuaXtndHKoSPA8WRC/+2q6uosQ+fmtYTeHyxhmVYelSd5bowUWfgw/uwItHmohU4/Y+bJcZa28SIeGZfJv4/rG1dwxYPVU7Y6+jlVlTu+KFiTMC88rT7cYgtw4Y/e5YRS2j8B6i8oiDakkszRfiuzYlA9pmDUB4Jgs3XENg5bhUl18ZSLSu+Nm47HHbh2aEeZrgitl2rH7secFfJMd1olzIlChTzp0dxavqYE8Vi5p71p9VOqZ6if57DPGiHFoBZWXMgnpVPEH9uFzhem1OqJY07enB4fvf7h7RHJL0VeoP8T9sevL4skjyuf6lXQlxdDuKqrFO0Q3q/08KMmYasXYo5PTpqErV+IektHLV8Iev1Dk7DyhaCTU4rj8Kw9w+dfC6Vn+bzZm4uXMQ9mXTw8KhXS2aHKz9VHu/vmpFpL5Gp4NNWGJmEh8zA/849H5/Hk+PXh0eRw8vbq6HR68tfpm9PRZDL5B0vYqpJb61nevpSdkt3v2uTf5BxUPJV4pevnmW8xFxYzP6vt3sR+7O7ouEA+ZpXOiVrw+4Gy59xQcglYez2zWAn15E11kCg90yrDmVAzXKDdmzo9cEIBseu2YTG7H0dtEJ7sK+mXukJfEhNaovKwtFoVCRiJ3CF4uwZecKGAtrHf/e9qPVqrn6ghL9NsmD9CSaFw1vGZ2clkMjvqnXDy0AlXg9oOc12r/Nuauu/8xw06mZ32Br15aNC5WnAp8kCjr/Qdqm9rz/B4H49/GLEiCoXvbMfY4Xo00mFWW+HXgV+vDrkRh/H79OaWqCtFim6JeSDkvmRT1rOX8WZAxhtG+9lFR9fDA9ETHsdVnurVSBtURFYkTx0V+zE3Yrw4GlEVv4/hxrxIHuvDl0Kc54VQxVO4262rLuk6443tOGxLPIz4OxLzaO9jKNX2KyXywBgb+j3XAdze0keDispTuONw+P2+5hplpiukLsaXCB3gyz//EzBd4xWCMOzw3Sf1SX2sLRi9REtNBlc5zCWuRCpjS4hV+NY3hQ55JdE5uQahPBaWkigXhfBcAvmIno+MG54KKSiASUwT2sIgB9wIrkv0JVr69BeLwCHHBUqKe6AXvdrtFmGp7d2c2tMEOKS1EwqdA1QlVxkJdreQgLbAFaDyaI0VDqmvJK1F1E0rb3nmoeKKF0h7JzuuylEKClWwOq2dB6dlHVQG6oK1xRw6g0LTOCInvqM+0CLQaqYrY7GkkFkgFLXI0SWQ6Rwh9kFkgsohRefBkC4iw9B71krq7C5c3ryWEoym50NwSf3qUEeCe8uVo6IadenuoHeYsZpaR4wKHhz85pBu+INQd256cPBJHcJNH1PXmDrh8fb7LvyXy+WDsH+1i3kv/M91Cr+i0U54bddbdCF8WachVYab9D/iTu9RYYifQSJs98h15h5mHq2OS5RmfImeIsSNzy7Ow4v7Cr788S/4gNwqKPUyRmtWW5RrKLqjyHPx5qPb+gczDCl47UvyeBaDj9p/dL7z4HXJ/Zc//u3gF1yCiCkUHXlwcFGnUmTbOcjBwRR+CoSw73pdnDRkXNGQwZWcQmkhOHAwES2FuhvBmVoDdX9xPkLBQOsBt2MG+WUwTUm5wxy0Coh9kxlfYuVQLtDRXlT4UgTMhaeILq2ui3jaUJnWOItzISVcR+5Mtp3lOY1uwnJLqcnhA3VwTgnhS1wDtwgOlR/BxT1I+FIboy1pIaLyc01UkC4AVW40jZCmkFs+99v9k22gx8mSVnuWogt5746k3aa/kpiJrcX96ugTPcj3HvHdt9biHC0dGMze3osRbTjddGEJFK1/JqypVNOrxbPAJNrOmarJj/f3CVUdbeU+zi/RLkTWTRa+ktHjIDxmCZMiQ+VwwBbO3l98gMXr0YQlg9L4jOQefzj/6d0vl+9IGXpIo8OORpPRJDTE2vmKq8FJwznk/aK22ZKo/4OZZVvoqRUdG8lFoFltPxQp0s22R0jYdDixvE1YqZ0nkc2Gkvk3K5uGln+vQ3tyc5uwBbeCurLAo3Lh6O+8nz5+1XPf/9oOMl/B84efe43pqIwiHrPgsg7tW8LucH1vAtvc0pgg8hnSNkqcZRkaP8A+IMY77PL9uysWOrxyl0fdBR7V/kG779Vrl2BFBehfYnt7AZtN5GhN08vHT19FtAZ20uSk26Zp/guv8jML",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,x={},w=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,r.jsx)(l(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,r.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(s(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,r.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/4227e71a.b0ea3081.js b/assets/js/4227e71a.b0ea3081.js deleted file mode 100644 index 8e91cd917..000000000 --- a/assets/js/4227e71a.b0ea3081.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5342],{30649:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>g,default:()=>P,frontMatter:()=>y,metadata:()=>s,toc:()=>b});const s=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":"eJzVWNtuHLkR/ZVavmRttGZGsixv5mmFxJCFGLGw0sJAZGHAblZP02KTXJI9FwwayEP+IH+QT9svCYp9mZ7RWBdsYCAvtoZdh3VhFesUNyzwuWfTW3aDpVU8oGd3CRPoMydtkEazKbspEC4wQCcC51eXwJUySw9rU0Ew4DA4iQsEgYFL5YGnpgrAwVvMZC4zCC141G/jwaNbIHAPqarQOqmDh9w4yBzyIPUchMmqEml5KUMB1qHAXGoU4IOrslA59COWMGPRcbL2UrApm2PodLCEWe54iQEdublhmpfIpqwzZyYFS5gkNy0PBdv3/fKvYPLeeAgFD6ARhSevU4QcQ1Yg7eHwt0o6FGwaXIUJ82GtSJOXpVVkCK6sMgLZNOfKk0BWYMnZdMPC2kbJ4KSes4TlxpU8NCt6zur6jrb31miPngAnkwn9t2uqr7IMvc8rBX08WMIyowPqQPLcWiWz+GH81RNo89AKk37FLFDgHG0TZKOyWab4Pm5vs4IrHr2estXxh1SX/uRqzuqEBRlo9eEWW4CPf/QhJ5Q24QlQf0BRtCaTlED3vdxqkuoxAxt7IArW20Bs87A1mEyXT4WoCMH66XjcgSuPbpSZktBmqXf8fixYsc5MZ1XCvJzrWCc9mjvH11QgAUv/dDSdecr0DM3zAvbVIKQYzcKSS/WkdIr4c7vQxcIWRj+h5vTt2cnxm5/eHZP8Uoo5hj/gf/P1ZZkUcBVSs4r28vkQrqsyRTeE9ys9/LhO2OqFmJPT0zph6xei3pGq5QtBb36qE1a8EHR6Rnkcr7VnxPxbqfSsmNcHa/G6qYNZlw+PSsVy9qjFpf7kdu+c1BiFXA9VU2+oExYrD8V5eDw7TyYnb46OJ0eTdzfHZ9PTP0/fno0mk8k/WMJWpdp6z0R7U3ZGdr8rK76LHtQ8VXhjque571BIh1mYVe5gYT92dqQuko9ZaQRRC76fKAf0xpZLwCqYmcNS6idPqoM00jOjM5xJPcMFuoOl0wMnlBC7YRs2s/08apPw9FBLvzYlhoKY0BJ1gKUzep6AVcg9QnBr4HMuNdA27of/Xa9H58wTPeRllg3rR2olNc46PjM7nUxmx30QTh8G4WbQ2yE3lRbf19VD+h936HR21jv09qFDl3rBlRSRRt+Ye9Tf15+h+tCof5ixshGK39mOs8P1xkmPWeVkWEd+vTriVh4136e3d0RdKVNMS8wjIQ8Fm7KevYw3AzJeM9rPLTq6Hi+InvB4rkVqViNjURNZUTz11OzH3Mrx4nhEXXwfw619kTxWRy+F+MDnUs+fwt1tQ3VNx9mc2E7AtsTDyr8hMY/2PIZS7bxSII+MsabfuYng9pQ+WdTUnuIZR+X7c81nVJkpkaaYUCB0gN//9Z+I6QavmIRxhx++6C/6U+XAmiU6GjK4FpArXMlUNSMhlvFbPxR65KVC79UapA44d1REQs5l4AooRnR9ZNzyVCpJCUxihtAOBjXgR/C5wFCgo09/cggcBC5QUd4D3ejl7rQIS+PucxpPE+CQVl5q9B5QF1xnJNidQgLGAdeAOqCzTnqkuZKslo1tRgfHswAl13yOtHeyEyqBSlKqgjNp5QN4o6poMtAUbBwK6ByKQ+OIgvie5kCHQKuZKa3DglJmgTCvpECfQGYEQjMHkQtaQIo+gCVbZIZx9qy0Mtl9PLy8UgqsoetDckXz6tBGggfHtaem2tjSnUEfMOsMjY7YGPj69a8e6YQ/Sn3vp69ff9FHcNvn1GdMvQx492OX/svl8kHav9rFXMjwoUrhF7TGy2Dceouey1BUaSyV4Sb9j2anC9QY82dQCNs9hMn8w8qj1XGByo6vMVCG+PH51WW8cV/B7//8N3xE7jQUZtlka1Y5VGuYd6oocs3JN2HrL8z4SMGrUFDEsyb5aPxHH/oIRuIFsimeNoZXVaoGTyFTOAe7uwQZ1/Ss0PLDaIIvOCXSQnLgoKS+H8G5XgMNfc2zCOUArUdwg2yAFHm+PeXcmRJkGMEHsyQak8Q9PMGotaGQIe7VGyODR5WPoukOc6kUNJR4uvfbA3cIWKYoBAryeqA2xZzSXQaQ9OSjQ0xf0jyCmwLXEcsXXCrikASOSW2I41FkUQtr6G1oCsLxPGxfhZKtkubJyOgDS02QeO9W0m7T/W5LbO8k/Ai+0FW7dz3v3qIOc3SkMZbkNnGsbBPltks4oDz8IwlLTZjuI55FjtDOxNQnft7fJ/ZrdKX/lF+jW8isezP4Rq2Oo/CYJUzJDLXHAQ84v7j6CAt4M5qwZND1nlG344+Xf3n/9+v3ZA3dkU3EjkeT0STOusaHkuuBquET436/2mz50f/Bc2Tbw2nKHFvFZWRQ7ajTsJ/bLf1P2HT4GHmXsML4QCKbTco9/upUXdPyb1WcPG7vErbgTlKxRIokpKe/Rf+w+M3I/fhL+0b5Cp7/rnnQmY6laKIoC66qOJkl7B7Xe4+r9R29ADRUhaxtJM6zDG0YYB9w3h3iePH+hsXhrdilSPeRIrV/0O4H7drlTo0B9C8RuYOAzaahX3XdyzefvoloHeykKUh3dV3/FyIYI8Q=","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 r=a(74848),o=a(28453),n=a(33617),p=a.n(n),l=a(17543),i=a.n(l),m=a(86013),d=a.n(m),c=a(63723),u=a.n(c),x=(a(18766),a(79329),a(9303));const y={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:"eJzVWNtuHLkR/ZVavmRttGZGsixv5mmFxJCFGLGw0sJAZGHAblZP02KTXJI9FwwayEP+IH+QT9svCYp9mZ7RWBdsYCAvtoZdh3VhFesUNyzwuWfTW3aDpVU8oGd3CRPoMydtkEazKbspEC4wQCcC51eXwJUySw9rU0Ew4DA4iQsEgYFL5YGnpgrAwVvMZC4zCC141G/jwaNbIHAPqarQOqmDh9w4yBzyIPUchMmqEml5KUMB1qHAXGoU4IOrslA59COWMGPRcbL2UrApm2PodLCEWe54iQEdublhmpfIpqwzZyYFS5gkNy0PBdv3/fKvYPLeeAgFD6ARhSevU4QcQ1Yg7eHwt0o6FGwaXIUJ82GtSJOXpVVkCK6sMgLZNOfKk0BWYMnZdMPC2kbJ4KSes4TlxpU8NCt6zur6jrb31miPngAnkwn9t2uqr7IMvc8rBX08WMIyowPqQPLcWiWz+GH81RNo89AKk37FLFDgHG0TZKOyWab4Pm5vs4IrHr2estXxh1SX/uRqzuqEBRlo9eEWW4CPf/QhJ5Q24QlQf0BRtCaTlED3vdxqkuoxAxt7IArW20Bs87A1mEyXT4WoCMH66XjcgSuPbpSZktBmqXf8fixYsc5MZ1XCvJzrWCc9mjvH11QgAUv/dDSdecr0DM3zAvbVIKQYzcKSS/WkdIr4c7vQxcIWRj+h5vTt2cnxm5/eHZP8Uoo5hj/gf/P1ZZkUcBVSs4r28vkQrqsyRTeE9ys9/LhO2OqFmJPT0zph6xei3pGq5QtBb36qE1a8EHR6Rnkcr7VnxPxbqfSsmNcHa/G6qYNZlw+PSsVy9qjFpf7kdu+c1BiFXA9VU2+oExYrD8V5eDw7TyYnb46OJ0eTdzfHZ9PTP0/fno0mk8k/WMJWpdp6z0R7U3ZGdr8rK76LHtQ8VXhjque571BIh1mYVe5gYT92dqQuko9ZaQRRC76fKAf0xpZLwCqYmcNS6idPqoM00jOjM5xJPcMFuoOl0wMnlBC7YRs2s/08apPw9FBLvzYlhoKY0BJ1gKUzep6AVcg9QnBr4HMuNdA27of/Xa9H58wTPeRllg3rR2olNc46PjM7nUxmx30QTh8G4WbQ2yE3lRbf19VD+h936HR21jv09qFDl3rBlRSRRt+Ye9Tf15+h+tCof5ixshGK39mOs8P1xkmPWeVkWEd+vTriVh4136e3d0RdKVNMS8wjIQ8Fm7KevYw3AzJeM9rPLTq6Hi+InvB4rkVqViNjURNZUTz11OzH3Mrx4nhEXXwfw619kTxWRy+F+MDnUs+fwt1tQ3VNx9mc2E7AtsTDyr8hMY/2PIZS7bxSII+MsabfuYng9pQ+WdTUnuIZR+X7c81nVJkpkaaYUCB0gN//9Z+I6QavmIRxhx++6C/6U+XAmiU6GjK4FpArXMlUNSMhlvFbPxR65KVC79UapA44d1REQs5l4AooRnR9ZNzyVCpJCUxihtAOBjXgR/C5wFCgo09/cggcBC5QUd4D3ejl7rQIS+PucxpPE+CQVl5q9B5QF1xnJNidQgLGAdeAOqCzTnqkuZKslo1tRgfHswAl13yOtHeyEyqBSlKqgjNp5QN4o6poMtAUbBwK6ByKQ+OIgvie5kCHQKuZKa3DglJmgTCvpECfQGYEQjMHkQtaQIo+gCVbZIZx9qy0Mtl9PLy8UgqsoetDckXz6tBGggfHtaem2tjSnUEfMOsMjY7YGPj69a8e6YQ/Sn3vp69ff9FHcNvn1GdMvQx492OX/svl8kHav9rFXMjwoUrhF7TGy2Dceouey1BUaSyV4Sb9j2anC9QY82dQCNs9hMn8w8qj1XGByo6vMVCG+PH51WW8cV/B7//8N3xE7jQUZtlka1Y5VGuYd6oocs3JN2HrL8z4SMGrUFDEsyb5aPxHH/oIRuIFsimeNoZXVaoGTyFTOAe7uwQZ1/Ss0PLDaIIvOCXSQnLgoKS+H8G5XgMNfc2zCOUArUdwg2yAFHm+PeXcmRJkGMEHsyQak8Q9PMGotaGQIe7VGyODR5WPoukOc6kUNJR4uvfbA3cIWKYoBAryeqA2xZzSXQaQ9OSjQ0xf0jyCmwLXEcsXXCrikASOSW2I41FkUQtr6G1oCsLxPGxfhZKtkubJyOgDS02QeO9W0m7T/W5LbO8k/Ai+0FW7dz3v3qIOc3SkMZbkNnGsbBPltks4oDz8IwlLTZjuI55FjtDOxNQnft7fJ/ZrdKX/lF+jW8isezP4Rq2Oo/CYJUzJDLXHAQ84v7j6CAt4M5qwZND1nlG344+Xf3n/9+v3ZA3dkU3EjkeT0STOusaHkuuBquET436/2mz50f/Bc2Tbw2nKHFvFZWRQ7ajTsJ/bLf1P2HT4GHmXsML4QCKbTco9/upUXdPyb1WcPG7vErbgTlKxRIokpKe/Rf+w+M3I/fhL+0b5Cp7/rnnQmY6laKIoC66qOJkl7B7Xe4+r9R29ADRUhaxtJM6zDG0YYB9w3h3iePH+hsXhrdilSPeRIrV/0O4H7drlTo0B9C8RuYOAzaahX3XdyzefvoloHeykKUh3dV3/FyIYI8Q=",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,f={},b=[];function Q(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:"Get Template"}),"\n",(0,r.jsx)(p(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,r.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(i(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,r.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(Q,{...e})}):Q(e)}}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.3387244e.js b/assets/js/5144c8d4.3387244e.js new file mode 100644 index 000000000..790335b24 --- /dev/null +++ b/assets/js/5144c8d4.3387244e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7904],{8437:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>I,default:()=>x,frontMatter:()=>g,metadata:()=>s,toc:()=>k});const s=JSON.parse('{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/v1.1/get-user.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-user","permalink":"/docs/API-docs/v1.1/get-user","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar_label":"Get your account details","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81uGzcQfpUJL22MtST/JGl1ilu4rlMjMWobBmobAXd3tMuYSzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjg/3/zsTJCsghheiYuAXtxkosRQeOVIWSOG4rxGOEICPoWD02NAI3ONAaa2BbJQIfGjBzsxIIvCtoagRJJKh57IhHXoJes6LsVQVEjxmkx4DM6agEEMZ2J3MOC/9ZvP2qLAEEathqUSkYnCGkJDzC+d06qIB/13gYVmIhQ1NpKfaOpQDIXN32FBIhPOsxpS6cpEZqOWnIG8MpXIxMj6RtIqBe9k4zQz/XSkbnf38vrilZhnwsgGH6vhlUX4AZHFsZFKP1b+ncUc8eWC0Ctsw6pcbc2jTdl/9vzFd3u7O7t7rOKdzc8V6UdrKXHM4oVtnDTTx0pbhyaoykQVHiVheUCfUnIvsjvY3dveGWwPXpzvPB/ufz989rw3GAx+E5m4a2I8U15EKSnGmZJby/fWlV/hnvkmW8vQX2FL73Nm3B/sP6yAWHPGEoxsa8on/x/40Xvr/9n3zbvnK3Yro5XBt10Jv2XjOzeePXTj2IylVmXsHuf2Fs3X9WT1ekrXP0yNSkzxXKy5ukpPTgYsWq9oKoZXM3G3LZ3aTufDq5v5TSYapNouuh0bLKkWQ9GvkNrU+wL6MfoQ5VuvxVDURC4M+/0gTZnbu15XFFrmgSu8L53qj3d6O2KebcpI5x7Fj+32Y0UCyUqZ6t/kbu5jc8b5Sylai9AyUdKpX3Aquha6xpUJxbipUZaxQPh9ZKPwIi1vHJozVZmY1Hj55ty6RF3YBnlEUY3QCXz8/a8oU9qibdBQRF3U8OTaXJs3rQdnJ+h56khTwkjjnco1ptHXxLPl7AsoG40h6CkoQ1h5SQilqhRJDRwjZSoopJO50ooRy2w2jcsV0IceXNZINXo++sYjSChxjJqBDrIl20hiVZ3RMLH+dqTtJGQgIW+DMhgCoKmlKZixy0IG1oM0gIbQO68CQiDPVqtkmzXkZUHQSCMrZN3ZWqhK1IqhCt7mbSAIVrfRZOABbz2W0DlkEMvQ4yAe3jk+AqbyUPBYM2TGCFWrSgwZFLZECLFA2QVTQo6BwLEtqsDASlujbXEbkzdqtQZnuV8oqcGO1mxkcfLSBJ4yyZYuB8uAOW95l8Bk4NbWRUDO8Ikyt2G4tXVttuFqialLzIMivPm2g/9kMnkA+6frMkeKfm5z+BWdDYqsn95LV4rqNo+lsqpk+ZI0HaHBiJ+VQrjXUdoiPKw8pvZr1K5/hsQICf2D0+PYYp/Cxw9/wAlKb6C2k4TWovWop1B1V3HkUuZT2JYdEkY2Aq/miBcJfB7ftxioi+BlLenjhz8DvMYJqFRCKZBbW6dtrlUB59g4LQnD1tYQfoyjHaijAdWSoJAGcoRQS4bSWEmQ4JK0Vua2BwdmCtw1YaKojmBgepRbc4Pjskx3gFwGLMGaKNHd2bu3iOlNQD3GwLp4zuUIWCpiRNfetlW6bdWYhXMeR0pruFRlhRR9OyhLcAvyJJE54Cvm4IgLgmqcgvQIAQ314HRDJJ60zlnPVqhk/MhqbSecADSls8pQGELp5Yju9Wf3QI8blLLmE6QUQrkMR7ZQs0xJqsSFx0tq75ob8kYTX++1Hkfo+cKQvgi6vDi1gNNVB0tgtH4JrNOiaUgWcXVYLNA8TV5u6oljHH0T3ozO0I9VgYuJ9pmK7kfmvsiEVgWagCvrwcHR6QmM93oDka2Mxv9Q3P2T4x8PX58dsjHcSFPAdnqD3iBu7TZQI83KTUfd99TGt9TmgJvdb1Bf/I22GMmEd9R3Wqq4AUU3Z4vt5Up028tNJmobiEmzGZfZhdfzOZPft+h5J7rJxFh6xRbEjSjrBjmvO7c45XAWBTrejcZSt2kb2FgB1/aoo8NzkQnuR+sLxG1cIBYPrL07MtMV3eubRTKAf3nN+aTAbJaWk/l8yZ+OPiuxcLDj5gDezOfzvwGAWVmf","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":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var n=o(74848),i=o(28453),a=o(33617),r=o.n(a),l=o(17543),c=o.n(l),p=o(86013),d=o.n(p),u=o(63723),m=o.n(u),b=(o(18766),o(79329),o(9303));const g={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81uGzcQfpUJL22MtST/JGl1ilu4rlMjMWobBmobAXd3tMuYSzLkrGRBEJBD36CnXvtoeZJiSK0syUlbI0Uu0u5wZjg/3/zsTJCsghheiYuAXtxkosRQeOVIWSOG4rxGOEICPoWD02NAI3ONAaa2BbJQIfGjBzsxIIvCtoagRJJKh57IhHXoJes6LsVQVEjxmkx4DM6agEEMZ2J3MOC/9ZvP2qLAEEathqUSkYnCGkJDzC+d06qIB/13gYVmIhQ1NpKfaOpQDIXN32FBIhPOsxpS6cpEZqOWnIG8MpXIxMj6RtIqBe9k4zQz/XSkbnf38vrilZhnwsgGH6vhlUX4AZHFsZFKP1b+ncUc8eWC0Ctsw6pcbc2jTdl/9vzFd3u7O7t7rOKdzc8V6UdrKXHM4oVtnDTTx0pbhyaoykQVHiVheUCfUnIvsjvY3dveGWwPXpzvPB/ufz989rw3GAx+E5m4a2I8U15EKSnGmZJby/fWlV/hnvkmW8vQX2FL73Nm3B/sP6yAWHPGEoxsa8on/x/40Xvr/9n3zbvnK3Yro5XBt10Jv2XjOzeePXTj2IylVmXsHuf2Fs3X9WT1ekrXP0yNSkzxXKy5ukpPTgYsWq9oKoZXM3G3LZ3aTufDq5v5TSYapNouuh0bLKkWQ9GvkNrU+wL6MfoQ5VuvxVDURC4M+/0gTZnbu15XFFrmgSu8L53qj3d6O2KebcpI5x7Fj+32Y0UCyUqZ6t/kbu5jc8b5Sylai9AyUdKpX3Aquha6xpUJxbipUZaxQPh9ZKPwIi1vHJozVZmY1Hj55ty6RF3YBnlEUY3QCXz8/a8oU9qibdBQRF3U8OTaXJs3rQdnJ+h56khTwkjjnco1ptHXxLPl7AsoG40h6CkoQ1h5SQilqhRJDRwjZSoopJO50ooRy2w2jcsV0IceXNZINXo++sYjSChxjJqBDrIl20hiVZ3RMLH+dqTtJGQgIW+DMhgCoKmlKZixy0IG1oM0gIbQO68CQiDPVqtkmzXkZUHQSCMrZN3ZWqhK1IqhCt7mbSAIVrfRZOABbz2W0DlkEMvQ4yAe3jk+AqbyUPBYM2TGCFWrSgwZFLZECLFA2QVTQo6BwLEtqsDASlujbXEbkzdqtQZnuV8oqcGO1mxkcfLSBJ4yyZYuB8uAOW95l8Bk4NbWRUDO8Ikyt2G4tXVttuFqialLzIMivPm2g/9kMnkA+6frMkeKfm5z+BWdDYqsn95LV4rqNo+lsqpk+ZI0HaHBiJ+VQrjXUdoiPKw8pvZr1K5/hsQICf2D0+PYYp/Cxw9/wAlKb6C2k4TWovWop1B1V3HkUuZT2JYdEkY2Aq/miBcJfB7ftxioi+BlLenjhz8DvMYJqFRCKZBbW6dtrlUB59g4LQnD1tYQfoyjHaijAdWSoJAGcoRQS4bSWEmQ4JK0Vua2BwdmCtw1YaKojmBgepRbc4Pjskx3gFwGLMGaKNHd2bu3iOlNQD3GwLp4zuUIWCpiRNfetlW6bdWYhXMeR0pruFRlhRR9OyhLcAvyJJE54Cvm4IgLgmqcgvQIAQ314HRDJJ60zlnPVqhk/MhqbSecADSls8pQGELp5Yju9Wf3QI8blLLmE6QUQrkMR7ZQs0xJqsSFx0tq75ob8kYTX++1Hkfo+cKQvgi6vDi1gNNVB0tgtH4JrNOiaUgWcXVYLNA8TV5u6oljHH0T3ozO0I9VgYuJ9pmK7kfmvsiEVgWagCvrwcHR6QmM93oDka2Mxv9Q3P2T4x8PX58dsjHcSFPAdnqD3iBu7TZQI83KTUfd99TGt9TmgJvdb1Bf/I22GMmEd9R3Wqq4AUU3Z4vt5Up028tNJmobiEmzGZfZhdfzOZPft+h5J7rJxFh6xRbEjSjrBjmvO7c45XAWBTrejcZSt2kb2FgB1/aoo8NzkQnuR+sLxG1cIBYPrL07MtMV3eubRTKAf3nN+aTAbJaWk/l8yZ+OPiuxcLDj5gDezOfzvwGAWVmf",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,h={},k=[];function v(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,n.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,n.jsx)(c(),{parameters:void 0}),"\n",(0,n.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"Joe Bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4567832123"},jobTitle:{type:"string",format:"string",example:"dev"},company:{type:"string",format:"string",example:"opensign"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"user"},title:"user"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/5144c8d4.5e457a22.js b/assets/js/5144c8d4.5e457a22.js deleted file mode 100644 index ee926d4e0..000000000 --- a/assets/js/5144c8d4.5e457a22.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7904],{8437:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>G,contentTitle:()=>b,default:()=>w,frontMatter:()=>I,metadata:()=>s,toc:()=>x});const s=JSON.parse('{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/v1.1/get-user.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/get-user","permalink":"/docs/API-docs/v1.1/get-user","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar_label":"Get your account details","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V91u2zYUfpVT3mwtFNv5abvpqtmQpemCNVgSFFhiFJR0JDGhSJY8smMYBnaxN9gb7NH6JMOhLMd22m1Bh94kJnn+z3d+NBckqyDSK3EZ0ItxIgoMuVeOlDUiFRc1wjES8Cscnp0AGplpDDCzLZCFCol/erBTAzLPbWsICiSpdBiIRFiHXrKsk0KkokKKahLhMThrAgaRzsXeaMT/NjWft3mOIZSthpUQkYjcGkJDTC+d0yqPD8ObwExzEfIaG8m/aOZQpMJmN5iTSITzLIZUp7K7ZqNWlIG8MpVIRGl9I2n9Bu9k4zQT/XSsbvf2s/ryjVgkwsgGHyvhjUX4AZHZsZFKP5b/xmKG+Gp5Mchtw6Jcbc2jTTl4/uLld/t7u3v7LOLGZheK9KOlFDhh9tw2TprZY7mtQxNUZaIIj5KwOKRPCbln2Rvt7e/sjnZGLy92X6QH36fPXwxGo9FvIhF3TYxnlxdRSIpxps6t1bl1xVfQs9gmaxn6a2TdecGEB6ODhxUQa85YgtK2pnjy/4Efvbf+n33f1r1Ys1sZrQy+70v4PRvfu/H8oRsnZiK1KmL3uLC3aL6uJ+vqqVP/MDWqI4rvYsPV9fvOyYB56xXNRHo1F3c70qmd7j29Gi/GiWiQarvsdmywpFqkYlghtV3vC+gn6EPkb70WqaiJXEiHwyBNkdm7QV8UWmaBK3wonRpOdge7YpFs80jnHkWP7c5jWQLJSpnq3/jG97E55/x1KdqI0CpR0qmfcSb6FrpBlQjFuKlRFrFA+FzayLxMy1uH5lxVJiY1Kt+eW+9Q57ZBHlFUI/QMH//4K/IUNm8bNBRRFyU8uTbX5m3rwdkpep460hRQarxTmcZu9DXxbTX7AspGYwh6BsoQVl4SQqEqRVIDx0iZCnLpZKa0YsQyme3G5RrowwDe1Ug1en76xiNIKHCCmoEOsiXbSGJRvdEwtf621HYaEpCQtUEZDAHQ1NLkTNhnIQHrQRpAQ+idVwEhkGerVWebNeRlTtBIIytk2clGqArUiqEK3mZtIAhWt9Fk4AFvPRbQO2QQizDgIB7dOX4CvuWh4LFmyEwQqlYVGBLIbYEQYoGyC6aADAOBY1tUjoGFtkbb/DYmr2y1Bme5XyipwZYbNjI7eWkCT5nOlj4Hq4A5b3mXwM7AZ88uA3KGT5W5DemzZ9dmB65WmHqHWVCE4297+E+n0wewf7rJc6zodZvBr+hsUGT97J67UlS3WSyVdSGrQyfpGA1G/KwVwr2MwubhYeXx7bBG7YbnSIyQMDw8O4kt9il8/P1POEXpDdR22qE1bz3qGVS9Ko5cl/kubKsOCaWNwKs54nkHPo8fWgy0imAcoaC64lnG8KzNtMqBsHFaEqZwCG7zCnJpIENYTvpoQqglA2miJEjQytwO4NDMgJslTBXVEQN8H5k7zo6RIy/vs1x624CiAby2U5ygT6KMwGw8ybBQFGWtjFEUUJeDaLrHUmkNU1VUSOnWOYD0CNhkWBRYsNdrajMsGe6KQAUIfMPwZc0DuKhxFnnlRCrNmzMzR1Bbre2UI4umcFYZCikUXpa0khySeyXRbWXNJ666IMmVW8lSTH9elthWJsIArrnVbrXnzS7qsUTPGkO36/fAcWoJlKsecMA4/BLAdiukIZnHpWC5GvOceLUtJw5o9E14W56jn6gcl7PqM7U6jMRDkQitcjQB1wb/4fHZKUxgfzASydrU+w91Ozw9+fHol/MjtoZ7ZBex3cFoMIoLuQ3USLOm6rj/VNr6TNqeXfP75eiLP7+W05bwjoZOSxWXm+jmfLmYXIl+MRknoraB+Go+z2TAS68XC77+0KLndWeciIn0ii2Iy07Sz2jeZG5xxvHMc3S89kykbrtBv7XdbaxIx0cXIhHcajZ3g9u4Gyx/sPT+yczWZG8uDZ0B/Jc3mE8yzOfd3rFYrOi7p89yLB3sqTmA48Vi8TeUZUpY","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":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var o=n(74848),i=n(28453),r=n(33617),a=n.n(r),p=n(17543),l=n.n(p),c=n(86013),d=n.n(c),m=n(63723),u=n.n(m),y=(n(18766),n(79329),n(9303));const I={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:"eJy9V91u2zYUfpVT3mwtFNv5abvpqtmQpemCNVgSFFhiFJR0JDGhSJY8smMYBnaxN9gb7NH6JMOhLMd22m1Bh94kJnn+z3d+NBckqyDSK3EZ0ItxIgoMuVeOlDUiFRc1wjES8Cscnp0AGplpDDCzLZCFCol/erBTAzLPbWsICiSpdBiIRFiHXrKsk0KkokKKahLhMThrAgaRzsXeaMT/NjWft3mOIZSthpUQkYjcGkJDTC+d0yqPD8ObwExzEfIaG8m/aOZQpMJmN5iTSITzLIZUp7K7ZqNWlIG8MpVIRGl9I2n9Bu9k4zQT/XSsbvf2s/ryjVgkwsgGHyvhjUX4AZHZsZFKP5b/xmKG+Gp5Mchtw6Jcbc2jTTl4/uLld/t7u3v7LOLGZheK9KOlFDhh9tw2TprZY7mtQxNUZaIIj5KwOKRPCbln2Rvt7e/sjnZGLy92X6QH36fPXwxGo9FvIhF3TYxnlxdRSIpxps6t1bl1xVfQs9gmaxn6a2TdecGEB6ODhxUQa85YgtK2pnjy/4Efvbf+n33f1r1Ys1sZrQy+70v4PRvfu/H8oRsnZiK1KmL3uLC3aL6uJ+vqqVP/MDWqI4rvYsPV9fvOyYB56xXNRHo1F3c70qmd7j29Gi/GiWiQarvsdmywpFqkYlghtV3vC+gn6EPkb70WqaiJXEiHwyBNkdm7QV8UWmaBK3wonRpOdge7YpFs80jnHkWP7c5jWQLJSpnq3/jG97E55/x1KdqI0CpR0qmfcSb6FrpBlQjFuKlRFrFA+FzayLxMy1uH5lxVJiY1Kt+eW+9Q57ZBHlFUI/QMH//4K/IUNm8bNBRRFyU8uTbX5m3rwdkpep460hRQarxTmcZu9DXxbTX7AspGYwh6BsoQVl4SQqEqRVIDx0iZCnLpZKa0YsQyme3G5RrowwDe1Ug1en76xiNIKHCCmoEOsiXbSGJRvdEwtf621HYaEpCQtUEZDAHQ1NLkTNhnIQHrQRpAQ+idVwEhkGerVWebNeRlTtBIIytk2clGqArUiqEK3mZtIAhWt9Fk4AFvPRbQO2QQizDgIB7dOX4CvuWh4LFmyEwQqlYVGBLIbYEQYoGyC6aADAOBY1tUjoGFtkbb/DYmr2y1Bme5XyipwZYbNjI7eWkCT5nOlj4Hq4A5b3mXwM7AZ88uA3KGT5W5DemzZ9dmB65WmHqHWVCE4297+E+n0wewf7rJc6zodZvBr+hsUGT97J67UlS3WSyVdSGrQyfpGA1G/KwVwr2MwubhYeXx7bBG7YbnSIyQMDw8O4kt9il8/P1POEXpDdR22qE1bz3qGVS9Ko5cl/kubKsOCaWNwKs54nkHPo8fWgy0imAcoaC64lnG8KzNtMqBsHFaEqZwCG7zCnJpIENYTvpoQqglA2miJEjQytwO4NDMgJslTBXVEQN8H5k7zo6RIy/vs1x624CiAby2U5ygT6KMwGw8ybBQFGWtjFEUUJeDaLrHUmkNU1VUSOnWOYD0CNhkWBRYsNdrajMsGe6KQAUIfMPwZc0DuKhxFnnlRCrNmzMzR1Bbre2UI4umcFYZCikUXpa0khySeyXRbWXNJ666IMmVW8lSTH9elthWJsIArrnVbrXnzS7qsUTPGkO36/fAcWoJlKsecMA4/BLAdiukIZnHpWC5GvOceLUtJw5o9E14W56jn6gcl7PqM7U6jMRDkQitcjQB1wb/4fHZKUxgfzASydrU+w91Ozw9+fHol/MjtoZ7ZBex3cFoMIoLuQ3USLOm6rj/VNr6TNqeXfP75eiLP7+W05bwjoZOSxWXm+jmfLmYXIl+MRknoraB+Go+z2TAS68XC77+0KLndWeciIn0ii2Iy07Sz2jeZG5xxvHMc3S89kykbrtBv7XdbaxIx0cXIhHcajZ3g9u4Gyx/sPT+yczWZG8uDZ0B/Jc3mE8yzOfd3rFYrOi7p89yLB3sqTmA48Vi8TeUZUpY",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,G={},x=[];function h(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,o.jsx)(a(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,o.jsx)(l(),{parameters:void 0}),"\n",(0,o.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"Joe Bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4567832123"},jobTitle:{type:"string",format:"string",example:"dev"},company:{type:"string",format:"string",example:"opensign"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"user"},title:"user"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function w(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.540e438b.js b/assets/js/58abd73c.540e438b.js deleted file mode 100644 index 70b67b648..000000000 --- a/assets/js/58abd73c.540e438b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8564],{73135:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>x,contentTitle:()=>g,default:()=>k,frontMatter:()=>f,metadata:()=>i,toc:()=>z});const i=JSON.parse('{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/v1.1/folderlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/folderlist","permalink":"/docs/API-docs/v1.1/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V+9uI7cRf5UJv7Q5rKW17y5F9lOM4uq4NXJG7eCA+owDd3ek5YlLMuSs/kAQkA99g7xBHi1PUgyplVayLjm3ab5YXnL+/GbmR85wLUhOgygexN+srtGLx0zUGCqvHClrRCHuG4S0BzcqEFzeXgO2zi7QB1jZDsiCR/IK5wgSNMvYCUySykJRAzb92o7ASY+Gkr3rWmTCOvSSXV3XohBJi22ITDjpZYuEnvGthZEtikI8saAY5Q8d+pU4xm7Lj1jRdb0HJDLh8YdOeaxFMZE6YCYCrTRG574VmcCl07bG/XbVYCtFsRa0ciwXyCszFVlUkDRcwaVsXTQmNptsh1mrVtEx1M/GQb47gNHKpWq7VhSv8zzrQZmuLdGLzQDDeT6AEGbK/W4IPu0z3zyy3eCsCRhY9iLP+eewMKGrKgxh0mnYEUBkorKG0BDLS+e0quLG+GNgpfVTAKm+TBXPZkgllx5Dp2kgJ72XHLAibMNv6/e0eW7NXXNeNsuLj45Tkvj2Xcz+88wYXPRs3WTHfH+mrb9fGBlez9QtHtv6b5GFrhygqzxKwvqSTpnaK17kFy/PzvOz/C/3518Vr74uXn81yvP8XyITy1az7pamtaSIlBTp4Xfn6j/Az2AhhfjBYxCb4boyWhn80FP8w0Wefzh/yTKbTLw6xfU72yI1ykxhgYZg4a2ZZuA0yoBAfgVyKpUBLQn9F7/fIUDvrf/1bD0P2a9l4RVnYZeE10+TcG3mUqs6do97O0Pzx0Y6dE/JPUM95IRKQnFfHAQ7XE9BBqw6r2gVO9PyTDp1lvaLh0e+AjmxljvaFFMro0YUYnzQ3wL6ed/cOq9FIRoiF4rxOEhTl3Y5sg5NUFOjZRlGlW3H0qnx/Hx0LvhmP9SRzj1LHruz56oEklNlpr+l97hPzx2XMFXpIEn7m9mpfyBfzdsaDKW23apBGS+bDX9PbFTeVuatQ3OnpibWNTo/ngDeoa5sizykUIPQK/zy75+jTm2rrkVDkXjRwhfvzXvztvMQJxxuUNLUMNG4VKXGk9NPQNlqDEGvQBnCqZeEUKupIqmBc8QnrJJOlkorJi2LWdb2MOB9GMG7BqlBz1t/8jxN1ThHzVwH2ZFtJbGpHjQsrJ9NtF2EDCSUXVAGQwA0jTQVC/ZVyHgCkwbQEHrnVUAI5Bm1StisIS8rglYaOUW2nR2kqkatmKrgbdkFgmB1FyEDSaWtxxr6gAxiHUacxDc8PXgEXq1s6zw2TJk5wrRTNYYMKlsjhHhGOQRTQ4mBwDEWVWFgo53RtprF4k06rcFZvjKU1DzTDTGyOnlpAjewhKWvwS5hzlseOzABfPHi+4Bc4RtlZqF48eK9OYOHHafeYRkU4eOfe/ovFosntP/yUOdK0bddCf9EZ4Mi61d77amipivjURka2X0kS1doMPJncBD2Nmpbhacnj1fHDWo3vkNihoTx5e11vGW/hF9+/AluUHoDjV0ktladR72Cae+KM5cqn9K2uyRhYiPxGs54lcjHMyMG2mUw9mVQ6fBsc3jblVpVQNg67h0FXII7XIJKGigRtuNDhBAayUSaKxmfEWY2gkuzgi70zwjmAK9H5aSZFDnzcl/libctKBrBt3aBc/RZtBFYzVgCrBVFWzswigLqyShC9zhRWsNC1VOk4ug7gPQI2JZY11hz1AO3JU6Y7opABQi8wvRlzyO4b3AVdeVcKi35JlEmkdpqbRecWTS1s8pQKKD2ckI7yyHbO4lhK2tOLKUkyV1Y2dZM/709YkeVCCN4z1ft0fV8eIt6nKBnj/FI7onj1JYoDz3hgHn4vxA2DpXWkKziXICtVDr1iW+O7cQejb4Nbyd36Oeqwm2v+sRZHUfhsciEVhWagIPef3l1ewNzeDnKRTboep9xbsc31399893dG0bDd2TK2PkoH+Vx5LaBWmkGrq6Q+tfxdhA4SPZ6Pxb9v9/e2x5MuKSx01LFqScGv95OLA/DF/ljJhobiFfX61IG/N7rzYaX04OS55haBWb3/kn5ydhOvs1PIprh6tS7fy51l17a2Qm/Sal/eH+O7PaFvBd95A+vWDaOdVk/inCgSeeyqtANHTyZYw+Gwas39yITfKMejkCzOAJt/2Hr/ZZZDWwfzkYJAP/lmE4qrNdpvNpsdvJp65Ma2wB7ac7/42az+Q+IDlD0","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 l=r(74848),o=r(28453),s=r(33617),a=r.n(s),n=r(17543),d=r.n(n),p=r(86013),m=r.n(p),c=r(63723),h=r.n(c),y=(r(18766),r(79329),r(9303));const f={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:"eJy9V+9uI7cRf5UJv7Q5rKW17y5F9lOM4uq4NXJG7eCA+owDd3ek5YlLMuSs/kAQkA99g7xBHi1PUgyplVayLjm3ab5YXnL+/GbmR85wLUhOgygexN+srtGLx0zUGCqvHClrRCHuG4S0BzcqEFzeXgO2zi7QB1jZDsiCR/IK5wgSNMvYCUySykJRAzb92o7ASY+Gkr3rWmTCOvSSXV3XohBJi22ITDjpZYuEnvGthZEtikI8saAY5Q8d+pU4xm7Lj1jRdb0HJDLh8YdOeaxFMZE6YCYCrTRG574VmcCl07bG/XbVYCtFsRa0ciwXyCszFVlUkDRcwaVsXTQmNptsh1mrVtEx1M/GQb47gNHKpWq7VhSv8zzrQZmuLdGLzQDDeT6AEGbK/W4IPu0z3zyy3eCsCRhY9iLP+eewMKGrKgxh0mnYEUBkorKG0BDLS+e0quLG+GNgpfVTAKm+TBXPZkgllx5Dp2kgJ72XHLAibMNv6/e0eW7NXXNeNsuLj45Tkvj2Xcz+88wYXPRs3WTHfH+mrb9fGBlez9QtHtv6b5GFrhygqzxKwvqSTpnaK17kFy/PzvOz/C/3518Vr74uXn81yvP8XyITy1az7pamtaSIlBTp4Xfn6j/Az2AhhfjBYxCb4boyWhn80FP8w0Wefzh/yTKbTLw6xfU72yI1ykxhgYZg4a2ZZuA0yoBAfgVyKpUBLQn9F7/fIUDvrf/1bD0P2a9l4RVnYZeE10+TcG3mUqs6do97O0Pzx0Y6dE/JPUM95IRKQnFfHAQ7XE9BBqw6r2gVO9PyTDp1lvaLh0e+AjmxljvaFFMro0YUYnzQ3wL6ed/cOq9FIRoiF4rxOEhTl3Y5sg5NUFOjZRlGlW3H0qnx/Hx0LvhmP9SRzj1LHruz56oEklNlpr+l97hPzx2XMFXpIEn7m9mpfyBfzdsaDKW23apBGS+bDX9PbFTeVuatQ3OnpibWNTo/ngDeoa5sizykUIPQK/zy75+jTm2rrkVDkXjRwhfvzXvztvMQJxxuUNLUMNG4VKXGk9NPQNlqDEGvQBnCqZeEUKupIqmBc8QnrJJOlkorJi2LWdb2MOB9GMG7BqlBz1t/8jxN1ThHzVwH2ZFtJbGpHjQsrJ9NtF2EDCSUXVAGQwA0jTQVC/ZVyHgCkwbQEHrnVUAI5Bm1StisIS8rglYaOUW2nR2kqkatmKrgbdkFgmB1FyEDSaWtxxr6gAxiHUacxDc8PXgEXq1s6zw2TJk5wrRTNYYMKlsjhHhGOQRTQ4mBwDEWVWFgo53RtprF4k06rcFZvjKU1DzTDTGyOnlpAjewhKWvwS5hzlseOzABfPHi+4Bc4RtlZqF48eK9OYOHHafeYRkU4eOfe/ovFosntP/yUOdK0bddCf9EZ4Mi61d77amipivjURka2X0kS1doMPJncBD2Nmpbhacnj1fHDWo3vkNihoTx5e11vGW/hF9+/AluUHoDjV0ktladR72Cae+KM5cqn9K2uyRhYiPxGs54lcjHMyMG2mUw9mVQ6fBsc3jblVpVQNg67h0FXII7XIJKGigRtuNDhBAayUSaKxmfEWY2gkuzgi70zwjmAK9H5aSZFDnzcl/libctKBrBt3aBc/RZtBFYzVgCrBVFWzswigLqyShC9zhRWsNC1VOk4ug7gPQI2JZY11hz1AO3JU6Y7opABQi8wvRlzyO4b3AVdeVcKi35JlEmkdpqbRecWTS1s8pQKKD2ckI7yyHbO4lhK2tOLKUkyV1Y2dZM/709YkeVCCN4z1ft0fV8eIt6nKBnj/FI7onj1JYoDz3hgHn4vxA2DpXWkKziXICtVDr1iW+O7cQejb4Nbyd36Oeqwm2v+sRZHUfhsciEVhWagIPef3l1ewNzeDnKRTboep9xbsc31399893dG0bDd2TK2PkoH+Vx5LaBWmkGrq6Q+tfxdhA4SPZ6Pxb9v9/e2x5MuKSx01LFqScGv95OLA/DF/ljJhobiFfX61IG/N7rzYaX04OS55haBWb3/kn5ydhOvs1PIprh6tS7fy51l17a2Qm/Sal/eH+O7PaFvBd95A+vWDaOdVk/inCgSeeyqtANHTyZYw+Gwas39yITfKMejkCzOAJt/2Hr/ZZZDWwfzkYJAP/lmE4qrNdpvNpsdvJp65Ma2wB7ac7/42az+Q+IDlD0",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,x={},z=[];function b(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,l.jsx)(a(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,l.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(d(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,l.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/58abd73c.fdfdf0e6.js b/assets/js/58abd73c.fdfdf0e6.js new file mode 100644 index 000000000..26f11ba89 --- /dev/null +++ b/assets/js/58abd73c.fdfdf0e6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8564],{73135:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>x,contentTitle:()=>u,default:()=>Q,frontMatter:()=>g,metadata:()=>r,toc:()=>I});const r=JSON.parse('{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/v1.1/folderlist.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/folderlist","permalink":"/docs/API-docs/v1.1/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WM1uHDcSfpUyL5sIrZmRbCfYOa0QOIp2BVuIFAhYWTDY3TXd9LBJhqyeHwwGyGHfYE+55tH8JEGR0zM90ji28neR1MWq4ldVH1lFrQTJKojxnfjW6hK9uM9EiaHwypGyRozFTY2Q1uBSBYKzqwvAxtk5+gBL2wJZ8Ehe4QxBgmYdO4FJMpkrqsGm37YlcNKjoeTvohSZsA695K0uSjEWyYp9iEw46WWDhJ7xrYSRDYqxeORBMcofW/RL8RC7zd9jQRflDpDIhMcfW+WxFOOJ1AEzEWipMW7uG5EJXDhtS9wtFzU2UoxXgpaO9QJ5ZSqRRQNJfQkuZOOiM7FeZ1vMWjWKHkL9bBzk2z0YjVyopm3E+OVolHWgTNvk6MW6h+Fk1IMQpsr9aQg+vudofc9+g7MmYGDd09GIf+0XJrRFgSFMWg1bAohMFNYQGmJ96ZxWRVwYvg9stHoMINWXqeLZDam0pcfQaurpSe8lB6wIm/Bp+442T625q0/yenH63nFKEt9ex+w/zY3BecfWdfaQ70/09e9TI8PLqbrCh75+L7LQ5j10hUdJWJ7RIVc7w9PR6fPjk9Hx6Oubk6/GL/45fvnVYDQa/VdkYtFott3QtJQUkZIi3f9uXfk37NMTpBDfeQxi3Zcro5XBdx3F352ORu9OnrPOOhMvDnH92jZItTIVzNEQzL01VQZOowwI5JcgK6kMaEnon/15hwC9t/63s/U0ZL+VhRechW0SXj5OwoWZSa3K2D1u7BTN3xtpf3tK2zPUfU6opBTXxV6wfXkKMmDRekXL2JkWx9Kp47Q+vrvnK5ATa7mjVZhaGdViLIZ7/S2gn3XNrfVajEVN5MJ4OAzSlLldDKxDE1RltMzDoLDNUDo1nJ0MTgTf7Ps20rkn6WN7/FSTQLJSpvqU3f0uPddcwlSlvSTtbman/oN8NW9q0NfadKsaZbxs1vw9sdF4U5k3Ds21qkysa9z84QRwi7qwDfKQQjVCZ/Dhf79Em9IWbYOGIvGih2dvzVvzpvUQJxxuUNKUMNG4ULnGg9NPQNloDEEvQRnCyktCKFWlSGrgHPEJK6STudKKSctqlq099HgfBnBbI9XoeekfnqepEmeomesgW7KNJHbVgYa59dOJtvOQgYS8DcpgCICmlqZgxa4KGU9g0gAaQu+8CgiBPKNWCZs15GVB0EgjK2Tf2V6qStSKqQre5m0gCFa3ETKQVNp6LKELyCCWYcBJfMXTg0dgaWEb57FmyswQqlaVGDIobIkQ4hnlEEwJOQYCx1hUgYGdtkbbYhqLN2m1Bmf5ylBS80zXx8jm5KUJ3MASlq4G24Q5b3nswATw6OiHgFzhS2WmYXx09NYcw92WU7eYB0V4/0VH//l8/oj2X+7bnCv6rs3he3Q2KLJ+ubOuFNVtHo9K38n2I3k6R4ORP72DsPNR2iI8PnksHdao3fAaiRkShmdXF/GW/RI+/PR/uETpDdR2nthatB71EqpuK85cqnxK2/aShImNxKs540UiH8+MGKjL4G0t6cNPPwd4jXNQ6QilRB4dXbW5VgXcYOO4hYSjozF8E+cFoE4GVEuCQhrIEUItmUozJUGCS9ZamekAzswS2tC9J5gMLI92e2FwXrblDpDLgCVYEy26PQc7RCxvAuoZBvZlLDEMLBUxo2tv2yrt1gezCc7jRGkNt6qskGJsZ2UJbiOeJzEnvAcHJ3wgqMYlSI8Q0NAArh6YxJXWOesZhUrgJ1ZrO+cCoCmdVYbCGEovJ7Tzn+2IHscyZc0BUUqh3KYj27jZliSdxE3EW+ngLV/IDy7x/bvW4wQ9bxjD3tXFqQ2d7jpaArP1j9A6jp7WkCzi9ICNVDp1k3899BM7OfomvJlco5+pAjcd7SMnehiVhyITWhVoAvYmhLPzq0uYPR+MRNZrjZ9xuIeXF9+8en39isHwRZoSdjIYDUZxLreBGml6O50jdU/ozbSwl+vVbnb6qx/om0ZNuKCh01LF0SgGv9qMNXf9Z/t9JmobiKWrFZ+/H7xer1mcXp087JQqyFz33p0fje3gA/4goikuD/1zYCZ1m57j2YF9k1H3Ov8c3c0zeqd6zx9esW6c/bJuXuFAk81ZUaDrb/Bo2N2bGM9f3YhM8LW7PydN45y0+YO9d0tm2fO9P0AlAPyTYzposFqlGWy93uqnpY9abALstDn/9+v1+lfM3mA7","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=o(74848),s=o(28453),n=o(33617),l=o.n(n),d=o(17543),a=o.n(d),p=o(86013),c=o.n(p),m=o(63723),f=o.n(m),h=(o(18766),o(79329),o(9303));const g={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WM1uHDcSfpUyL5sIrZmRbCfYOa0QOIp2BVuIFAhYWTDY3TXd9LBJhqyeHwwGyGHfYE+55tH8JEGR0zM90ji28neR1MWq4ldVH1lFrQTJKojxnfjW6hK9uM9EiaHwypGyRozFTY2Q1uBSBYKzqwvAxtk5+gBL2wJZ8Ehe4QxBgmYdO4FJMpkrqsGm37YlcNKjoeTvohSZsA695K0uSjEWyYp9iEw46WWDhJ7xrYSRDYqxeORBMcofW/RL8RC7zd9jQRflDpDIhMcfW+WxFOOJ1AEzEWipMW7uG5EJXDhtS9wtFzU2UoxXgpaO9QJ5ZSqRRQNJfQkuZOOiM7FeZ1vMWjWKHkL9bBzk2z0YjVyopm3E+OVolHWgTNvk6MW6h+Fk1IMQpsr9aQg+vudofc9+g7MmYGDd09GIf+0XJrRFgSFMWg1bAohMFNYQGmJ96ZxWRVwYvg9stHoMINWXqeLZDam0pcfQaurpSe8lB6wIm/Bp+442T625q0/yenH63nFKEt9ex+w/zY3BecfWdfaQ70/09e9TI8PLqbrCh75+L7LQ5j10hUdJWJ7RIVc7w9PR6fPjk9Hx6Oubk6/GL/45fvnVYDQa/VdkYtFott3QtJQUkZIi3f9uXfk37NMTpBDfeQxi3Zcro5XBdx3F352ORu9OnrPOOhMvDnH92jZItTIVzNEQzL01VQZOowwI5JcgK6kMaEnon/15hwC9t/63s/U0ZL+VhRechW0SXj5OwoWZSa3K2D1u7BTN3xtpf3tK2zPUfU6opBTXxV6wfXkKMmDRekXL2JkWx9Kp47Q+vrvnK5ATa7mjVZhaGdViLIZ7/S2gn3XNrfVajEVN5MJ4OAzSlLldDKxDE1RltMzDoLDNUDo1nJ0MTgTf7Ps20rkn6WN7/FSTQLJSpvqU3f0uPddcwlSlvSTtbman/oN8NW9q0NfadKsaZbxs1vw9sdF4U5k3Ds21qkysa9z84QRwi7qwDfKQQjVCZ/Dhf79Em9IWbYOGIvGih2dvzVvzpvUQJxxuUNKUMNG4ULnGg9NPQNloDEEvQRnCyktCKFWlSGrgHPEJK6STudKKSctqlq099HgfBnBbI9XoeekfnqepEmeomesgW7KNJHbVgYa59dOJtvOQgYS8DcpgCICmlqZgxa4KGU9g0gAaQu+8CgiBPKNWCZs15GVB0EgjK2Tf2V6qStSKqQre5m0gCFa3ETKQVNp6LKELyCCWYcBJfMXTg0dgaWEb57FmyswQqlaVGDIobIkQ4hnlEEwJOQYCx1hUgYGdtkbbYhqLN2m1Bmf5ylBS80zXx8jm5KUJ3MASlq4G24Q5b3nswATw6OiHgFzhS2WmYXx09NYcw92WU7eYB0V4/0VH//l8/oj2X+7bnCv6rs3he3Q2KLJ+ubOuFNVtHo9K38n2I3k6R4ORP72DsPNR2iI8PnksHdao3fAaiRkShmdXF/GW/RI+/PR/uETpDdR2nthatB71EqpuK85cqnxK2/aShImNxKs540UiH8+MGKjL4G0t6cNPPwd4jXNQ6QilRB4dXbW5VgXcYOO4hYSjozF8E+cFoE4GVEuCQhrIEUItmUozJUGCS9ZamekAzswS2tC9J5gMLI92e2FwXrblDpDLgCVYEy26PQc7RCxvAuoZBvZlLDEMLBUxo2tv2yrt1gezCc7jRGkNt6qskGJsZ2UJbiOeJzEnvAcHJ3wgqMYlSI8Q0NAArh6YxJXWOesZhUrgJ1ZrO+cCoCmdVYbCGEovJ7Tzn+2IHscyZc0BUUqh3KYj27jZliSdxE3EW+ngLV/IDy7x/bvW4wQ9bxjD3tXFqQ2d7jpaArP1j9A6jp7WkCzi9ICNVDp1k3899BM7OfomvJlco5+pAjcd7SMnehiVhyITWhVoAvYmhLPzq0uYPR+MRNZrjZ9xuIeXF9+8en39isHwRZoSdjIYDUZxLreBGml6O50jdU/ozbSwl+vVbnb6qx/om0ZNuKCh01LF0SgGv9qMNXf9Z/t9JmobiKWrFZ+/H7xer1mcXp087JQqyFz33p0fje3gA/4goikuD/1zYCZ1m57j2YF9k1H3Ov8c3c0zeqd6zx9esW6c/bJuXuFAk81ZUaDrb/Bo2N2bGM9f3YhM8LW7PydN45y0+YO9d0tm2fO9P0AlAPyTYzposFqlGWy93uqnpY9abALstDn/9+v1+lfM3mA7",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,x={},I=[];function v(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,i.jsx)(l(),{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:"Request"}),"\n",(0,i.jsx)(a(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function Q(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a144266.686c24b3.js b/assets/js/5a144266.686c24b3.js new file mode 100644 index 000000000..0b9c0488a --- /dev/null +++ b/assets/js/5a144266.686c24b3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4232],{38483:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>h,contentTitle:()=>f,default:()=>g,frontMatter:()=>b,metadata:()=>a,toc:()=>v});const a=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":"eJzdWM1u5DYSfpUKL7sx5G7Z4/Fk+xQjGDjGGhkjdmBgPUaDkqpbHFMkQ1L9g4aAHPYN9rTXfbR5kkWRUkvtf2+CHPZit8j66o9F8itumOdzxyY37AorI7lHx24TVqDLrTBeaMUm7KpEOEUPnQicC+fh5OIMuJR66WCta/AaLHorcIHAQZKEngFfcCF5JhF8p38EV6VwMKtVTvq5FH4NxuqFKNABV6AXaBcClwEvZY9MABXPpFBzqB1aRzbzUmuHMLO6AlwJ52l2i4BliQpyizyMFzqvK1TejVjCtEHLyYOzgk3YHH2HIt9Zwgy3vEKPltKzYYpXyCZMikrQrKDE/FqjXbOEWfy1FhYLNplx6TBhzq8lSc+0rVjCcGWkLpBNvK1pNi+x4myyYRVfiaqu2OR9mibMrw2BVF1laFlDOF4ZUnSQNsnWBXcnzB/mwdM20+aW9DqjlUNHsodpSv92i8PVeY7OzWoJ24yyhOVaeVSe5LkxUuRhYvzFEWjz0AGdfcE8pN2SGi+iSYuuln4gx63lFLDwWLmX8XGYVngr6bwVas6SkBruhyPb2Nnq4MdMVe7wYk458cLT6EMVPcCFH9vKI5TS/gVQJw1BtCGXZIH2zwor1tNzDkZ/IAg2fSK2jk9bh8l18VKKSu+Nm4zHHZj28CjXFaH1Uu3E/VyywnbWnVcJc2Kuwi79X4vE6pdcz1G/LmFfNEKGwS2suJAvSmeI37cDXS5MqdULZo7eHx8evPvuwwHJL0UxR/874o+zb6skjyuf6VXwl8/x4VEygG9H+vOsSdjqjZjDo6MmYes3oj6QqeUbQe++axJWvhF0dEx1HI7FV+T8qVJ6Vc6bR/fiZdwH064enpUK29mhKs7UJ7t75mRaS+RqaJpujSZhYedhceKfr87D9PDd/kG6n364OjieHP1t8v54lKbpP1jCVpXso2dFe1J2TnbftSn+FDuBTuCVrl8XvsVCWMz9tLaPbuzn1o7MBbY0rXQhZu196J63G+5yAtZeTy1WQr24Uh0kSk+1ynEq1BQXxBMeKejBdd/cT9vwMrtfR7vVJZQUCqcdW5gepun0uK3To/T9Q9ZwphZciiKQyCt9h+qbP44zoLX6hbtkaN5H8w/DF1EozLOdYIfjMUiHeW2FXwequNrnRuzH+cnNLfGoCn2pW54ZuKUv2YSN71FOh3bR8c1QY9s703FVZHo10gYV3XeSZ47uizE3Yrw4GNFFcB/DjXmTPNb7b4U4z+dCzV/C3fYJuqRFjOu0k6b+7jLi70iXV7sKQ6mW9JbIA+lo6HumA7hdm08GFZ1wYWWD8fvNzDXKXFdIvYMvETrA13/+J2C6FiGUXtDwzWf1WX2qLRi9REs8l6sCZhJXgvoaAmEV5raNkENeSXROrkEoj3NLtKUQc+G5BMoRNSM5NzwTUlDZkpgmtIVB5bsRXJfoS7Q09RdLjVWBC5RU7UCHQrXb18BS27sZtWQJcMhqJxQ6B6hKrnIS7FYhAW2p1ULl0RorHILzlrwW0TetvOW5h4orPkfSneykqkApqFTB6qx2HpyWdXAZPBdSWyygC0ghFm5ESfxITYhFoNFcV8ZiSSWzQJjX1PwlkOsCIVJpCkEVkKHzYMgXkWPo+GoldX4XFm9WSwlG06EhuKR+cegjwb3lytG5HH3p1mCbMGM1dS8YHdzb+8UhrfC5UHdusrf3We3DzbamrjFzwuPtX7vyXy6XD8r+213MqfA/1hn8jEY74bVd9+i58GWdha0yVLL9iJpOUWGon8FG6HUUOncPdx6NjkuUZnyJnirEjU8uzsI5+y18/e1fcI7cKij1MlZrXluUa5h3pihzceVj2rbHJMx0KLySMp7H4qPWE53vMnhdcv/1t387+AmXIOIWionc27uoMyny7TuC29ubwA+BUwxadl9yDzlXkCG4klMpLQQHDiaipVB3IzhR6/AIAEvhy1AMNB5wO2FQXvq+HzLusACtAqKzOeo9ovHKoVygI11Ke3IDC+Gpokur63m0NnSmDc7iTEgJ15F+UWwnRQGmHW5ZGSV84A7OaEP4EtfALYJD5UdwcQ8SZmpjtCUvRHR+polN0AKgKowWyrsJFJbPfK8/6Qs9voFo9chQTCHfpiNp1QzeXSiTbcT9O85nOpDvHeK7Z63FGVoyGMLu18WItpxuurIEqtbfU9Z0QdOpxfPAH9rmi26T7+/rCXc52sp9ml3SS1PeNadP7OhxEB6zhEmRo3I44AgnpxfnsHg3SlkyuBpfsbnH52c/fPzp8iM5QwdpTNjBKB2loafSzldcDSztPMC1fGEn25ueP/2fvti1DIHaoLGRXARW1nLxyKhu2A6juk1YqZ2n8c2Gtv4vVjYNDcd3M+JZhXAUbf9ydofrwTvfgsu65e9PyrYPcr3oLX1YQbKBACYdZSGDEXOS52iGBh4w3h3aePrxioU+oNylSneBKrU/SHs3pdYD3bscKjpAfymmRwGbTaRhTbOVj1NPItoAO2lam9umaf4LgbbLVQ==","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 o=i(74848),l=i(28453),n=i(33617),p=i.n(n),s=i(17543),r=i.n(s),m=i(86013),d=i.n(m),c=i(63723),u=i.n(c),y=(i(18766),i(79329),i(9303));const b={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:"eJzdWM1u5DYSfpUKL7sx5G7Z4/Fk+xQjGDjGGhkjdmBgPUaDkqpbHFMkQ1L9g4aAHPYN9rTXfbR5kkWRUkvtf2+CHPZit8j66o9F8itumOdzxyY37AorI7lHx24TVqDLrTBeaMUm7KpEOEUPnQicC+fh5OIMuJR66WCta/AaLHorcIHAQZKEngFfcCF5JhF8p38EV6VwMKtVTvq5FH4NxuqFKNABV6AXaBcClwEvZY9MABXPpFBzqB1aRzbzUmuHMLO6AlwJ52l2i4BliQpyizyMFzqvK1TejVjCtEHLyYOzgk3YHH2HIt9Zwgy3vEKPltKzYYpXyCZMikrQrKDE/FqjXbOEWfy1FhYLNplx6TBhzq8lSc+0rVjCcGWkLpBNvK1pNi+x4myyYRVfiaqu2OR9mibMrw2BVF1laFlDOF4ZUnSQNsnWBXcnzB/mwdM20+aW9DqjlUNHsodpSv92i8PVeY7OzWoJ24yyhOVaeVSe5LkxUuRhYvzFEWjz0AGdfcE8pN2SGi+iSYuuln4gx63lFLDwWLmX8XGYVngr6bwVas6SkBruhyPb2Nnq4MdMVe7wYk458cLT6EMVPcCFH9vKI5TS/gVQJw1BtCGXZIH2zwor1tNzDkZ/IAg2fSK2jk9bh8l18VKKSu+Nm4zHHZj28CjXFaH1Uu3E/VyywnbWnVcJc2Kuwi79X4vE6pdcz1G/LmFfNEKGwS2suJAvSmeI37cDXS5MqdULZo7eHx8evPvuwwHJL0UxR/874o+zb6skjyuf6VXwl8/x4VEygG9H+vOsSdjqjZjDo6MmYes3oj6QqeUbQe++axJWvhF0dEx1HI7FV+T8qVJ6Vc6bR/fiZdwH064enpUK29mhKs7UJ7t75mRaS+RqaJpujSZhYedhceKfr87D9PDd/kG6n364OjieHP1t8v54lKbpP1jCVpXso2dFe1J2TnbftSn+FDuBTuCVrl8XvsVCWMz9tLaPbuzn1o7MBbY0rXQhZu196J63G+5yAtZeTy1WQr24Uh0kSk+1ynEq1BQXxBMeKejBdd/cT9vwMrtfR7vVJZQUCqcdW5gepun0uK3To/T9Q9ZwphZciiKQyCt9h+qbP44zoLX6hbtkaN5H8w/DF1EozLOdYIfjMUiHeW2FXwequNrnRuzH+cnNLfGoCn2pW54ZuKUv2YSN71FOh3bR8c1QY9s703FVZHo10gYV3XeSZ47uizE3Yrw4GNFFcB/DjXmTPNb7b4U4z+dCzV/C3fYJuqRFjOu0k6b+7jLi70iXV7sKQ6mW9JbIA+lo6HumA7hdm08GFZ1wYWWD8fvNzDXKXFdIvYMvETrA13/+J2C6FiGUXtDwzWf1WX2qLRi9REs8l6sCZhJXgvoaAmEV5raNkENeSXROrkEoj3NLtKUQc+G5BMoRNSM5NzwTUlDZkpgmtIVB5bsRXJfoS7Q09RdLjVWBC5RU7UCHQrXb18BS27sZtWQJcMhqJxQ6B6hKrnIS7FYhAW2p1ULl0RorHILzlrwW0TetvOW5h4orPkfSneykqkApqFTB6qx2HpyWdXAZPBdSWyygC0ghFm5ESfxITYhFoNFcV8ZiSSWzQJjX1PwlkOsCIVJpCkEVkKHzYMgXkWPo+GoldX4XFm9WSwlG06EhuKR+cegjwb3lytG5HH3p1mCbMGM1dS8YHdzb+8UhrfC5UHdusrf3We3DzbamrjFzwuPtX7vyXy6XD8r+213MqfA/1hn8jEY74bVd9+i58GWdha0yVLL9iJpOUWGon8FG6HUUOncPdx6NjkuUZnyJnirEjU8uzsI5+y18/e1fcI7cKij1MlZrXluUa5h3pihzceVj2rbHJMx0KLySMp7H4qPWE53vMnhdcv/1t387+AmXIOIWionc27uoMyny7TuC29ubwA+BUwxadl9yDzlXkCG4klMpLQQHDiaipVB3IzhR6/AIAEvhy1AMNB5wO2FQXvq+HzLusACtAqKzOeo9ovHKoVygI11Ke3IDC+Gpokur63m0NnSmDc7iTEgJ15F+UWwnRQGmHW5ZGSV84A7OaEP4EtfALYJD5UdwcQ8SZmpjtCUvRHR+polN0AKgKowWyrsJFJbPfK8/6Qs9voFo9chQTCHfpiNp1QzeXSiTbcT9O85nOpDvHeK7Z63FGVoyGMLu18WItpxuurIEqtbfU9Z0QdOpxfPAH9rmi26T7+/rCXc52sp9ml3SS1PeNadP7OhxEB6zhEmRo3I44AgnpxfnsHg3SlkyuBpfsbnH52c/fPzp8iM5QwdpTNjBKB2loafSzldcDSztPMC1fGEn25ueP/2fvti1DIHaoLGRXARW1nLxyKhu2A6juk1YqZ2n8c2Gtv4vVjYNDcd3M+JZhXAUbf9ydofrwTvfgsu65e9PyrYPcr3oLX1YQbKBACYdZSGDEXOS52iGBh4w3h3aePrxioU+oNylSneBKrU/SHs3pdYD3bscKjpAfymmRwGbTaRhTbOVj1NPItoAO2lam9umaf4LgbbLVQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,h={},v=[];function x(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,o.jsx)(p(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,o.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,o.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(r(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,o.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}},title:"inline_response_200_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a144266.c9604a6f.js b/assets/js/5a144266.c9604a6f.js deleted file mode 100644 index 88af3ff5b..000000000 --- a/assets/js/5a144266.c9604a6f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4232],{38483:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>h,default:()=>V,frontMatter:()=>y,metadata:()=>i,toc:()=>u});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":"eJzdWNtu5DYS/ZUKXzYZyN1tj8eT7acYi4HHWCNjxA4GWI/RoKRSq8YUqZBUX9AQkIf9g/2D/bR8yaKoS6t9a3sT5CEvdouswyoWD8lT3Agv505Mb8Q1FqWSHp24jUSKLrFUejJaTMV1jnCGHjoTuCDn4fTyHKRSZulgbSrwBix6S7hAkKDYwmQgF5KUjBWC78YfwXVODrJKJzy+VOTXUFqzoBQdSA1mgXZBuAx4pbbICFDLWJGeQ+XQOvaZ5MY4hMyaAnBFznNvj4BljhoSizK0pyapCtTejUQkTIlWcgTnqZiKOfoOxbGLSJTSygI9Wk7PRmhZoJgKRQVxL3FifqnQrkUkLP5SkcVUTDOpHEbC+bVi68zYQkQCV6UyKYqptxX3JjkWUkw3opArKqpCTN9NJpHw65JBuipitKJmnCxKHuhwUkd9CO6Oyj8sgqd9TupbHteVRjt0bHs0mfC/XXK4KknQuaxS0GdURCIx2qP2bC/LUlESOsZfHYM2DwMw8VdMQtotD+OpcWnRVcoP7KS1kidMHgu3H9808wr3ls5b0nMRhdRIP2zp5y5Whx9jXbijyznnxJPn1odDbAEu/OiZxyht/B5QZw3BtOaQVIr2z5pWw6fnAmzigWBYbxPRBz5rA+bQaV+Kcu9LNx2POzDv4VFiCkabpd6Z93PJCtvZdFFFwtFch136/5LEmn2hJ2helrCvBiHGEBYWktRe6xjxh7ahy0WZG73HzfG7k6PDt9+/P2T7JaVz9L9j/k3v65jkceVjswrxyjk+PEoG8L5le57VkVi9EnN0fFxHYv1K1Ht2tXwl6O33dSTyV4KOT5jH4Vh8Qc6fotKLcl4/uhevmn0w6/jwrFXYzg51eq4/2d0zJzZGodRD13xr1JEIOw/TU/88O48mR28PDicHk/fXhyfT479P352MJpPJv0QkVoXazl6k7UnZBdl9V2X6p/gJcgKvTfWy6VtMyWLiZ5V9dGM/t3bsLqilWWFSytr70D3vN9zlDKy8mVksSO9dqQ7SWM+MTnBGeoYL1gmPEHpw3df30za8zO7zaJddpBVpnHVqYXY0mcxOWp4eT949VA3neiEVpUFEXps71N/8cZoBrTV77pKhe9+4fzh9aoxCv9iZ7LC9maTDpLLk10Eqrg5kSQdN//TmlnVUgT43rc4M2tLnYirG9ySnQ7vo9GbgWH9nOqnT2KxGpkTN952SseP7YixLGi8OR3wR3MfIsnyVPVYHr4U4L+ek5/twt9sEXfEiNuu0k6bt3VXSP5Evr3YVhlat6M1RBtFR83dmArhdm08laj7hwsoG5/eLmc+oElMg1w4+R+gAv/37vwHTlQiBemGEb77oL/pTZaE0S7Ssc6VOIVO4Iq5rGIRF6OsLIYeyUOicWgNpj3PLsiWlOXmpgHPExUgiSxmTIqYtmxlGWxgw343gc44+R8tdf7NcWKW4QMVsBz4Uit26BpbG3mVckkUgIa4caXQOUOdSJ2zYrUIExnKphdqjLS05BOctR01NbEZ7KxMPhdRyjjx2tJOqFBUxVcGauHIenFFVCBm8JGUsptBNSCOmbsRJ/MBFiEXg1sQUpcWcKbNAmFdc/EWQmBShkdI8BZ1CjM5DybFQgqHiq7QyyV1YvKxSCkrDhwZJxfXiMEaGeyu143O5iaVbgz5hpTVcvWAT4Js3PzvkFb4gfeemb9580Qdw03PqM8aOPN5+29F/uVw+oP13u5gz8h+rGH7C0jjyxq636Dn5vIrDVhkO0n80I52hxsCfwUbYjpGaxD3cedw6zlGV4yv0zBA3Pr08D+fsd/Dbr/+BC5RWQ26WDVuTyqJaw7xzxZlrVr5JW39MQmYC8XLOeNKQj0tPdL7PYLi7gZrN0+bwsooVJX11NIVTKHebIJEa4lbcYxpCcLlkIi1IhhcFfTeCU70OtT8syeeBA9wewA2yAXLm5XaVw+sA+RF8NEu+CaP2/SCRWhsPmJIPY/XBkHeoslEI3WJGSkGjqqb3vh1Ii4BFjGmKKc964DbGjOlOHsiB4xamL3vmNxBcB+z2hYR0Q2rDMoEzizotDWnvppBamfnt+0W0ddI8bhj9SFOTJNlPK2qHGTyocLburYQbwRc+au8dz7unqMUMLXsMW3JLnJJaotx0hAPm4e8hLF+9fB7JJCiDtqzie+KH++OEWxpt4T5lV/yGlHRl5xN7dRyMxyISihLUDge3/+nZ5QUs4O1oIqLBrfeCfTu+OP/Hhx+vPnA0fEY2GTscTUaTUC4Z5wupB6523tZaKbCT7s1WGv1FH+Pay58rnHGpJAXB1crsRizdiB2xdBuJ3DjP7ZtNLB3+bFVdc3PzJMYSKiXHs90+it3hevCEt5CqaqX5k7btW9vW9JY/LLFt0HZRp0bYYYM5TRIshw4eiNkdRXj24VoEiZ/vqqC7oILaHzx616XXg7F35VETAP/lOT0K2GwahVXXvX3T9SSinWBnzWtzW9f1/wBPLbwO","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 s=a(74848),n=a(28453),l=a(33617),p=a.n(l),o=a(17543),r=a.n(o),m=a(86013),d=a.n(m),c=a(63723),x=a.n(c),b=(a(18766),a(79329),a(9303));const y={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:"eJzdWNtu5DYS/ZUKXzYZyN1tj8eT7acYi4HHWCNjxA4GWI/RoKRSq8YUqZBUX9AQkIf9g/2D/bR8yaKoS6t9a3sT5CEvdouswyoWD8lT3Agv505Mb8Q1FqWSHp24jUSKLrFUejJaTMV1jnCGHjoTuCDn4fTyHKRSZulgbSrwBix6S7hAkKDYwmQgF5KUjBWC78YfwXVODrJKJzy+VOTXUFqzoBQdSA1mgXZBuAx4pbbICFDLWJGeQ+XQOvaZ5MY4hMyaAnBFznNvj4BljhoSizK0pyapCtTejUQkTIlWcgTnqZiKOfoOxbGLSJTSygI9Wk7PRmhZoJgKRQVxL3FifqnQrkUkLP5SkcVUTDOpHEbC+bVi68zYQkQCV6UyKYqptxX3JjkWUkw3opArKqpCTN9NJpHw65JBuipitKJmnCxKHuhwUkd9CO6Oyj8sgqd9TupbHteVRjt0bHs0mfC/XXK4KknQuaxS0GdURCIx2qP2bC/LUlESOsZfHYM2DwMw8VdMQtotD+OpcWnRVcoP7KS1kidMHgu3H9808wr3ls5b0nMRhdRIP2zp5y5Whx9jXbijyznnxJPn1odDbAEu/OiZxyht/B5QZw3BtOaQVIr2z5pWw6fnAmzigWBYbxPRBz5rA+bQaV+Kcu9LNx2POzDv4VFiCkabpd6Z93PJCtvZdFFFwtFch136/5LEmn2hJ2helrCvBiHGEBYWktRe6xjxh7ahy0WZG73HzfG7k6PDt9+/P2T7JaVz9L9j/k3v65jkceVjswrxyjk+PEoG8L5le57VkVi9EnN0fFxHYv1K1Ht2tXwl6O33dSTyV4KOT5jH4Vh8Qc6fotKLcl4/uhevmn0w6/jwrFXYzg51eq4/2d0zJzZGodRD13xr1JEIOw/TU/88O48mR28PDicHk/fXhyfT479P352MJpPJv0QkVoXazl6k7UnZBdl9V2X6p/gJcgKvTfWy6VtMyWLiZ5V9dGM/t3bsLqilWWFSytr70D3vN9zlDKy8mVksSO9dqQ7SWM+MTnBGeoYL1gmPEHpw3df30za8zO7zaJddpBVpnHVqYXY0mcxOWp4eT949VA3neiEVpUFEXps71N/8cZoBrTV77pKhe9+4fzh9aoxCv9iZ7LC9maTDpLLk10Eqrg5kSQdN//TmlnVUgT43rc4M2tLnYirG9ySnQ7vo9GbgWH9nOqnT2KxGpkTN952SseP7YixLGi8OR3wR3MfIsnyVPVYHr4U4L+ek5/twt9sEXfEiNuu0k6bt3VXSP5Evr3YVhlat6M1RBtFR83dmArhdm08laj7hwsoG5/eLmc+oElMg1w4+R+gAv/37vwHTlQiBemGEb77oL/pTZaE0S7Ssc6VOIVO4Iq5rGIRF6OsLIYeyUOicWgNpj3PLsiWlOXmpgHPExUgiSxmTIqYtmxlGWxgw343gc44+R8tdf7NcWKW4QMVsBz4Uit26BpbG3mVckkUgIa4caXQOUOdSJ2zYrUIExnKphdqjLS05BOctR01NbEZ7KxMPhdRyjjx2tJOqFBUxVcGauHIenFFVCBm8JGUsptBNSCOmbsRJ/MBFiEXg1sQUpcWcKbNAmFdc/EWQmBShkdI8BZ1CjM5DybFQgqHiq7QyyV1YvKxSCkrDhwZJxfXiMEaGeyu143O5iaVbgz5hpTVcvWAT4Js3PzvkFb4gfeemb9580Qdw03PqM8aOPN5+29F/uVw+oP13u5gz8h+rGH7C0jjyxq636Dn5vIrDVhkO0n80I52hxsCfwUbYjpGaxD3cedw6zlGV4yv0zBA3Pr08D+fsd/Dbr/+BC5RWQ26WDVuTyqJaw7xzxZlrVr5JW39MQmYC8XLOeNKQj0tPdL7PYLi7gZrN0+bwsooVJX11NIVTKHebIJEa4lbcYxpCcLlkIi1IhhcFfTeCU70OtT8syeeBA9wewA2yAXLm5XaVw+sA+RF8NEu+CaP2/SCRWhsPmJIPY/XBkHeoslEI3WJGSkGjqqb3vh1Ii4BFjGmKKc964DbGjOlOHsiB4xamL3vmNxBcB+z2hYR0Q2rDMoEzizotDWnvppBamfnt+0W0ddI8bhj9SFOTJNlPK2qHGTyocLburYQbwRc+au8dz7unqMUMLXsMW3JLnJJaotx0hAPm4e8hLF+9fB7JJCiDtqzie+KH++OEWxpt4T5lV/yGlHRl5xN7dRyMxyISihLUDge3/+nZ5QUs4O1oIqLBrfeCfTu+OP/Hhx+vPnA0fEY2GTscTUaTUC4Z5wupB6523tZaKbCT7s1WGv1FH+Pay58rnHGpJAXB1crsRizdiB2xdBuJ3DjP7ZtNLB3+bFVdc3PzJMYSKiXHs90+it3hevCEt5CqaqX5k7btW9vW9JY/LLFt0HZRp0bYYYM5TRIshw4eiNkdRXj24VoEiZ/vqqC7oILaHzx616XXg7F35VETAP/lOT0K2GwahVXXvX3T9SSinWBnzWtzW9f1/wBPLbwO",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,g={},u=[];function T(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,s.jsx)(p(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,s.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(r(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(x(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}},title:"inline_response_200_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function V(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.4901096f.js b/assets/js/5ce6d213.4901096f.js new file mode 100644 index 000000000..2a3fe32a3 --- /dev/null +++ b/assets/js/5ce6d213.4901096f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3460],{78912:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>w,frontMatter:()=>h,metadata:()=>n,toc:()=>b});const n=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":"eJzFWF9vG7kR/ypzfGlirCUl5+RQPdXNpYlxQSLENoLWMQTu7qyWZy7JI7mSBWGBe+g36FNf+9HySYohd1erP3GS3rV9MWTucDjzmyHnN7Nhni8cm96wK6yM5B4du01Yji6zwnihFZuyqxLh2uTcI3RScD67AFQ8lehgrWvwGiqdi2INXOVQR2lfIuTouZAOdAEcnMFMFCID3+oZsYRpg5bTURc5m7K4tTuHJcxwyyv0aMnMDVO8QjZlnYK5yFnCBJlpuC/Zvu0XP9LJZEi3A3zJPSjE3JHVKbbWkh6Lv9TCYs6m3taYMOfXkk5zojKSjMF7I3WObFpw6UggK7HibLphfm2CpLdCLVjCCm0r7rcrTXMb9aPzf9b5mvbsmjqzeilyhBSlXkHvNhnZ4dnFCB5xDxK586AVDmQ7Bx6zhGVaeVSeDuLGSJEFkMc/Ozptc2i6Tn/GzBPilkLiBTr6GgH/soMEDg8wTZkLP3p7WZMwpf03q5mRiwgWlwJXIbGcWCjwpXCQ66yuyL1mL+TfdkSfFUMdDe2ROVrKyEN9290kGW/Bu6vZQDTVWiJXB9lIWQWn0QEdFmElpGxvEry7msESLd2QEKsRXDu0LspYzFAsEfiOCGQ6R1gKDlhxIRNYlSIrKeHXUNXOA6o2h1rosEduBCGJ4RQODcqFO2pRAlxKvRJqAXUw7ZhiyIXFzMs1rIQvde2B57mg7VyC82jcaIhisKIH8krX9rcjyWFRixxz8Lq2UGgbrETrEjDhmpEHQjlv64w2O8hrim7wg0Tpt7E6Q+e2OHWokNBAfwKoXNzOoeDOo02gVoKQt7XxmPcq8d6gFagyPApBAHceHtIWcPf1WMzQVsK7zlMKDc9zQIkUFAeuzkrg8Tv3tUWXgFDCCy5dAs7zyrgEtAWP9/SugNeGHk+8F86T8SuRL9A7EJ/Lo/dIdyQb2FBYXYXoEzZqPUyE3i6v99RdUVCFa8tHwWvpYcllfRyzQsijD8suRn/VNVR83UY/hjDlDp+fASq6QznMfvwLkDIyyKKRPItivf9a4fA1idsP3gOLMf3ntZVftusyVkSM3l6/fwOrEi32eYg25nVKz2BUjFRfw82nU32Xtf3t20/fAwt57fXcYiVUjl9z1y7RhyBRmnndX7Ha64p7kUGnyo2gFY0J4fXwxlTwqAtmiiVfCm0fHw1oVDfXKsO5UHNcol0PrFR1laI9MPJtWKZ8zfnaQYp+haiGtnVppZVcQ1sRybZViQp2MCEpt3V6x8pnTZMwL/xO9ZgP6Mg8pereNE1wxRmtXCykTyeTw6LfE6qWhNAtpagVtZTr736/Kh6Xv1TPuMufvnazs9eG8qQ16dw/vOnp5On3p08mp5Mfrp48n579cfrs+WgymfyNJey+klsKwfKWCnToxf8HC0JJoXDeoTZ/OpnMv2+hPDuGXksQuku95FLkUAiUOdCZ7ncEEK3V9j8kMA/Y95D75HLn/NkDqaO0h0LXKv9/u3vMoocdPJv/0Lv47NDFCxUho27jSt+h+l94uPVneLyPx5Opu1ktolD4znacHa5HJx1mtRV+HTqZ+1NuxGn8Pr25pf6gQl9q6oJMHQymjmbKxt3rMt4M3pmGkT677BqjUG5Y6b1x0/HYcZWn+n6kDSoqCJKnbpTpasyNGC+fjJ6wJtnfw435JnmsT791i/N8IdTiS/tut1BdUjhjxHYA6+PGjfgJ1yzp4jGUajvDEjlVOooAZcn7bRf2sot1H8791qXrXL6uGTmgZsfai2F3wdhOB9G2lUMq3C4dpYbtt0iBGNsnH7SyV+zbHcdr7LOGACt0QLdN43cG1SU5SpcgRGffxw8oM11hx+O6DZ/+/q+wp8Mmtiuk4buP6qN6V1sweoW2qGVAs5B4L6geh9FCFb71swWHvJLonFwD0eqFDZiKhfDUUrSEJ+OGp0IKuuEkpmm3hcEj4UbwoURfoqVPf7DUKOS4REkPQ89o1GJLplba3hVSr1wCHNLaCYXOAaqSq4wEuzQNxJmr2G4ZKxyC85asFtE2rbzlmYeKK74IzDfZgSpHKegug9Up9W1Oyzp2JjQ/0Tb0GtGhMLsYEYgvaRxhEWiV6KDFku7Usm1PXBLbw5jT5ILKIUXnwZAtIsPAvmsldXYXgke0A4ym91VwSWxqaCNt95YrR0Ug2tLFoAesZZ0YDTw5uXZIEX4j1J2bnpx8VKdw0+fUB0yd8Hj7qHsfVqvVwbvweHfPK+Ff1ym8R6Od8Nqut7sXwpd1Gt6SoZL+n6jpFSoM+TN4KbY6cp25w6eJVsclSjO+RE8Z4sbns4tQkh7Dp1//AW+QWwWlXsVszWqLcg2L7ihCLkY+wtZXlNCb8tqXhHgWk6+dEnUIfii5//TrPx28xRX1XnSFIpAnJ7M6lSLrx3Lu5GQKLyzuDovCwCvjipoIV3JKJRoYcDBxtxTqbgTnah16+tC0h2Sg9bBvx43w6nXhdqGJykO3OJixjbYWBervUC7RkS5iBikC5oLIri+trhfxtKExrXMWC+p9PsS+k3w7z3Mw7XLXjlKbsTUHCx3bpzVwi+BCRznb2xK+1MZoS1a0/Wyhu9EGqtxoobybQm554bf6k22iZwRzGIkcLEUIeQ9H0qrpQxJvYutxvzr6SLVhr8rtvrUWC7R0YHB7Gxcj2nS66dISKFt/S1oTl6FXi2eBaoXxUiy3f9rXE2gP2sq9Ky7RLkWGbcn/zI0eB+ExS5gUGSo3rL/nr2ZvYPn9aMKSAXf4iss9fnPx4uXby5dkDD2kEbAno8loQktGO19xNThpb6S9X9c2W6L5356At0yG5i5jI7kIPLIdH0QOeMMGhGQ6HH7fJqzUzpPIZkOX8drKpqHlX+pQ1G9uE7bkVpClgSi2PXnek4HPuv3ofTdOhm+box91qONrishamOdEhnKH672BfnPbJB1pI4ujxIto1+kV6dlqOOgBiHXGHedZhsY/KDsk3bPrK5awtB3OV2HOzyxfEa/iq2hsnDUGOhrWNkxytaj5gmSjyiaOWMpdjnoXOGr7g5w6CscueY1e0F/y6eiGzSby36bp5eOnz+5oce2kKTa3TdP8G7SzMIs=","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 s=i(74848),p=i(28453),a=i(33617),o=i.n(a),r=i(17543),l=i.n(r),d=i(86013),m=i.n(d),c=i(63723),u=i.n(c),f=(i(18766),i(79329),i(9303));const h={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWF9vG7kR/ypzfGlirCUl5+RQPdXNpYlxQSLENoLWMQTu7qyWZy7JI7mSBWGBe+g36FNf+9HySYohd1erP3GS3rV9MWTucDjzmyHnN7Nhni8cm96wK6yM5B4du01Yji6zwnihFZuyqxLh2uTcI3RScD67AFQ8lehgrWvwGiqdi2INXOVQR2lfIuTouZAOdAEcnMFMFCID3+oZsYRpg5bTURc5m7K4tTuHJcxwyyv0aMnMDVO8QjZlnYK5yFnCBJlpuC/Zvu0XP9LJZEi3A3zJPSjE3JHVKbbWkh6Lv9TCYs6m3taYMOfXkk5zojKSjMF7I3WObFpw6UggK7HibLphfm2CpLdCLVjCCm0r7rcrTXMb9aPzf9b5mvbsmjqzeilyhBSlXkHvNhnZ4dnFCB5xDxK586AVDmQ7Bx6zhGVaeVSeDuLGSJEFkMc/Ozptc2i6Tn/GzBPilkLiBTr6GgH/soMEDg8wTZkLP3p7WZMwpf03q5mRiwgWlwJXIbGcWCjwpXCQ66yuyL1mL+TfdkSfFUMdDe2ROVrKyEN9290kGW/Bu6vZQDTVWiJXB9lIWQWn0QEdFmElpGxvEry7msESLd2QEKsRXDu0LspYzFAsEfiOCGQ6R1gKDlhxIRNYlSIrKeHXUNXOA6o2h1rosEduBCGJ4RQODcqFO2pRAlxKvRJqAXUw7ZhiyIXFzMs1rIQvde2B57mg7VyC82jcaIhisKIH8krX9rcjyWFRixxz8Lq2UGgbrETrEjDhmpEHQjlv64w2O8hrim7wg0Tpt7E6Q+e2OHWokNBAfwKoXNzOoeDOo02gVoKQt7XxmPcq8d6gFagyPApBAHceHtIWcPf1WMzQVsK7zlMKDc9zQIkUFAeuzkrg8Tv3tUWXgFDCCy5dAs7zyrgEtAWP9/SugNeGHk+8F86T8SuRL9A7EJ/Lo/dIdyQb2FBYXYXoEzZqPUyE3i6v99RdUVCFa8tHwWvpYcllfRyzQsijD8suRn/VNVR83UY/hjDlDp+fASq6QznMfvwLkDIyyKKRPItivf9a4fA1idsP3gOLMf3ntZVftusyVkSM3l6/fwOrEi32eYg25nVKz2BUjFRfw82nU32Xtf3t20/fAwt57fXcYiVUjl9z1y7RhyBRmnndX7Ha64p7kUGnyo2gFY0J4fXwxlTwqAtmiiVfCm0fHw1oVDfXKsO5UHNcol0PrFR1laI9MPJtWKZ8zfnaQYp+haiGtnVppZVcQ1sRybZViQp2MCEpt3V6x8pnTZMwL/xO9ZgP6Mg8pereNE1wxRmtXCykTyeTw6LfE6qWhNAtpagVtZTr736/Kh6Xv1TPuMufvnazs9eG8qQ16dw/vOnp5On3p08mp5Mfrp48n579cfrs+WgymfyNJey+klsKwfKWCnToxf8HC0JJoXDeoTZ/OpnMv2+hPDuGXksQuku95FLkUAiUOdCZ7ncEEK3V9j8kMA/Y95D75HLn/NkDqaO0h0LXKv9/u3vMoocdPJv/0Lv47NDFCxUho27jSt+h+l94uPVneLyPx5Opu1ktolD4znacHa5HJx1mtRV+HTqZ+1NuxGn8Pr25pf6gQl9q6oJMHQymjmbKxt3rMt4M3pmGkT677BqjUG5Y6b1x0/HYcZWn+n6kDSoqCJKnbpTpasyNGC+fjJ6wJtnfw435JnmsT791i/N8IdTiS/tut1BdUjhjxHYA6+PGjfgJ1yzp4jGUajvDEjlVOooAZcn7bRf2sot1H8791qXrXL6uGTmgZsfai2F3wdhOB9G2lUMq3C4dpYbtt0iBGNsnH7SyV+zbHcdr7LOGACt0QLdN43cG1SU5SpcgRGffxw8oM11hx+O6DZ/+/q+wp8Mmtiuk4buP6qN6V1sweoW2qGVAs5B4L6geh9FCFb71swWHvJLonFwD0eqFDZiKhfDUUrSEJ+OGp0IKuuEkpmm3hcEj4UbwoURfoqVPf7DUKOS4REkPQ89o1GJLplba3hVSr1wCHNLaCYXOAaqSq4wEuzQNxJmr2G4ZKxyC85asFtE2rbzlmYeKK74IzDfZgSpHKegug9Up9W1Oyzp2JjQ/0Tb0GtGhMLsYEYgvaRxhEWiV6KDFku7Usm1PXBLbw5jT5ILKIUXnwZAtIsPAvmsldXYXgke0A4ym91VwSWxqaCNt95YrR0Ug2tLFoAesZZ0YDTw5uXZIEX4j1J2bnpx8VKdw0+fUB0yd8Hj7qHsfVqvVwbvweHfPK+Ff1ym8R6Od8Nqut7sXwpd1Gt6SoZL+n6jpFSoM+TN4KbY6cp25w6eJVsclSjO+RE8Z4sbns4tQkh7Dp1//AW+QWwWlXsVszWqLcg2L7ihCLkY+wtZXlNCb8tqXhHgWk6+dEnUIfii5//TrPx28xRX1XnSFIpAnJ7M6lSLrx3Lu5GQKLyzuDovCwCvjipoIV3JKJRoYcDBxtxTqbgTnah16+tC0h2Sg9bBvx43w6nXhdqGJykO3OJixjbYWBervUC7RkS5iBikC5oLIri+trhfxtKExrXMWC+p9PsS+k3w7z3Mw7XLXjlKbsTUHCx3bpzVwi+BCRznb2xK+1MZoS1a0/Wyhu9EGqtxoobybQm554bf6k22iZwRzGIkcLEUIeQ9H0qrpQxJvYutxvzr6SLVhr8rtvrUWC7R0YHB7Gxcj2nS66dISKFt/S1oTl6FXi2eBaoXxUiy3f9rXE2gP2sq9Ky7RLkWGbcn/zI0eB+ExS5gUGSo3rL/nr2ZvYPn9aMKSAXf4iss9fnPx4uXby5dkDD2kEbAno8loQktGO19xNThpb6S9X9c2W6L5356At0yG5i5jI7kIPLIdH0QOeMMGhGQ6HH7fJqzUzpPIZkOX8drKpqHlX+pQ1G9uE7bkVpClgSi2PXnek4HPuv3ofTdOhm+box91qONrishamOdEhnKH672BfnPbJB1pI4ujxIto1+kV6dlqOOgBiHXGHedZhsY/KDsk3bPrK5awtB3OV2HOzyxfEa/iq2hsnDUGOhrWNkxytaj5gmSjyiaOWMpdjnoXOGr7g5w6CscueY1e0F/y6eiGzSby36bp5eOnz+5oce2kKTa3TdP8G7SzMIs=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},b=[];function x(e){const t={p:"p",...(0,p.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,s.jsx)(o(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,s.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,s.jsx)(m(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"template_template_id_body"}}}}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Template not found!"}},title:"inline_response_404_7"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function w(e={}){const{wrapper:t}={...(0,p.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce6d213.b41b8b05.js b/assets/js/5ce6d213.b41b8b05.js deleted file mode 100644 index b724de1e7..000000000 --- a/assets/js/5ce6d213.b41b8b05.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3460],{78912:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>f,contentTitle:()=>b,default:()=>T,frontMatter:()=>h,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":"eJzFWO9u3LgRf5U5fmkSyLtrx8mh+6nuXZoYF1wWsY2gdYwFJY5WPFOkjqR2vVgI6Ie+wb3BPdo9STGkpNX+iZP0ru0XY03NDOcfZ34zG+b5wrHpLbvGslLco2N3CRPoMisrL41mU3ZdINxUgnuEjgouZpeAmqcKHaxNDd5AaYTM18C1gDpS+wJBoOdSOTA5cHAVZjKXGfhWzoglzFRoOV11KdiURdbuHpawilteokdLam6Y5iWyKesEzKVgCZOkZsV9wfZ1v/yebiZFOg7wBfegEYUjrVNstSU5Fn+upUXBpt7WmDDn14puc7KsFCmDD5UyAtk058oRQVZgydl0w/y6CpTeSr1gCcuNLbnfnjTNXZSPzv/ViDXx7Ko6s2YpBUKKyqygN5uU7PzZxQiecA8KufNgNA5oOwOesoRlRnvUni7iVaVkFpw8/snRbZtD1U36E2aePG4pJF6io6/R4Z83kJzDg5umzIUfvb6sSZg2/qvFzMhEBItLiauQWE4uNPhCOhAmq0syr9kL+ddd0WfFUEZDPEqgpYw8lLflJsr4Ct5dzwakqTEKuT7IRsoqOIkGmHAIK6lU+5Lg3fUMlmjphYRYjeDGoXWRxmKGconAd0ggMwJhKTlgyaVKYFXIrKCEX0NZOw+o2xxqXYe950YQkhhO4FAhId1RjRLgSpmV1Auog2rHBIOQFjOv1rCSvjC1By6EJHauwHms3GjoxaBF78hrU9vf70kOi1oKFOBNbSE3NmiJ1iVQhWdGFkjtvK0zYnYgaopusINI6XdlTYbObf3UeYWIBvITQO0iO4ecO482gVpL8rytK4+iF4kPFVqJOsOjLgjOnYdC2jrcfbkvZmhL6V1nKYWGCwGokILiwNVZATx+57626BKQWnrJlUvAeV5WLgFjweMD1RXwpqLiiQ/SeVJ+JcUCvQP5qTx6j/RGsoEOuTVliD75Rq+HidDr5c2euGsKqnRt+8h5rTwsuaqP+yyX6mhh2fXR300NJV+30Y8hTLnDl+eAmt6QgNn3fwMSRgpZrBTPIllvv9E4rCaR/aAeWIzpP6+t+rxeV7EjYrT25v1bWBVosc9DtDGvUyqDUTBSfw0vn271Xdb2r28/fQ805LU3c4ul1AK/5K1doQ9BojTzpn9itTcl9zKDTpQbQUsaE8Kb4Ysp4UkXzBQLvpTGPj0a0ChubnSGc6nnuES7Hmip6zJFe6Dkj+GY8lXwtYMU/QpRD3Xr0spotYa2I5JuqwI17PiEqNzW6B0tXzRNwrz0O91jPoAj85S6e9M0wRRXGe1iIz2bTA6bfg+oWhBCr5SiltdKrb/547p4PP5cP+NOnL1xs/M3FeVJq9KFf5zpbHL2/OR0cjL59vr05fT8z9MXL0eTyeQfLGEPpdpCCCZaKNB5L/4/OJBaSY3zzmvzs8lk/rx15fkx77UAoXvUS66kgFyiEkB3uj/QgWitsf8hgHlEv8fMJ5M7488fSR1tPOSm1uL/be4xjR438Hz+bW/ii0MTL3V0GU0b1+Ye9f/Cwq09w+t9vJ5U3c1qGYnCd7Zj7PA8Gukwq6306zDJPJzwSp7E79PbO5oPSvSFoSmoqoPCNNFM2birLuPNoM40jOTZZTcYhXbDCu8rNx2PHdciNQ8jU6GmhqB46kaZKce8kuPl6eiUNck+D6+qr6LH+uRrWZznC6kXn+O727rqisIZI7bjsD5uvJI/4JolXTyGVO1kWCCnTkcRoCx5v53CXnWx7sO5P7p0k8uXDSMH0OzYeDGcLhjbmSDasXIIhdujo9Cw/RYhEGP74INO9pp9y3G8x75oyGG5Cd5t0/hdhfqKDKVHEKKzb+MHVJkpscNxHcNv//o18HS+ieMKSfjmo/6o39UWKrNCm9cqeDNX+CCpH4fVQhm+9bsFh7xU6JxaA8HqhQ0+lQvpaaRoAU/GK55KJemFE5khbguDIuFG8KFAX6ClT3+yNCgIXKKiwtAjGr3YgqmVsfe5MiuXAIe0dlKjc4C64Dojwi5NA3DmOo5blZUOwXlLWsuom9He8sxDyTVfBOSb7LhKoJL0lsGalOY2Z1QdJxPanxgbZo1oUNhdjMiJr2gdYRHolOCgxYLe1LIdT1wSx8OY02SCFpCi81CRLjLDgL5rrUx2H4JHsAMqQ/VVckVoaqgjsXvLtaMmEHXpYtA7rEWdGBV89uzGIUX4rdT3bvrs2Ud9Ard9Tn3A1EmPd0+6+rBarQ7qwtNdntfSv6lTeI+VcdIbu95yL6Qv6jTUkqGQ/p8o6TVqDPkzqBRbGcJk7rA00em4QFWNr9BThrjxxewytKSn8Ns/f4G3yK2Gwqxitma1RbWGRXcVeS5GPrqt7yhhNuW1L8jjWUy+dkvUezAuf2R8PK0PZ3WqBnu0KVxAtXsEGdc0NmQWA7AMFavglEi0LuCgpL4fwYVeh1E+zOohB+g8MEfObanj2yiHuU76EbwxKyoeSbsOyLim3o9C+t2lm/QOVT4KqlvMaaSJ4+R0738H3CJgmaKgoUzuXJtiTukufUToOkD0cDPBe1wHXr7kUgVk3w6quel2FqhFZaT2bgrC8tz3kl2yvSSYHXYdB0fRSbw3K2nF9Iu5+MT2IuFG8JGq/l7/2q2iFnO0dGN4ktvEqWSbKLddwgHl4e9JWEIpVI94FkBUWBzFRvqXfTkB0KAt3bv8Cu1SZtg280+81XEgHrOEKZmhdsPOevF69haW8Hw0YckAFnzBux2/vfzu1Y9Xr0gbqpHRY6ejyWhCR5VxvuR6cNXetnq/ZW22GPK/vdxuQQqtVMaV4jJAxHYzEOHdLRtgjelwr32XsMI4TySbDW0bbqxqGjr+uQ79+vYuYUtuJWkaMGA7bou+z3/S7Cfvu00xfN2K/KhBHRTThMPCqiaCj3tc7+3qm7sm6fAYaRwpvot6nVyTnK2EA3hPgDJyXGQZVv5R2iGent1cs4Sl7d69DCt8ZvmKIBNfRWXjGjEgzXC2YYrrRc0XRBtFNnF7UuzCz/sAP9sfZNRRd+zi0mgF/SWbjjJsNhHaNk1PHz99kqP1a0dNsblrmubfW14hRA==","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 o=i(74848),s=i(28453),n=i(33617),p=i.n(n),r=i(17543),d=i.n(r),l=i(86013),u=i.n(l),m=i(63723),c=i.n(m),g=(i(18766),i(79329),i(9303));const h={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWO9u3LgRf5U5fmkSyLtrx8mh+6nuXZoYF1wWsY2gdYwFJY5WPFOkjqR2vVgI6Ie+wb3BPdo9STGkpNX+iZP0ru0XY03NDOcfZ34zG+b5wrHpLbvGslLco2N3CRPoMisrL41mU3ZdINxUgnuEjgouZpeAmqcKHaxNDd5AaYTM18C1gDpS+wJBoOdSOTA5cHAVZjKXGfhWzoglzFRoOV11KdiURdbuHpawilteokdLam6Y5iWyKesEzKVgCZOkZsV9wfZ1v/yebiZFOg7wBfegEYUjrVNstSU5Fn+upUXBpt7WmDDn14puc7KsFCmDD5UyAtk058oRQVZgydl0w/y6CpTeSr1gCcuNLbnfnjTNXZSPzv/ViDXx7Ko6s2YpBUKKyqygN5uU7PzZxQiecA8KufNgNA5oOwOesoRlRnvUni7iVaVkFpw8/snRbZtD1U36E2aePG4pJF6io6/R4Z83kJzDg5umzIUfvb6sSZg2/qvFzMhEBItLiauQWE4uNPhCOhAmq0syr9kL+ddd0WfFUEZDPEqgpYw8lLflJsr4Ct5dzwakqTEKuT7IRsoqOIkGmHAIK6lU+5Lg3fUMlmjphYRYjeDGoXWRxmKGconAd0ggMwJhKTlgyaVKYFXIrKCEX0NZOw+o2xxqXYe950YQkhhO4FAhId1RjRLgSpmV1Auog2rHBIOQFjOv1rCSvjC1By6EJHauwHms3GjoxaBF78hrU9vf70kOi1oKFOBNbSE3NmiJ1iVQhWdGFkjtvK0zYnYgaopusINI6XdlTYbObf3UeYWIBvITQO0iO4ecO482gVpL8rytK4+iF4kPFVqJOsOjLgjOnYdC2jrcfbkvZmhL6V1nKYWGCwGokILiwNVZATx+57626BKQWnrJlUvAeV5WLgFjweMD1RXwpqLiiQ/SeVJ+JcUCvQP5qTx6j/RGsoEOuTVliD75Rq+HidDr5c2euGsKqnRt+8h5rTwsuaqP+yyX6mhh2fXR300NJV+30Y8hTLnDl+eAmt6QgNn3fwMSRgpZrBTPIllvv9E4rCaR/aAeWIzpP6+t+rxeV7EjYrT25v1bWBVosc9DtDGvUyqDUTBSfw0vn271Xdb2r28/fQ805LU3c4ul1AK/5K1doQ9BojTzpn9itTcl9zKDTpQbQUsaE8Kb4Ysp4UkXzBQLvpTGPj0a0ChubnSGc6nnuES7Hmip6zJFe6Dkj+GY8lXwtYMU/QpRD3Xr0spotYa2I5JuqwI17PiEqNzW6B0tXzRNwrz0O91jPoAj85S6e9M0wRRXGe1iIz2bTA6bfg+oWhBCr5SiltdKrb/547p4PP5cP+NOnL1xs/M3FeVJq9KFf5zpbHL2/OR0cjL59vr05fT8z9MXL0eTyeQfLGEPpdpCCCZaKNB5L/4/OJBaSY3zzmvzs8lk/rx15fkx77UAoXvUS66kgFyiEkB3uj/QgWitsf8hgHlEv8fMJ5M7488fSR1tPOSm1uL/be4xjR438Hz+bW/ii0MTL3V0GU0b1+Ye9f/Cwq09w+t9vJ5U3c1qGYnCd7Zj7PA8Gukwq6306zDJPJzwSp7E79PbO5oPSvSFoSmoqoPCNNFM2birLuPNoM40jOTZZTcYhXbDCu8rNx2PHdciNQ8jU6GmhqB46kaZKce8kuPl6eiUNck+D6+qr6LH+uRrWZznC6kXn+O727rqisIZI7bjsD5uvJI/4JolXTyGVO1kWCCnTkcRoCx5v53CXnWx7sO5P7p0k8uXDSMH0OzYeDGcLhjbmSDasXIIhdujo9Cw/RYhEGP74INO9pp9y3G8x75oyGG5Cd5t0/hdhfqKDKVHEKKzb+MHVJkpscNxHcNv//o18HS+ieMKSfjmo/6o39UWKrNCm9cqeDNX+CCpH4fVQhm+9bsFh7xU6JxaA8HqhQ0+lQvpaaRoAU/GK55KJemFE5khbguDIuFG8KFAX6ClT3+yNCgIXKKiwtAjGr3YgqmVsfe5MiuXAIe0dlKjc4C64Dojwi5NA3DmOo5blZUOwXlLWsuom9He8sxDyTVfBOSb7LhKoJL0lsGalOY2Z1QdJxPanxgbZo1oUNhdjMiJr2gdYRHolOCgxYLe1LIdT1wSx8OY02SCFpCi81CRLjLDgL5rrUx2H4JHsAMqQ/VVckVoaqgjsXvLtaMmEHXpYtA7rEWdGBV89uzGIUX4rdT3bvrs2Ud9Ard9Tn3A1EmPd0+6+rBarQ7qwtNdntfSv6lTeI+VcdIbu95yL6Qv6jTUkqGQ/p8o6TVqDPkzqBRbGcJk7rA00em4QFWNr9BThrjxxewytKSn8Ns/f4G3yK2Gwqxitma1RbWGRXcVeS5GPrqt7yhhNuW1L8jjWUy+dkvUezAuf2R8PK0PZ3WqBnu0KVxAtXsEGdc0NmQWA7AMFavglEi0LuCgpL4fwYVeh1E+zOohB+g8MEfObanj2yiHuU76EbwxKyoeSbsOyLim3o9C+t2lm/QOVT4KqlvMaaSJ4+R0738H3CJgmaKgoUzuXJtiTukufUToOkD0cDPBe1wHXr7kUgVk3w6quel2FqhFZaT2bgrC8tz3kl2yvSSYHXYdB0fRSbw3K2nF9Iu5+MT2IuFG8JGq/l7/2q2iFnO0dGN4ktvEqWSbKLddwgHl4e9JWEIpVI94FkBUWBzFRvqXfTkB0KAt3bv8Cu1SZtg280+81XEgHrOEKZmhdsPOevF69haW8Hw0YckAFnzBux2/vfzu1Y9Xr0gbqpHRY6ejyWhCR5VxvuR6cNXetnq/ZW22GPK/vdxuQQqtVMaV4jJAxHYzEOHdLRtgjelwr32XsMI4TySbDW0bbqxqGjr+uQ79+vYuYUtuJWkaMGA7bou+z3/S7Cfvu00xfN2K/KhBHRTThMPCqiaCj3tc7+3qm7sm6fAYaRwpvot6nVyTnK2EA3hPgDJyXGQZVv5R2iGent1cs4Sl7d69DCt8ZvmKIBNfRWXjGjEgzXC2YYrrRc0XRBtFNnF7UuzCz/sAP9sfZNRRd+zi0mgF/SWbjjJsNhHaNk1PHz99kqP1a0dNsblrmubfW14hRA==",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,f={},v=[];function j(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,o.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,o.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,o.jsx)(u(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"template_template_id_body"}}}}}),"\n",(0,o.jsx)(c(),{id:void 0,label:void 0,responses:{200:{description:"Template updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Template not found!"}},title:"inline_response_404_7"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function T(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.65eb58f6.js b/assets/js/62b755e6.65eb58f6.js new file mode 100644 index 000000000..8c65464e9 --- /dev/null +++ b/assets/js/62b755e6.65eb58f6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9350],{30456:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>X,frontMatter:()=>h,metadata:()=>n,toc:()=>j});const n=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":"eJztWc1uGzkSfpUa5rCJ0ZZkW05mdRoj4/V6N0iM2EGAjQ2B3V1SM2aTPSRbsmA0MId9gz3NdR4tT7Iosv9ky46VGeQ0F1siq4r187FYVbpljs8tm3xiP+ukzFE5y64ilqJNjCic0IpN2LNnz6DZhotVgXZyqd6jMwIXCByksA70DNJGBMTcYgpagVsVeKku1d4AdnZ+NnzmWkl2srNzqQAAdrs1cBl3wA1CUhqDyskVCAWp57SOu9IOSN4+yTtVu2dGzw1a+01Si5rZSzwgia91Xkh0mD5FXsYXCDGiAlsmCVo7K6VcQdLKWAqXAZcSDP5SCoMpWDFX3JUGw5ljOvP4pvB7Tz0Ra3quUm+S0iC1mqMB7rUQsUQv/dD7HBMp1LYGpQ1XvAKXIZQWzeBSsYjpAg0nXJymbMLm6JqgEwhYxApueI4ODYHqlimeI5uwVCeEBBYxQYAquMvYXZRdZOjhso4kp8HUSGMRaxzJJs6UGDHrVpLkW0E+ZxHDm0LqFNlkxqUlgiTDnLPJLfPnT5h1Rqg5UaoyJ9x7aHnFGjiwiLUxDCL9kaRv8Aq7qqqotU2KXLjGsl9KNKs1RRtFak1n2uR9PWs7WjVzfiNy0uxwNIoapVWZx2hYRXzcWzrZG/VUsNei+NM0ePjMUXVFcm2hlUVLtPujEf1bD2R3G6BFi/epcqgc0fOikCLxG8PPlphu7yug48+YeEgZEuNEONKgLaXr0XFjOBksHOb26/xhmdB7HxPkGu7WUNLYzv5xIq73D+Lsw7/IJzNBi9tJyJwr7GQ4rFdKIweJzkmaE257cdZ/oKtCIpR2W0soJHKLPim1N84bp2WK5nu5MmB4OwlBQ/CsVedA1lgxrU2oIqaXas2WJ8n/rH0iJH7yjs9m3wo4ozfHtjstQf2YIzaqhTkX8qvUMeJP9UKDtSLT6ivHjA9f7u8d/Phqj+iXIp2j+wP2h93t/O/wxsX6xuvL53g/LfXY25UuN1YRu9mSZ388riK22pLrFR213JLp4McqYtmWTOOXhGWfYp/g82+5U63Pq/6NcpgXkjucnod7MG3w8CiVv5QWVXqq3pn1XBJrLZGr/tH0AlURSwxyh+mRexyd+6P9g9290e7o1cXey8n475PDl4PRaPQfFrGbXHbWs5Q7ZP3kUH8vi/S7nIOKxxIvdPk08w2mwmDipqXZeLEfix0dx6XUy2muUzGr31b7+Lm+LiC9m+CJjZm8j5CWEIQFreQK+IILSXbCMkPli8UmCRNNHVOYGZ0Dh0bCwCtcOj01mAv1EELW64pzdFQOkrvof3AvkJScO5FAI8oOoCb1FtKHVFhP7DLM4XmKM15KBzFmfCG0eTHY5JYgbqpVglOhprigumrDpV1X8q1f9jUsX1mI0S2poO7pdpEJ27kvVEKt/9Z8QlS2M3pNyxHdsDs47D3hdx/E9esqFNWx06aUm+6PRtNxffHHo/H9ku49Fto4UNp1Af/hz6vp0Bi98Y3usLdZg8eMGo/G08PWqMP7Rp2qBZcihaOzU7jQ16i+r0X94104/n5MRSDy+2zN2P56MNJiUhrhVr7xutnlhdgN+5NPV1S55+gyXXdtvlNzGZuwYb+BG97WnVrFSJ5ZNH2cz0ltBWu5SmN9M9AFKqqPJI8t1RdDXojhYm9AhcNdHl4UW9Fjubsti3V8LtT8a3xXnavOKZwhYmsO62qdQvwbqdip49GnqhuuDLkvNSv6PtOeuY7SuwIVvYg+xv7wu+niI8pE5z5HUepsGL7893fP08TGg9BL+IE6+3elgUIv0VCPRXOAmcQb6vs9E+Z+z8JKlyTYIs8lWuuHHg7nhjuEVMyF49IX/0LNIeEFj4UUBGAi08RtoHcH7AA+ZugyNLT1N0OTnxQXKAn3bRpW8y7/L7W5nkm9tBFwiEsrFE1qUGVcJUTYRCECbYArQOXQFEZQT+IMaS2Cblo5wxMHOVd8jiQ7WnNVilIQVMHouLQOrJalVxkcF1LTtKQxSCGmYfhyTA2wQaBV6vcNZgSZBcK8FCnaCBKdIoQ2i0xQKcRoHRSki0jQDydKJXVy7YNH4x8oNKUPwSU9AX0did0Zriy940GXJgatwwqjqXOup0M7Ox8sUoTfCHUdxja78KnF1EeMrXB49byB/3K5vAf7F+s8J8L9s4yBkqkVTptVxz0XLitjf1X6QtovQdIJKvT46V2ETkaqE3v/5tHqMENZDM/REULs8Ojs1GfcF/Dl1//BG+RGQaaXAa1JaVCuYN4cRZ4LkQ9uaxMmzLQHXkYeTwL4aOyB1jUe/Jhx9+XX3yy8xSWN/OgKBUfu7JyVsRQJXNQ1id3ZmcBrX6+0dUo9GEu4ghjBZpygtBAcOBSBWwp1PYAjtfIzsjDyIzDQuudbM2Ot1e6PSbPuzEGnka9XLMoFWpJFj1+MgKmgksplRpfzcFpfmdo4gzMhJXwM5TrZdpSmUNTLdRXva6NOHZzRhXAZrvxk0aJyAzi7w+J3yoKeY0zJpx77mqpPCgCqtNCC5oz11LaVH3VA92Wh0GrDUj01bd0R1WLakISbWFvcrobp5J0kvp5rDc7Q0IHe7C4uhajh9KmBJRBa/wis6ammrMUTX0nUzTq9Jj/dleNfdTS5fTc7R7MQSTMqeuBGDz3xkEVMigSVxV61cHRy9gYWB4MRi3pP4xMu9/DN6evjt+fHpAwl0uCwvcFoMPI9uLYu56p30gl2g/ww//cVfpjQ333lbruq6q/fEv76LaH9LaGusWjwMCwkF77CrbvfUJ1+Ynd+Xpg0vyRcRSzT1hHJ7S1B5IORVUXLYQBORWvd9XUj8Gtc9Qb2Cy7Lunl+kLaerHekV/TFCKLdfMaDyH/+vo7cC3jKTx0bndNUpWrVV6pRtvFNdUUDplCWko5h9yhJsOjbfa+/WWsSTo4vmO/Rs/Vy+NqXw/UHkr5Rp/U6OShAf8nVGxlub0OpXVUtfdh6kKM2sKEmB11VVfV/7hH+lQ==","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=s(74848),r=s(28453),o=s(33617),p=s.n(o),a=s(17543),l=s.n(a),m=s(86013),d=s.n(m),c=s(63723),u=s.n(c),x=(s(18766),s(79329),s(9303));const h={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:"eJztWc1uGzkSfpUa5rCJ0ZZkW05mdRoj4/V6N0iM2EGAjQ2B3V1SM2aTPSRbsmA0MId9gz3NdR4tT7Iosv9ky46VGeQ0F1siq4r187FYVbpljs8tm3xiP+ukzFE5y64ilqJNjCic0IpN2LNnz6DZhotVgXZyqd6jMwIXCByksA70DNJGBMTcYgpagVsVeKku1d4AdnZ+NnzmWkl2srNzqQAAdrs1cBl3wA1CUhqDyskVCAWp57SOu9IOSN4+yTtVu2dGzw1a+01Si5rZSzwgia91Xkh0mD5FXsYXCDGiAlsmCVo7K6VcQdLKWAqXAZcSDP5SCoMpWDFX3JUGw5ljOvP4pvB7Tz0Ra3quUm+S0iC1mqMB7rUQsUQv/dD7HBMp1LYGpQ1XvAKXIZQWzeBSsYjpAg0nXJymbMLm6JqgEwhYxApueI4ODYHqlimeI5uwVCeEBBYxQYAquMvYXZRdZOjhso4kp8HUSGMRaxzJJs6UGDHrVpLkW0E+ZxHDm0LqFNlkxqUlgiTDnLPJLfPnT5h1Rqg5UaoyJ9x7aHnFGjiwiLUxDCL9kaRv8Aq7qqqotU2KXLjGsl9KNKs1RRtFak1n2uR9PWs7WjVzfiNy0uxwNIoapVWZx2hYRXzcWzrZG/VUsNei+NM0ePjMUXVFcm2hlUVLtPujEf1bD2R3G6BFi/epcqgc0fOikCLxG8PPlphu7yug48+YeEgZEuNEONKgLaXr0XFjOBksHOb26/xhmdB7HxPkGu7WUNLYzv5xIq73D+Lsw7/IJzNBi9tJyJwr7GQ4rFdKIweJzkmaE257cdZ/oKtCIpR2W0soJHKLPim1N84bp2WK5nu5MmB4OwlBQ/CsVedA1lgxrU2oIqaXas2WJ8n/rH0iJH7yjs9m3wo4ozfHtjstQf2YIzaqhTkX8qvUMeJP9UKDtSLT6ivHjA9f7u8d/Phqj+iXIp2j+wP2h93t/O/wxsX6xuvL53g/LfXY25UuN1YRu9mSZ388riK22pLrFR213JLp4McqYtmWTOOXhGWfYp/g82+5U63Pq/6NcpgXkjucnod7MG3w8CiVv5QWVXqq3pn1XBJrLZGr/tH0AlURSwxyh+mRexyd+6P9g9290e7o1cXey8n475PDl4PRaPQfFrGbXHbWs5Q7ZP3kUH8vi/S7nIOKxxIvdPk08w2mwmDipqXZeLEfix0dx6XUy2muUzGr31b7+Lm+LiC9m+CJjZm8j5CWEIQFreQK+IILSXbCMkPli8UmCRNNHVOYGZ0Dh0bCwCtcOj01mAv1EELW64pzdFQOkrvof3AvkJScO5FAI8oOoCb1FtKHVFhP7DLM4XmKM15KBzFmfCG0eTHY5JYgbqpVglOhprigumrDpV1X8q1f9jUsX1mI0S2poO7pdpEJ27kvVEKt/9Z8QlS2M3pNyxHdsDs47D3hdx/E9esqFNWx06aUm+6PRtNxffHHo/H9ku49Fto4UNp1Af/hz6vp0Bi98Y3usLdZg8eMGo/G08PWqMP7Rp2qBZcihaOzU7jQ16i+r0X94104/n5MRSDy+2zN2P56MNJiUhrhVr7xutnlhdgN+5NPV1S55+gyXXdtvlNzGZuwYb+BG97WnVrFSJ5ZNH2cz0ltBWu5SmN9M9AFKqqPJI8t1RdDXojhYm9AhcNdHl4UW9Fjubsti3V8LtT8a3xXnavOKZwhYmsO62qdQvwbqdip49GnqhuuDLkvNSv6PtOeuY7SuwIVvYg+xv7wu+niI8pE5z5HUepsGL7893fP08TGg9BL+IE6+3elgUIv0VCPRXOAmcQb6vs9E+Z+z8JKlyTYIs8lWuuHHg7nhjuEVMyF49IX/0LNIeEFj4UUBGAi08RtoHcH7AA+ZugyNLT1N0OTnxQXKAn3bRpW8y7/L7W5nkm9tBFwiEsrFE1qUGVcJUTYRCECbYArQOXQFEZQT+IMaS2Cblo5wxMHOVd8jiQ7WnNVilIQVMHouLQOrJalVxkcF1LTtKQxSCGmYfhyTA2wQaBV6vcNZgSZBcK8FCnaCBKdIoQ2i0xQKcRoHRSki0jQDydKJXVy7YNH4x8oNKUPwSU9AX0did0Zriy940GXJgatwwqjqXOup0M7Ox8sUoTfCHUdxja78KnF1EeMrXB49byB/3K5vAf7F+s8J8L9s4yBkqkVTptVxz0XLitjf1X6QtovQdIJKvT46V2ETkaqE3v/5tHqMENZDM/REULs8Ojs1GfcF/Dl1//BG+RGQaaXAa1JaVCuYN4cRZ4LkQ9uaxMmzLQHXkYeTwL4aOyB1jUe/Jhx9+XX3yy8xSWN/OgKBUfu7JyVsRQJXNQ1id3ZmcBrX6+0dUo9GEu4ghjBZpygtBAcOBSBWwp1PYAjtfIzsjDyIzDQuudbM2Ot1e6PSbPuzEGnka9XLMoFWpJFj1+MgKmgksplRpfzcFpfmdo4gzMhJXwM5TrZdpSmUNTLdRXva6NOHZzRhXAZrvxk0aJyAzi7w+J3yoKeY0zJpx77mqpPCgCqtNCC5oz11LaVH3VA92Wh0GrDUj01bd0R1WLakISbWFvcrobp5J0kvp5rDc7Q0IHe7C4uhajh9KmBJRBa/wis6ammrMUTX0nUzTq9Jj/dleNfdTS5fTc7R7MQSTMqeuBGDz3xkEVMigSVxV61cHRy9gYWB4MRi3pP4xMu9/DN6evjt+fHpAwl0uCwvcFoMPI9uLYu56p30gl2g/ww//cVfpjQ333lbruq6q/fEv76LaH9LaGusWjwMCwkF77CrbvfUJ1+Ynd+Xpg0vyRcRSzT1hHJ7S1B5IORVUXLYQBORWvd9XUj8Gtc9Qb2Cy7Lunl+kLaerHekV/TFCKLdfMaDyH/+vo7cC3jKTx0bndNUpWrVV6pRtvFNdUUDplCWko5h9yhJsOjbfa+/WWsSTo4vmO/Rs/Vy+NqXw/UHkr5Rp/U6OShAf8nVGxlub0OpXVUtfdh6kKM2sKEmB11VVfV/7hH+lQ==",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={},j=[{value:"Document Types:",id:"document-types",level:3}];function f(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.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)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:0}},xml:{name:"document"},title:"document"}}},title:"inline_response_200_4"}}}},404:{description:"Report not available!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Report not available!"}},title:"inline_response_404_5"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function X(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/62b755e6.f80b7cac.js b/assets/js/62b755e6.f80b7cac.js deleted file mode 100644 index bf440086a..000000000 --- a/assets/js/62b755e6.f80b7cac.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9350],{30456:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>g,default:()=>v,frontMatter:()=>f,metadata:()=>r,toc:()=>b});const r=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":"eJztWc1uGzkSfpUa5rCJ0ZZkW05mdRpjJuvxbDAxYgcB1jYEdndJzZhN9pBsyYLRwB72DfYN9tHmSRZF9p9k2bEyg5zmYqvZ9V8fi8Xqe+b43LLJFftJJ2WOyll2E7EUbWJE4YRWbMJevHgBzWu4XBVoJ9fqAzojcIHAQQrrQM8gbURAzC2moBW4VYHX6lodDGBv7yfDZ66VZCd7e9cKAGC/WwOXcQfcICSlMaicXIFQkHpO67gr7YDkHZK8M7V/bvTcoLVfJbWomb3EI5L4o84LiQ7T58jL+AIhRlRgyyRBa2ellCtIWhlL4TLgUoLB30phMAUr5oq70mDQOSadb+8K/+65GrGm5yr1LikNUqs5GuDeChFL9NKPfcwxkULt6lDacMUrcBlCadEMrhWLmC7QcMLFWcombI6uSTqBgEWs4Ibn6NAQqO6Z4jmyCUt1QkhgERMEqIK7jG2i7DJDD5d1JDkNpkYai1gTSDZxpsSIWbeSJN8KijmLGN4VUqfIJjMuLREkGeacTe6Z1z9h1hmh5kSpypxw76HlDWvgwCLW5jCI9CrJ3hAVdlNVUeubFLlwjWe/lWhWa4Y2htSWzrTJ+3bWfrRm5vxO5GTZ8WgUNUarMo/RsIr4uPd0cjDqmWBvRfGnWfC4zlF1Q3JtoZVFS7SHoxH9W09ktxugRYuPqXKoHNHzopAi8S+Gny0x3T80QMefMfGQMiTGiaDSoC2l69FxYzg5LBzm9sv8YZnQ+xATFBru1lDS+M7+cSpuD4/i7OMvFJOZoMXdJGTOFXYyHNYrpZGDROckzQm3uzjrf9BWIRFKu50lFBK5RV+U2h3nndMyRfOtQhkwvJuEYCF41qoLIGu8mNYuVBHTS7Xmy7Pkf9a+EBI/RcdXs68FnNHbc9tpS1A/FYitZmHOhfwidYz4Q73QYK3ItPqCmvHx68ODo+/fHBD9UqRzdH/A//B2t/g7vHOxvvP28jk+LEs99nalq41VxO525Dkcj6uIrXbkekOqljsyHX1fRSzbkWn8mrDsS+wzYv41e6qNedXfUQ7zQnKH04uwD6YNHp6k8pvSokrP1HuzXktirSVy1VdNJ1AVscQgd5ieuKfReTg6PNo/GO2P3lwevJ6M/z45fj0YjUb/YhG7y2XnPUu5Q9YvDvVzWaTfRA8qHku81OXz3DeYCoOJm5Zm68Z+Knekjkupl9Ncp2JWn632ab2+LyC7m+SJrZW8j5CWEIQFreQK+IILSX7CMkPlm8WmCBNNnVOYGZ0Dh0bCwBtcOj01mAv1GELW+4oLdNQOUrjofwgvkJScO5FAI8oOoCb1HtKPVFhP7DLM4WWKM15KBzFmfCG0eTXYFpYgbqpVglOhprigvmrLpl038le/7HtYvrIQo1tSQ92z7TITtgtf6ITa+K3FhKhs5/SalSPaYRs47B3hmwfi+nYVivrYadPKTQ9Ho+m43vjj0fhhS/cBC20cKO26hH/35/V0aIzeekZ32NtuwVNOjUfj6XHr1PFDp87UgkuRwsn5GVzqW1Tf1qO+ehfUP8ypCET+PVtztr8enLSYlEa4lb943e3zQuyH95OrG+rcc3SZrm9t/qbmMjZhw/4Fbnhf39QqRvLMornH+ZrUdrCWqzTWdwNdoKL+SPLYUn8x5IUYLg4G1Dhs8vCi2Ikey/1dWazjc6HmX+K76UJ1QekMGVsLWNfrFOKfSM1OnY8+VX3hypD7VrOi55n2zHWW3heo6ET0OfbKN8vFJ5SJzn2NotLZMPz+n/95niY3HoRewnd0s39fGij0Eg3dsWgOMJN4R/d+z4S5f2dhpUsSbJHnEq31Qw+Hc8MdQirmwnHpm3+h5pDwgsdCCgIwkWniNtDbA3YAnzJ0GRp69TdDk58UFygJ920ZVvOu/i+1uZ1JvbQRcIhLKxRNalBlXCVE2GQhAm2AK0Dl0BRG0J3EGbJaBNu0coYnDnKu+BxJdrQWqhSlIKiC0XFpHVgtS28yOC6kpmlJ45BCTMPw5S1dgA0CrdJ932BGkFkgzEuRoo0g0SlCuGaRCyqFGK2DgmwRCfrhRKmkTm598mj8A4Wm8iG4pCOgbyOxO8OVpXM82NLkoA1YYTTdnOvp0N7eR4uU4XdC3YaxzT5ctZj6hLEVDm9eNvBfLpcPYP9qnedUuJ/LGKiYWuG0WXXcc+GyMvZbpS+kfQiSTlGhx09vI3QyUp3YhzuPVocZymJ4gY4QYocn52e+4r6C3//9X3iH3CjI9DKgNSkNyhXMG1UUuZD5ELa2YMJMe+BlFPEkgI/GHmhdG0Hf69GwjzZPHcPzMpYiaZuRCZxAsb4ECVcQY9u+kAk24wSkheB+5KluB3CiVn40FiZ9hAFa98yBMzBS5HmXZd8LCTeAn/WSuorIy7DERscbpsJ5Wa0xwlmUs4E33eBMSAmhC59sPFs/EMQ8xjTFlLzuqY1xRnAXLrQVyvcVXjP1JLjyvF07J0IzN9PUVlJkUaWFFjRArMex7ZAu6pR4t4VWW5bqcWjrVlSLaZ7rLbaRCTsAP3fcKM/rVdTgDA1p9FuyA04haqBcNYADwuEfASwdwlSPeOJ7hPoaTufED5ty/HmNJrfvZxdoFiJphkCP7NWhJx6yiEmRoLLY6wNOTs/fwQKOBiMW9U69Z+zb4buzH9/+evGWrKEaGSJ2MBgNRv56ra3LueqpOsVuRh9G+x6wYfi+eYDddw3TX58J/vpM0H4mqNsnmikMC8mFb17ri21oPK/YxpeDSfOR4CZimbaOSO7vCSIfjawqWg6zbepH6wtdN92+xVVvFr/gsqzvxY/S1kPzjvSGHowg2u06HkX+yw915l7Bc75ibA1O03CqVd+oxtgmNtUNzY5Cx0k2hrcnSYJF3+8HV5e1/v/07SXz1+9svdO99Z1u/YOkb7VpvQUOBtBfCvVWhvv70EVXVUsfXj3KUTvYUFOAbqqq+j/spO9O","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"}}');var s=n(74848),i=n(28453),o=n(33617),l=n.n(o),a=n(17543),m=n.n(a),p=n(86013),d=n.n(p),c=n(63723),u=n.n(c),h=(n(18766),n(79329),n(9303));const f={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:"eJztWc1uGzkSfpUa5rCJ0ZZkW05mdRpjJuvxbDAxYgcB1jYEdndJzZhN9pBsyYLRwB72DfYN9tHmSRZF9p9k2bEyg5zmYqvZ9V8fi8Xqe+b43LLJFftJJ2WOyll2E7EUbWJE4YRWbMJevHgBzWu4XBVoJ9fqAzojcIHAQQrrQM8gbURAzC2moBW4VYHX6lodDGBv7yfDZ66VZCd7e9cKAGC/WwOXcQfcICSlMaicXIFQkHpO67gr7YDkHZK8M7V/bvTcoLVfJbWomb3EI5L4o84LiQ7T58jL+AIhRlRgyyRBa2ellCtIWhlL4TLgUoLB30phMAUr5oq70mDQOSadb+8K/+65GrGm5yr1LikNUqs5GuDeChFL9NKPfcwxkULt6lDacMUrcBlCadEMrhWLmC7QcMLFWcombI6uSTqBgEWs4Ibn6NAQqO6Z4jmyCUt1QkhgERMEqIK7jG2i7DJDD5d1JDkNpkYai1gTSDZxpsSIWbeSJN8KijmLGN4VUqfIJjMuLREkGeacTe6Z1z9h1hmh5kSpypxw76HlDWvgwCLW5jCI9CrJ3hAVdlNVUeubFLlwjWe/lWhWa4Y2htSWzrTJ+3bWfrRm5vxO5GTZ8WgUNUarMo/RsIr4uPd0cjDqmWBvRfGnWfC4zlF1Q3JtoZVFS7SHoxH9W09ktxugRYuPqXKoHNHzopAi8S+Gny0x3T80QMefMfGQMiTGiaDSoC2l69FxYzg5LBzm9sv8YZnQ+xATFBru1lDS+M7+cSpuD4/i7OMvFJOZoMXdJGTOFXYyHNYrpZGDROckzQm3uzjrf9BWIRFKu50lFBK5RV+U2h3nndMyRfOtQhkwvJuEYCF41qoLIGu8mNYuVBHTS7Xmy7Pkf9a+EBI/RcdXs68FnNHbc9tpS1A/FYitZmHOhfwidYz4Q73QYK3ItPqCmvHx68ODo+/fHBD9UqRzdH/A//B2t/g7vHOxvvP28jk+LEs99nalq41VxO525Dkcj6uIrXbkekOqljsyHX1fRSzbkWn8mrDsS+wzYv41e6qNedXfUQ7zQnKH04uwD6YNHp6k8pvSokrP1HuzXktirSVy1VdNJ1AVscQgd5ieuKfReTg6PNo/GO2P3lwevJ6M/z45fj0YjUb/YhG7y2XnPUu5Q9YvDvVzWaTfRA8qHku81OXz3DeYCoOJm5Zm68Z+Knekjkupl9Ncp2JWn632ab2+LyC7m+SJrZW8j5CWEIQFreQK+IILSX7CMkPlm8WmCBNNnVOYGZ0Dh0bCwBtcOj01mAv1GELW+4oLdNQOUrjofwgvkJScO5FAI8oOoCb1HtKPVFhP7DLM4WWKM15KBzFmfCG0eTXYFpYgbqpVglOhprigvmrLpl038le/7HtYvrIQo1tSQ92z7TITtgtf6ITa+K3FhKhs5/SalSPaYRs47B3hmwfi+nYVivrYadPKTQ9Ho+m43vjj0fhhS/cBC20cKO26hH/35/V0aIzeekZ32NtuwVNOjUfj6XHr1PFDp87UgkuRwsn5GVzqW1Tf1qO+ehfUP8ypCET+PVtztr8enLSYlEa4lb943e3zQuyH95OrG+rcc3SZrm9t/qbmMjZhw/4Fbnhf39QqRvLMornH+ZrUdrCWqzTWdwNdoKL+SPLYUn8x5IUYLg4G1Dhs8vCi2Ikey/1dWazjc6HmX+K76UJ1QekMGVsLWNfrFOKfSM1OnY8+VX3hypD7VrOi55n2zHWW3heo6ET0OfbKN8vFJ5SJzn2NotLZMPz+n/95niY3HoRewnd0s39fGij0Eg3dsWgOMJN4R/d+z4S5f2dhpUsSbJHnEq31Qw+Hc8MdQirmwnHpm3+h5pDwgsdCCgIwkWniNtDbA3YAnzJ0GRp69TdDk58UFygJ920ZVvOu/i+1uZ1JvbQRcIhLKxRNalBlXCVE2GQhAm2AK0Dl0BRG0J3EGbJaBNu0coYnDnKu+BxJdrQWqhSlIKiC0XFpHVgtS28yOC6kpmlJ45BCTMPw5S1dgA0CrdJ932BGkFkgzEuRoo0g0SlCuGaRCyqFGK2DgmwRCfrhRKmkTm598mj8A4Wm8iG4pCOgbyOxO8OVpXM82NLkoA1YYTTdnOvp0N7eR4uU4XdC3YaxzT5ctZj6hLEVDm9eNvBfLpcPYP9qnedUuJ/LGKiYWuG0WXXcc+GyMvZbpS+kfQiSTlGhx09vI3QyUp3YhzuPVocZymJ4gY4QYocn52e+4r6C3//9X3iH3CjI9DKgNSkNyhXMG1UUuZD5ELa2YMJMe+BlFPEkgI/GHmhdG0Hf69GwjzZPHcPzMpYiaZuRCZxAsb4ECVcQY9u+kAk24wSkheB+5KluB3CiVn40FiZ9hAFa98yBMzBS5HmXZd8LCTeAn/WSuorIy7DERscbpsJ5Wa0xwlmUs4E33eBMSAmhC59sPFs/EMQ8xjTFlLzuqY1xRnAXLrQVyvcVXjP1JLjyvF07J0IzN9PUVlJkUaWFFjRArMex7ZAu6pR4t4VWW5bqcWjrVlSLaZ7rLbaRCTsAP3fcKM/rVdTgDA1p9FuyA04haqBcNYADwuEfASwdwlSPeOJ7hPoaTufED5ty/HmNJrfvZxdoFiJphkCP7NWhJx6yiEmRoLLY6wNOTs/fwQKOBiMW9U69Z+zb4buzH9/+evGWrKEaGSJ2MBgNRv56ra3LueqpOsVuRh9G+x6wYfi+eYDddw3TX58J/vpM0H4mqNsnmikMC8mFb17ri21oPK/YxpeDSfOR4CZimbaOSO7vCSIfjawqWg6zbepH6wtdN92+xVVvFr/gsqzvxY/S1kPzjvSGHowg2u06HkX+yw915l7Bc75ibA1O03CqVd+oxtgmNtUNzY5Cx0k2hrcnSYJF3+8HV5e1/v/07SXz1+9svdO99Z1u/YOkb7VpvQUOBtBfCvVWhvv70EVXVUsfXj3KUTvYUFOAbqqq+j/spO9O",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,x={},b=[{value:"Document Types:",id:"document-types",level:3}];function y(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,s.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,s.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,s.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(m(),{parameters:[{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:0}},xml:{name:"document"},title:"document"}}},title:"inline_response_200_4"}}}},404:{description:"Report not available!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Report not available!"}},title:"inline_response_404_5"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.1dc1445c.js b/assets/js/6d2e526e.1dc1445c.js deleted file mode 100644 index a9beec2d3..000000000 --- a/assets/js/6d2e526e.1dc1445c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5752],{50839:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>R,frontMatter:()=>h,metadata:()=>n,toc:()=>k});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":"eJy9V+Fu5LYRfpUJ/zR3kHfXPidF9atOcrgzesgZZwcH1LcwKHEkMaZIhqR2vVgI6I++Qd+gj5YnKYaUdrVrn5tD0/yxV+TMcOabj8OZLQu89iy/ZT+YsmtRB8+WGRPoSydtkEaznN00CB9wZe4RxCAFF1eXwJUyaw8b00Ew4JKEt1jKSpZ70cqZloTcbsnPWMaMRcfphEvBcpa0RwGWMcsdbzGgI++2TPMWWc5GgTspWMYkeWd5aNixy1fOrKRAMMXPWIZLAabaO7RzlmXM4S+ddChYHlyHGfNho+ggL1urSAAfrDICWV5x5UmgbLDlLN+ysLFRMjipa5axyriWh+kKPvBoJWe2OSuaM+4F6/tlOhV9+M6IDVkqjQ4Udb5l3Foly4jL/GdPsWwfH5miIpAcoRgketp1yAeNY9f2jrC+z1iQIX4cgd73tOnQW6N9Mnm2WNC/Q3BHqgwoCvBdWaL3VafU5iuW/V7xjMl7PqLvHghY+9a+YtH76NJFeF7pbHH26uR0cbL4883pt/n5X/Jvvp0tFou/s4w9tIp0R8LxgGwCWfruj8UGPj3CdsD0/CkYr02LoZG6hjWBuXZG1xlYhdwjBLcBXnOpQfGA7ndEFZ0z7nl0vsyzKaOkVlLj3cihu/PF4u50B8L5M1zSJkBlOi3+2FCfOv/5gM7vXu0C+uZxQJd6xZUUsUDemHvUf2w80+NDOv4xW2USivvsINjpegrSY9k5GTaxCj+ccCtP0n5+u6RSRkwxVMGt8aluh4blbD5Wlfl2UrN7RgbdaqzqnVMsZ00I1ufzuedaFOZhZixqL2uteOFnpWnn3Mr56nR2yvrsWIdb+0Xy2J18qYoPvJa6/m96yz1W15TPlLIDxHaJ41b+DTcsGxMylRqetQa5QBeTRzT5sH8xXo/J3ld8RlmUujLxjCGb7y3qa1nryIXo4/Er+RFVaVqkBzE0CKPCr//8d9QZExfJGi189Ul/0u87B9as0VWdAq4FVAofZKEwKmEb93ZtgUfeKvRebUDqgLXjAUHIWgaugKCkMlNyywupJBGdxEzqFyZ3xc/gY4OhQUdbf3IIHASuUNH9AN4F0/JApnav/Nq4+4oalAw4FJ2XGr0H1A3XJQmOycrAOOAaUAd01kmP4IMjr2XyzejgeBmg5ZrXSLazA6gEKkmMBmeKzgfwRnXRZQhcKuNQwBiQRhR+RiC+prbCIdBqaVrrsCFmrRDqTgr0GZRGIPiYagpBCyjQB7DkiyzRk9FOK1Pex+TR4wvWUJmRXFG/M/WR1IPj2lOTMjRjQw52gFln6BXH5ODLlz95pAy/k/re5y9fftIncLvj1EcsvAy4/Hq8Jev1+tHteHGo80aGt10BH9AaL4Nxm712LUPTFfFGTY3sPpKlN6gx8mdyX/Y2hCn94wtKq/MGlZ1fYyCG+PnF1WWszC/g13/8C94hdxoas05sLTuHagP1eBQhlzKfYNsVVqhMJF5DiJeJfENft0PQUrsAMl2eAcOrrlCyhICtpQc0hwuwh0tQcg0FQumQBxTRBd9wItJKcuCgpL6fwYXeQOfRwVqGJnKA1qNy0kyKhDw/6sZlmMFbs8YVuiza8KRGTyAKGaKtnTMyeFTVLLrusJJKwVqKGkN+9O2BOwRsCxQCBUU9ObbAiuguA0gPfujC48kzuGlwE3X5ikvFqZJInUhtaMQgZFELa6QOPgfheBX2s0S2PySGLY1+YimBxHdhZYOZ8Xu4YkeZ8DP4RBX5qIofVlGHFcbZJl7JPXGsHIhyOxIOiIf/C2GpzFM94mXsJbDlUqXn5K/HduK7jq7176trdCtZ4vCkfeauzqPwnGVMyRK1x0m/cPHm6h2s4NVswbLJ4/gb7u383eX3r3+8fk3eUI1MiJ3OFrMFLVHP0HI9OWqYM3/YD4IHYE9mpf/TWDq80AEfwtwqLmODFGPeDr3NLZuMqfl0Il1mrKEuKL9l223BPf7kVN/T8i8dOmqhlhlbcSeJ47EBEtLTb7EbLz8b7dcfhkn1Bfzm4fbJWMYWRFP/seKqi2Nhxu5xczRg98s+G/sQcjZJfJ9cOrkhO3sLj/paaqSSxkVZog3Pyk4byav31zcsY8UwHLdx+maOr2lc5+vkrYkQpbGX1rZMcV13vCbZZJNaJ6rPh33Xfey7hh8U1ZN4HDZkKQz6S0E9qbDdpp6u73fyaeuzGgOwozQlZ9n3/X8AnecsmQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"}}');var s=o(74848),a=o(28453),c=o(33617),r=o.n(c),i=o(17543),d=o.n(i),l=o(86013),u=o.n(l),p=o(63723),m=o.n(p),f=(o(18766),o(79329),o(9303));const h={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:"eJy9V+Fu5LYRfpUJ/zR3kHfXPidF9atOcrgzesgZZwcH1LcwKHEkMaZIhqR2vVgI6I++Qd+gj5YnKYaUdrVrn5tD0/yxV+TMcOabj8OZLQu89iy/ZT+YsmtRB8+WGRPoSydtkEaznN00CB9wZe4RxCAFF1eXwJUyaw8b00Ew4JKEt1jKSpZ70cqZloTcbsnPWMaMRcfphEvBcpa0RwGWMcsdbzGgI++2TPMWWc5GgTspWMYkeWd5aNixy1fOrKRAMMXPWIZLAabaO7RzlmXM4S+ddChYHlyHGfNho+ggL1urSAAfrDICWV5x5UmgbLDlLN+ysLFRMjipa5axyriWh+kKPvBoJWe2OSuaM+4F6/tlOhV9+M6IDVkqjQ4Udb5l3Foly4jL/GdPsWwfH5miIpAcoRgketp1yAeNY9f2jrC+z1iQIX4cgd73tOnQW6N9Mnm2WNC/Q3BHqgwoCvBdWaL3VafU5iuW/V7xjMl7PqLvHghY+9a+YtH76NJFeF7pbHH26uR0cbL4883pt/n5X/Jvvp0tFou/s4w9tIp0R8LxgGwCWfruj8UGPj3CdsD0/CkYr02LoZG6hjWBuXZG1xlYhdwjBLcBXnOpQfGA7ndEFZ0z7nl0vsyzKaOkVlLj3cihu/PF4u50B8L5M1zSJkBlOi3+2FCfOv/5gM7vXu0C+uZxQJd6xZUUsUDemHvUf2w80+NDOv4xW2USivvsINjpegrSY9k5GTaxCj+ccCtP0n5+u6RSRkwxVMGt8aluh4blbD5Wlfl2UrN7RgbdaqzqnVMsZ00I1ufzuedaFOZhZixqL2uteOFnpWnn3Mr56nR2yvrsWIdb+0Xy2J18qYoPvJa6/m96yz1W15TPlLIDxHaJ41b+DTcsGxMylRqetQa5QBeTRzT5sH8xXo/J3ld8RlmUujLxjCGb7y3qa1nryIXo4/Er+RFVaVqkBzE0CKPCr//8d9QZExfJGi189Ul/0u87B9as0VWdAq4FVAofZKEwKmEb93ZtgUfeKvRebUDqgLXjAUHIWgaugKCkMlNyywupJBGdxEzqFyZ3xc/gY4OhQUdbf3IIHASuUNH9AN4F0/JApnav/Nq4+4oalAw4FJ2XGr0H1A3XJQmOycrAOOAaUAd01kmP4IMjr2XyzejgeBmg5ZrXSLazA6gEKkmMBmeKzgfwRnXRZQhcKuNQwBiQRhR+RiC+prbCIdBqaVrrsCFmrRDqTgr0GZRGIPiYagpBCyjQB7DkiyzRk9FOK1Pex+TR4wvWUJmRXFG/M/WR1IPj2lOTMjRjQw52gFln6BXH5ODLlz95pAy/k/re5y9fftIncLvj1EcsvAy4/Hq8Jev1+tHteHGo80aGt10BH9AaL4Nxm712LUPTFfFGTY3sPpKlN6gx8mdyX/Y2hCn94wtKq/MGlZ1fYyCG+PnF1WWszC/g13/8C94hdxoas05sLTuHagP1eBQhlzKfYNsVVqhMJF5DiJeJfENft0PQUrsAMl2eAcOrrlCyhICtpQc0hwuwh0tQcg0FQumQBxTRBd9wItJKcuCgpL6fwYXeQOfRwVqGJnKA1qNy0kyKhDw/6sZlmMFbs8YVuiza8KRGTyAKGaKtnTMyeFTVLLrusJJKwVqKGkN+9O2BOwRsCxQCBUU9ObbAiuguA0gPfujC48kzuGlwE3X5ikvFqZJInUhtaMQgZFELa6QOPgfheBX2s0S2PySGLY1+YimBxHdhZYOZ8Xu4YkeZ8DP4RBX5qIofVlGHFcbZJl7JPXGsHIhyOxIOiIf/C2GpzFM94mXsJbDlUqXn5K/HduK7jq7176trdCtZ4vCkfeauzqPwnGVMyRK1x0m/cPHm6h2s4NVswbLJ4/gb7u383eX3r3+8fk3eUI1MiJ3OFrMFLVHP0HI9OWqYM3/YD4IHYE9mpf/TWDq80AEfwtwqLmODFGPeDr3NLZuMqfl0Il1mrKEuKL9l223BPf7kVN/T8i8dOmqhlhlbcSeJ47EBEtLTb7EbLz8b7dcfhkn1Bfzm4fbJWMYWRFP/seKqi2Nhxu5xczRg98s+G/sQcjZJfJ9cOrkhO3sLj/paaqSSxkVZog3Pyk4byav31zcsY8UwHLdx+maOr2lc5+vkrYkQpbGX1rZMcV13vCbZZJNaJ6rPh33Xfey7hh8U1ZN4HDZkKQz6S0E9qbDdpp6u73fyaeuzGgOwozQlZ9n3/X8AnecsmQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},k=[];function v(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Revoke Document"}),"\n",(0,s.jsx)(r(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,s.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document revoked successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},revokedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"revoke"},title:"revoke"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function R(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/6d2e526e.89e61fc0.js b/assets/js/6d2e526e.89e61fc0.js new file mode 100644 index 000000000..bfe6a7315 --- /dev/null +++ b/assets/js/6d2e526e.89e61fc0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5752],{50839:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>f,default:()=>g,frontMatter:()=>v,metadata:()=>n,toc:()=>D});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":"eJy9V81u3DYQfpUpL20MeXftuCmqU900SI0GiRE7MFBnYVDSSGJNkSxJ7XqxENBD36CnXvtoeZJiSGlXu3bcBv252KvhzHDmm+H8rJnnlWPpNftO522Dyjs2T1iBLrfCeKEVS9lljfAWF/oWoei54PT8DLiUeulgpVvwGmzkcAZzUYp8y1pa3RCT3ZDchCVMG7ScbjgrWMqi9MDAEma45Q16tGTdmineIEvZwHAjCpYwQdYZ7mu2b/K51QtRIOjsJ8z9WQG63Bq0MZYlzOLPrbBYsNTbFhPm/ErSRU40RhID3hmpC2RpyaUjhrzGhrN0zfzKBE5vhapYwkptG+7HFLzjQUvKTH2c1cfcFazr5vFWdP5bXaxIU66VJ6/TNePGSJEHXKY/OfJlff/K6BWBZAlFL9DRqUXeS+ybtjWEdV3CvPDhYw/0rqNDi85o5aLK49mM/u2CO6RKj2IBrs1zdK5spVx9xpJ/y58heI979O0dAWu+N09ZsD6YdOofFzqeHT89PJodzr66PHqWnnydfvlsMpvNfmQJu2skyQ4Jxz2yEWTxu9tn6/PpHrY9picPwXihG/S1UBUsCcyl1apKwEjkDsHbFfCKCwWSe7T/IqporbaPo/Nplo0zSigpFN4MOXRzMpvdHG1AOHkkl5T2UOpWFf+vqw/d/7hDJzdPNw59ed+hM7XgUhShQF7qW1T/rz/j6328/n62isgUztmOs2N6dNJh3lrhV6EK3x1yIw7jeXo9p1JGmaKpghvtYt32NUvZdKgq0/WoZneMFNrFUNVbK1nKau+NS6dTx1WR6buJNqicqJTkmZvkuplyI6aLo8kR65J9GW7MJ/Fje/ipIs7zSqjqr+TmW6wuKJ4xZDuIbQLHjfgBVywZAjLm6ttajbxAG4JHafJ22zFeDMHeVnxGURSq1OGOPppvDKoLUamQC8HG/S55hTLXDVJD9DXCIPDh1z+CzBC4kKxBw2fv1Xv1prVg9BJt2UrgqoBS4p3IJAYhbMLZZixwyBuJzskVCOWxstwjFKISnksgKKnM5NzwTEhBiU5sOs4Lo7fiJnBVo6/R0tHnFoFDgQuU9D6At1433JOqTZdfantb0oCSAIesdUKhc4Cq5ionxiFYCWgLXAEqj9ZY4RCct2S1iLZp5S3PPTRc8QpJd7IDVYFSUEaD1VnrPDgt22AyeC6ktljA4JBCLNyEQHxBY4VFIGquG2OxpsxaIFStKNAlkOsCwYVQkwuqgAydB0O2iBwdKW2V1PltCB41XzCayozgkuadsY0k7i1XjoaUfhjrY7ABzFhNXRyjgQcH7xxShF8JdevSg4P36hCuNzl1hZkTHudfDK9kuVzeex1PdmVeCv99m8FbNNoJr+1qK10JX7dZeFFjJZuPqOklKgz5M3ovWx2Fzt39B0rUaY3STC/QU4a46en5WajMT+DDL7/BK+RWQa2XMVvz1qJcQTVcRcjFyEfYNoUVSh0SrybE85h8/Vw3IHhVc//hl98dvMYliPiEIpAHB+dtJkUOl9gY6qPu4CCF5xbpSj/QwNfcQ84VZAiu5pRKC8GBg4nSUqjbCZyqFbQOLSyFr0MyED3I7bhBuGxncMi4wwK0ChLDnZOtRURvHMoFOtJFDTJDwEJ4yuja6raKt42N6Z2zWAop4UoUFfrg22lRgOnJy0gmwEfmYEkPwte4Am4RHCo/gfM9kXDSGqMtWSGi8aWmTYQCgKowWijvUigsL/1Wf7JN9JxgFlo9QIoQ8g0cSa9mE5L4EnuPN9TJe6rbe7V+t9ZaLDFsQMHtbVyM6NPpekhLoGz9J2lNzYCqFs/DxIENFzI2nW/29YTuj7Zxb8oLtAuRY9/4PvKip4F5yhImRY7K4WiqOH15/goWTyczlow66N943NNXZ89fvL54QcZQIY2AHU1mkxmRaLBouBrd1C+j3223xR2sRwvVf7S79m3c452fGslFmKKCz+t+ALpmo102Ha+t84TVNCql12y9pjf4zsquI/LPLVqas+YJW3AreEZt/HrNCuHod7HZQT/q7Rdv+3X2CfztDfhBX4Y5RdGQsuCyDbtjwm5xtbeFd/MuGYYVMjZyPI8mHV6Snq2Ge8MvTVtR4jTP0fhHecfT5vmbi0uWsKzfoJuwojPLl7TT82W0VgeI4m5MtDWTXFUtr4g36qT5ior47nB2G4az/gd59SAeu1NbdIP+klMPCqzXcfDrug1/PPqoRA/swE3BmXdd9yc+jTvg","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/v1.1/deletedocument"}}');var s=o(74848),i=o(28453),r=o(33617),d=o.n(r),p=o(17543),a=o.n(p),c=o(86013),u=o.n(c),l=o(63723),m=o.n(l),h=(o(18766),o(79329),o(9303));const v={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u3DYQfpUpL20MeXftuCmqU900SI0GiRE7MFBnYVDSSGJNkSxJ7XqxENBD36CnXvtoeZJiSGlXu3bcBv252KvhzHDmm+H8rJnnlWPpNftO522Dyjs2T1iBLrfCeKEVS9lljfAWF/oWoei54PT8DLiUeulgpVvwGmzkcAZzUYp8y1pa3RCT3ZDchCVMG7ScbjgrWMqi9MDAEma45Q16tGTdmineIEvZwHAjCpYwQdYZ7mu2b/K51QtRIOjsJ8z9WQG63Bq0MZYlzOLPrbBYsNTbFhPm/ErSRU40RhID3hmpC2RpyaUjhrzGhrN0zfzKBE5vhapYwkptG+7HFLzjQUvKTH2c1cfcFazr5vFWdP5bXaxIU66VJ6/TNePGSJEHXKY/OfJlff/K6BWBZAlFL9DRqUXeS+ybtjWEdV3CvPDhYw/0rqNDi85o5aLK49mM/u2CO6RKj2IBrs1zdK5spVx9xpJ/y58heI979O0dAWu+N09ZsD6YdOofFzqeHT89PJodzr66PHqWnnydfvlsMpvNfmQJu2skyQ4Jxz2yEWTxu9tn6/PpHrY9picPwXihG/S1UBUsCcyl1apKwEjkDsHbFfCKCwWSe7T/IqporbaPo/Nplo0zSigpFN4MOXRzMpvdHG1AOHkkl5T2UOpWFf+vqw/d/7hDJzdPNw59ed+hM7XgUhShQF7qW1T/rz/j6328/n62isgUztmOs2N6dNJh3lrhV6EK3x1yIw7jeXo9p1JGmaKpghvtYt32NUvZdKgq0/WoZneMFNrFUNVbK1nKau+NS6dTx1WR6buJNqicqJTkmZvkuplyI6aLo8kR65J9GW7MJ/Fje/ipIs7zSqjqr+TmW6wuKJ4xZDuIbQLHjfgBVywZAjLm6ttajbxAG4JHafJ22zFeDMHeVnxGURSq1OGOPppvDKoLUamQC8HG/S55hTLXDVJD9DXCIPDh1z+CzBC4kKxBw2fv1Xv1prVg9BJt2UrgqoBS4p3IJAYhbMLZZixwyBuJzskVCOWxstwjFKISnksgKKnM5NzwTEhBiU5sOs4Lo7fiJnBVo6/R0tHnFoFDgQuU9D6At1433JOqTZdfantb0oCSAIesdUKhc4Cq5ionxiFYCWgLXAEqj9ZY4RCct2S1iLZp5S3PPTRc8QpJd7IDVYFSUEaD1VnrPDgt22AyeC6ktljA4JBCLNyEQHxBY4VFIGquG2OxpsxaIFStKNAlkOsCwYVQkwuqgAydB0O2iBwdKW2V1PltCB41XzCayozgkuadsY0k7i1XjoaUfhjrY7ABzFhNXRyjgQcH7xxShF8JdevSg4P36hCuNzl1hZkTHudfDK9kuVzeex1PdmVeCv99m8FbNNoJr+1qK10JX7dZeFFjJZuPqOklKgz5M3ovWx2Fzt39B0rUaY3STC/QU4a46en5WajMT+DDL7/BK+RWQa2XMVvz1qJcQTVcRcjFyEfYNoUVSh0SrybE85h8/Vw3IHhVc//hl98dvMYliPiEIpAHB+dtJkUOl9gY6qPu4CCF5xbpSj/QwNfcQ84VZAiu5pRKC8GBg4nSUqjbCZyqFbQOLSyFr0MyED3I7bhBuGxncMi4wwK0ChLDnZOtRURvHMoFOtJFDTJDwEJ4yuja6raKt42N6Z2zWAop4UoUFfrg22lRgOnJy0gmwEfmYEkPwte4Am4RHCo/gfM9kXDSGqMtWSGi8aWmTYQCgKowWijvUigsL/1Wf7JN9JxgFlo9QIoQ8g0cSa9mE5L4EnuPN9TJe6rbe7V+t9ZaLDFsQMHtbVyM6NPpekhLoGz9J2lNzYCqFs/DxIENFzI2nW/29YTuj7Zxb8oLtAuRY9/4PvKip4F5yhImRY7K4WiqOH15/goWTyczlow66N943NNXZ89fvL54QcZQIY2AHU1mkxmRaLBouBrd1C+j3223xR2sRwvVf7S79m3c452fGslFmKKCz+t+ALpmo102Ha+t84TVNCql12y9pjf4zsquI/LPLVqas+YJW3AreEZt/HrNCuHod7HZQT/q7Rdv+3X2CfztDfhBX4Y5RdGQsuCyDbtjwm5xtbeFd/MuGYYVMjZyPI8mHV6Snq2Ge8MvTVtR4jTP0fhHecfT5vmbi0uWsKzfoJuwojPLl7TT82W0VgeI4m5MtDWTXFUtr4g36qT5ior47nB2G4az/gd59SAeu1NbdIP+klMPCqzXcfDrug1/PPqoRA/swE3BmXdd9yc+jTvg",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={},D=[];function J(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:"Revoke Document"}),"\n",(0,s.jsx)(d(),{method:"post",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Revoke document API allows you to revoke specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to revoke",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,s.jsx)(u(),{title:"Body",body:{content:{"application/json":{schema:{type:"object",properties:{reason:{type:"string",example:""}},title:"revokedocument"}}}}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document revoked successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},revokedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"revoke"},title:"revoke"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(J,{...e})}):J(e)}}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.49c09fa4.js b/assets/js/7357a3c5.49c09fa4.js deleted file mode 100644 index 98e23a85a..000000000 --- a/assets/js/7357a3c5.49c09fa4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1665],{13980:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>g,contentTitle:()=>S,default:()=>P,frontMatter:()=>f,metadata:()=>o,toc:()=>x});const o=JSON.parse('{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/v1.1/getfolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getfolder","permalink":"/docs/API-docs/v1.1/getfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar_label":"Get Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V91u3LYSfpUpb9oE8u7adfqjq2MUOY5Pg8SoXQSoszAoaSQxpkiWHO16sRBwLs4b9A36aH2SYqhdrXbt5ByfFrmxVyRn+M3MR87HtSBZBZHeiH9aXaAX80QUGHKvHClrRCqua4RzJOjn4ezyAqTWdhlgZVsgCx7JK1wgFEhS6QAysy2BhOAwV6XKoYymE5EI69BLdnxRiFRUSP2USISTXjZI6BnMWhjZoEhFP32rCpEIxWicpFocQrTZB8zpogBbwuDQ46+t8liIlHyLiQi00uwyqMZpFInAe6dtgSItpQ68IK+xkSJdC1q5uJK8MpVIRGl9I2k8gvcyekmFe3Wc1flJ7TLRdXPeNjhrAgZ2dDKb8b99tKHNcwyhbDUM6RCJyK0hNMTrpXNa5XFi+iGw0fohuj5ozpxnN6T6Lbe5eHIc9XFW3598cKJLNml/E2vwNDcGl9sSdLGoaKhnztMh/evEyPDiTl3ioa//F1losxG63KMkLM7oMVc7w5PZyddHx7Oj2bfXx9+kp9+nL76ZzGazX0Qi7hvNthuyFpIiUlKkx9+tKz7DPqOBzanxGETX8cTpYzy8sg1SrUwFSzQES29NlYDTKAMC+RXISioDWhL6L/4+gqL31n86E09DNo5cGa0M3m4P4e3pbHZ7PCTh9GES+lSBsQSlbU0x+QyBfoqlD/F8OrzT2++G8F48DO/CLKRWRby1r+0dms9byPH21G/PUPfprPpFcV7sBTse74MMmLde0Sr2iPsj6dRRP5/ezPn2Zd7YTWuJTYVqkYppn9XpemgnnWBffrFtN63XIhU1kQvpdBqkKTJ7P7EOTVCV0TILk9w2U+nUdHE8ORZdcmgjnXvSemyPnmoSSFbKVP/Nbr5L0xWXsq/WXrKGmkmnfsSVSLa1GK/adNwaZbwvO/4ubTTeVOitQ3OlKhPrGzc/7MzvUOe2QZYJVCNsDf74z+/RprB526ChSMDo4Yv35r1523pwdomee6Q0BZQa71WmMRphE+cG/RFQNhpD0CtQhrDykhAKVSmSGjhHfJHk0slMacXk5WWWrT2M+B8m8K5GqtHz1JceQUKBC9TMeZAt2UYSu9qChqX1dyUroQQkZG1QBkMANLU0OS/cViEB60EaQEPonVcBIZBn1KrHZg15mRM00sgK2Xeyl6oCtWKqgrdZGwiC1W2EDCy4rMcCtgEZxCJMOIkvWd54BB7NbeM81kyZBULVqgJDArktEEI8qxyCKSDDQOAYi8oxsNPWaJvfxeKVrdbgLF8dSmrWWmOMbE5emsC3W49lW4MhYc5bVj7YA3z+/OeAXOHXytyF9Pnz9+YIbgZOvcMsKML5V1v6L5fLB7R/tm9zruhVm8FP6GxQZP1qZ10pqtssHpWxk+Gj93SOBiN/Rgdh56OweXh48nh0WqN20yskZkiYnl1exNv2Gfzx79/gNUpvoLbLnq1561GvoNpuxZnrK9+nbbgsobSReDVnPO/Jx6oWAw0ZjNICVH94Njm8bDOtciBsHLfIFM7A7Q9BLg1kCBsFFCGEWjKRFkqCBK3M3QTOzAragB6WiurIAR6Pxr1lb8iZl7sql942oGgCr+wSF+iT6COwGbc1LBRFXwMYRQF1OYnQPZZKa1iqokJKD74DSI+ATYZFgQVHPdo2w5LprghUgMAjTF/eeQLXNa6irVxIpSXfJMr0pLb8luHMoimcVYZCCoWXJQ2eQ7LbJIatrHlkqE+SHMJKNm6235sjdlCJMIH3fNUeXM/7t6jHEj3vGI/kjjhObYhysyUcMA//CmGjLraGZB71ATZS6b5P/OPQT+zV6JvwtrxCv1A5bnrVR87qNC6eikRolaMJONIAZ+eXr2EBX09mIhl1vf/h3E5fX/zw8s3VS0bDd2SfsePJbDKLrwYbqJFmtNXuLXvYrdY7ZfT3vno3zZbwnqZOSxVlToxyvZEoN2J4t6a7N+88EbUNxNPrdSYD/ux11/Hwry16FkHzRCykV8zoqGMKFfh3MTxqPxrgVz9t3sfP4NHn86OYt6rBsGRYSN3yl0jEHa72HuvdvEu2woFh9fNneY6ORpYP1OeehDt/eS0SwfffvmC5i4Jl84O9P4pqX8n0APgvy6pHDdbrXgx13bC+n/qoxSbA7WpO0bzruj8BtW4KSw==","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 n=r(74848),i=r(28453),s=r(33617),a=r.n(s),d=r(17543),l=r.n(d),p=r(86013),c=r.n(p),b=r(63723),h=r.n(b),m=(r(18766),r(79329),r(9303));const f={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V91u3LYSfpUpb9oE8u7adfqjq2MUOY5Pg8SoXQSoszAoaSQxpkiWHO16sRBwLs4b9A36aH2SYqhdrXbt5ByfFrmxVyRn+M3MR87HtSBZBZHeiH9aXaAX80QUGHKvHClrRCqua4RzJOjn4ezyAqTWdhlgZVsgCx7JK1wgFEhS6QAysy2BhOAwV6XKoYymE5EI69BLdnxRiFRUSP2USISTXjZI6BnMWhjZoEhFP32rCpEIxWicpFocQrTZB8zpogBbwuDQ46+t8liIlHyLiQi00uwyqMZpFInAe6dtgSItpQ68IK+xkSJdC1q5uJK8MpVIRGl9I2k8gvcyekmFe3Wc1flJ7TLRdXPeNjhrAgZ2dDKb8b99tKHNcwyhbDUM6RCJyK0hNMTrpXNa5XFi+iGw0fohuj5ozpxnN6T6Lbe5eHIc9XFW3598cKJLNml/E2vwNDcGl9sSdLGoaKhnztMh/evEyPDiTl3ioa//F1losxG63KMkLM7oMVc7w5PZyddHx7Oj2bfXx9+kp9+nL76ZzGazX0Qi7hvNthuyFpIiUlKkx9+tKz7DPqOBzanxGETX8cTpYzy8sg1SrUwFSzQES29NlYDTKAMC+RXISioDWhL6L/4+gqL31n86E09DNo5cGa0M3m4P4e3pbHZ7PCTh9GES+lSBsQSlbU0x+QyBfoqlD/F8OrzT2++G8F48DO/CLKRWRby1r+0dms9byPH21G/PUPfprPpFcV7sBTse74MMmLde0Sr2iPsj6dRRP5/ezPn2Zd7YTWuJTYVqkYppn9XpemgnnWBffrFtN63XIhU1kQvpdBqkKTJ7P7EOTVCV0TILk9w2U+nUdHE8ORZdcmgjnXvSemyPnmoSSFbKVP/Nbr5L0xWXsq/WXrKGmkmnfsSVSLa1GK/adNwaZbwvO/4ubTTeVOitQ3OlKhPrGzc/7MzvUOe2QZYJVCNsDf74z+/RprB526ChSMDo4Yv35r1523pwdomee6Q0BZQa71WmMRphE+cG/RFQNhpD0CtQhrDykhAKVSmSGjhHfJHk0slMacXk5WWWrT2M+B8m8K5GqtHz1JceQUKBC9TMeZAt2UYSu9qChqX1dyUroQQkZG1QBkMANLU0OS/cViEB60EaQEPonVcBIZBn1KrHZg15mRM00sgK2Xeyl6oCtWKqgrdZGwiC1W2EDCy4rMcCtgEZxCJMOIkvWd54BB7NbeM81kyZBULVqgJDArktEEI8qxyCKSDDQOAYi8oxsNPWaJvfxeKVrdbgLF8dSmrWWmOMbE5emsC3W49lW4MhYc5bVj7YA3z+/OeAXOHXytyF9Pnz9+YIbgZOvcMsKML5V1v6L5fLB7R/tm9zruhVm8FP6GxQZP1qZ10pqtssHpWxk+Gj93SOBiN/Rgdh56OweXh48nh0WqN20yskZkiYnl1exNv2Gfzx79/gNUpvoLbLnq1561GvoNpuxZnrK9+nbbgsobSReDVnPO/Jx6oWAw0ZjNICVH94Njm8bDOtciBsHLfIFM7A7Q9BLg1kCBsFFCGEWjKRFkqCBK3M3QTOzAragB6WiurIAR6Pxr1lb8iZl7sql942oGgCr+wSF+iT6COwGbc1LBRFXwMYRQF1OYnQPZZKa1iqokJKD74DSI+ATYZFgQVHPdo2w5LprghUgMAjTF/eeQLXNa6irVxIpSXfJMr0pLb8luHMoimcVYZCCoWXJQ2eQ7LbJIatrHlkqE+SHMJKNm6235sjdlCJMIH3fNUeXM/7t6jHEj3vGI/kjjhObYhysyUcMA//CmGjLraGZB71ATZS6b5P/OPQT+zV6JvwtrxCv1A5bnrVR87qNC6eikRolaMJONIAZ+eXr2EBX09mIhl1vf/h3E5fX/zw8s3VS0bDd2SfsePJbDKLrwYbqJFmtNXuLXvYrdY7ZfT3vno3zZbwnqZOSxVlToxyvZEoN2J4t6a7N+88EbUNxNPrdSYD/ux11/Hwry16FkHzRCykV8zoqGMKFfh3MTxqPxrgVz9t3sfP4NHn86OYt6rBsGRYSN3yl0jEHa72HuvdvEu2woFh9fNneY6ORpYP1OeehDt/eS0SwfffvmC5i4Jl84O9P4pqX8n0APgvy6pHDdbrXgx13bC+n/qoxSbA7WpO0bzruj8BtW4KSw==",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,g={},x=[];function y(e){const t={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 Folder"}),"\n",(0,n.jsx)(a(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,n.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(l(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function P(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/7357a3c5.56289604.js b/assets/js/7357a3c5.56289604.js new file mode 100644 index 000000000..e21d74ea6 --- /dev/null +++ b/assets/js/7357a3c5.56289604.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1665],{13980:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>b,default:()=>k,frontMatter:()=>g,metadata:()=>a,toc:()=>S});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":"eJy9V8Fu5LgR/ZVaXrJjyN1tr2eT6BRjMfE6GcwYay8MxGMYlFSSOKZILlnqdqMhYA/5g5xyzafNlwRFtdRq2zOJk8Vc7BbJKr6qemQ9bgTJKoj0RvzZ6gK9uE1EgSH3ypGyRqTiqkY4Q4J+Hk4vzkFqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMpoOhOJsA69ZMfnhUhFhdRPiUQ46WWDhJ7BbISRDYpU9NN3qhCJUIzGSarFY4g2+4g5nRdgSxgdevylVR4LkZJvMRGB1ppdBtU4jSIR+OC0LVCkpdSBF+Q1NlKkG0FrF1eSV6YSiSitbyRNR/BBRi+pcD8eZXV+XLtMdN0tbxucNQEDOzpeLPjfPtrQ5jmGULYaxnSIROTWEBri9dI5rfI4Mf8Y2GjzFF0fNGfOsxtS/ZZDLl4cR32U1Q/HH53okm3a38UavMyNwdVQgi4WFQ31zHk5pL8cGxle36sLfOzrf0UW2myCLvcoCYtTes7VzvB4cfzd4dHicPH7q6Pv05M/pq+/ny0Wi7+JRDw0mm23ZC0kRaSkSE+/W1d8hX0mA9tT4zGIruOJk+d4eGkbpFqZClZoCFbemioBp1EGBPJrkJVUBrQk9N/8dgRF763/ciZehmwauTJaGbwbDuHdyWJxdzQm4eRpEvpUgbEEpW1NMfsKgX6JpU/xfDm8k7s/jOG9fhreuVlKrYp4a1/ZezRft5DT7anfnqHu01n1i+K82At2Ot4HGTBvvaJ17BEPh9Kpw34+vbnl25d5Y7etJTYVqkUq5n1W55uxnXSCffnl0G5ar0UqaiIX0vk8SFNk9mFmHZqgKqNlFma5bebSqfnyaHYkuuSxjXTuReuxPXypSSBZKVP9J7vbXZouuZR9tfaSNdZMOvVXXItkqMV01bbj1ijjfdnxd2mj8bZC7x2aS1WZWN+4+ePOfI06tw2yTKAaYTD49Pd/RZvC5m2DhiIBo4dvPpgP5n3rwdkVeu6R0hRQanxQmcZohE2cG/VHQNloDEGvQRnCyktCKFSlSGrgHPFFkksnM6UVk5eXWbb2MOF/mMF1jVSj56nfeQQJBS5RM+dBtmQbSexqAA0r6+9LVkIJSMjaoAyGAGhqaXJeOFQhAetBGkBD6J1XASGQZ9Sqx2YNeZkTNNLICtl3speqArViqoK3WRsIgtVthAwsuKzHAoaADGIRZpzENyxvPAKP5rZxHmumzBKhalWBIYHcFgghnlUOwRSQYSBwjEXlGNhpa7TN72PxylZrcJavDiU1a60pRjYnL03g263HMtRgTJjzlpUP9gAPDn4OyBV+q8x9SA8OPphDuBk5dY1ZUIS33w70X61WT2j/at/mTNGPbQY/obNBkfXrnXWlqG6zeFSmTsaP3tMZGoz8mRyEnY/C5uHpyePReY3azS+RmCFhfnpxHm/bV/Dp13/AW5TeQG1XPVvz1qNeQzVsxZnrK9+nbbwsobSReDVnPO/Jx6oWAw0ZvK4lffr1nwHe4QpUf4T6RB4cXLSZVjlcYeO4U4aDgxR+iJIHaBgDqiVBLg1kCKGWTKWlkiDB9dZamfsZnJo1tAE9rBTVkQw8Hu32wuC8jOUOkMmABVgTLYY9ZztEPN4E1EsM7IubXoaAhSJmdO1tW/W7TcFsg/NYKq3hWhUVUozttCjAbYdX/TAnfAIHSz4QVOMapEcIaGgGF49M4kzrnPWMQvXgS8tPHi4AmsJZZSikUHhZ0s5/siN6VJbKmmeG+hTKMR3J1s1Ykv4kbiMeR2cf+EJ+dInv37UeS/S8YQx7VxentnS6GWgJzNb/h9ZRPVtDMo8qAhupdN9N/vTYT+zo6JvwvrxEv1Q5bjvaZ070PC6ei0RolaMJOFEKp2cXb2H53Wwhkklr/C8O9/zt+Q9v3l2+YTB8kfYJO5otZov4tLCBGmkmO+0evI9b2mYnn37bp/G2IxM+0NxpqaIWilFutjrmRoyP23T3ML5NRG0D8fRmwyfuZ6+7jod/adGzUrpNxFJ6JTNu2jcbUajAv4vx5fvZAL/9afuIfgXPvrGfxTxIC8O6Yil1y18iEfe43nvRd7ddMqgLhtXPn+Y5OppYPpGoezrv7M2VSARfkvuq5j6qmu0P9v4sqn250wPgv6y9njXYbHrF1HXj+n7qsxbbAIfVnKLbruv+DQvgGZI=","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 o=n(74848),r=n(28453),i=n(33617),d=n.n(i),l=n(17543),s=n.n(l),p=n(86013),f=n.n(p),c=n(63723),m=n.n(c),v=(n(18766),n(79329),n(9303));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:"eJy9V8Fu5LgR/ZVaXrJjyN1tr2eT6BRjMfE6GcwYay8MxGMYlFSSOKZILlnqdqMhYA/5g5xyzafNlwRFtdRq2zOJk8Vc7BbJKr6qemQ9bgTJKoj0RvzZ6gK9uE1EgSH3ypGyRqTiqkY4Q4J+Hk4vzkFqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMpoOhOJsA69ZMfnhUhFhdRPiUQ46WWDhJ7BbISRDYpU9NN3qhCJUIzGSarFY4g2+4g5nRdgSxgdevylVR4LkZJvMRGB1ppdBtU4jSIR+OC0LVCkpdSBF+Q1NlKkG0FrF1eSV6YSiSitbyRNR/BBRi+pcD8eZXV+XLtMdN0tbxucNQEDOzpeLPjfPtrQ5jmGULYaxnSIROTWEBri9dI5rfI4Mf8Y2GjzFF0fNGfOsxtS/ZZDLl4cR32U1Q/HH53okm3a38UavMyNwdVQgi4WFQ31zHk5pL8cGxle36sLfOzrf0UW2myCLvcoCYtTes7VzvB4cfzd4dHicPH7q6Pv05M/pq+/ny0Wi7+JRDw0mm23ZC0kRaSkSE+/W1d8hX0mA9tT4zGIruOJk+d4eGkbpFqZClZoCFbemioBp1EGBPJrkJVUBrQk9N/8dgRF763/ciZehmwauTJaGbwbDuHdyWJxdzQm4eRpEvpUgbEEpW1NMfsKgX6JpU/xfDm8k7s/jOG9fhreuVlKrYp4a1/ZezRft5DT7anfnqHu01n1i+K82At2Ot4HGTBvvaJ17BEPh9Kpw34+vbnl25d5Y7etJTYVqkUq5n1W55uxnXSCffnl0G5ar0UqaiIX0vk8SFNk9mFmHZqgKqNlFma5bebSqfnyaHYkuuSxjXTuReuxPXypSSBZKVP9J7vbXZouuZR9tfaSNdZMOvVXXItkqMV01bbj1ijjfdnxd2mj8bZC7x2aS1WZWN+4+ePOfI06tw2yTKAaYTD49Pd/RZvC5m2DhiIBo4dvPpgP5n3rwdkVeu6R0hRQanxQmcZohE2cG/VHQNloDEGvQRnCyktCKFSlSGrgHPFFkksnM6UVk5eXWbb2MOF/mMF1jVSj56nfeQQJBS5RM+dBtmQbSexqAA0r6+9LVkIJSMjaoAyGAGhqaXJeOFQhAetBGkBD6J1XASGQZ9Sqx2YNeZkTNNLICtl3speqArViqoK3WRsIgtVthAwsuKzHAoaADGIRZpzENyxvPAKP5rZxHmumzBKhalWBIYHcFgghnlUOwRSQYSBwjEXlGNhpa7TN72PxylZrcJavDiU1a60pRjYnL03g263HMtRgTJjzlpUP9gAPDn4OyBV+q8x9SA8OPphDuBk5dY1ZUIS33w70X61WT2j/at/mTNGPbQY/obNBkfXrnXWlqG6zeFSmTsaP3tMZGoz8mRyEnY/C5uHpyePReY3azS+RmCFhfnpxHm/bV/Dp13/AW5TeQG1XPVvz1qNeQzVsxZnrK9+nbbwsobSReDVnPO/Jx6oWAw0ZvK4lffr1nwHe4QpUf4T6RB4cXLSZVjlcYeO4U4aDgxR+iJIHaBgDqiVBLg1kCKGWTKWlkiDB9dZamfsZnJo1tAE9rBTVkQw8Hu32wuC8jOUOkMmABVgTLYY9ZztEPN4E1EsM7IubXoaAhSJmdO1tW/W7TcFsg/NYKq3hWhUVUozttCjAbYdX/TAnfAIHSz4QVOMapEcIaGgGF49M4kzrnPWMQvXgS8tPHi4AmsJZZSikUHhZ0s5/siN6VJbKmmeG+hTKMR3J1s1Ykv4kbiMeR2cf+EJ+dInv37UeS/S8YQx7VxentnS6GWgJzNb/h9ZRPVtDMo8qAhupdN9N/vTYT+zo6JvwvrxEv1Q5bjvaZ070PC6ei0RolaMJOFEKp2cXb2H53Wwhkklr/C8O9/zt+Q9v3l2+YTB8kfYJO5otZov4tLCBGmkmO+0evI9b2mYnn37bp/G2IxM+0NxpqaIWilFutjrmRoyP23T3ML5NRG0D8fRmwyfuZ6+7jod/adGzUrpNxFJ6JTNu2jcbUajAv4vx5fvZAL/9afuIfgXPvrGfxTxIC8O6Yil1y18iEfe43nvRd7ddMqgLhtXPn+Y5OppYPpGoezrv7M2VSARfkvuq5j6qmu0P9v4sqn250wPgv6y9njXYbHrF1HXj+n7qsxbbAIfVnKLbruv+DQvgGZI=",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,u={},S=[];function R(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,o.jsx)(d(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,o.jsx)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(s(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,o.jsx)(f(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(R,{...e})}):R(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.6ad534f5.js b/assets/js/7ad5624c.6ad534f5.js new file mode 100644 index 000000000..3ad40f188 --- /dev/null +++ b/assets/js/7ad5624c.6ad534f5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[33],{82903:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>X,contentTitle:()=>m,default:()=>h,frontMatter:()=>g,metadata:()=>a,toc:()=>y});const a=JSON.parse('{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/v1.1/getcontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcontact","permalink":"/docs/API-docs/v1.1/getcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar_label":"Get Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V81u5DYSfpUKL5sx5P7xOFmsTjEGA8fIIGPEDgysp2FQUrXEMUUyZKnbjYaAHPYN9rTXfbR5kkVRUrfa9mTjJBjAaHcXq4r189UPt4JkGUR6K95YQzKnIBaJKDDkXjlS1ohUXFcI50jQc8DZ5QVIre06wMY2QBY8kle4QiiQpNIBZGYbAgnBYa6WKoe8k52IRFiHXrLqi0KkokTqz0QinPSyRkLPFm2FkTWKVPTnd6oQiVBskZNUicdm2uwj5nRRgF3CXqXHXxrlsRAp+QYTEWijWWlQtdMoEoEPTtsCRbqUOjBDXmEtRboVtHGRk7wypUjE0vpa0piCDzJqSYX7fp5V+UnlMtG2C742OGsCBlZ0Mpvxv0NzQ5PnGMKy0bCLiEiis2iI+aVzWuXxYPoxsND2qXWd1xw7z2pIdVcOwXixH9U8qx5OPjrRJn38X6bgo0XIEFkca6n0H5DPEL/rCZPc1qzKVda82JTT+ev5SfxjFblHSVic0XNq9kIns5PXx/PZ8ezv1/Nv09N/pN98O5nNZv8UiXioozc9KgtJ0UtSpMe/G1d8gXvax2w94vsCHAsMtdC2LHX6HBavbI1UKVPCGg3B2ltTJuA0yoBAfgOylMqAloT+q78OpOi99b8dppdZ1o7cVkYrg3dDId6dzmZ3810QTp8GYWhvxhIsbWOKL+vpM9f/tjundyc7d7556s6FWUmtititr+09mi/rzvh66q5/ClrVMcVzceDsmN45GTBvvKJNnAwPx9Kp4+48vV1wx2Wc2H6ixFFClUjFtEf/dLufIq1gbX41jJnGa5GKisiFdDoN0hSZfZhYhyao0miZBW5DU+nUdDWfcDN5LCOdexE/NscvFQkkS2XK/ye32AfqipPZ5esgXLusSad+wI0Y+vwBVz9oK5QF+pg5ZZY2Cvc5eu/QXKnSxAzHyx8P5BvUua2RFwSqEAaBT//6b5QpbN7UaChCMGr46oP5YN43Hpxdo+fJKE0BS40PKtMYhbCOZ7vNI6CsNYagN6AMYeklIRSqVCQ1cIy4deTSyUxpxfBlNsvSHkYVECZwUyFV6Pnobx5BQoEr1Ix6kA3ZWhKrGoyGtfX3S96BEpCQNUEZDAHQVNLkzDhkIQHrQRpAQ+idVwEhkGerVWebNeS57mtpZImsOzkIVYFaMVTB26wJBMHqJpoM3OmtxwIGhwxiESYcxLe81HgEpua2dh4rhswKoWxUgSGB3BYIIVYru2AKyDAQOLZF5RhYaWO0ze9j8paN1uAsNw8lNa9YYxtZnLw0gcdxZ8uQg13AnLe872Bn4NHRzwE5w++UuQ/p0dEHcwy3O0zdYBYU4eLrAf7r9foJ7F8dypwr+r7J4Cd0NiiyfrOXLhVVTRZLZaxk96PTdI4GI35GhbDXUdg8PK08pk4r1G56hcQICdOzy4vYb1/Bp1//De9QegOVXXdozRuPegPlcBVHrst8F7Zdu4SljcCrOOJ5Bz7eZTHQEMGbStKnX/8T4Edcg+pKqAvk0dFlk2mVwzXWjmdjODpK4U3cgIAGGlAlCXJpIEMIlWQorZQECa6T1srcT+DMbKAJ6GGtqIpgYHqUO3CD47JLd4BMBizAmigx3DnZW8T0OqBeYWBdPPYyBCwUMaIrb5uyu21sTO+cx6XSGm5UUSJF386KAlxPXndkDvjIHFxyQVCFG5AeIaChCVw+EoknjXPWsxWqM35p+bHDCUBTOKsMhRQKL5e015/sgR4XTWXNM6QuhHIXjqRXs0tJV4m9xzvq5AM35EdN/LDXelyi5wuj2/u8ONXD6XaAJTBa/wys4zLd75S8C3RbPk+T7x7riTMdfR3eL6/Qr1SO/UT7TEVPI/NUJEKrHE3A0a5wdn75DlavJzORjEbj7yju6buLN29/vHrLxnAj7QI2n8wms/i0sIFqaUY3jd66j2fadr9B/dXP4n4oEz7Q1Gmp4kIUHd32y8yt2D9r09GjeJGIygZihu2Wy+5nr9uWyb806HlhWiRiJb2SGU/u260oVODvxe7R+1knv/6pfz+/guff18+aPSwYhreLldQN/xKJuMfN4Xu+XbTJsGSwYR3DWZ6jo5Hok131YOE7f3stEsG98nC5uY/LTf+FtT9r1uHW0xnAn7yCPSuw3XaLU9vu+Lujz0r0Dg7cHKNF27b/AyPAGZI=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/v1.1/deletecontact"}}');var o=n(74848),i=n(28453),s=n(33617),c=n.n(s),r=n(17543),d=n.n(r),p=n(86013),l=n.n(p),x=n(63723),u=n.n(x),I=(n(18766),n(79329),n(9303));const g={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V81u5DYSfpUKL5sx5P7xOFmsTjEGA8fIIGPEDgysp2FQUrXEMUUyZKnbjYaAHPYN9rTXfbR5kkVRUrfa9mTjJBjAaHcXq4r189UPt4JkGUR6K95YQzKnIBaJKDDkXjlS1ohUXFcI50jQc8DZ5QVIre06wMY2QBY8kle4QiiQpNIBZGYbAgnBYa6WKoe8k52IRFiHXrLqi0KkokTqz0QinPSyRkLPFm2FkTWKVPTnd6oQiVBskZNUicdm2uwj5nRRgF3CXqXHXxrlsRAp+QYTEWijWWlQtdMoEoEPTtsCRbqUOjBDXmEtRboVtHGRk7wypUjE0vpa0piCDzJqSYX7fp5V+UnlMtG2C742OGsCBlZ0Mpvxv0NzQ5PnGMKy0bCLiEiis2iI+aVzWuXxYPoxsND2qXWd1xw7z2pIdVcOwXixH9U8qx5OPjrRJn38X6bgo0XIEFkca6n0H5DPEL/rCZPc1qzKVda82JTT+ev5SfxjFblHSVic0XNq9kIns5PXx/PZ8ezv1/Nv09N/pN98O5nNZv8UiXioozc9KgtJ0UtSpMe/G1d8gXvax2w94vsCHAsMtdC2LHX6HBavbI1UKVPCGg3B2ltTJuA0yoBAfgOylMqAloT+q78OpOi99b8dppdZ1o7cVkYrg3dDId6dzmZ3810QTp8GYWhvxhIsbWOKL+vpM9f/tjundyc7d7556s6FWUmtititr+09mi/rzvh66q5/ClrVMcVzceDsmN45GTBvvKJNnAwPx9Kp4+48vV1wx2Wc2H6ixFFClUjFtEf/dLufIq1gbX41jJnGa5GKisiFdDoN0hSZfZhYhyao0miZBW5DU+nUdDWfcDN5LCOdexE/NscvFQkkS2XK/ye32AfqipPZ5esgXLusSad+wI0Y+vwBVz9oK5QF+pg5ZZY2Cvc5eu/QXKnSxAzHyx8P5BvUua2RFwSqEAaBT//6b5QpbN7UaChCMGr46oP5YN43Hpxdo+fJKE0BS40PKtMYhbCOZ7vNI6CsNYagN6AMYeklIRSqVCQ1cIy4deTSyUxpxfBlNsvSHkYVECZwUyFV6Pnobx5BQoEr1Ix6kA3ZWhKrGoyGtfX3S96BEpCQNUEZDAHQVNLkzDhkIQHrQRpAQ+idVwEhkGerVWebNeS57mtpZImsOzkIVYFaMVTB26wJBMHqJpoM3OmtxwIGhwxiESYcxLe81HgEpua2dh4rhswKoWxUgSGB3BYIIVYru2AKyDAQOLZF5RhYaWO0ze9j8paN1uAsNw8lNa9YYxtZnLw0gcdxZ8uQg13AnLe872Bn4NHRzwE5w++UuQ/p0dEHcwy3O0zdYBYU4eLrAf7r9foJ7F8dypwr+r7J4Cd0NiiyfrOXLhVVTRZLZaxk96PTdI4GI35GhbDXUdg8PK08pk4r1G56hcQICdOzy4vYb1/Bp1//De9QegOVXXdozRuPegPlcBVHrst8F7Zdu4SljcCrOOJ5Bz7eZTHQEMGbStKnX/8T4Edcg+pKqAvk0dFlk2mVwzXWjmdjODpK4U3cgIAGGlAlCXJpIEMIlWQorZQECa6T1srcT+DMbKAJ6GGtqIpgYHqUO3CD47JLd4BMBizAmigx3DnZW8T0OqBeYWBdPPYyBCwUMaIrb5uyu21sTO+cx6XSGm5UUSJF386KAlxPXndkDvjIHFxyQVCFG5AeIaChCVw+EoknjXPWsxWqM35p+bHDCUBTOKsMhRQKL5e015/sgR4XTWXNM6QuhHIXjqRXs0tJV4m9xzvq5AM35EdN/LDXelyi5wuj2/u8ONXD6XaAJTBa/wys4zLd75S8C3RbPk+T7x7riTMdfR3eL6/Qr1SO/UT7TEVPI/NUJEKrHE3A0a5wdn75DlavJzORjEbj7yju6buLN29/vHrLxnAj7QI2n8wms/i0sIFqaUY3jd66j2fadr9B/dXP4n4oEz7Q1Gmp4kIUHd32y8yt2D9r09GjeJGIygZihu2Wy+5nr9uWyb806HlhWiRiJb2SGU/u260oVODvxe7R+1knv/6pfz+/guff18+aPSwYhreLldQN/xKJuMfN4Xu+XbTJsGSwYR3DWZ6jo5Hok131YOE7f3stEsG98nC5uY/LTf+FtT9r1uHW0xnAn7yCPSuw3XaLU9vu+Lujz0r0Dg7cHKNF27b/AyPAGZI=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},m=void 0,X={},y=[];function b(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,o.jsx)(c(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,o.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(d(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,o.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ad5624c.91c9b890.js b/assets/js/7ad5624c.91c9b890.js deleted file mode 100644 index 4b8b42c24..000000000 --- a/assets/js/7ad5624c.91c9b890.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[33],{82903:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>b,contentTitle:()=>C,default:()=>h,frontMatter:()=>u,metadata:()=>o,toc:()=>x});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":"eJy9V91u3LYSfpUpb9oE8v44bg6qqxpF4BgnOAlqFwGOszAoaSQxpkiWHO16sRDQi75B36CPlicphpL2z07PcVsEMGyLnBnODL+Z+bgRJKsg0hvxgzUkcwpikYgCQ+6VI2WNSMV1jXCBBIMEnL+7BKm1XQVY2xbIgkfyCpcIBZJUOoDMbEsgITjMValyyHvdiUiEdeglm74sRCoqpGFPJMJJLxsk9OzRRhjZoEjFsH+rCpEIxR45SbU4dtNmHzGnywJsCTuTHn9ulcdCpORbTESgtWajQTVOo0gE3jttCxRpKXVggbzGRop0I2jtoiR5ZSqRiNL6RtL+Ct7LaCUV7vU8q/PT2mWi6xZ8bHDWBAxs6HQ24z+H7oY2zzGEstWwzYhIYrBoiOWlc1rlcWP6MbDS5qF3fdScO89mSPVHjsl4chz1PKvvTz860SVD/p9m4KNFyBBZHRup9F/QzxC/HxYmuW3YlKutebIrZ/MX89P4wyZyj5KwOKfHzOyUTmenL07ms5PZv67nL9Oz79JvX05ms9l/RSLumxjNgMpCUoySFOn979YVX+Cc7lhsQPxQgPsKYy10HWudPYbFK9sg1cpUsEJDsPLWVAk4jTIgkF+DrKQyoCWh/+qfAyl6b/2fp+lpnnV7YSujlcHbsRBvz2az2/k2CWcPkzC2N2MJStua4stG+sjxfx7O2e3pNpxvH4ZzaZZSqyJ262t7h+bLhrN/PPXHPwSt6oXivjgIdn+9DzJg3npF6zgZ7k+kUyf9fnqz4I7LOLHDRImjhGqRiumA/ulmN0U6wdb8chwzrdciFTWRC+l0GqQpMns/sQ5NUJXRMgvchqbSqelyPuFmcqwjnXuSPLYnT1UJJCtlqv+lt9gl6oovs7+vg3Rtb0069W9ci7HPH0gNg7ZGWaCPN6dMaaPycEdvHZorVZl4w/Hw44H8HnVuG2SCQDXCqPDp19+jTmHztkFDEYLRwlcfzAfztvXg7Ao9T0ZpCig13qtMY1TCJu5tmUdA2WgMQa9BGcLKS0IoVKVIauAccevIpZOZ0orhy2KWtT3sVUCYwPsaqUbPW197BAkFLlEz6kG2ZBtJbGp0GlbW35XMgRKQkLVBGQwB0NTS5Cw43kIC1oM0gIbQO68CQiDPXqveN2vIc9030sgK2XZykKoCtWKogrdZGwiC1W10GbjTW48FjAEZxCJMOImvmNR4BF7NbeM81gyZJULVqgJDArktEEKsVg7BFJBhIHDsi8oxsNHWaJvfxcsrW63BWW4eSmqmWPs+sjp5aQKP496X8Q62CXPeMt/B3sHnz38KyDf8Rpm7kD5//sGcwM0WU+8xC4pw8c0I/9Vq9QD2zw51LhS9bjP4EZ0Niqxf77QrRXWbxVLZN7L96C1doMGIn71C2NkobB4eVh6vTmvUbnqFxAgJ0/N3l7HfPoNPv/wGb1B6A7Vd9WjNW496DdV4FGeuv/k+bdt2CaWNwKs543kPPuayGGibwcg0QPXFM+TwXZtplQNh43gopnAO7nAJcmkgQxgIUXQh1JKBtFQSJGhl7iZwbtbQBvSwUlRHDPB6VO41e0XOvNzdcultA4om8NqucIk+iTYCq/Fgw0JRtLV1RlFAXU6i6x5LpTWsVFEhpUffAaRHwCbDosCCo947NsOS4a4IVIDAKwxfPnkC1zWuo65cSqUldxJlelBbfsVwZtEUzipDIYXCy5K2lkOyOySGrax5ZKlPktyGlQxmxu+hxI5uIkzgA7fao/Z82EU9luj5xFiSO+A4NQDlZgQcMA7/DmAjTR7YIk/5nr/znPj+2E6c1uib8La8Qr9UOQ6z6jO1Oo3CU5EIrXI0AfdYwPnFuzewhBeTmUj2pt7/UbfTN5c/vPrP1Sv2hntkn7H5ZDaZxVeDDdRIs3fU3jP2eFxtduTon37xDvOW8J6mTksVuU4MdDPwlBuxe7Gme+/dRSJqG4gFNptMBvzJ667j5Z9b9MyFFolYSq8Y1pHMFCrw/8X2PfvZIL/5cXgaP4PHn86Puj1yB8PEYSl1y18iEXe4Pnyqd4suGfkDO9YLnOc5OtpTfUBDD7jcxatrkQhug4e85S7yluEftv6oW4eEpneAfzO7elRhs+k5Uddt5futz2oMAY7SnKNF13V/ANOtCks=","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=n(74848),a=n(28453),c=n(33617),i=n.n(c),l=n(17543),p=n.n(l),r=n(86013),d=n.n(r),g=n(63723),m=n.n(g),P=(n(18766),n(79329),n(9303));const u={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:"eJy9V91u3LYSfpUpb9oE8v44bg6qqxpF4BgnOAlqFwGOszAoaSQxpkiWHO16sRDQi75B36CPlicphpL2z07PcVsEMGyLnBnODL+Z+bgRJKsg0hvxgzUkcwpikYgCQ+6VI2WNSMV1jXCBBIMEnL+7BKm1XQVY2xbIgkfyCpcIBZJUOoDMbEsgITjMValyyHvdiUiEdeglm74sRCoqpGFPJMJJLxsk9OzRRhjZoEjFsH+rCpEIxR45SbU4dtNmHzGnywJsCTuTHn9ulcdCpORbTESgtWajQTVOo0gE3jttCxRpKXVggbzGRop0I2jtoiR5ZSqRiNL6RtL+Ct7LaCUV7vU8q/PT2mWi6xZ8bHDWBAxs6HQ24z+H7oY2zzGEstWwzYhIYrBoiOWlc1rlcWP6MbDS5qF3fdScO89mSPVHjsl4chz1PKvvTz860SVD/p9m4KNFyBBZHRup9F/QzxC/HxYmuW3YlKutebIrZ/MX89P4wyZyj5KwOKfHzOyUTmenL07ms5PZv67nL9Oz79JvX05ms9l/RSLumxjNgMpCUoySFOn979YVX+Cc7lhsQPxQgPsKYy10HWudPYbFK9sg1cpUsEJDsPLWVAk4jTIgkF+DrKQyoCWh/+qfAyl6b/2fp+lpnnV7YSujlcHbsRBvz2az2/k2CWcPkzC2N2MJStua4stG+sjxfx7O2e3pNpxvH4ZzaZZSqyJ262t7h+bLhrN/PPXHPwSt6oXivjgIdn+9DzJg3npF6zgZ7k+kUyf9fnqz4I7LOLHDRImjhGqRiumA/ulmN0U6wdb8chwzrdciFTWRC+l0GqQpMns/sQ5NUJXRMgvchqbSqelyPuFmcqwjnXuSPLYnT1UJJCtlqv+lt9gl6oovs7+vg3Rtb0069W9ci7HPH0gNg7ZGWaCPN6dMaaPycEdvHZorVZl4w/Hw44H8HnVuG2SCQDXCqPDp19+jTmHztkFDEYLRwlcfzAfztvXg7Ao9T0ZpCig13qtMY1TCJu5tmUdA2WgMQa9BGcLKS0IoVKVIauAccevIpZOZ0orhy2KWtT3sVUCYwPsaqUbPW197BAkFLlEz6kG2ZBtJbGp0GlbW35XMgRKQkLVBGQwB0NTS5Cw43kIC1oM0gIbQO68CQiDPXqveN2vIc9030sgK2XZykKoCtWKogrdZGwiC1W10GbjTW48FjAEZxCJMOImvmNR4BF7NbeM81gyZJULVqgJDArktEEKsVg7BFJBhIHDsi8oxsNHWaJvfxcsrW63BWW4eSmqmWPs+sjp5aQKP496X8Q62CXPeMt/B3sHnz38KyDf8Rpm7kD5//sGcwM0WU+8xC4pw8c0I/9Vq9QD2zw51LhS9bjP4EZ0Niqxf77QrRXWbxVLZN7L96C1doMGIn71C2NkobB4eVh6vTmvUbnqFxAgJ0/N3l7HfPoNPv/wGb1B6A7Vd9WjNW496DdV4FGeuv/k+bdt2CaWNwKs543kPPuayGGibwcg0QPXFM+TwXZtplQNh43gopnAO7nAJcmkgQxgIUXQh1JKBtFQSJGhl7iZwbtbQBvSwUlRHDPB6VO41e0XOvNzdcultA4om8NqucIk+iTYCq/Fgw0JRtLV1RlFAXU6i6x5LpTWsVFEhpUffAaRHwCbDosCCo947NsOS4a4IVIDAKwxfPnkC1zWuo65cSqUldxJlelBbfsVwZtEUzipDIYXCy5K2lkOyOySGrax5ZKlPktyGlQxmxu+hxI5uIkzgA7fao/Z82EU9luj5xFiSO+A4NQDlZgQcMA7/DmAjTR7YIk/5nr/znPj+2E6c1uib8La8Qr9UOQ6z6jO1Oo3CU5EIrXI0AfdYwPnFuzewhBeTmUj2pt7/UbfTN5c/vPrP1Sv2hntkn7H5ZDaZxVeDDdRIs3fU3jP2eFxtduTon37xDvOW8J6mTksVuU4MdDPwlBuxe7Gme+/dRSJqG4gFNptMBvzJ667j5Z9b9MyFFolYSq8Y1pHMFCrw/8X2PfvZIL/5cXgaP4PHn86Puj1yB8PEYSl1y18iEXe4Pnyqd4suGfkDO9YLnOc5OtpTfUBDD7jcxatrkQhug4e85S7yluEftv6oW4eEpneAfzO7elRhs+k5Uddt5futz2oMAY7SnKNF13V/ANOtCks=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},C=void 0,b={},x=[];function v(t){const e={p:"p",...(0,a.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(P.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,s.jsx)(i(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,s.jsx)(e.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,s.jsx)(P.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,s.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function h(t={}){const{wrapper:e}={...(0,a.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(v,{...t})}):v(t)}}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.c8c9648e.js b/assets/js/7ef59f7a.c8c9648e.js deleted file mode 100644 index 5ce2c5c7b..000000000 --- a/assets/js/7ef59f7a.c8c9648e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4865],{84605:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>y,contentTitle:()=>f,default:()=>S,frontMatter:()=>b,metadata:()=>o,toc:()=>x});const o=JSON.parse('{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.1/getdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocument","permalink":"/docs/API-docs/v1.1/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WO9uGzcSf5Upv1wTrCXZVpKePtW4yzm+C5qgdhCgjiFwl7NaxlySJbmSBUFAP9wb3Bvco/VJiuH+0UpW7ChN8yWxuPOfM8PfzIoFPvNscs3+abKqRB08u0mYQJ85aYM0mk3YVYFwjgFaEjh7ewGoearQw9JUEAw4DE7iHEFg4FJ54KmpAnDwFjOZywxEwz1gCTMWHSfpF4JN2AxD+5ElzHLHSwzoyKwV07xENmEtwVQKljBJZlkeCrZrq0k/YhYuBJi8s5clzOGvlXQo2CS4ChPmw1KRWC9Lq5AlDO+sMgLZJOfKE0FWYMnZZMXC0kbK4KSesYTlxpU89E/wjkcpE2ZfHadFdlLYlK3XN6TWW6M9ehJ0MhrRf9v2+irL0Pu8UtAFhSUsMzqQ5ZMV49YqmcUPw4+emFb3ravdpug5EhNkrdIHHip/qBdSH1lnZg69Z+ukC+mhYv51Lm9PTtPi3b9JSi7p8DAJRQjWT4bD5qRyapCZkqRl5GNOYflioT0RPcFBhsPt9PEPynASoc3hRlmF3CN4OdNdocSoGSXQPX7RX+eO6lo7TEJtIUTW9SaAm4JtXKBEWugtXz5L/keDkCISP0UntoVOAneOL6kfBCz941FyZv/dbrRlaB4KxF6zsORSPUqdIv7YHLS5ZgujH1Ezfvb85Pj0hxfHRL+QYobhT/hffz0s/gHvQmruor181mfXVZmi67N3Jx378TphdwfynIzH64QtD+R6QaoWBzKd/rBOWHEg0/g55XJs4J8R8y+pqS7m635FBSyt4gGnl3UdTNt8eJAqFqVHLS70G7fdS1JjFHLdV02vI7VXhzygOAsPZ+fJ6OT06Hh0NHpxdfx8Mv775NnzwWg0+oUl7K5UG++ZoD7dbw7N78qKb6KnBitXpvo89x0K6TAL08rtLeyH7o7UcaXMYloaUb8vO4myR28EHcRYCRmmwW03lAOr/Iv70VziAvc+IV/xKmIT/2uV7HmFFjIUNRia9mMcSduCkY9Y1SME6cFotQQ+51JRbsGiQA2hwO75JpqmjiB3pgQOrYRBTJIqmKnDUupHq7JNj5p6anSGU6mnOEe3t012jCNycCdk9yLCHoxX04TG+8DrpSkxFFLPYEEOL5zRswQaLBPcEviMSw3ksvvu66FadM7sxRGbuzrMsn7GSK2kxmmL3Kfj0Wh63AVhfD8I3VSkTYDcVFp8W1f36X/YofH0tHPo2X2HLvScKynilHdlblF/W3/66kOt/n4Wy5oofmdbzvbPayc9ZpWTYRnHybsjbuVR/X1yfUNDGmWKaebQOH+Ggk3YsC2F4ao3e64ZyXPzdjqND0Q3UniuRWruBsaipj6neOqpuQ65lcP58YBQ3C4Pt/YgeqyODmXxgc+knj3Gd7MJ1SVdZ31jWwHbPElW/gfpTWruo0/VjOcF8oj71/Q7N5G5uaU3FjXBk3jHUfnuGP8eVWZKpM0C9dSW4ff//j/ytDcSkzBK+O6D/qDfVA6sWaCjcZprAbnCO0ndOW4syvitW1l45KVC79USpA44czwgCDmTgas4iVH7yLjlqVSSEpjIDHE76NWAH8D7AkOBjj79zSFwEDhHRXkP1OVLHkhU9zAsjLvNlVn4BDiklZcavQfUBdcZEba3kIBxwDWgDuiskzQgBkdWy9o2o4PjWYCSaz5Dkp1shUqgkpSq4Exa+QDeqCqaDLSjMQ4FtA5pROEHFMSXtAlxCHSamdI6LChl5gizSgr0CWRGINQzL7mgBaToA1iyRWboSWillclu4+XllVJgDbUPyRUtZvo2EntwXHsCVbUt7R10AbPO0JIEawOfPn3nkW74tdS3fvL06Qd9BNddTr3H1MuAN9+36b9YLO6l/ZNtnnMZXlUp/IzWeBmMW264ZzIUVRpLpS+k+1FLOkeNMX96hbCRIUzm71cenQ4LVHZ4iYEyxA/P3l7EjvsEfv/tf/AaudNQmEWdrVnlUC1h1qqiyNU3X4eta5iQm5h4BUU8q5OPFmDoQxfBCLxB1sXTxPBtlSqZdShlAmdgt48g4xpS7HANmeALTok0lxw4KKlvB3Cml1B5dEAwIuYAnUfmmrNmpMjzzS1HkCTDAF6ZBUGbJMrwxEZPGwoZoqzOGBk8qnwQTXeYS6WgHokmO789cIeAZYpCoCCve2pTzCndZQRsnk4ofUnzAK4KXEbeDc6TNcrLDWF8iixqYY3UwU9AOJ6HTrJPNkqi29LoPUd1kDbgMGnEtL+bEtu5CT+AD9Rqd9rzdhd1mKMjjbEkN4ljZZMo123CAeXhn0nYuJQzOvAs9GYQeid+3JUT32t0pX+TX6Kby6zdyn2iVoeReMgSpmSG2mMPB5ydv30NczgdjFjSe/U+o26Hry/+8fKny5dx8EHn64gdD0aDUdx1GB9Krnuq+hvw3fdqtcFHf8G2vHlzaSswtIrLiHia0bRGK9est0Cf9HflNwkrjA9Eslql3OM7p9ZrOv61itPD9U3C5txJsi9CGiE9/S26VfgnPf3+52ar/gQ+sXbfa3kLITThhzlXVRybE3aLy51F//qG1jM1jiDTaoqzLEMberz3AOkWqjt/ecXitFVs45fbiF+aP0j6Xru2gU1tAP1LKGsvw2pVY6P1uqOvP32So3GwpaYg3azX6z8AJiXcEw==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"}}');var a=n(74848),i=n(28453),p=n(33617),r=n.n(p),s=n(17543),m=n.n(s),l=n(86013),d=n.n(l),c=n(63723),u=n.n(c),g=(n(18766),n(79329),n(9303));const b={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:"eJy9WO9uGzcSf5Upv1wTrCXZVpKePtW4yzm+C5qgdhCgjiFwl7NaxlySJbmSBUFAP9wb3Bvco/VJiuH+0UpW7ChN8yWxuPOfM8PfzIoFPvNscs3+abKqRB08u0mYQJ85aYM0mk3YVYFwjgFaEjh7ewGoearQw9JUEAw4DE7iHEFg4FJ54KmpAnDwFjOZywxEwz1gCTMWHSfpF4JN2AxD+5ElzHLHSwzoyKwV07xENmEtwVQKljBJZlkeCrZrq0k/YhYuBJi8s5clzOGvlXQo2CS4ChPmw1KRWC9Lq5AlDO+sMgLZJOfKE0FWYMnZZMXC0kbK4KSesYTlxpU89E/wjkcpE2ZfHadFdlLYlK3XN6TWW6M9ehJ0MhrRf9v2+irL0Pu8UtAFhSUsMzqQ5ZMV49YqmcUPw4+emFb3ravdpug5EhNkrdIHHip/qBdSH1lnZg69Z+ukC+mhYv51Lm9PTtPi3b9JSi7p8DAJRQjWT4bD5qRyapCZkqRl5GNOYflioT0RPcFBhsPt9PEPynASoc3hRlmF3CN4OdNdocSoGSXQPX7RX+eO6lo7TEJtIUTW9SaAm4JtXKBEWugtXz5L/keDkCISP0UntoVOAneOL6kfBCz941FyZv/dbrRlaB4KxF6zsORSPUqdIv7YHLS5ZgujH1Ezfvb85Pj0hxfHRL+QYobhT/hffz0s/gHvQmruor181mfXVZmi67N3Jx378TphdwfynIzH64QtD+R6QaoWBzKd/rBOWHEg0/g55XJs4J8R8y+pqS7m635FBSyt4gGnl3UdTNt8eJAqFqVHLS70G7fdS1JjFHLdV02vI7VXhzygOAsPZ+fJ6OT06Hh0NHpxdfx8Mv775NnzwWg0+oUl7K5UG++ZoD7dbw7N78qKb6KnBitXpvo89x0K6TAL08rtLeyH7o7UcaXMYloaUb8vO4myR28EHcRYCRmmwW03lAOr/Iv70VziAvc+IV/xKmIT/2uV7HmFFjIUNRia9mMcSduCkY9Y1SME6cFotQQ+51JRbsGiQA2hwO75JpqmjiB3pgQOrYRBTJIqmKnDUupHq7JNj5p6anSGU6mnOEe3t012jCNycCdk9yLCHoxX04TG+8DrpSkxFFLPYEEOL5zRswQaLBPcEviMSw3ksvvu66FadM7sxRGbuzrMsn7GSK2kxmmL3Kfj0Wh63AVhfD8I3VSkTYDcVFp8W1f36X/YofH0tHPo2X2HLvScKynilHdlblF/W3/66kOt/n4Wy5oofmdbzvbPayc9ZpWTYRnHybsjbuVR/X1yfUNDGmWKaebQOH+Ggk3YsC2F4ao3e64ZyXPzdjqND0Q3UniuRWruBsaipj6neOqpuQ65lcP58YBQ3C4Pt/YgeqyODmXxgc+knj3Gd7MJ1SVdZ31jWwHbPElW/gfpTWruo0/VjOcF8oj71/Q7N5G5uaU3FjXBk3jHUfnuGP8eVWZKpM0C9dSW4ff//j/ytDcSkzBK+O6D/qDfVA6sWaCjcZprAbnCO0ndOW4syvitW1l45KVC79USpA44czwgCDmTgas4iVH7yLjlqVSSEpjIDHE76NWAH8D7AkOBjj79zSFwEDhHRXkP1OVLHkhU9zAsjLvNlVn4BDiklZcavQfUBdcZEba3kIBxwDWgDuiskzQgBkdWy9o2o4PjWYCSaz5Dkp1shUqgkpSq4Exa+QDeqCqaDLSjMQ4FtA5pROEHFMSXtAlxCHSamdI6LChl5gizSgr0CWRGINQzL7mgBaToA1iyRWboSWillclu4+XllVJgDbUPyRUtZvo2EntwXHsCVbUt7R10AbPO0JIEawOfPn3nkW74tdS3fvL06Qd9BNddTr3H1MuAN9+36b9YLO6l/ZNtnnMZXlUp/IzWeBmMW264ZzIUVRpLpS+k+1FLOkeNMX96hbCRIUzm71cenQ4LVHZ4iYEyxA/P3l7EjvsEfv/tf/AaudNQmEWdrVnlUC1h1qqiyNU3X4eta5iQm5h4BUU8q5OPFmDoQxfBCLxB1sXTxPBtlSqZdShlAmdgt48g4xpS7HANmeALTok0lxw4KKlvB3Cml1B5dEAwIuYAnUfmmrNmpMjzzS1HkCTDAF6ZBUGbJMrwxEZPGwoZoqzOGBk8qnwQTXeYS6WgHokmO789cIeAZYpCoCCve2pTzCndZQRsnk4ofUnzAK4KXEbeDc6TNcrLDWF8iixqYY3UwU9AOJ6HTrJPNkqi29LoPUd1kDbgMGnEtL+bEtu5CT+AD9Rqd9rzdhd1mKMjjbEkN4ljZZMo123CAeXhn0nYuJQzOvAs9GYQeid+3JUT32t0pX+TX6Kby6zdyn2iVoeReMgSpmSG2mMPB5ydv30NczgdjFjSe/U+o26Hry/+8fKny5dx8EHn64gdD0aDUdx1GB9Krnuq+hvw3fdqtcFHf8G2vHlzaSswtIrLiHia0bRGK9est0Cf9HflNwkrjA9Eslql3OM7p9ZrOv61itPD9U3C5txJsi9CGiE9/S26VfgnPf3+52ar/gQ+sXbfa3kLITThhzlXVRybE3aLy51F//qG1jM1jiDTaoqzLEMberz3AOkWqjt/ecXitFVs45fbiF+aP0j6Xru2gU1tAP1LKGsvw2pVY6P1uqOvP32So3GwpaYg3azX6z8AJiXcEw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,y={},x=[];function j(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,a.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(m(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},audit_trail:{type:"array",items:{type:"object",properties:{email:{type:"string",example:"joebee@example.com"},viewed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},signed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"documentwithstatus_audit_trail"}},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"documentwithstatus"},title:"documentwithstatus"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function S(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/7ef59f7a.e7cadeec.js b/assets/js/7ef59f7a.e7cadeec.js new file mode 100644 index 000000000..5e18ebd85 --- /dev/null +++ b/assets/js/7ef59f7a.e7cadeec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4865],{84605:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>h,contentTitle:()=>b,default:()=>k,frontMatter:()=>g,metadata:()=>o,toc:()=>x});const o=JSON.parse('{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.1/getdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocument","permalink":"/docs/API-docs/v1.1/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9GctuGznyV2p42YnRluRHklmdxpjNerwbTIyxgwDrGAK7u1rNmE1ySLZkQRAwh/2DPe11Py1fsiiyu9WSFTvKZHKxJbLeL1aVlszzqWPjG/Y3ndUVKu/YbcJydJkVxgut2Jhdlwjn6KEFgbPLC0DFU4kOFroGr8GitwJnCDl6LqQDnuraAwdnMBOFyCBvsAcsYdqg5UT9ImdjNkXfXrKEGW55hR4tibVkilfIxqwFmIicJUyQWIb7km3LqtMPmPmLHHTRycsSZvG3WljM2djbGhPm/EISWScqI5ElDO+N1DmyccGlI4CsxIqz8ZL5hQmQ3go1ZQkrtK2475/gPQ9Uxsz8fJSW2XFpUrZa3RJbZ7Ry6IjQ8WhE/zbldXWWoXNFLaEzCktYppUnycdLxo2RIgsXww+OkJYPpYtqk/UskfEisnSe+9rtq4VQh8bqqUXn2CrpTLovmb+fi7vjk7R8+w+iUgg63I9C6b1x4+GwOamtHGS6ImoZ6ViQWb6YaI9Ej7AXfn85XfhAEU4klN5fKCOROwQnpqpLlGA1LXO0Tzv66/go5tp+FKKEEFBXawOuE7ZRgQJprjZ0+Sz6HzRCikj4ZJ1QFjoK3Fq+oHrgsXJPW8nq3b5dc8tQP2aInWJhxYV8EjpF/LE5aGPNlFo9web0+Yvjo5MfXh4R/FzkU/R/QP94u5/9Pd77VN8Hefm0j67qKkXbR+9OOvSjVcLu98Q5Pj1dJWyxJ9ZLYjXfE+nkh1XCyj2RTl9QLIcC/hk2/5Kc6my+6meUx8pI7nFyFfNg0sbDo1AhKR2q/EK9sZu1JNVaIld91vQ6Unm1yD3mZ/7x6DweHZ8cHo0ORy+vj16MT/86fv5iMBqN/sUSdl/JtfYspzrdLw7N99rk34RPbFaudf156lvMhcXMT2q7M7Ef8x2x41Lq+aTSeXxftgJlB9/QdBBinQs/8XazoOyZ5V9cj2YC57jzCfmKrghF/M9lsuMVmgtfxmZo0rdxAG0TRjwhVQ8QhAOt5AL4jAtJsQXzEhX4Ervnm2CaPILC6go4tBQGIUhqrycWK6GezMo2PCL0RKsMJ0JNcIZ2Z5nsEEek4JbJHliEPWqvpgid7mper3SFvhRqCnNSeG61mibQ9DLeLoBPuVBAKtvvvl5Xi9bqnX3E2lf7SdaPGKGkUDhpO/fJ6Wg0OeqMcPrQCN1UpLSHQtcq/7aq7uL/uEKnk5NOoecPFbpQMy5FHqa8a32H6tvq02fvI/uHUSwiULhnG8r2z6OSDrPaCr8I4+T9ITfiMN6Pb25pSKNI0c0cGuZPX7IxG7apMFz2Zs8VI3p21k6n4YHoRgrHVZ7q+4E2qKjOSZ46Kq5DbsRwdjSgLm4bhxuzFzzWh/uiOM+nQk2fwrtdm+qK3Bk9tmGw9ZNkxD+R3qTGH32oZjwvkYe+f0XfCx2QGy+9MaioPQk+Dsy3x/h3KDNdIW0WqKa2CB///b+A03okBGGg8N179V69qS0YPUdL4zRXORQS7wVV57CxqMJdt7JwyCuJzskFCOVxarlHyMVUeC7DJEblI+OGp0IKCmAC04RtoZcDbgDvSvQlWrr6i0XgkOMMJcU9UJWvuCdS3cMw1/aukHruEuCQ1k4odA5QlVxlBNh6IQFtgStA5dEaK2hA9JakFlE2rbzlmYeKKz5Fop1smCpHKShUweq0dh6clnUQGWhHoy3m0CqkEHM3ICO+ok2IRaDTTFfGYkkhM0OY1iJHl0Cmc4Q485IKKocUnQdDsogMHRGtldTZXXBeUUsJRlP5EFzSYqYvI6F7y5WjpirK0vqgM5ixmpYkGAU8OHjrkDz8Wqg7Nz44eK8O4aaLqXeYOuHx9vs2/Ofz+YOwf7aJcy78z3UKv6LRTnhtF2vsqfBlnYZU6RPpvkRK56gwxE8vEdY0cp25h5lHp8MSpRleoacIccOzy4tQcZ/Bx9//A6+RWwWlnsdozWqLcgHTlhVZLno+mq0rmFDoEHglWTyLwUcLMHS+teC7kvuPv//XwS84BxFTKBry4OCyTqXI4LppVtzBwRh+Co1M18A48CX3kHEFKYIrOYXSTHDgYCK2FOpuAGdqAbVDC9RPhGCg84C3ocbG3sNByh3moGM/1TVNa4novHIoZ+iIFj18KQLmgnotX1pdTyO3vjCNchYLISW8i7MT6XaW52Ca42akIoP3xMGCEsKXuABuERxtMeFyCyXc1MZoS1KIKHyhaRQgB6DKjRbKuzHklhd+TT9ZB3roF4VWO46iCdc9ZNKQ6VwSM7HRuDsdvKeCvFXEN2utxQItMQxqr/1iRBNON21YAkXrHwnrsLrTyvPM9yYVek1+3KYTXnW0lXtTXKGdiazd3X0io4cBeMgSJkWGymGvWzg7v3wNs5PBiCW9p/Ezknv4+uKnV79cvQrTEVoXDXY0GA1GYSGina+46nHqr8m3H7Xluon6E1bqzcNMq4OhkVyEtqiZX2NLc8N6W/Zxf6F+m7BSO08gyyUl31srVys6/q0OI8bNbcJm3AqSL/Q9uXD0Oe/25Z/U9Ptfm9X7M/jEbn6n5G2foajJmHFZh9k6YXe42Po1YHVLO5zYbJBoEeIsy9D4Hu6DrnWj9Tt/dc3CSFZuNjl3oclpPhD1nXJtdj9RAPpLrdhOhOUyNlCrVQcfrz6J0SjYQpORbler1f8ByerrWg==","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 r=n(74848),a=n(28453),i=n(33617),s=n.n(i),p=n(17543),l=n.n(p),m=n(86013),c=n.n(m),d=n(63723),u=n.n(d),y=(n(18766),n(79329),n(9303));const g={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9GctuGznyV2p42YnRluRHklmdxpjNerwbTIyxgwDrGAK7u1rNmE1ySLZkQRAwh/2DPe11Py1fsiiyu9WSFTvKZHKxJbLeL1aVlszzqWPjG/Y3ndUVKu/YbcJydJkVxgut2Jhdlwjn6KEFgbPLC0DFU4kOFroGr8GitwJnCDl6LqQDnuraAwdnMBOFyCBvsAcsYdqg5UT9ImdjNkXfXrKEGW55hR4tibVkilfIxqwFmIicJUyQWIb7km3LqtMPmPmLHHTRycsSZvG3WljM2djbGhPm/EISWScqI5ElDO+N1DmyccGlI4CsxIqz8ZL5hQmQ3go1ZQkrtK2475/gPQ9Uxsz8fJSW2XFpUrZa3RJbZ7Ry6IjQ8WhE/zbldXWWoXNFLaEzCktYppUnycdLxo2RIgsXww+OkJYPpYtqk/UskfEisnSe+9rtq4VQh8bqqUXn2CrpTLovmb+fi7vjk7R8+w+iUgg63I9C6b1x4+GwOamtHGS6ImoZ6ViQWb6YaI9Ej7AXfn85XfhAEU4klN5fKCOROwQnpqpLlGA1LXO0Tzv66/go5tp+FKKEEFBXawOuE7ZRgQJprjZ0+Sz6HzRCikj4ZJ1QFjoK3Fq+oHrgsXJPW8nq3b5dc8tQP2aInWJhxYV8EjpF/LE5aGPNlFo9web0+Yvjo5MfXh4R/FzkU/R/QP94u5/9Pd77VN8Hefm0j67qKkXbR+9OOvSjVcLu98Q5Pj1dJWyxJ9ZLYjXfE+nkh1XCyj2RTl9QLIcC/hk2/5Kc6my+6meUx8pI7nFyFfNg0sbDo1AhKR2q/EK9sZu1JNVaIld91vQ6Unm1yD3mZ/7x6DweHZ8cHo0ORy+vj16MT/86fv5iMBqN/sUSdl/JtfYspzrdLw7N99rk34RPbFaudf156lvMhcXMT2q7M7Ef8x2x41Lq+aTSeXxftgJlB9/QdBBinQs/8XazoOyZ5V9cj2YC57jzCfmKrghF/M9lsuMVmgtfxmZo0rdxAG0TRjwhVQ8QhAOt5AL4jAtJsQXzEhX4Ervnm2CaPILC6go4tBQGIUhqrycWK6GezMo2PCL0RKsMJ0JNcIZ2Z5nsEEek4JbJHliEPWqvpgid7mper3SFvhRqCnNSeG61mibQ9DLeLoBPuVBAKtvvvl5Xi9bqnX3E2lf7SdaPGKGkUDhpO/fJ6Wg0OeqMcPrQCN1UpLSHQtcq/7aq7uL/uEKnk5NOoecPFbpQMy5FHqa8a32H6tvq02fvI/uHUSwiULhnG8r2z6OSDrPaCr8I4+T9ITfiMN6Pb25pSKNI0c0cGuZPX7IxG7apMFz2Zs8VI3p21k6n4YHoRgrHVZ7q+4E2qKjOSZ46Kq5DbsRwdjSgLm4bhxuzFzzWh/uiOM+nQk2fwrtdm+qK3Bk9tmGw9ZNkxD+R3qTGH32oZjwvkYe+f0XfCx2QGy+9MaioPQk+Dsy3x/h3KDNdIW0WqKa2CB///b+A03okBGGg8N179V69qS0YPUdL4zRXORQS7wVV57CxqMJdt7JwyCuJzskFCOVxarlHyMVUeC7DJEblI+OGp0IKCmAC04RtoZcDbgDvSvQlWrr6i0XgkOMMJcU9UJWvuCdS3cMw1/aukHruEuCQ1k4odA5QlVxlBNh6IQFtgStA5dEaK2hA9JakFlE2rbzlmYeKKz5Fop1smCpHKShUweq0dh6clnUQGWhHoy3m0CqkEHM3ICO+ok2IRaDTTFfGYkkhM0OY1iJHl0Cmc4Q485IKKocUnQdDsogMHRGtldTZXXBeUUsJRlP5EFzSYqYvI6F7y5WjpirK0vqgM5ixmpYkGAU8OHjrkDz8Wqg7Nz44eK8O4aaLqXeYOuHx9vs2/Ofz+YOwf7aJcy78z3UKv6LRTnhtF2vsqfBlnYZU6RPpvkRK56gwxE8vEdY0cp25h5lHp8MSpRleoacIccOzy4tQcZ/Bx9//A6+RWwWlnsdozWqLcgHTlhVZLno+mq0rmFDoEHglWTyLwUcLMHS+teC7kvuPv//XwS84BxFTKBry4OCyTqXI4LppVtzBwRh+Co1M18A48CX3kHEFKYIrOYXSTHDgYCK2FOpuAGdqAbVDC9RPhGCg84C3ocbG3sNByh3moGM/1TVNa4novHIoZ+iIFj18KQLmgnotX1pdTyO3vjCNchYLISW8i7MT6XaW52Ca42akIoP3xMGCEsKXuABuERxtMeFyCyXc1MZoS1KIKHyhaRQgB6DKjRbKuzHklhd+TT9ZB3roF4VWO46iCdc9ZNKQ6VwSM7HRuDsdvKeCvFXEN2utxQItMQxqr/1iRBNON21YAkXrHwnrsLrTyvPM9yYVek1+3KYTXnW0lXtTXKGdiazd3X0io4cBeMgSJkWGymGvWzg7v3wNs5PBiCW9p/Ezknv4+uKnV79cvQrTEVoXDXY0GA1GYSGina+46nHqr8m3H7Xluon6E1bqzcNMq4OhkVyEtqiZX2NLc8N6W/Zxf6F+m7BSO08gyyUl31srVys6/q0OI8bNbcJm3AqSL/Q9uXD0Oe/25Z/U9Ptfm9X7M/jEbn6n5G2foajJmHFZh9k6YXe42Po1YHVLO5zYbJBoEeIsy9D4Hu6DrnWj9Tt/dc3CSFZuNjl3oclpPhD1nXJtdj9RAPpLrdhOhOUyNlCrVQcfrz6J0SjYQpORbler1f8ByerrWg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,h={},x=[];function f(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,r.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,r.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},audit_trail:{type:"array",items:{type:"object",properties:{email:{type:"string",example:"joebee@example.com"},viewed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},signed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"documentwithstatus_audit_trail"}},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"documentwithstatus"},title:"documentwithstatus"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function k(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.069815d8.js b/assets/js/851f8f65.069815d8.js new file mode 100644 index 000000000..153532b69 --- /dev/null +++ b/assets/js/851f8f65.069815d8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>f});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":"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7XglhkWtY5bUcNBV2V0Qq4AygGKzzWDEPMwf7NO+zqf5SzYyAdTRB0lJtIeabT/IbBSORCIzkcjrMrJ8aqL94+iFSqoCpDXR+zhKwSRalFYoGe1HRxmwF5pPLAud2MHhK8bzXM0Mqwxow6xiU5CguQUmYcbSMB0bz1mp1blIhZyylFvOZsJmjLMxN/Bol4FMVAopm4gceifyRB6Jcp+9K3PFUzZXlWaHL/5Qz4cLYdvx1tYLGFdT9u7V1tb7rzJrS7Pf7/Oy7KkSpBFTmfOx6SWq6KfYsUwnD2M2y0ADzsoSLhlwI/I542nKZiKdgjUxsxlIlqhyzhKldCokt2BiVvIpMFkVY9AmZlymrFAamJCMMw08nW9btV0ZYP/x9s1rNlG64LbHDvPKxPVyqdCQ2HzuprcZ1Lt6YAI2jNVCTmNW8DPEl7Dsp0okZ7htAzLF/+PAg8NXhKutrbdVWSptIWU/ui3sb23hl28gVzPGNVD/RBWFkqzkmhdg6cAybumzhp8qoSH1x5LnARf7J3KbbW3ZeQn7W1vslUxFgsigCbGVqYnv23NdEUnY9W0JiZgI37WFOqYkm2UiyQgnM+7Os8x54sDUYEpIrDiH7sQXMZvjxC9AqgBBprT4WUnLczqOc9BWJDxvHxsCiF2N5doiOkslpA2tfgX2J388eHp0KJ6uELQUkVUISV8MsHOeV2A8VLOYZQjVD1BqMETsfl5EpExZBmKarV2Ppx8qYzsTs8ogmG0o/FrhlAi9QGib8NwAE5MOLgt+Bq3VmCIm5nmPfTNnKUx4lduYCaQ4qyvosdfKMl6WuUj4OAekXIbMw22lYZtO2ZODB0Tygs74kHgaDOMsFZMJaGRO/EhT+DEBOqSzRggQ59iMS6bkwkEnKld6mYSouYtHlihpQdoeOzjnIifg3WYNEzLJqxTYOOfJWczGeQUx05A6xp0DCq7Y0Tt1Ydx4nBN+mIEcqVBJhF8qv7wwzHio0h47yoRp+Ak/BlTTIsK0seq5dqJwZURBYDEGBRd5TIiL2Qc1ZlbYHGJk2JLLeYwSE2Jm4cKO1UXMkgySM/pL81QoNq6sVdJtLNWqTNVMelxOlLRG/LyCI8OXj8foKGa7MXsUsycxGw5iNhzFbLgbs+GjmA2fxGw0iNloFLPRbsxGjxxYoydxEPkBwW0AhiOHZfvlYBfl7vfCEGejwDS1DJ51ZPCwx7a2am7Ctr/85S8n8vJEMnYSIXOdRPvsJKq7nESx+4YyE78N/e8L/LEzeux/zvHno9ET/3NGXYe7/meGP0fDE3nlFzyRI4LE8qK8Bgr8fKcQ+F+eiLCNFsW2IM+wEQVRHD7gWXXgwQ9X7b3s4F6EFFbw3KzfTuhxj3bUgLS0qV3cFJHr+h3R53u0nTY8+IXEpPtEYrX1KTA8QTFa2v1ez98s6zfvlr03e2+B83lbf4RbR9F0hKJp/f5r6XWPkLAI0+dh4nGPFACSzOvx4DvcIyx0Ifo8HDxBHOCltB4B+PUe7b4FDn7wN7z7NtjdHu5tjwaj3Q4G8G3kOhTFdppuz+fzu8Ae6jx+eVR5gobqNDt8l060KlY8P+h10PTyOhH9HVT2/0RFfRx0WEjx3UcPi6Cx1C++tpZtVcrnD4ybKgytlTPs36hm8xaY9AnhoNdvkimReOCxT1DJxvjA6yEOtgmT/TTttzCJjWm6XRTbC434c5sQ32osil6a9hZ6Lp2OayxYmsZsuXlle5qyoijWNLv2TnO/KJZ30SsKDxspX18jk3idbT2f+A6/Fas0HNFd+Fo2QsuBkjmtTc+51Xy0cNlkQvoPnqjYQgcN0yrnGi7wXWqEkq733fNYYLFGs6d3LD0ByUrgUMG+euO194ee/HEL3Qmw5eZxSzvDSQ5YUhmrCqZhChes5NaCljTZOc9Fyukpt00NcMGLEp8A/T+fnKT/+i99MkDgG98yPAmWiqlAO1D/z8cH2//9fkWPqixBJ9wAywFXMjEDm/TYcQZ52ZiiZrNZb7Zjkkyp3NmhPhgNE/fvqRp/OCVwyx435cNVO3Wk0XrwI+ksvvcN2A7GuGFh5IonP9EY8dBwQLetf+9cc936HvfoxlkACT866wl+Pj6JCk4KCZIyNH8rm4E+id7XY9wjH9Ibxr6/BbNmIoWcjyFf/nRrRqubcz5XlefvYNTqbtVTdAtv+KEQsrZb0HYGcesjv1j46L5dreBvh5A2d4YrJ7BnOAGWCxMsN110tkd70xYZHCUA2TDHwMIANBAH6fG5XFADdjs2cJLIn90NS2A/Rh1rs2JY7YYVOgfTRgzOUQgpiqqo7aOTetaAssLrHm184Ui0u4cV2qe7tAK/uGEFNEauX+BEDsmOEewf12imvsc9khULIF3Pxp8iRTr39B1dsDczYNhWmwFXXMvY1V3INfOZ9dzXY2/wekObrBuEVrYkgdKiRe5zWbMG+dY3FNmsnB3uG7LDrae8trXuHlHfCrB+ZQr0/e769vkkIm3v/gsi1A7YtyZWZ5Qs+PSalzt9vkfk6eFZMkJsbR1qmIg8b7kUWWgKnh106UAOhXd7eWciXnVkCBfSKnwWBLftGCbkL7XkRsl443B094w70rZPlCUauFWaZdw4/ZsUfjwqdNjaDIoFU3wArTHHCxngxlMZ3t27cfT1oH1Ow0d7nXPaG3TOabDunK55NuIJmlJJU9vaoPnU4ms64tC+fLUssm2YFI/0pUTfSng9OGZQVZ6yXJyRVyUVpsz5HE81cKmHctFd9zxTyjQ9vMfsK7/h/a4nTml0xj3s1Y6J2xi8Fg6jdRbDxzuto9h78qTLMR2Guc37vVlv+RQGu/3hXt9ZtFYbtBozzHohfI0mwNhtzovsRLc6L+rZHNjG7PSpZqe7Ifedu3x1Dx+POpfFzuBTL4s7f1y3ueaGZ/VdPJ7v7BXbZrdbvl9/s3fk51PfbqNRj+9Mox4+3mlT4ePhHZhQ1yjOn0uJS/rxndEeuyvleBUB3kI7vlYl/mwCbQP7qxPp3t1o0sNBR0P7uqOgfT1qE+Xe3q2Isr3oAmWdROK/vnnzw2zwx2+n6uDg4OD123fZy3fTg4ODAn/3er2Vj6hVp03LoObqIwL9vUx3/JpVer0eohCDK/dpeL+U039z4+P1Y3onMoojVWLUplDyVRrtRynGeQYVPIrpGQHGfqPSebR/GfkQIfzTB+DgyP4Hg4Gil5FJMig4/hWeHxhaipGdURyRpxijS/Eco/1IjT9AgmuUGmGwAgyOpN77l6GXC4iMYq9mRfuR21cUR96WXzfVoaRlOomuwoLXTVW3NFMZ+qN+heA8GHP4idO8xqFXCwG1nzTTi9YMtLcCjtRzhd8svOBz05rXmfqixTheHIMcnvhRLOVzg5KiMu5WS3ieVDkqg3BRCj2vHaKkEbaoooa3XqmGd7h3FVNAE+g2SFxrPo/iSFgo2u1riECrjz+5BBRihqJSPnbsBwVjgN/7BvTW0MHz4qOh+KCAjYEOvcyU/Ojxw9HOcDTcGY5wBv+i/XQ8uq/LEHQJ4wAD5yANms52EwEaM4rC6t1Eo6E/bZtP4WZiPFoXGdwKSDQZPW94WQLXPQrQ/eTY7y5911dq7wZqvoqji5s3c8EStR3CjtlXOUyscxOyRGkJ+mE79uDebG60u3sVR/Obtzf/Irf3GA9vdvPufqR47SaW/R8B686TqzjKbob1uzqi/B8I7O6jq+Z2jchMB+FyOB2rdH4a5NbVTR3DRYH9JipPQaMWsiyvGlGDEgYzIU4X5fxYqRy4XCFoOqHEPmsFNV40+noryCwDfDg0ijDN3mjZ3kTsoMXwZFiIeBAGFVRdwUnUY68mLZ2ddOjFaObQlyKLpWIPaL1TU5EYf9D3vxFHD9pZG2hjbYKOAgjUmVkoypzSHmZoqB2TBy/tsfo/UvdqTCIA4boMC998VTx3kRa0oB/UzRlgXmPssedc1nHj3fhsdnlZkwFRx9UVu7zEUwV9ipfu1VXcNOBanQa6V12LhgTEeWdU3QTNwLqtNdSpOKeo4rgGH8fXBkBMpZDT00r7eVATvLrqdQhyAXAyV3scQFrTmZjKFbuu9RU66VtjfwnZngJwkv83eH9aPvtOrADlab989rR89iNmCJXgeM+hZyJk6jh/BnneY0+N1UpOny2g4Gnft68+Sg3nAmbEuHSqzSyLuK0n6nmY/oSCujk8YViiq0TwnEKMtEogeEXw3CQ+m42F0qAbSlga6ZI4SB/nUw3kfyFYeGUpI4oeZGHBp5xlGib//mABpw+evUXQMRnuaZ8/871fOUNAxs+BcTlntHGyWijtLF+TSpOYTHKuxcS//mJW5oDhUPg45InzojmMBjiOMi7PTPx0rJ8dAS/YmxIkQvDL3/6OPYJMfyXf6BT0LYT6q4nz1yn2AOXYg9iFZhG5C22sF9VOEnoKcXCtYR0fmo9uvpe16DfV2GAvGeZrRKvVYjoF9GL5HjTYJ7oATzJ3aRBUfBLs9iUSj6pMAA8JLLzGyKUlHH0IOe3aWVrYIQdae++9VVJdYmbMm6PDW+CSjEDbjlGcBcTt0s3B3hwdYnJdfdw99s7UmAio5Z0uDJ/h7FzwkIBTa/ZzF84CzpPh5WLb69fzaW3bbBmgVJiVEMXuUkcJVyejLk3cZF/iEanKohdR+Jwi4rIOHgmKGpFHqroNVd6ASc6mFUUPW2TfcGtSAGGTHCeksbpyoTwsrXTIB/Rk4cSEMQ2eAlawU2v+mIE0bjhnE24s6JhVUiDmdYV2wXpKuChBC5AJrESBBoc6FB03X1HdTLN3P3zvc27DHgJTjpED3cSQsqokqiFOqDMgw8ktbn2lPujF980Aou5GeYreuFmCNkqiiFN6yqWXoO49ihbMMWQ8d129qEAnGMKDHN4FJmjav/zt7y241loklgFzK/A0xfDWGyAkY7AjeIzg0lCiBFRdiHA+0L9ffAIgdMQ0p4VKa0Yyt6fxQwqINbVc9F75OiLAVEmG11Ytb00cZKzxRgVDdl8yDpNbv8T9woUwtpXDFyLtl+XDD4B4TFow0CMUuRppXs7bDN5EKqiF6eh5ILr5n/UjaIkXeGXVqYZCyNvdU207u1W1IKisKrgVCQtTmV43q9c5cwNfF+yrABpS47lQ+uEaVsXpTpVM4FTIUzgHfYvn/es6MpAMgmOwMwDZhi0gyV1nTeblDJPlOzhp3U6UX9yGEi2DpQvHWGW56gIVsqRDiHugB3eVUPZ+McawIBdYgqxGgiO80pZMYV+KLc1HWGwsaV+QqWk4GPwzW9J2Bl+OJW138AVZ0p4gsN7reLMAWqffrJQdwbV4/YAPikz25Jy9vif68shI53zfqxDcsMPoyv3XGP+C3G+3dXyNzgJCYxrfoX/NhL0QFkaDAf6ve5ovOkGDqNtWCeqKkyrP57+L4ts7Lq8/ghpasdJMeZ1czz6I0c8XyfnoEPG4Rpe+dgJPiJXOsdgM3njbtR5DOl0Lt0LmQsIpofg0VcmpBnM6GgxOh5E7mN1VaHyrCrAZqV+IzBlaL+rnvdVzxqdcSIY0ru8Qq6D1TeT3cZCtwESgodPdDhL2lpHwSlKODdU4OlJnIH/bnbaXt255BPWiyBsZEAnXib5Hnc22290mDSSVFnYe7R9fRhfbvBTb7vv+8fur93GEiFXo+y+VIYi5zaL9qL8YCmBAn5NT9/jSkW9NkYbLFOOXlsQjL0X/fNgbRlfx4piV4vSa/lBtf+wQY/lUyOlN4943KHqLx+hOqoOoRmUsxR8BdUZ/Du1ecSSQfDLg+DZAzCN1/NAEULwMZxyCHFbFLTRnuRiJEAIROrEFi9faimiB1cECw72Wm/44eNzJiV770Fe5xeutB0d37eduua5bnuvjhtZrJ3HQbIekEo52d0l3ejwkJWPnCd3fu4+uiDobr1AUdT0/FNW+6L/4PHN81xq/MTH/E5mYFyzMnngaM6mL/uvY+3xT1/4VqLC2N3WMPos2n7X2lzXmF7/kgpmhBmTV636v86hewXdBKexyHcbHIdftDIjrdgfEdU8GHX3U77CZodEqSXWsNUdSD9vaIaqA71EGCjlRJEC9VAvnQvcbCeClVwTkiSrqsk6tg6QxgQWcEQxn+B2GDb6pNCvVDPSkcjWiJjlcCDRS4CAo6Fvj9wVe5GBMjsHyFqZUt5BSv9Ea7O2NCS/5WOQCL2+X0OKYorn/TY/92HiOH2iXCX8OOd75tZkH6x4G/XSm9NkEPdAxVkDEcm9o6AOZcZk4m6K7icg2hkYOtNeWWhisYqcRauFgU9Jq5ISCSz4lHo07qEohR5FlmFZjNLkblVeO0ywXudIu4os2RAGlFHv58qLET/QMQmushgzp9txblk3sLPvukvF1EMfoRCkRFpEAGdgqmSssWYjOmCrPWamsc5Dga6sNIw63mkuDaq8PMvNnUCPMG33B+GSfdwbwhL8X8syV2dpmxzVN/QhjIyx0k/AXee9hd8y3wn5XjbGInzLCKj1vRk+FzaoxqQvtSeofbqZvQ93LljLQzJGqxKx4N6rE9LFeQP8tWKQQ0z84fEXa5kP2y1//h30PXEuWqZmj1qTSkM+bEptUgJJO3qGtVhbJrYCCGjGeOOLz90vA4I8Zt7/89X8New0zNK8iCzlEbm0dVuNcJOwohBJsbe2z5/SkaoUXdJKGXSoX+no4K93oXMizHjuQc7JON7cNttO4zjbohmuVC+UYjKikjxx2a/YaiMgeaiA/BzJ7Y924MTBIhfOgaVVN3WptYPzmulltuLeDNGXlQmYb2l4bcJx5kVxX3NkZsa7nimS4TtZZ1+8OMqXKk2afkVLdzB8vpLvRXbfUFDLlAjpiP019JI4T/Y7rVhffu6DIdmWthglQZGe3gisvhSen40CWrFvd4uPJ2tkZ6Pqml5C/IHkpVnonsO6meTN5C/pcJOH5u4aj+9S5H8VRLhLwRg9/dx18e/g9O9/pDaK49Ty4BXP3v3/1/OXrty8RGBSkDmHD3qA3INusMrbgsrVSt0Tu4rXWip3eFNTdFNTdFNTdFNTdFNT9ckq+bgrqbgrqbgrqbgrqbgrqbgrq/npI2BTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTUvT+yYlNQ977UKd0U1P0tKHBTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdNQd1W2kW/zLmQrXxPl1t3vFBm930cZZh7t38cXV7iKu8wgwabf6oox+P4fRydcy0wOofS9uKQZoZ5HmeAyUrPXbDR9hEuHzvWpvjahWxFzJNzIw6Inq/t204PPHzz9iiKo1CprFAp5QXzGeaF8JlLjWklj1DbZZRzOa0o8SRyc165OhpZN63ujNLq/B+t7BUu5y0Iu/l2bhv4L25q5YDLS5eyR8ldrr/7tHaER2zojcf3/urq6v8AS3ubAA==","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),o=t(28453),r=t(33617),l=t.n(r),d=t(17543),a=t.n(d),c=t(86013),h=t.n(c),p=t(63723),m=t.n(p),u=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNlyHDeSv4Kp2AhZ3GJfJCWZq1UMLWls7XglhkWtY5bUcNBV2V0Qq4AygGKzzWDEPMwf7NO+zqf5SzYyAdTRB0lJtIeabT/IbBSORCIzkcjrMrJ8aqL94+iFSqoCpDXR+zhKwSRalFYoGe1HRxmwF5pPLAud2MHhK8bzXM0Mqwxow6xiU5CguQUmYcbSMB0bz1mp1blIhZyylFvOZsJmjLMxN/Bol4FMVAopm4gceifyRB6Jcp+9K3PFUzZXlWaHL/5Qz4cLYdvx1tYLGFdT9u7V1tb7rzJrS7Pf7/Oy7KkSpBFTmfOx6SWq6KfYsUwnD2M2y0ADzsoSLhlwI/I542nKZiKdgjUxsxlIlqhyzhKldCokt2BiVvIpMFkVY9AmZlymrFAamJCMMw08nW9btV0ZYP/x9s1rNlG64LbHDvPKxPVyqdCQ2HzuprcZ1Lt6YAI2jNVCTmNW8DPEl7Dsp0okZ7htAzLF/+PAg8NXhKutrbdVWSptIWU/ui3sb23hl28gVzPGNVD/RBWFkqzkmhdg6cAybumzhp8qoSH1x5LnARf7J3KbbW3ZeQn7W1vslUxFgsigCbGVqYnv23NdEUnY9W0JiZgI37WFOqYkm2UiyQgnM+7Os8x54sDUYEpIrDiH7sQXMZvjxC9AqgBBprT4WUnLczqOc9BWJDxvHxsCiF2N5doiOkslpA2tfgX2J388eHp0KJ6uELQUkVUISV8MsHOeV2A8VLOYZQjVD1BqMETsfl5EpExZBmKarV2Ppx8qYzsTs8ogmG0o/FrhlAi9QGib8NwAE5MOLgt+Bq3VmCIm5nmPfTNnKUx4lduYCaQ4qyvosdfKMl6WuUj4OAekXIbMw22lYZtO2ZODB0Tygs74kHgaDOMsFZMJaGRO/EhT+DEBOqSzRggQ59iMS6bkwkEnKld6mYSouYtHlihpQdoeOzjnIifg3WYNEzLJqxTYOOfJWczGeQUx05A6xp0DCq7Y0Tt1Ydx4nBN+mIEcqVBJhF8qv7wwzHio0h47yoRp+Ak/BlTTIsK0seq5dqJwZURBYDEGBRd5TIiL2Qc1ZlbYHGJk2JLLeYwSE2Jm4cKO1UXMkgySM/pL81QoNq6sVdJtLNWqTNVMelxOlLRG/LyCI8OXj8foKGa7MXsUsycxGw5iNhzFbLgbs+GjmA2fxGw0iNloFLPRbsxGjxxYoydxEPkBwW0AhiOHZfvlYBfl7vfCEGejwDS1DJ51ZPCwx7a2am7Ctr/85S8n8vJEMnYSIXOdRPvsJKq7nESx+4YyE78N/e8L/LEzeux/zvHno9ET/3NGXYe7/meGP0fDE3nlFzyRI4LE8qK8Bgr8fKcQ+F+eiLCNFsW2IM+wEQVRHD7gWXXgwQ9X7b3s4F6EFFbw3KzfTuhxj3bUgLS0qV3cFJHr+h3R53u0nTY8+IXEpPtEYrX1KTA8QTFa2v1ez98s6zfvlr03e2+B83lbf4RbR9F0hKJp/f5r6XWPkLAI0+dh4nGPFACSzOvx4DvcIyx0Ifo8HDxBHOCltB4B+PUe7b4FDn7wN7z7NtjdHu5tjwaj3Q4G8G3kOhTFdppuz+fzu8Ae6jx+eVR5gobqNDt8l060KlY8P+h10PTyOhH9HVT2/0RFfRx0WEjx3UcPi6Cx1C++tpZtVcrnD4ybKgytlTPs36hm8xaY9AnhoNdvkimReOCxT1DJxvjA6yEOtgmT/TTttzCJjWm6XRTbC434c5sQ32osil6a9hZ6Lp2OayxYmsZsuXlle5qyoijWNLv2TnO/KJZ30SsKDxspX18jk3idbT2f+A6/Fas0HNFd+Fo2QsuBkjmtTc+51Xy0cNlkQvoPnqjYQgcN0yrnGi7wXWqEkq733fNYYLFGs6d3LD0ByUrgUMG+euO194ee/HEL3Qmw5eZxSzvDSQ5YUhmrCqZhChes5NaCljTZOc9Fyukpt00NcMGLEp8A/T+fnKT/+i99MkDgG98yPAmWiqlAO1D/z8cH2//9fkWPqixBJ9wAywFXMjEDm/TYcQZ52ZiiZrNZb7Zjkkyp3NmhPhgNE/fvqRp/OCVwyx435cNVO3Wk0XrwI+ksvvcN2A7GuGFh5IonP9EY8dBwQLetf+9cc936HvfoxlkACT866wl+Pj6JCk4KCZIyNH8rm4E+id7XY9wjH9Ibxr6/BbNmIoWcjyFf/nRrRqubcz5XlefvYNTqbtVTdAtv+KEQsrZb0HYGcesjv1j46L5dreBvh5A2d4YrJ7BnOAGWCxMsN110tkd70xYZHCUA2TDHwMIANBAH6fG5XFADdjs2cJLIn90NS2A/Rh1rs2JY7YYVOgfTRgzOUQgpiqqo7aOTetaAssLrHm184Ui0u4cV2qe7tAK/uGEFNEauX+BEDsmOEewf12imvsc9khULIF3Pxp8iRTr39B1dsDczYNhWmwFXXMvY1V3INfOZ9dzXY2/wekObrBuEVrYkgdKiRe5zWbMG+dY3FNmsnB3uG7LDrae8trXuHlHfCrB+ZQr0/e769vkkIm3v/gsi1A7YtyZWZ5Qs+PSalzt9vkfk6eFZMkJsbR1qmIg8b7kUWWgKnh106UAOhXd7eWciXnVkCBfSKnwWBLftGCbkL7XkRsl443B094w70rZPlCUauFWaZdw4/ZsUfjwqdNjaDIoFU3wArTHHCxngxlMZ3t27cfT1oH1Ow0d7nXPaG3TOabDunK55NuIJmlJJU9vaoPnU4ms64tC+fLUssm2YFI/0pUTfSng9OGZQVZ6yXJyRVyUVpsz5HE81cKmHctFd9zxTyjQ9vMfsK7/h/a4nTml0xj3s1Y6J2xi8Fg6jdRbDxzuto9h78qTLMR2Guc37vVlv+RQGu/3hXt9ZtFYbtBozzHohfI0mwNhtzovsRLc6L+rZHNjG7PSpZqe7Ifedu3x1Dx+POpfFzuBTL4s7f1y3ueaGZ/VdPJ7v7BXbZrdbvl9/s3fk51PfbqNRj+9Mox4+3mlT4ePhHZhQ1yjOn0uJS/rxndEeuyvleBUB3kI7vlYl/mwCbQP7qxPp3t1o0sNBR0P7uqOgfT1qE+Xe3q2Isr3oAmWdROK/vnnzw2zwx2+n6uDg4OD123fZy3fTg4ODAn/3er2Vj6hVp03LoObqIwL9vUx3/JpVer0eohCDK/dpeL+U039z4+P1Y3onMoojVWLUplDyVRrtRynGeQYVPIrpGQHGfqPSebR/GfkQIfzTB+DgyP4Hg4Gil5FJMig4/hWeHxhaipGdURyRpxijS/Eco/1IjT9AgmuUGmGwAgyOpN77l6GXC4iMYq9mRfuR21cUR96WXzfVoaRlOomuwoLXTVW3NFMZ+qN+heA8GHP4idO8xqFXCwG1nzTTi9YMtLcCjtRzhd8svOBz05rXmfqixTheHIMcnvhRLOVzg5KiMu5WS3ieVDkqg3BRCj2vHaKkEbaoooa3XqmGd7h3FVNAE+g2SFxrPo/iSFgo2u1riECrjz+5BBRihqJSPnbsBwVjgN/7BvTW0MHz4qOh+KCAjYEOvcyU/Ojxw9HOcDTcGY5wBv+i/XQ8uq/LEHQJ4wAD5yANms52EwEaM4rC6t1Eo6E/bZtP4WZiPFoXGdwKSDQZPW94WQLXPQrQ/eTY7y5911dq7wZqvoqji5s3c8EStR3CjtlXOUyscxOyRGkJ+mE79uDebG60u3sVR/Obtzf/Irf3GA9vdvPufqR47SaW/R8B686TqzjKbob1uzqi/B8I7O6jq+Z2jchMB+FyOB2rdH4a5NbVTR3DRYH9JipPQaMWsiyvGlGDEgYzIU4X5fxYqRy4XCFoOqHEPmsFNV40+noryCwDfDg0ijDN3mjZ3kTsoMXwZFiIeBAGFVRdwUnUY68mLZ2ddOjFaObQlyKLpWIPaL1TU5EYf9D3vxFHD9pZG2hjbYKOAgjUmVkoypzSHmZoqB2TBy/tsfo/UvdqTCIA4boMC998VTx3kRa0oB/UzRlgXmPssedc1nHj3fhsdnlZkwFRx9UVu7zEUwV9ipfu1VXcNOBanQa6V12LhgTEeWdU3QTNwLqtNdSpOKeo4rgGH8fXBkBMpZDT00r7eVATvLrqdQhyAXAyV3scQFrTmZjKFbuu9RU66VtjfwnZngJwkv83eH9aPvtOrADlab989rR89iNmCJXgeM+hZyJk6jh/BnneY0+N1UpOny2g4Gnft68+Sg3nAmbEuHSqzSyLuK0n6nmY/oSCujk8YViiq0TwnEKMtEogeEXw3CQ+m42F0qAbSlga6ZI4SB/nUw3kfyFYeGUpI4oeZGHBp5xlGib//mABpw+evUXQMRnuaZ8/871fOUNAxs+BcTlntHGyWijtLF+TSpOYTHKuxcS//mJW5oDhUPg45InzojmMBjiOMi7PTPx0rJ8dAS/YmxIkQvDL3/6OPYJMfyXf6BT0LYT6q4nz1yn2AOXYg9iFZhG5C22sF9VOEnoKcXCtYR0fmo9uvpe16DfV2GAvGeZrRKvVYjoF9GL5HjTYJ7oATzJ3aRBUfBLs9iUSj6pMAA8JLLzGyKUlHH0IOe3aWVrYIQdae++9VVJdYmbMm6PDW+CSjEDbjlGcBcTt0s3B3hwdYnJdfdw99s7UmAio5Z0uDJ/h7FzwkIBTa/ZzF84CzpPh5WLb69fzaW3bbBmgVJiVEMXuUkcJVyejLk3cZF/iEanKohdR+Jwi4rIOHgmKGpFHqroNVd6ASc6mFUUPW2TfcGtSAGGTHCeksbpyoTwsrXTIB/Rk4cSEMQ2eAlawU2v+mIE0bjhnE24s6JhVUiDmdYV2wXpKuChBC5AJrESBBoc6FB03X1HdTLN3P3zvc27DHgJTjpED3cSQsqokqiFOqDMgw8ktbn2lPujF980Aou5GeYreuFmCNkqiiFN6yqWXoO49ihbMMWQ8d129qEAnGMKDHN4FJmjav/zt7y241loklgFzK/A0xfDWGyAkY7AjeIzg0lCiBFRdiHA+0L9ffAIgdMQ0p4VKa0Yyt6fxQwqINbVc9F75OiLAVEmG11Ytb00cZKzxRgVDdl8yDpNbv8T9woUwtpXDFyLtl+XDD4B4TFow0CMUuRppXs7bDN5EKqiF6eh5ILr5n/UjaIkXeGXVqYZCyNvdU207u1W1IKisKrgVCQtTmV43q9c5cwNfF+yrABpS47lQ+uEaVsXpTpVM4FTIUzgHfYvn/es6MpAMgmOwMwDZhi0gyV1nTeblDJPlOzhp3U6UX9yGEi2DpQvHWGW56gIVsqRDiHugB3eVUPZ+McawIBdYgqxGgiO80pZMYV+KLc1HWGwsaV+QqWk4GPwzW9J2Bl+OJW138AVZ0p4gsN7reLMAWqffrJQdwbV4/YAPikz25Jy9vif68shI53zfqxDcsMPoyv3XGP+C3G+3dXyNzgJCYxrfoX/NhL0QFkaDAf6ve5ovOkGDqNtWCeqKkyrP57+L4ts7Lq8/ghpasdJMeZ1czz6I0c8XyfnoEPG4Rpe+dgJPiJXOsdgM3njbtR5DOl0Lt0LmQsIpofg0VcmpBnM6GgxOh5E7mN1VaHyrCrAZqV+IzBlaL+rnvdVzxqdcSIY0ru8Qq6D1TeT3cZCtwESgodPdDhL2lpHwSlKODdU4OlJnIH/bnbaXt255BPWiyBsZEAnXib5Hnc22290mDSSVFnYe7R9fRhfbvBTb7vv+8fur93GEiFXo+y+VIYi5zaL9qL8YCmBAn5NT9/jSkW9NkYbLFOOXlsQjL0X/fNgbRlfx4piV4vSa/lBtf+wQY/lUyOlN4943KHqLx+hOqoOoRmUsxR8BdUZ/Du1ecSSQfDLg+DZAzCN1/NAEULwMZxyCHFbFLTRnuRiJEAIROrEFi9faimiB1cECw72Wm/44eNzJiV770Fe5xeutB0d37eduua5bnuvjhtZrJ3HQbIekEo52d0l3ejwkJWPnCd3fu4+uiDobr1AUdT0/FNW+6L/4PHN81xq/MTH/E5mYFyzMnngaM6mL/uvY+3xT1/4VqLC2N3WMPos2n7X2lzXmF7/kgpmhBmTV636v86hewXdBKexyHcbHIdftDIjrdgfEdU8GHX3U77CZodEqSXWsNUdSD9vaIaqA71EGCjlRJEC9VAvnQvcbCeClVwTkiSrqsk6tg6QxgQWcEQxn+B2GDb6pNCvVDPSkcjWiJjlcCDRS4CAo6Fvj9wVe5GBMjsHyFqZUt5BSv9Ea7O2NCS/5WOQCL2+X0OKYorn/TY/92HiOH2iXCX8OOd75tZkH6x4G/XSm9NkEPdAxVkDEcm9o6AOZcZk4m6K7icg2hkYOtNeWWhisYqcRauFgU9Jq5ISCSz4lHo07qEohR5FlmFZjNLkblVeO0ywXudIu4os2RAGlFHv58qLET/QMQmushgzp9txblk3sLPvukvF1EMfoRCkRFpEAGdgqmSssWYjOmCrPWamsc5Dga6sNIw63mkuDaq8PMvNnUCPMG33B+GSfdwbwhL8X8syV2dpmxzVN/QhjIyx0k/AXee9hd8y3wn5XjbGInzLCKj1vRk+FzaoxqQvtSeofbqZvQ93LljLQzJGqxKx4N6rE9LFeQP8tWKQQ0z84fEXa5kP2y1//h30PXEuWqZmj1qTSkM+bEptUgJJO3qGtVhbJrYCCGjGeOOLz90vA4I8Zt7/89X8New0zNK8iCzlEbm0dVuNcJOwohBJsbe2z5/SkaoUXdJKGXSoX+no4K93oXMizHjuQc7JON7cNttO4zjbohmuVC+UYjKikjxx2a/YaiMgeaiA/BzJ7Y924MTBIhfOgaVVN3WptYPzmulltuLeDNGXlQmYb2l4bcJx5kVxX3NkZsa7nimS4TtZZ1+8OMqXKk2afkVLdzB8vpLvRXbfUFDLlAjpiP019JI4T/Y7rVhffu6DIdmWthglQZGe3gisvhSen40CWrFvd4uPJ2tkZ6Pqml5C/IHkpVnonsO6meTN5C/pcJOH5u4aj+9S5H8VRLhLwRg9/dx18e/g9O9/pDaK49Ty4BXP3v3/1/OXrty8RGBSkDmHD3qA3INusMrbgsrVSt0Tu4rXWip3eFNTdFNTdFNTdFNTdFNT9ckq+bgrqbgrqbgrqbgrqbgrqbgrq/npI2BTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTU3RTUvT+yYlNQ977UKd0U1P0tKHBTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdTUHdNQd1W2kW/zLmQrXxPl1t3vFBm930cZZh7t38cXV7iKu8wgwabf6oox+P4fRydcy0wOofS9uKQZoZ5HmeAyUrPXbDR9hEuHzvWpvjahWxFzJNzIw6Inq/t204PPHzz9iiKo1CprFAp5QXzGeaF8JlLjWklj1DbZZRzOa0o8SRyc165OhpZN63ujNLq/B+t7BUu5y0Iu/l2bhv4L25q5YDLS5eyR8ldrr/7tHaER2zojcf3/urq6v8AS3ubAA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},f=[];function 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)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/851f8f65.caa1985b.js b/assets/js/851f8f65.caa1985b.js deleted file mode 100644 index acf058696..000000000 --- a/assets/js/851f8f65.caa1985b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9070],{72700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>b});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":"eJztPGtzHLeRfwWZuipZvOG+SEoyT6cKbSm2Lj6LZVHnypEKg53p3YE4A4wBDJcb1lbdh/yD+wf5afklV90A5rEPkpIYh8qtP8hcDB6NRnej0a/ryPKpiQ5Po5cqqQqQ1kTv4ygFk2hRWqFkdBidZMBeaj6xLHRiR8evGc9zNTOsMqANs4pNQYLmFpiEGUvDdGw8Z6VWlyIVcspSbjmbCZsxzsbcwJN9BjJRKaRsInLonckzeSLKQ/auzBVP2VxVmh2//F09Hy6Ebac7Oy9hXE3Zu9c7O++/yqwtzWG/z8uyp0qQRkxlzseml6iin2LHMp08jtksAw04K0u4ZMCNyOeMpymbiXQK1sTMZiBZoso5S5TSqZDcgolZyafAZFWMQZuYcZmyQmlgQjLONPB0vmvVbmWA/cfbNz+yidIFtz12nFcmrpdLhYbE5nM3vc2g3tUjE7BhrBZyGrOCXyC+hGW/VCK5wG0bkCn+HwceHb8mXO3svK3KUmkLKfvZbeFwZwe/fAO5mjGugfonqiiUZCXXvABLB5ZxS581/FIJDak/ljwPuDg8k7tsZ8fOSzjc2WGvZSoSRAZNiK1MTXzfnuuKSMKub0tIxET4ri3UMSXZLBNJRjiZcXeeZc4TB6YGU0JixSV0J76K2RwnfglSBQgypcWflbQ8p+O4BG1FwvP2sSGA2NVYri2is1RC2tDqV2B/8MeDp0eH4ukKQUsRWYWQ9MUAu+R5BcZDNYtZhlD9BKUGQ8Tu50VEypRlIKbZxvV4+qEytjMxqwyC2YbCrxVOidALhLYJzw0wMengsuAX0FqNKWJinvfYN3OWwoRXuY2ZQIqzuoIe+1FZxssyFwkf54CUy5B5uK007NIpe3LwgEhe0BkfE0+DYZylYjIBjcyJH2kKPyZAh3TWCAHiHJtxyZRcOuhE5UqvkhA1d/HIEiUtSNtjR5dc5AS826xhQiZ5lQIb5zy5iNk4ryBmGlLHuHNAwRU7eqcujBuPc8IPM5AjFSqJ8EvllxeGGQ9V2mMnmTANP+HHgGpaRJg2Vj3XThSujCgILMag4CKPCXEx+6DGzAqbQ4wMW3I5j1FiQswsXNmxuopZkkFyQX9pngrFxpW1SrqNpVqVqZpJj8uJktaIP6/hyPDl4zE6itl+zJ7E7FnMhoOYDUcxG+7HbPgkZsNnMRsNYjYaxWy0H7PREwfW6FkcRH5AcBuA4chh2X452EW5+4MwxNkoME0tg2cdGTzssZ2dmpuw7U9/+tOZvD6TjJ1FyFxn0SE7i+ouZ1HsvqHMxG9D//sKf+yNnvqfc/z5ZPTM/5xR1+G+/5nhz9HwTC78gmdyRJBYXpQ3QIGf7xUC/8sTEbbRotgW5Bk2oiCKwwc8qw48+GHR3sse7kVIYQXPzebthB4PaEcNSCub2sdNEblu3hF9fkDbacODX0hMuk8kVlufAsMTFKOV3R/0/M2yefNu2Qez9xY4n7f1J7h1FE0nKJo277+WXg8ICcswfR4mnvZIASDJvBkPvsMDwkIXos/DwTPEAV5KmxGAXx/Q7lvg4Ad/w7tvg/3d4cHuaDDa72AA30auQ1HspunufD6/D+yhzuOXR5UnaKhOs8N36USrYs3zg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+yLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJglzDZT9N+C5PYmKa7RbG71Ig/dwnxrcai6KVpb6nnyum4xoKlacxWm9e2pykrimJDs2vvNPeLYnUXvaLwsJHy9TUyidfZNvOJ7/BrsUrDEd2Fb2QjtBwomdPa9Jxbz0dLl00mpP/giYotddAwrXKu4QrfpUYo6XrfP48FFms0e3rH0hOQrAQOFeyrN157f+zJH7fQnQBbbh+3sjOc5IgllbGqYBqmcMVKbi1oSZNd8lyknJ5yu9QAV7wo8QnQ/+PZWfqv/9InAwS+8S3Dk2CpmAq0A/X/eHq0+9/v1/SoyhJ0wg2wHHAlEzOwSY+dZpCXjSlqNpv1ZnsmyZTKnR3qg9Ewcf+eq/GHcwK37HFTPl63U0carQc/ks7ye9+A7WCMGxZGrnnyE40RDw0HdNv6984N163v8YBunCWQ8KOznuDn07Oo4KSQIClD87eyGeiz6H09xj3yIb1l7Ps7MGsmUsj5GPLVT3dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yq6WP7ttiDX87hLS5M1w5gT3DCbBcmGC56aKzPdqbtsjgKAHIhjkGFgaggThIj8/lghqwu7GBk0T+7G5ZAvsx6libFcNqt6zQOZg2YnCOQkhRVEVtH53UswaUFV73aOMLR6LdPazQPt2VFfjVLSugMXLzAmdySHaMYP+4QTP1PR6QrFgC6WY2/hQp0rmn7+mCvZ0Bw7baDLjmWsau7kKumc9s5r4ee4PXG9pk3SC0siUJlBYtcp/LmjXId76hyGbl7HDfkB1uM+W1rXUPiPrWgPV3pkDf775vn08i0vbuvyBC7YB9Z2J1RsmCT294udPnB0SeHp4VI8TOzrGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgyxQfQGnO8kAFuPJXh/b0bR18P2uc0fHLQOaeDQeecBpvO6YZnI56gKZU0ta0Nmk8tvqYjDu2rV8sy24ZJ8UhfSfSthNeDYwZV5SnLxQV5VVJhypzP8VQDl3ool91132ZKmaaH95h95Td82PXEKY3OuMe92jFxF4PX0mG0zmL4dK91FAfPnnU5psMwd3m/N+utnsJgvz886DuL1nqDVmOG2SyEb9AEGLvLeZGd6E7nRT2bA9uanT7V7HQ/5L53n6/u4dNR57LYG3zqZXHvj+s219zyrL6Px/O9vWLb7HbH9+uv9o78fOrbbzTq8b1p1MOne20qfDq8BxPqBsX5cylxRT++N9pj96UcryPAO2jHN6rEn02gbWD/7kR6cD+a9HDQ0dC+7ihoX4/aRHlwcCeibC+6RFlnkfivb978NBv8/rupOjo6Ovrx7bvs1bvp0dFRgb97vd7aR9S606ZlUHP1EYH+XqY7fsMqvV4PUYjBlYc0vF/K6b+58fHmMb0zGcWRKjFqUyj5Oo0OoxTjPIMKHsX0jABjv1HpPDq8jnyIEP7pA3BwZP+DwUDR68gkGRQc/wrPDwwtxcjOKI7IU4zRpXiO0WGkxh8gwTVKjTBYAQZHUu/D69DLBURGsVezosPI7SuKI2/Lr5vqUNIynUSLsOBNU9UtzVSG/qhfITgPxhx+4jQ/4tDFUkDtJ830sjUD7a2AE/Wtwm8WXvK5ac3rTH3RchwvjkEOT/wolvK5QUlRGXerJTxPqhyVQbgqhZ7XDlHSCFtUUcNbr1TDOzxYxBTQBLoNEteaz6M4EhaKdvsGItDq408uAYWYoaiUjx37QcEY4Le+Ab01dPC8+GgoPihgY6BDLzMlP3r8cLQ3HA33hiOcwb9oPx2P7usqBF3COMLAOUiDprPbRIDGjKKwerfRaOhP2+ZTuJ0YTzZFBrcCEk1GzxtelsB1jwJ0Pzn2u0vf9ZXau4WaF3F0dftmrliidkPYMfsqh4l1bkKWKC1BP27HHjyYzY329xdxNL99e/MvcntP8fBmt+/uZ4rXbmLZ/xGw7j1bxFF2O6zf1xHl/0Bg958smts1IjMdhMvhfKzS+XmQW4vbOoaLAvtNVJ6CRi1kVV41ogYlDGZCnC/L+bFSOXC5RtB0Qol91gpqvGj09VaQWQb4cGgUYZq90bK9idhBi+HJsBTxIAwqqLqCs6jHXk9aOjvp0MvRzKEvRRZLxR7ReuemIjH+qO9/I44etbM20MbaBB0FEKgzs1CUOaU9zNBQOyYPXtpj9X+k7tWYRADCdRkWvv2q+NZFWtCCflA3Z4B5jbHHvuWyjhvvxmez6+uaDIg6Fgt2fY2nCvocL93FIm4acK1OA92rrkVDAuKyM6pugmZg3dYa6lScc1RxXIOP42sDIKZSyOl5pf08qAkuFr0OQS4BTuZqjwNIazoTU7lm17W+Qid9Z+yvINtTAE7y/wbvz8sX34s1oDzvly+ely9+xgyhEhzvOfRMhEwd588gz3vsubFayemLJRQ87/v29Uep4VLAjBiXTrWZZRm39UQ9D9MfUFA3hycMS3SVCJ5TiJFWCQSvCJ6bxGezsVAadEMJSyNdEgfp43yqgfwvBAuvLGVE0YMsLPics0zD5N8fLeH00Yu3CDomwz3v8xe+92tnCMj4JTAu54w2TlYLpZ3la1JpEpNJzrWY+NdfzMocMBwKH4c8cV40h9EAx0nG5YWJn4/1ixPgBXtTgkQI/vaXv2KPINNfyzc6BX0Hof564vx1ij1COfYodqFZRO5CG+tFtZOEnkIcXBtYx4fmo5vvVS36TTU22EuG+RrRarWYTgG9WL4HDfaJLsCTzF0aBBWfBLt9icSjKhPAQwILrzFyaQlHH0JOu3aWFnbIgdbee2+dVJeYGfPm5PgOuCQj0K5jFGcBcbt0c7A3J8eYXFcfd4+9MzUmAmp5pwvDZzi7FDwk4NSa/dyFs4DzZHi52Pb69Xxa2y5bBSgVZi1EsbvUUcLVyagrEzfZl3hEqrLoRRQ+p4i4rINHgqJG5Imq7kKVt2CSs2lF0cMW2TfcmhRA2CTHCWmsrlwoD0srHfIBPVk4MWFMg6eAFezUmj9mII0bztmEGws6ZpUUiHldoV2wnhKuStACZAJrUaDBoQ5Fx+1XVDfT7N1PP/ic27CHwJRj5EA3MaSsKolqiBPqDMhwcstbX6sPevF9O4Cou1GeojdulqCNkijilJ5y6SWoe4+iBXMMGc9dVy8q0AmG8CCHd4EJmvbf/vLXFlwbLRKrgLkVeJpieOstEJIx2BE8RnBpKFECqi5EOB/o3y4/ARA6YprzQqU1I5m70/gxBcSaWi56r3wdEWCqJMNrq5a3Jg4y1nijgiG7LxmHya1f4n7hShjbyuELkfar8uEnQDwmLRjoEYpcjTQv520GbyIV1NJ09DwQ3fzP+hG0wgu8supcQyHk3e6ptp3dqloQVFYV3IqEhalMr5vV65y5ga8L9lUADanxUij9eAOr4nTnSiZwLuQ5XIK+w/P+xzoykAyCY7AzANmGLSDJXWdN5uUMk+U7OGndTpRf3IYSLYOlC8dYZ7nqAhWypEOIe6AHd5VQ9n4xxrAgF1iCrEaCI7zSVkxhX4otzUdYbC1pX5CpaTgY/DNb0vYGX44lbX/wBVnSniGw3ut4uwDapN+slR3BtXjzgA+KTPbknL25J/ryyEjnfN/rENyww2jh/muMf0Hut9s6vkZnAaExje/Qv2bCXggLo8EA/9c9zZedoEHUbasEdcVJlefz30Tx3R2XNx9BDa1Ya6a8Sa5nH8Toz1fJ5egY8bhBl75xAk+Ilc6x2AzeeLu1HkM6XQu3QuZCwjmh+DxVybkGcz4aDM6HkTuY/XVofKsKsBmpX4jMGVov6ue91XPGp1xIhjSu7xGroPVt5PdxkK3BRKCh8/0OEg5WkfBaUo4N1Tg6URcgf92dtpe3bnkE9arIGxkQCdeJvkedzbbb3SYNJJUWdh4dnl5HV7u8FLvu++Hp+8X7OELEKvT9l8oQxNxm0WHUXw4FMKAvyal7eu3It6ZIw2WK8Usr4pGXon857A2jRbw8Zq04vaE/VLsfO8RYPhVyetu49w2K3uIxupPqIKpRGUvxe0Cd0Z9Du1ccCSSfDDi+DRDzSB0/NQEUr8IZhyCHdXELzVkuRyKEQIRObMHytbYmWmB9sMDwoOWmPw0ed3Ki1z70dW7xeuvB0V37uVuu65bn+rSh9dpJHDTbIamEo/190p2eDknJ2HtG9/f+kwVRZ+MViqKu54ei2pf9F59nju9a47cm5n8iE/OShdkTT2MmddF/HXufb+ravwIV1vamjtFn2eaz0f6ywfzil1wyM9SArHvdH3Qe1Wv4LiiFXa7D+Djkur0Bcd3+gLju2aCjj/odNjM0WiWpjrXmSOphWztEFfA9ykAhJ4oEqJdq4VzofiMBvPKKgDxRRV3WqXWQNCawgDOC4Qy/wbDBN5VmpZqBnlSuRtQkhyuBRgocBAV9a/y+wIscjMkxWN7ClOoWUuo3WoO9vTHhJR+LXODl7RJaHFM097/psZ8bz/Ej7TLhLyHHO78282Ddw6CfzpS+mKAHOsYKiFjuDQ19IDMuE2dTdDcR2cbQyIH22lILg1XsNEItHGxKWo2cUHDJp8SjcQdVKeQosgzTaowmd6PyynGa5SJX2kV80YYooJRiL19dlfiJnkFojdWQId1eesuyiZ1l310yvg7iGJ0oJcIiEiADWyVzhSUL0RlT5TkrlXUOEnxttWHE4VZzaVDt9UFm/gxqhHmjLxif7PPOAJ7wD0JeuDJbu+y0pqmfYWyEhW4S/jLvPe6O+U7Y76sxFvFTRlil583oqbBZNSZ1oT1J/cPN9F2oe9lSBpo5UpWYNe9GlZg+1gvovwWLFGL6R8evSdt8zP72P//LfgCuJcvUzFFrUmnI502JTSpASSfv0FYri+RWQEGNGE8c8fn7pcZgSWF9wjGPx+FxNc5FUscQHLIjVnabQppweGHR7eQSudDTw1ku5EWPHck5GaWbSwbbabAb2VxrrfQwsnoI22PfqxnKtbgxbGNlOEhFKHPggRHWQD6hoONuZtrh+kw1tBX6wi0bs9J8lAetTDEecxrL62p43hbdONRBplRS0hwy0pabsqfxUh4bXWIrTSEFLmwr9tPUoRyOxZZOwvRcKMeSitqVohomQDGb3dqsvBSeUE4DwbFu3YqPJ1hnQaCLmd44/urjpVjrd8CKmubN5C3oS5GEh+0GXu1T534UR7lIwJsz/K109N3xD+yS7fUGUdzS/O/At/0fXn/76se3rxAalJEOY8PeoDcgs6sytuCytVS3+u3yjdUKi97Wyt3Wyt3Wyt3Wyt3Wyv1yqrlua+Vua+Vua+Vua+Vua+Vua+X+/ZCwrZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZX7cGTFtlbuQylBuq2V+2tQ4LZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7oZaua2Min6ZcyFbqZwube50qYLu+zjKMK3u8DS6vsZV3mFyDDb/UlH6xun7OLrkWmB0DmXkxSGDDFM4LgDzkL51wUa7J7h87FibAmyXEhExBc6NOCJ6vrFvO/Pv+M3bkyiOQhGyQqWU8stnmPLBZy7rpZUXQm3XUc7ltKKcksjNuXAlMrJuxtwFZcz5P1qJKVzOWxB2U+ncNvBf3NTaAdfXLhuP8rZcf/dp4wiP2NAbj+/9YrH4P8Gni7k=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/v1.1/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/v1.1/createdocument"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztPGtzHLeRfwWZuipZvOG+SEoyT6cKbSm2Lj6LZVHnypEKg53p3YE4A4wBDJcb1lbdh/yD+wf5afklV90A5rEPkpIYh8qtP8hcDB6NRnej0a/ryPKpiQ5Po5cqqQqQ1kTv4ygFk2hRWqFkdBidZMBeaj6xLHRiR8evGc9zNTOsMqANs4pNQYLmFpiEGUvDdGw8Z6VWlyIVcspSbjmbCZsxzsbcwJN9BjJRKaRsInLonckzeSLKQ/auzBVP2VxVmh2//F09Hy6Ebac7Oy9hXE3Zu9c7O++/yqwtzWG/z8uyp0qQRkxlzseml6iin2LHMp08jtksAw04K0u4ZMCNyOeMpymbiXQK1sTMZiBZoso5S5TSqZDcgolZyafAZFWMQZuYcZmyQmlgQjLONPB0vmvVbmWA/cfbNz+yidIFtz12nFcmrpdLhYbE5nM3vc2g3tUjE7BhrBZyGrOCXyC+hGW/VCK5wG0bkCn+HwceHb8mXO3svK3KUmkLKfvZbeFwZwe/fAO5mjGugfonqiiUZCXXvABLB5ZxS581/FIJDak/ljwPuDg8k7tsZ8fOSzjc2WGvZSoSRAZNiK1MTXzfnuuKSMKub0tIxET4ri3UMSXZLBNJRjiZcXeeZc4TB6YGU0JixSV0J76K2RwnfglSBQgypcWflbQ8p+O4BG1FwvP2sSGA2NVYri2is1RC2tDqV2B/8MeDp0eH4ukKQUsRWYWQ9MUAu+R5BcZDNYtZhlD9BKUGQ8Tu50VEypRlIKbZxvV4+qEytjMxqwyC2YbCrxVOidALhLYJzw0wMengsuAX0FqNKWJinvfYN3OWwoRXuY2ZQIqzuoIe+1FZxssyFwkf54CUy5B5uK007NIpe3LwgEhe0BkfE0+DYZylYjIBjcyJH2kKPyZAh3TWCAHiHJtxyZRcOuhE5UqvkhA1d/HIEiUtSNtjR5dc5AS826xhQiZ5lQIb5zy5iNk4ryBmGlLHuHNAwRU7eqcujBuPc8IPM5AjFSqJ8EvllxeGGQ9V2mMnmTANP+HHgGpaRJg2Vj3XThSujCgILMag4CKPCXEx+6DGzAqbQ4wMW3I5j1FiQswsXNmxuopZkkFyQX9pngrFxpW1SrqNpVqVqZpJj8uJktaIP6/hyPDl4zE6itl+zJ7E7FnMhoOYDUcxG+7HbPgkZsNnMRsNYjYaxWy0H7PREwfW6FkcRH5AcBuA4chh2X452EW5+4MwxNkoME0tg2cdGTzssZ2dmpuw7U9/+tOZvD6TjJ1FyFxn0SE7i+ouZ1HsvqHMxG9D//sKf+yNnvqfc/z5ZPTM/5xR1+G+/5nhz9HwTC78gmdyRJBYXpQ3QIGf7xUC/8sTEbbRotgW5Bk2oiCKwwc8qw48+GHR3sse7kVIYQXPzebthB4PaEcNSCub2sdNEblu3hF9fkDbacODX0hMuk8kVlufAsMTFKOV3R/0/M2yefNu2Qez9xY4n7f1J7h1FE0nKJo277+WXg8ICcswfR4mnvZIASDJvBkPvsMDwkIXos/DwTPEAV5KmxGAXx/Q7lvg4Ad/w7tvg/3d4cHuaDDa72AA30auQ1HspunufD6/D+yhzuOXR5UnaKhOs8N36USrYs3zg14HTS+vE9HfQWX/T1TUx0GHhRTfffSwCBpL/eJra9lWpXz+yLipwtBaOcP+jWo2b4FJnxAOev0mmRKJBx77BJVsjA+8HuJglzDZT9N+C5PYmKa7RbG71Ig/dwnxrcai6KVpb6nnyum4xoKlacxWm9e2pykrimJDs2vvNPeLYnUXvaLwsJHy9TUyidfZNvOJ7/BrsUrDEd2Fb2QjtBwomdPa9Jxbz0dLl00mpP/giYotddAwrXKu4QrfpUYo6XrfP48FFms0e3rH0hOQrAQOFeyrN157f+zJH7fQnQBbbh+3sjOc5IgllbGqYBqmcMVKbi1oSZNd8lyknJ5yu9QAV7wo8QnQ/+PZWfqv/9InAwS+8S3Dk2CpmAq0A/X/eHq0+9/v1/SoyhJ0wg2wHHAlEzOwSY+dZpCXjSlqNpv1ZnsmyZTKnR3qg9Ewcf+eq/GHcwK37HFTPl63U0carQc/ks7ye9+A7WCMGxZGrnnyE40RDw0HdNv6984N163v8YBunCWQ8KOznuDn07Oo4KSQIClD87eyGeiz6H09xj3yIb1l7Ps7MGsmUsj5GPLVT3dmtLo553NVef4ORq3uVj1Ft/CGHwoha7sFbWcQtz7yq6WP7ttiDX87hLS5M1w5gT3DCbBcmGC56aKzPdqbtsjgKAHIhjkGFgaggThIj8/lghqwu7GBk0T+7G5ZAvsx6libFcNqt6zQOZg2YnCOQkhRVEVtH53UswaUFV73aOMLR6LdPazQPt2VFfjVLSugMXLzAmdySHaMYP+4QTP1PR6QrFgC6WY2/hQp0rmn7+mCvZ0Bw7baDLjmWsau7kKumc9s5r4ee4PXG9pk3SC0siUJlBYtcp/LmjXId76hyGbl7HDfkB1uM+W1rXUPiPrWgPV3pkDf775vn08i0vbuvyBC7YB9Z2J1RsmCT294udPnB0SeHp4VI8TOzrGGicjzlkuRhabg2UGXDuRQeLeXdybiVUeGcCGtwmdBcNuOYUL+UktulIw3Dkd3z7gjbftEWaKBW6VZxo3Tv0nhx6NCh63NoFgyxQfQGnO8kAFuPJXh/b0bR18P2uc0fHLQOaeDQeecBpvO6YZnI56gKZU0ta0Nmk8tvqYjDu2rV8sy24ZJ8UhfSfSthNeDYwZV5SnLxQV5VVJhypzP8VQDl3ool91132ZKmaaH95h95Td82PXEKY3OuMe92jFxF4PX0mG0zmL4dK91FAfPnnU5psMwd3m/N+utnsJgvz886DuL1nqDVmOG2SyEb9AEGLvLeZGd6E7nRT2bA9uanT7V7HQ/5L53n6/u4dNR57LYG3zqZXHvj+s219zyrL6Px/O9vWLb7HbH9+uv9o78fOrbbzTq8b1p1MOne20qfDq8BxPqBsX5cylxRT++N9pj96UcryPAO2jHN6rEn02gbWD/7kR6cD+a9HDQ0dC+7ihoX4/aRHlwcCeibC+6RFlnkfivb978NBv8/rupOjo6Ovrx7bvs1bvp0dFRgb97vd7aR9S606ZlUHP1EYH+XqY7fsMqvV4PUYjBlYc0vF/K6b+58fHmMb0zGcWRKjFqUyj5Oo0OoxTjPIMKHsX0jABjv1HpPDq8jnyIEP7pA3BwZP+DwUDR68gkGRQc/wrPDwwtxcjOKI7IU4zRpXiO0WGkxh8gwTVKjTBYAQZHUu/D69DLBURGsVezosPI7SuKI2/Lr5vqUNIynUSLsOBNU9UtzVSG/qhfITgPxhx+4jQ/4tDFUkDtJ830sjUD7a2AE/Wtwm8WXvK5ac3rTH3RchwvjkEOT/wolvK5QUlRGXerJTxPqhyVQbgqhZ7XDlHSCFtUUcNbr1TDOzxYxBTQBLoNEteaz6M4EhaKdvsGItDq408uAYWYoaiUjx37QcEY4Le+Ab01dPC8+GgoPihgY6BDLzMlP3r8cLQ3HA33hiOcwb9oPx2P7usqBF3COMLAOUiDprPbRIDGjKKwerfRaOhP2+ZTuJ0YTzZFBrcCEk1GzxtelsB1jwJ0Pzn2u0vf9ZXau4WaF3F0dftmrliidkPYMfsqh4l1bkKWKC1BP27HHjyYzY329xdxNL99e/MvcntP8fBmt+/uZ4rXbmLZ/xGw7j1bxFF2O6zf1xHl/0Bg958smts1IjMdhMvhfKzS+XmQW4vbOoaLAvtNVJ6CRi1kVV41ogYlDGZCnC/L+bFSOXC5RtB0Qol91gpqvGj09VaQWQb4cGgUYZq90bK9idhBi+HJsBTxIAwqqLqCs6jHXk9aOjvp0MvRzKEvRRZLxR7ReuemIjH+qO9/I44etbM20MbaBB0FEKgzs1CUOaU9zNBQOyYPXtpj9X+k7tWYRADCdRkWvv2q+NZFWtCCflA3Z4B5jbHHvuWyjhvvxmez6+uaDIg6Fgt2fY2nCvocL93FIm4acK1OA92rrkVDAuKyM6pugmZg3dYa6lScc1RxXIOP42sDIKZSyOl5pf08qAkuFr0OQS4BTuZqjwNIazoTU7lm17W+Qid9Z+yvINtTAE7y/wbvz8sX34s1oDzvly+ely9+xgyhEhzvOfRMhEwd588gz3vsubFayemLJRQ87/v29Uep4VLAjBiXTrWZZRm39UQ9D9MfUFA3hycMS3SVCJ5TiJFWCQSvCJ6bxGezsVAadEMJSyNdEgfp43yqgfwvBAuvLGVE0YMsLPics0zD5N8fLeH00Yu3CDomwz3v8xe+92tnCMj4JTAu54w2TlYLpZ3la1JpEpNJzrWY+NdfzMocMBwKH4c8cV40h9EAx0nG5YWJn4/1ixPgBXtTgkQI/vaXv2KPINNfyzc6BX0Hof564vx1ij1COfYodqFZRO5CG+tFtZOEnkIcXBtYx4fmo5vvVS36TTU22EuG+RrRarWYTgG9WL4HDfaJLsCTzF0aBBWfBLt9icSjKhPAQwILrzFyaQlHH0JOu3aWFnbIgdbee2+dVJeYGfPm5PgOuCQj0K5jFGcBcbt0c7A3J8eYXFcfd4+9MzUmAmp5pwvDZzi7FDwk4NSa/dyFs4DzZHi52Pb69Xxa2y5bBSgVZi1EsbvUUcLVyagrEzfZl3hEqrLoRRQ+p4i4rINHgqJG5Imq7kKVt2CSs2lF0cMW2TfcmhRA2CTHCWmsrlwoD0srHfIBPVk4MWFMg6eAFezUmj9mII0bztmEGws6ZpUUiHldoV2wnhKuStACZAJrUaDBoQ5Fx+1XVDfT7N1PP/ic27CHwJRj5EA3MaSsKolqiBPqDMhwcstbX6sPevF9O4Cou1GeojdulqCNkijilJ5y6SWoe4+iBXMMGc9dVy8q0AmG8CCHd4EJmvbf/vLXFlwbLRKrgLkVeJpieOstEJIx2BE8RnBpKFECqi5EOB/o3y4/ARA6YprzQqU1I5m70/gxBcSaWi56r3wdEWCqJMNrq5a3Jg4y1nijgiG7LxmHya1f4n7hShjbyuELkfar8uEnQDwmLRjoEYpcjTQv520GbyIV1NJ09DwQ3fzP+hG0wgu8supcQyHk3e6ptp3dqloQVFYV3IqEhalMr5vV65y5ga8L9lUADanxUij9eAOr4nTnSiZwLuQ5XIK+w/P+xzoykAyCY7AzANmGLSDJXWdN5uUMk+U7OGndTpRf3IYSLYOlC8dYZ7nqAhWypEOIe6AHd5VQ9n4xxrAgF1iCrEaCI7zSVkxhX4otzUdYbC1pX5CpaTgY/DNb0vYGX44lbX/wBVnSniGw3ut4uwDapN+slR3BtXjzgA+KTPbknL25J/ryyEjnfN/rENyww2jh/muMf0Hut9s6vkZnAaExje/Qv2bCXggLo8EA/9c9zZedoEHUbasEdcVJlefz30Tx3R2XNx9BDa1Ya6a8Sa5nH8Toz1fJ5egY8bhBl75xAk+Ilc6x2AzeeLu1HkM6XQu3QuZCwjmh+DxVybkGcz4aDM6HkTuY/XVofKsKsBmpX4jMGVov6ue91XPGp1xIhjSu7xGroPVt5PdxkK3BRKCh8/0OEg5WkfBaUo4N1Tg6URcgf92dtpe3bnkE9arIGxkQCdeJvkedzbbb3SYNJJUWdh4dnl5HV7u8FLvu++Hp+8X7OELEKvT9l8oQxNxm0WHUXw4FMKAvyal7eu3It6ZIw2WK8Usr4pGXon857A2jRbw8Zq04vaE/VLsfO8RYPhVyetu49w2K3uIxupPqIKpRGUvxe0Cd0Z9Du1ccCSSfDDi+DRDzSB0/NQEUr8IZhyCHdXELzVkuRyKEQIRObMHytbYmWmB9sMDwoOWmPw0ed3Ki1z70dW7xeuvB0V37uVuu65bn+rSh9dpJHDTbIamEo/190p2eDknJ2HtG9/f+kwVRZ+MViqKu54ei2pf9F59nju9a47cm5n8iE/OShdkTT2MmddF/HXufb+ravwIV1vamjtFn2eaz0f6ywfzil1wyM9SArHvdH3Qe1Wv4LiiFXa7D+Djkur0Bcd3+gLju2aCjj/odNjM0WiWpjrXmSOphWztEFfA9ykAhJ4oEqJdq4VzofiMBvPKKgDxRRV3WqXWQNCawgDOC4Qy/wbDBN5VmpZqBnlSuRtQkhyuBRgocBAV9a/y+wIscjMkxWN7ClOoWUuo3WoO9vTHhJR+LXODl7RJaHFM097/psZ8bz/Ej7TLhLyHHO78282Ddw6CfzpS+mKAHOsYKiFjuDQ19IDMuE2dTdDcR2cbQyIH22lILg1XsNEItHGxKWo2cUHDJp8SjcQdVKeQosgzTaowmd6PyynGa5SJX2kV80YYooJRiL19dlfiJnkFojdWQId1eesuyiZ1l310yvg7iGJ0oJcIiEiADWyVzhSUL0RlT5TkrlXUOEnxttWHE4VZzaVDt9UFm/gxqhHmjLxif7PPOAJ7wD0JeuDJbu+y0pqmfYWyEhW4S/jLvPe6O+U7Y76sxFvFTRlil583oqbBZNSZ1oT1J/cPN9F2oe9lSBpo5UpWYNe9GlZg+1gvovwWLFGL6R8evSdt8zP72P//LfgCuJcvUzFFrUmnI502JTSpASSfv0FYri+RWQEGNGE8c8fn7pcZgSWF9wjGPx+FxNc5FUscQHLIjVnabQppweGHR7eQSudDTw1ku5EWPHck5GaWbSwbbabAb2VxrrfQwsnoI22PfqxnKtbgxbGNlOEhFKHPggRHWQD6hoONuZtrh+kw1tBX6wi0bs9J8lAetTDEecxrL62p43hbdONRBplRS0hwy0pabsqfxUh4bXWIrTSEFLmwr9tPUoRyOxZZOwvRcKMeSitqVohomQDGb3dqsvBSeUE4DwbFu3YqPJ1hnQaCLmd44/urjpVjrd8CKmubN5C3oS5GEh+0GXu1T534UR7lIwJsz/K109N3xD+yS7fUGUdzS/O/At/0fXn/76se3rxAalJEOY8PeoDcgs6sytuCytVS3+u3yjdUKi97Wyt3Wyt3Wyt3Wyt3Wyv1yqrlua+Vua+Vua+Vua+Vua+Vua+X+/ZCwrZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZX7cGTFtlbuQylBuq2V+2tQ4LZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7rZW7oZaua2Min6ZcyFbqZwube50qYLu+zjKMK3u8DS6vsZV3mFyDDb/UlH6xun7OLrkWmB0DmXkxSGDDFM4LgDzkL51wUa7J7h87FibAmyXEhExBc6NOCJ6vrFvO/Pv+M3bkyiOQhGyQqWU8stnmPLBZy7rpZUXQm3XUc7ltKKcksjNuXAlMrJuxtwFZcz5P1qJKVzOWxB2U+ncNvBf3NTaAdfXLhuP8rZcf/dp4wiP2NAbj+/9YrH4P8Gni7k=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,g={},b=[];function 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:"Draft Document"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/98334e25.0914355c.js b/assets/js/98334e25.0914355c.js new file mode 100644 index 000000000..ca398e9d7 --- /dev/null +++ b/assets/js/98334e25.0914355c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7024],{16460:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>g,default:()=>y,frontMatter:()=>Z,metadata:()=>i,toc:()=>m});const i=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":"eJy9Vktv20YQ/iuTvbQRaElpUxTQKUZguEaNxKgd+CALwZIckhstdze7Qz0gCMih/6CnXvvT8kuKWZJ6OUmbtuhFj9l5zzePjSBZBjGZintMK2vnYpaIHEPmlSNljZiIuwrhEgk6Bji/uQKptV3C2jZAFkokWHaPjdciEdahlyx+lYuJKJF65YnwGJw1AYOYbMR34zF/Hdu7bbIMQygaDTs9IhGZNYSGmF86p1UWH0bvAgttRMgqrCX/orVDMRE2fYcZiUQ4z2pItSY7Rw8YA3llSpEIXMnaaSZVRC5MRqO1bfxZJ3HWeP2iYxlmthbbbSJIURRQRiuDb/vg3n43Hr/9UWy3zPN8/PxxkG8CejCWoLCNyZ/8d/Gh99Z/ObpT218KhJ3vw/jhcRhXZiG1yiMm7uwczf8byaF5as2zq6tas5yRdRtSZIrv4ijUQ3obZMCs8YrWYjLdiNWZdOqsfZ9MZ9tZImqkynaYZoclVWIiRssdvAP6BfoQ5bkX9lgK0uSpXQ2tQxNUabRMA+NoJJ0aLZ4Nn4ltciojnfsqfmzOvlYkkCyVKf9KbrbPzS3Xry3RUYZ2hZJO/YxrkfQFOORKhGLcVChz9LFYyhQ2Cndlee3Q3KrSxKJG46cD6R51Zmvk0UMVQi/w8dc/okxus6ZGQxF1UcOTB/NgXjcenF2i58EiTQ6FxpVKNUYhrONb6GdaQFlrDEGvQRnC0ktCyFWpSGrgHClTQiadTJVWjFhmsyzt4QD0YQj3FVKFnp++8QgSclygZqCDbMjWklhV7zQsrZ8X2i5DAhLSJiiDIQCaSpqMGfsqJGA9SANoCL3zKiAE8uy1an2zhrzMCGppZImsOzlKVY5aMVTB27QJBMHqJroMJJW2HnPoAzKIeRhyEi9Wjp+AqZmtnceKIbNAKBuVY0ggszlCiA3KIZgcUgwEjn1RGQZW2hhts3ksXtFoDc7yvFBSgy2OfGRx8tKEwvq69aWvwS5hzlteF9g6OBi8CcgVvlZmHiaDwYM5g+kOU/eYBkU4+7aH/3K5fAT7p8cyl4p+alL4BZ0Niqxf76VLRVWTxlY5VLL702q6RIMRPweNsNeR2yw87jymjirUbnSLxAgJo/Obqzhin8LHD7/BNUpvoLLLFq1Z41GvoexNcebayrdp201IKGwEXsUZz1rweXzfYKA+g/eVpI8ffg/wCpeg2hZqEzkY3DSpVhncYe20JAyDwQReemST1NOAKkmQSQMpQqgkQ2mhJEhwrbRWZj6Ec7OGhlfRUlEVwcD0KHcUBudlV+4AqQyYgzVRorc53HvE9DqgXmBgXbznUgTMFTGiK2+bsrV26EwXnMdCaQ33Ki+RYmzneQ6uIy9bMif8wB0suCGowjVIjxDQ0BBuTkTiS+Oc9eyFap0vLF9RXAA0ubPKUJhA7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddfjAA/lkiB/PWo8FejYY2kuvr4tTHZymPSyB0fpvYM27maeWzOLpgLVUut0mL071xDWOvg6vi1v0C5X1R9tnOnoUmUciEVplaAIenAfnlzfXsPh+OBbJwWr8G809ur56efHq9oKd4UHaJuzZcDwcM8nZQLU0B5YOjujTnbbZH03/5N7uFi/hikZOSxXvnBjMprtRprvDd5aIygZi0mbDzfTG6+2Wye8b9Hz5zBKxkF7JlPfxdLZN+nXNR80c15y0LEPHF9BC6qbd+SeH3tG1dHlxJxLBU+f4TJjHM6H7wdr7J7M+0H18P7QO8CcfM58U2GzaE2S73fG3T5+V6ALsuTmBs+12+ydZv6Pt","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=o(74848),s=o(28453),l=o(33617),a=o.n(l),p=o(17543),r=o.n(p),c=o(86013),d=o.n(c),h=o(63723),b=o.n(h),u=(o(18766),o(79329),o(9303));const Z={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:"eJy9Vktv20YQ/iuTvbQRaElpUxTQKUZguEaNxKgd+CALwZIckhstdze7Qz0gCMih/6CnXvvT8kuKWZJ6OUmbtuhFj9l5zzePjSBZBjGZintMK2vnYpaIHEPmlSNljZiIuwrhEgk6Bji/uQKptV3C2jZAFkokWHaPjdciEdahlyx+lYuJKJF65YnwGJw1AYOYbMR34zF/Hdu7bbIMQygaDTs9IhGZNYSGmF86p1UWH0bvAgttRMgqrCX/orVDMRE2fYcZiUQ4z2pItSY7Rw8YA3llSpEIXMnaaSZVRC5MRqO1bfxZJ3HWeP2iYxlmthbbbSJIURRQRiuDb/vg3n43Hr/9UWy3zPN8/PxxkG8CejCWoLCNyZ/8d/Gh99Z/ObpT218KhJ3vw/jhcRhXZiG1yiMm7uwczf8byaF5as2zq6tas5yRdRtSZIrv4ijUQ3obZMCs8YrWYjLdiNWZdOqsfZ9MZ9tZImqkynaYZoclVWIiRssdvAP6BfoQ5bkX9lgK0uSpXQ2tQxNUabRMA+NoJJ0aLZ4Nn4ltciojnfsqfmzOvlYkkCyVKf9KbrbPzS3Xry3RUYZ2hZJO/YxrkfQFOORKhGLcVChz9LFYyhQ2Cndlee3Q3KrSxKJG46cD6R51Zmvk0UMVQi/w8dc/okxus6ZGQxF1UcOTB/NgXjcenF2i58EiTQ6FxpVKNUYhrONb6GdaQFlrDEGvQRnC0ktCyFWpSGrgHClTQiadTJVWjFhmsyzt4QD0YQj3FVKFnp++8QgSclygZqCDbMjWklhV7zQsrZ8X2i5DAhLSJiiDIQCaSpqMGfsqJGA9SANoCL3zKiAE8uy1an2zhrzMCGppZImsOzlKVY5aMVTB27QJBMHqJroMJJW2HnPoAzKIeRhyEi9Wjp+AqZmtnceKIbNAKBuVY0ggszlCiA3KIZgcUgwEjn1RGQZW2hhts3ksXtFoDc7yvFBSgy2OfGRx8tKEwvq69aWvwS5hzlteF9g6OBi8CcgVvlZmHiaDwYM5g+kOU/eYBkU4+7aH/3K5fAT7p8cyl4p+alL4BZ0Niqxf76VLRVWTxlY5VLL702q6RIMRPweNsNeR2yw87jymjirUbnSLxAgJo/Obqzhin8LHD7/BNUpvoLLLFq1Z41GvoexNcebayrdp201IKGwEXsUZz1rweXzfYKA+g/eVpI8ffg/wCpeg2hZqEzkY3DSpVhncYe20JAyDwQReemST1NOAKkmQSQMpQqgkQ2mhJEhwrbRWZj6Ec7OGhlfRUlEVwcD0KHcUBudlV+4AqQyYgzVRorc53HvE9DqgXmBgXbznUgTMFTGiK2+bsrV26EwXnMdCaQ33Ki+RYmzneQ6uIy9bMif8wB0suCGowjVIjxDQ0BBuTkTiS+Oc9eyFap0vLF9RXAA0ubPKUJhA7mVBe/3JHugZp1lZ8wlSm0K5S0fSqdmVpO3ELuIddfjAA/lkiB/PWo8FejYY2kuvr4tTHZymPSyB0fpvYM27maeWzOLpgLVUut0mL071xDWOvg6vi1v0C5X1R9tnOnoUmUciEVplaAIenAfnlzfXsPh+OBbJwWr8G809ur56efHq9oKd4UHaJuzZcDwcM8nZQLU0B5YOjujTnbbZH03/5N7uFi/hikZOSxXvnBjMprtRprvDd5aIygZi0mbDzfTG6+2Wye8b9Hz5zBKxkF7JlPfxdLZN+nXNR80c15y0LEPHF9BC6qbd+SeH3tG1dHlxJxLBU+f4TJjHM6H7wdr7J7M+0H18P7QO8CcfM58U2GzaE2S73fG3T5+V6ALsuTmBs+12+ydZv6Pt",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,k={},m=[];function v(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,n.jsx)(a(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,n.jsx)(r(),{parameters:void 0}),"\n",(0,n.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{webhook:{type:"string",example:"https://your-webhook-url@example.com"}},title:"inline_response_200_7"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/98334e25.eeca88c9.js b/assets/js/98334e25.eeca88c9.js deleted file mode 100644 index 5ea29fa03..000000000 --- a/assets/js/98334e25.eeca88c9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7024],{16460:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>h,contentTitle:()=>W,default:()=>m,frontMatter:()=>v,metadata:()=>s,toc:()=>w});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":"eJy9Vs1uGzcQfpUJL22MtaSkKQroFKMwHKNGE9QOfLCFgLs7uzsxl2Q4XMmCIKCHvkHfoI+WJymGq5UlOUmbtujF1pLzze/HmVmpqGtW0xt1jXnj3J2aZapELgL5SM6qqbpqEM4wwkYATt6cgzbGLWDpOogOaoyw2Fx2wahMOY9BC/y8VFNVYxyUZyoge2cZWU1X6vlkIv/27V12RYHMVWdgq0dlqnA2oo0ir703VKSL8XsW0Epx0WCr5VdcelRT5fL3WESVKR9ETaTe5MbRHUGOgWytMoX3uvVGjpoYPU/H46XrwvEGcdwF83IjMipcq9brTEWKCUDWkMV3Q3Dvnk8m735Q67XIvJi8eBzkW8YA1kWoXGfLJ/9dfBiCC1+O7tD2lwIR54cwvn8cxrmda0Nl4sSVu0P7/0ayaz725sXV+9YIzuq2DykJpXu1F+rueR8kY9EFiks1vVmp+2Pt6bi/n97M1rNMtRgbt+G0OKxjo6ZqvNjSmzHMMXDCy1t44BJrW+bufuQ8WqbaGp2z8GisPY3nz0bP1Do7xGjvv0oeu+OvhXDUNdn6r3Czh9xcSv36Eu1laFso7eknXKpsKMCuVKZIeNOgLjGkYpGtXAJvyvLao72k2qaiJuOHDekaTeFalNYTG4QB8PG3PxKmdEXXoo2JdUnDk1t7a193AbxbYJDGom0JlcF7yg0mELbpjoeexqhbg8xmCWQj1kFHhJJqitqA5IhsDYX2OidDwlgRc4IOsEN6HsF1g7HBIFffBAQNJc7RCNFBd9G1OoqqwWlYuHBXGbfgDDTkHZNFZkDbaFuI4FCFDFwAbQFtxOADMQLHIF5T75uzMegiQqutrlF0Z3upKtGQUBWCyzuOwM50yWWImowLWMIQkEUseSRJPL33cgVyWrjWB2yEMnOEuqMSOYPClQicHqiEYEvIkSN48YUKZFHaWeOKu1S8qjMGvJN+QdqAq/Z8FHgM2nLlQtv7MtRgmzAfnIwL7B08OnrLKBW+IHvH06OjW3sMN1tOXWPOFHH27UD/xWLxiPZP9zFnFF91OfyC3jFFF5YP6Jpi0+Xpqewq2X70ms7QYuLPzkN40FG6gh+/PDkdN2j8+BKjMITHJ2/OU4t9Ch9//R0uUAcLjVv0bC26gGYJ9WBKMtdXvk/btkNC5RLxGsl40ZMv4IcOOW4z6EtRQf3j2eTwTZcbKiBi642OOIUT8PtHUGgLOUIRUEcskwvcaCHSnDRoMGTvRnBil9DJBFpQbBIH5DyBe2QPlMzrhypXwbVAcQSv3ALnGLKkgwUmkwxLiknX1hmKjKYaJdcDVmQMLKisMU4Pvhl0QMA2x7LEUqLeMZtjJXSnCMTAciL0FcsjuGpwmbB6rslo6SRke1I7WY8ks2hL78hGnkIZdBW3mjl7MJLCJmc/cdQnSW/DyjZqhu/NEzuoBI/gVlrtQXve76IBKwxikfsdbiCOpw1RbgbCgfDw3xBWpq70I12kpQBbTaafEy8P9aQBjaHl19UlhjkVwzr2mbc6TsJjlSlDBVrGncF/cvbmAubw3Wiisp2p9zfe7fji/MfTny9PxRvpkX3Gno0mo4kcecex1XbH1M5+fDiuVg/70D9ZpTczNeJ9HHujKa0wKZjVZv242e60s0w1jqMcrVa5ZnwbzHotxx86DLLUzDI114GErGmlyYZJLPvKHS4la0WBXpabuTZdP84Pdri9Rejs9EplShrK/gZwlzaAzQ/RPlzZ5Y7u/dWgd0D+yp7yScBq1W8X6/VWvr/6LGIT4CAtCZyt1+s/AdIGlKY=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/v1.1/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"}}');var i=t(74848),n=t(28453),l=t(33617),a=t.n(l),p=t(17543),c=t.n(p),r=t(86013),d=t.n(r),k=t(63723),b=t.n(k),u=(t(18766),t(79329),t(9303));const v={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:"eJy9Vs1uGzcQfpUJL22MtaSkKQroFKMwHKNGE9QOfLCFgLs7uzsxl2Q4XMmCIKCHvkHfoI+WJymGq5UlOUmbtujF1pLzze/HmVmpqGtW0xt1jXnj3J2aZapELgL5SM6qqbpqEM4wwkYATt6cgzbGLWDpOogOaoyw2Fx2wahMOY9BC/y8VFNVYxyUZyoge2cZWU1X6vlkIv/27V12RYHMVWdgq0dlqnA2oo0ir703VKSL8XsW0Epx0WCr5VdcelRT5fL3WESVKR9ETaTe5MbRHUGOgWytMoX3uvVGjpoYPU/H46XrwvEGcdwF83IjMipcq9brTEWKCUDWkMV3Q3Dvnk8m735Q67XIvJi8eBzkW8YA1kWoXGfLJ/9dfBiCC1+O7tD2lwIR54cwvn8cxrmda0Nl4sSVu0P7/0ayaz725sXV+9YIzuq2DykJpXu1F+rueR8kY9EFiks1vVmp+2Pt6bi/n97M1rNMtRgbt+G0OKxjo6ZqvNjSmzHMMXDCy1t44BJrW+bufuQ8WqbaGp2z8GisPY3nz0bP1Do7xGjvv0oeu+OvhXDUNdn6r3Czh9xcSv36Eu1laFso7eknXKpsKMCuVKZIeNOgLjGkYpGtXAJvyvLao72k2qaiJuOHDekaTeFalNYTG4QB8PG3PxKmdEXXoo2JdUnDk1t7a193AbxbYJDGom0JlcF7yg0mELbpjoeexqhbg8xmCWQj1kFHhJJqitqA5IhsDYX2OidDwlgRc4IOsEN6HsF1g7HBIFffBAQNJc7RCNFBd9G1OoqqwWlYuHBXGbfgDDTkHZNFZkDbaFuI4FCFDFwAbQFtxOADMQLHIF5T75uzMegiQqutrlF0Z3upKtGQUBWCyzuOwM50yWWImowLWMIQkEUseSRJPL33cgVyWrjWB2yEMnOEuqMSOYPClQicHqiEYEvIkSN48YUKZFHaWeOKu1S8qjMGvJN+QdqAq/Z8FHgM2nLlQtv7MtRgmzAfnIwL7B08OnrLKBW+IHvH06OjW3sMN1tOXWPOFHH27UD/xWLxiPZP9zFnFF91OfyC3jFFF5YP6Jpi0+Xpqewq2X70ms7QYuLPzkN40FG6gh+/PDkdN2j8+BKjMITHJ2/OU4t9Ch9//R0uUAcLjVv0bC26gGYJ9WBKMtdXvk/btkNC5RLxGsl40ZMv4IcOOW4z6EtRQf3j2eTwTZcbKiBi642OOIUT8PtHUGgLOUIRUEcskwvcaCHSnDRoMGTvRnBil9DJBFpQbBIH5DyBe2QPlMzrhypXwbVAcQSv3ALnGLKkgwUmkwxLiknX1hmKjKYaJdcDVmQMLKisMU4Pvhl0QMA2x7LEUqLeMZtjJXSnCMTAciL0FcsjuGpwmbB6rslo6SRke1I7WY8ks2hL78hGnkIZdBW3mjl7MJLCJmc/cdQnSW/DyjZqhu/NEzuoBI/gVlrtQXve76IBKwxikfsdbiCOpw1RbgbCgfDw3xBWpq70I12kpQBbTaafEy8P9aQBjaHl19UlhjkVwzr2mbc6TsJjlSlDBVrGncF/cvbmAubw3Wiisp2p9zfe7fji/MfTny9PxRvpkX3Gno0mo4kcecex1XbH1M5+fDiuVg/70D9ZpTczNeJ9HHujKa0wKZjVZv242e60s0w1jqMcrVa5ZnwbzHotxx86DLLUzDI114GErGmlyYZJLPvKHS4la0WBXpabuTZdP84Pdri9Rejs9EplShrK/gZwlzaAzQ/RPlzZ5Y7u/dWgd0D+yp7yScBq1W8X6/VWvr/6LGIT4CAtCZyt1+s/AdIGlKY=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},W=void 0,h={},w=[];function G(e){const o={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,i.jsx)(c(),{parameters:void 0}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{webhook:{type:"string",example:"https://your-webhook-url@example.com"}},title:"inline_response_200_7"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function m(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(G,{...e})}):G(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.683dbb00.js b/assets/js/9c9cb35e.683dbb00.js new file mode 100644 index 000000000..0c7d5dd7e --- /dev/null +++ b/assets/js/9c9cb35e.683dbb00.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/v1.1/createtemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createtemplate","permalink":"/docs/API-docs/v1.1/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtyHLeOv8LTtVWJta3RzEiyHe3LKjnexHu8sSqWN7Ur6Sicbsw0rW6yQ7I1mqim6jycP9infT2fli/ZAkj2ZS6SbCuJvdV5cDTNGwACJAACuI0sn5no6Cw6haLMuQUTXcRRCibRorRCyegoOs2AhWb2jQaO39nxyUvG81zNDasMaMOsYgk2AksqY1UhfuGTHJgNE8dsnokkYwb0NTBu2CSvoNRCWsOmSrMZSNDcCjljqUqqArBhLmzGSg0pTIWElBmrq8RWGsyAvS2VZKZKEjBmWuX1Sg4MoWTMbAYEqAZbaWkYZ5UUP1fAdnZC70uR7uwwm3HLEi7ZBBCdFLHxAEELnAnHNiVpYlNCIqYCO/u5BufyXJ6K8oi9LXPFU7ZQlWYnf/63egqcF7+d7ez8GSbVjL19ubNz8WVmbWmO9vZ4WQ5UCdKImcz5xAwSVeyl2LFMp0+QgqABZyVYgRuRLxhPUzYX6QysIYwlS1S5YIlSOhXSkb7kM2CyKiagTcy4TFmhNDAhGWcaeLrYtWq3MsD+/c3r73E7Cm4H7CSvTFwvlwoNic0XbnqkQMDqC0eZpwe4P0LOYlbwK9xIYdnPlUiuEG0Dksjq94RotbPzpipLpS2k7EeHwtHODrZ8DbmaM66B+ieqKJRkJde8AEvchhuGzRp+roSG1LEKz/NAi6NzuYv7vCjhaGeHvZSpSJAYNCF+ZWrq+w5cVyQSdn3jN9Z1bZEOd94xMdJkzt1+ljlPHJgakCesuIbuxDcxW+DEfwapAgSZ0uIXJS3PaTuuQVuR8Ly9bQggMZrlmuSiVELa8NWvwP7Lbw/uHm2K5ysELUViFUJSiwF2zfMKjIdqHrMMofoBSg2G+NvPi4SUKctAzLKt6/H0XWVsZ2JWGQSzDYVfK+wSkReIbFOeG2Bi2qFlwa+gtRpTdAjxfMC+XrAUprzKbcwEcpzVFQzY98oyXpa5SOi0wYMEhYfjGbFLu+zZwQMieUF7fKLVtUgBj4RUTKegUTixkabwYwJ0yGclDUD0SHJsxiVTcmWjE5Urvc5C9LlLR5YoaUHaATu+5iIn4B2yhgmZ5FUKbJLz5CqmczJmGlInuAvAUzd2/E5d8DB1NCf6MAM5cqGSCL9UfnlhmhNrwE4zYRp5wsZAalpEmDZVvdROFa6MJAgixqDgIo+JcDF7pybMCptDjAJbcrmIWcotxMzCjZ2om5glGSRX9JfmqVBsUlmLBzWumWpVpmouPS2nSlojftkgkaHl/Sk6jtlBzJ7G7HnMRsOYjcYxGx3EbPQ0ZqPnMRsPYzYex2x8ELPxUwfW+LmnNa8J3AZgNHZUtp8PdfHcfSUMSTYemKY+g+edM3g0YDs7tTTht59++ulc3p5Lxs4jFK7z6IidR3WX8yh2bXhmYtvI/77BH/vjZ/7nAn8+HT/3P+fUdXTgf2b4czw6l0u/4LkcEySWF+UdUGDzo0Lgf3kmwm+0KH4L5xl+xIMoDg24Vx14sGHZxmUfcRFSWMFzsx2d0OMTwqgBaQ2pA0SK2HU7RtT8CaHThgdb6Jh0TXSstpqCwBMU4zXsDwf+ZtmOvFv2k8G9Bc7Hof4UUcej6RSPpu3416fXJ0SEVZg+jhLPBqQA0Mm8nQ6+wydEhS5EH0eD50gDvJS2EwBbPyHsW+Bgg7/hXdvwYHd0uDsejg86FEDbyHUoit003V0sFo9BPdR5/PKo8gQN1Wl2aIZOtSo2mB9kHTS9vE5EfweV/T9QUZ8EHRZStPu6Fmyw+NpatlUpX3xh3FRhaK2cYf9GNVu0wKQmhIOs3yRTIvHAY5+gkk3QwBsgDXaJkntputeiJH5M092i2F35iD93ifCtj0UxSNPBSs+13XEfC5amMVv/vPF7mrKiKLZ8dt87n/eKYh2LQVF42Ej5+mpA7gfS2bbLie/we4lKIxHdhe8UI/QcKJnT2mTObZajlcsmE9I3eKZiKx00zKqca7hBu9QIJV3vx5exIGKNZk92LJmA5CVwpGBfvvba+xPP/ohCdwL8cv+4NcxwkmPvMGMaZnDDSm4taEmTXfNcpM7ftksf4IYXJZoAe389P0//+Z/2yAGBNr5luBMsFTOBfqC9v54d7/73xYYeVVmCTrgBlgOuZGIGNhmwswzysnFFzefzwXzfJJlSufNDvTMapu7fSzV5d0nglgNuyiebMHWs0TL4kXVW7X0DtkMxblgYucHkJx4jGRoN6bb19s4d163v8QndOCsgYaPznmDz2XlUcFJIkJWh+VvZDPR5dFGPcUY+pPeMvXiAsGYihZxPIF9verCg1Z9zvlCVl+/g1Oqi6jm6RTdsKISs/RaEzjBuNfKblUbXttwg344gbekMV04Qz7ADLBcmeG665GyP9q4tcjhKcK7hCbAwgE1qLv1oKagBe5gYuJPI7909S2A/Rh1rt2JY7Z4VOhvTJgzOUQgpiqqo/aPTetZAssLrHm164Uh8NAgrtHd3bQV+c88K3m2/ZYFzOSI/RvB/3KGZ+h6f0FmxAtLdYvwhp0jnnn6kC/Z+AQxotQVww7WMXd2FXAuf2S59A/Yarzf0ybpB6GVLEigteuQ+VjRrkB98Q5HPqu2H28557V6fEPdtAOs35kDf77Fvnw9i0jb2nxGjdsB+MLM6p2TBZ3dY7tT8CbGnh2fNCbGzc6JhKvK89aTIwqfwsoNPOpBD4Z+9/GMiXnXkCBfSKjQLwrPtBKb0XmrpGSXjzYOju2fclrbfRN0rtNIs48bp36Tw41bhg63NoFhxxQfQGne8kAFu3JXR49mN46+G7X0aPT3s7NPhsLNPw237dIfZiDtoSiVN7WuDpqkl17TF4fv61bIqtmFS3NIXEt9WgvXghEFVecpycUWvKqkwZc4XuKtBSj2Uq89132RKmaaHfzH70iN81H2JUxof454M6oeJhzi8VjajtRejZ/utrTh8/rwrMR2BeYj93qy3vgvDg73R4Z7zaG12aDVumO2H8B2aAGMP2S/yEz1ov6hns2G92+lD3U6Pw+77j2l1j56NO5fF/vBDL4tHN67bUnOPWf0YxvOjWbFtcXug/fq72ZEfz30Hv4VGPXq23+bCZ6NHcKFuUZw/lhPX9ONH4z32WMrxJgZ8gHZ8p0r80QzaBvY3Z9LDx9GkR8OOhvZVR0H7atxmysPDBzFle9EVzjqPxH9+/fqH+fAv387U8fHx8fdv3mYv3s6Oj48L/D0YDDYaUZt2m5ZBzdVHBPp7me74LasMBgMkYcotP6Lhe6Wc/YsbH28fM/Cvz7+RZ+fwMR5TNjhwPv4UqLv+cd6a307OP04Cmf/vXEZxpEoKKFbyZRodRS44OYTqRjGZmGDs1ypdREe3kQ8fwz99cBYO3XtnMAj6NjJJBgXHv4JpimHTU5HjVBgBBdpEcUTxBBhDjdwXHUVq8g4SG8X41lWiQwIMzkHjjm5DLxc2G8VeGY+OIsf9URz5F5/6EwOZKHzDLdNptAwL3jVV/aWZytAfddwyzoORqR84DQ1droSNf9BM7RmWDVmbybjWfBGtRqiHkNTwnujG1TF3+SJcEsKiS6SOk6RuURwJC0V7lS2bptX7UzoBhZhQrNH7jqVt4cV7r4njykzJDxrovRAbaP5AKrnW9YW7W3aMwY6QBu10t4najRlFzg3u45jQn7Dls/aa7q1gbc3TbdHcrSBSk5FJyssSuB5QUPUHx+tTSgTPk4qyEurjsYNZDWqN2WgZRzf3I3PDErUbQsXZlzlMrXvaZYnSEvSTdrzIJ4Pc+OBgGUeL+9FbfJboPcPNm9+P3Y8UY9/kH/wRsO4/X8ZRdj+s39VZAH8gsAdPl81dt3KVX05UurgM59byvo7hUsF+mJPyUr7WKegWISZK5cDlGiVeTp2XXbEv0PL4InYBFRS8LbQJFwqbo6NZQwKYCEJxVuGsYl7ncJHdzAfUonP+BX4gdclUE4O9ZJjPuAknwKwWsxmg79n3oME+PB04JVdJH+bBp8HbVmq4FqoyATx0SGPQXw7oY7YZCJczIeSsax21qENu7zbug/bu4Be85CTGs78+PXkALcl022U2q2PjHZZuDvb69ARTYsTUq2ED9tbUlAik5Z0uDNUidi14CJuvz/aFe4QG539UhGzHVz/wySi7bB2gVJiNEMUu+w3j9ev8t7WJm5wp3CJVWfT9C58JYCyUpkNHgqIm5KmqHsKV91CSs1lFMX8WRTbkx1DYT5PSIqRLrCO9P610yOLxbIE9McuuoVOgCnZqzR8zkMYN52zKjQUdY8odUl5XqOXXU8JNCVqATGAjCTQ40l1WeqPe1KVBNz/k7Q+vfKZcwCEI5QQl0E0MKatK4hqShDpvKezcKuprihJKB+jLbQrauupB2UXeJVGCNkqi2aL0jEvxi2Nh0kjQ6plAxnPX1R8V6LpGeFDCu8CEs/bXv/+jBddWjXMdMLcCT1MMSrsHQjLtHMOjxq2hxBNQdSHC+UD/6+olgNCR0FwWKq0FyTycx08ojM3U56J/S6vf8UyVZKjg1+eticMZa7xaachWJIOSHuNKxBduhLGtzJsQH7t+PvwASMekBQOpISjVyPNy0Rbw5n1RrUxH+UGim7VVX4NrssArqy41FEI+7J5qe8esqg+CyqqCW5GwMJUZdHPx3BNMkOuCfRlAQ268Fko/2SKqON2lkglcCnkJ16AfoOB9X8fzpHyBzG3nALINWyCSu86afKk5prh2aNK6nSgrsA3lIZoH7hF1k+1ytyEZ+MFdJZRzW0zwMd89B6Oo0cGhGluyawx9LtaUfxftbanPyNgYDYf/n22p/eHnY0sdDD8jW+o5AuvdqPcfQNv0m41nR3AL3z3gnSKnDTl07+6JXtZlXDuxNxG4EYfx0v3XmH/h3L/HJHQ2Y+PW9eZMQIbIMB4O8X8rh2Cn4gQqt3U1inzxpyh+uE/57j1wn9GLfRexvs7G35lSFkmGNCvAmO5JvmHIPQi06SZkLiRcBqJcjofDy8PI0ftgE3HeqAJsRloV6tNzrbAwRJkDph5YvWB8xoVkuLx+RFqB1vdx1ftBdhcRDobDy1FNhMN1IryUFPBORUhO1RXI3xfT9vLWLY+g3hR5I9qRcJ2oPeog2/7ukDSQVFrYRXR0dhvd7PJS7Lr2o7OL5QVync0UvraUyhDE3GbRUbS39vhCVWDQtX92G5GJF4Ujz3CZYjTB2rHHS7F3PRqMomW8OmbjMXlHf6h233eIsXwm5Oy+cRcNjd7gPrqt6lCqUQVL8RdAXdBvRLtXHAnknww46vxIemSPH5onqxdhk8Nj0qb3oWYzV198woNP5w1n9bra8CrTepQ5Cy8i9MhRv3FEDUJR/Q6Bf9a68FnDsrUTP+idI1LYxgcHpNk8G5EKsP+cbteDp8sLR+CW146CQ9uuJxcH0fGh+E9dn0IUrdjwHUN61Y7eatNuMWn9kiumWw3IJovpsGOobKBWuGi7tMJIAaTV/pBodTAkWj0fdu54j2EzQ3NT03Vc38Z05bZvXLxWL5D/hJwqYl7PUa9LkG/Q4YWHCzH/mmYGeaKKusBFGPDr3/9BY4I57BwLOMOfMIDidaVZqeagsaYTVq6Y5nAj0PDDQVBQm6HnPAp75kUOxuAbn7QwcwWbMAkOPWzeh5Pwkk9ELvDkdKG9FCPYOnzNgP2YAT67Y9MX2uUEXkOOB25tOrdKU7G50ldTLH8VM84mWPgGnScgMy4T56dxpwD5G9BwRB9YqYXBej4aoRYONiWt5ollBZd8Rg6DuEOqFHKBRyXTaoJuTKPyyjnqLBe50i6iixCiJ3eKQnlxU2ITqZbo4dKQId9ee2+diZ231Am4rwg1Qcd0ibCIBMhpUclcYfEmdHBXec5KZZ3TGTXYNow43GouDaqdDpawBzXBvCMNjA97fmsAd/iVkFeu4MguO6t56keYGGGhm464KntPumO+Ffa7aoLljJQRVulFM3ombFZN6KhuT1L/cDN9Gwp+tQ7iZo5UJWaDLq4Ss4eZk3tvwCKHmL3jk5d01T9hv/7tf9gr4FqyTM0dtyaVhnzR1BajUly0845s9U1NrlpeYT0vS0wqZ+H1IFDwx4zbX//2v4Z9D3N0WaEIOULu7JxUk1wkdd02s7Nz5Gq3tSqyddOnXFA7+s85K93oXMirATuWC/L4uWcGZAb8TuM6aJD3e0uttLpCWgMR+ZgM5NdArkSsoDMBBqlwrxJaVTO3WhsYj1w3vh9xO05TVq7E+KM/qwHHuWzoOYA73w1WONuQFtCJv+9W5gGZUg0uc8RSzae2mT9eCfynF4K1TyFnIJAj9tO0iuQhJT3G9dcBhbOsKBHds1bDFDQuaDql63gpPDudBbZk3Tzf92drZ7tJyxNSYcMFyUux0eOLFcjM6+kb0NciAa9RbZHoPeq8F8VRLhLwhqS/u46/PXnFrvcHwyhuqWYPEO69Vy+/efH9mxcIDB6kjmCjwXAwJH+XMrbgsrWSl5PTRldaiWypFfi+NmJfG7GvjdjXRuxrI/a1EfvaiH1txL42Yl8bcQ2pvjZiXxuxr43Y10bsayP2tRH7JPW+NmJfG7GvjdjXRuxrI/a1EfvaiH1txL42Yl8bsa+N2NdG7GsjPqo7sq+N2NdG7Gsj9rURe7dTXxuxr43Y10bsayP2tRH72oh9bcS+NmJfGxGDyVspRXtlzgVl/vlaKy5p72y1YuJFHGWY1Xd0Ft3eIge+1flyiZ9/riiB6ewijq65Fhi5RQmBcchfwySmK1hgbLULRNs9xfVjt+EUPL6SB4kJeG7EMdHgzr7txMOT129Oozia+KqOhUopkZjPMemJz13eVyszir7dRjmXs4qyqiI359IV3si6+XpXlK/n/2ilZnG5aEHYTeRzaOC/iNTGAbe3Lhdwuaz7u6atIzxhQ2/cv4vlcvl/AS0rmw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyHLeOv8LTtVWJta3RzEiyHe3LKjnexHu8sSqWN7Ur6Sicbsw0rW6yQ7I1mqim6jycP9infT2fli/ZAkj2ZS6SbCuJvdV5cDTNGwACJAACuI0sn5no6Cw6haLMuQUTXcRRCibRorRCyegoOs2AhWb2jQaO39nxyUvG81zNDasMaMOsYgk2AksqY1UhfuGTHJgNE8dsnokkYwb0NTBu2CSvoNRCWsOmSrMZSNDcCjljqUqqArBhLmzGSg0pTIWElBmrq8RWGsyAvS2VZKZKEjBmWuX1Sg4MoWTMbAYEqAZbaWkYZ5UUP1fAdnZC70uR7uwwm3HLEi7ZBBCdFLHxAEELnAnHNiVpYlNCIqYCO/u5BufyXJ6K8oi9LXPFU7ZQlWYnf/63egqcF7+d7ez8GSbVjL19ubNz8WVmbWmO9vZ4WQ5UCdKImcz5xAwSVeyl2LFMp0+QgqABZyVYgRuRLxhPUzYX6QysIYwlS1S5YIlSOhXSkb7kM2CyKiagTcy4TFmhNDAhGWcaeLrYtWq3MsD+/c3r73E7Cm4H7CSvTFwvlwoNic0XbnqkQMDqC0eZpwe4P0LOYlbwK9xIYdnPlUiuEG0Dksjq94RotbPzpipLpS2k7EeHwtHODrZ8DbmaM66B+ieqKJRkJde8AEvchhuGzRp+roSG1LEKz/NAi6NzuYv7vCjhaGeHvZSpSJAYNCF+ZWrq+w5cVyQSdn3jN9Z1bZEOd94xMdJkzt1+ljlPHJgakCesuIbuxDcxW+DEfwapAgSZ0uIXJS3PaTuuQVuR8Ly9bQggMZrlmuSiVELa8NWvwP7Lbw/uHm2K5ysELUViFUJSiwF2zfMKjIdqHrMMofoBSg2G+NvPi4SUKctAzLKt6/H0XWVsZ2JWGQSzDYVfK+wSkReIbFOeG2Bi2qFlwa+gtRpTdAjxfMC+XrAUprzKbcwEcpzVFQzY98oyXpa5SOi0wYMEhYfjGbFLu+zZwQMieUF7fKLVtUgBj4RUTKegUTixkabwYwJ0yGclDUD0SHJsxiVTcmWjE5Urvc5C9LlLR5YoaUHaATu+5iIn4B2yhgmZ5FUKbJLz5CqmczJmGlInuAvAUzd2/E5d8DB1NCf6MAM5cqGSCL9UfnlhmhNrwE4zYRp5wsZAalpEmDZVvdROFa6MJAgixqDgIo+JcDF7pybMCptDjAJbcrmIWcotxMzCjZ2om5glGSRX9JfmqVBsUlmLBzWumWpVpmouPS2nSlojftkgkaHl/Sk6jtlBzJ7G7HnMRsOYjcYxGx3EbPQ0ZqPnMRsPYzYex2x8ELPxUwfW+LmnNa8J3AZgNHZUtp8PdfHcfSUMSTYemKY+g+edM3g0YDs7tTTht59++ulc3p5Lxs4jFK7z6IidR3WX8yh2bXhmYtvI/77BH/vjZ/7nAn8+HT/3P+fUdXTgf2b4czw6l0u/4LkcEySWF+UdUGDzo0Lgf3kmwm+0KH4L5xl+xIMoDg24Vx14sGHZxmUfcRFSWMFzsx2d0OMTwqgBaQ2pA0SK2HU7RtT8CaHThgdb6Jh0TXSstpqCwBMU4zXsDwf+ZtmOvFv2k8G9Bc7Hof4UUcej6RSPpu3416fXJ0SEVZg+jhLPBqQA0Mm8nQ6+wydEhS5EH0eD50gDvJS2EwBbPyHsW+Bgg7/hXdvwYHd0uDsejg86FEDbyHUoit003V0sFo9BPdR5/PKo8gQN1Wl2aIZOtSo2mB9kHTS9vE5EfweV/T9QUZ8EHRZStPu6Fmyw+NpatlUpX3xh3FRhaK2cYf9GNVu0wKQmhIOs3yRTIvHAY5+gkk3QwBsgDXaJkntputeiJH5M092i2F35iD93ifCtj0UxSNPBSs+13XEfC5amMVv/vPF7mrKiKLZ8dt87n/eKYh2LQVF42Ej5+mpA7gfS2bbLie/we4lKIxHdhe8UI/QcKJnT2mTObZajlcsmE9I3eKZiKx00zKqca7hBu9QIJV3vx5exIGKNZk92LJmA5CVwpGBfvvba+xPP/ohCdwL8cv+4NcxwkmPvMGMaZnDDSm4taEmTXfNcpM7ftksf4IYXJZoAe389P0//+Z/2yAGBNr5luBMsFTOBfqC9v54d7/73xYYeVVmCTrgBlgOuZGIGNhmwswzysnFFzefzwXzfJJlSufNDvTMapu7fSzV5d0nglgNuyiebMHWs0TL4kXVW7X0DtkMxblgYucHkJx4jGRoN6bb19s4d163v8QndOCsgYaPznmDz2XlUcFJIkJWh+VvZDPR5dFGPcUY+pPeMvXiAsGYihZxPIF9verCg1Z9zvlCVl+/g1Oqi6jm6RTdsKISs/RaEzjBuNfKblUbXttwg344gbekMV04Qz7ADLBcmeG665GyP9q4tcjhKcK7hCbAwgE1qLv1oKagBe5gYuJPI7909S2A/Rh1rt2JY7Z4VOhvTJgzOUQgpiqqo/aPTetZAssLrHm164Uh8NAgrtHd3bQV+c88K3m2/ZYFzOSI/RvB/3KGZ+h6f0FmxAtLdYvwhp0jnnn6kC/Z+AQxotQVww7WMXd2FXAuf2S59A/Yarzf0ybpB6GVLEigteuQ+VjRrkB98Q5HPqu2H28557V6fEPdtAOs35kDf77Fvnw9i0jb2nxGjdsB+MLM6p2TBZ3dY7tT8CbGnh2fNCbGzc6JhKvK89aTIwqfwsoNPOpBD4Z+9/GMiXnXkCBfSKjQLwrPtBKb0XmrpGSXjzYOju2fclrbfRN0rtNIs48bp36Tw41bhg63NoFhxxQfQGne8kAFu3JXR49mN46+G7X0aPT3s7NPhsLNPw237dIfZiDtoSiVN7WuDpqkl17TF4fv61bIqtmFS3NIXEt9WgvXghEFVecpycUWvKqkwZc4XuKtBSj2Uq89132RKmaaHfzH70iN81H2JUxof454M6oeJhzi8VjajtRejZ/utrTh8/rwrMR2BeYj93qy3vgvDg73R4Z7zaG12aDVumO2H8B2aAGMP2S/yEz1ov6hns2G92+lD3U6Pw+77j2l1j56NO5fF/vBDL4tHN67bUnOPWf0YxvOjWbFtcXug/fq72ZEfz30Hv4VGPXq23+bCZ6NHcKFuUZw/lhPX9ONH4z32WMrxJgZ8gHZ8p0r80QzaBvY3Z9LDx9GkR8OOhvZVR0H7atxmysPDBzFle9EVzjqPxH9+/fqH+fAv387U8fHx8fdv3mYv3s6Oj48L/D0YDDYaUZt2m5ZBzdVHBPp7me74LasMBgMkYcotP6Lhe6Wc/YsbH28fM/Cvz7+RZ+fwMR5TNjhwPv4UqLv+cd6a307OP04Cmf/vXEZxpEoKKFbyZRodRS44OYTqRjGZmGDs1ypdREe3kQ8fwz99cBYO3XtnMAj6NjJJBgXHv4JpimHTU5HjVBgBBdpEcUTxBBhDjdwXHUVq8g4SG8X41lWiQwIMzkHjjm5DLxc2G8VeGY+OIsf9URz5F5/6EwOZKHzDLdNptAwL3jVV/aWZytAfddwyzoORqR84DQ1droSNf9BM7RmWDVmbybjWfBGtRqiHkNTwnujG1TF3+SJcEsKiS6SOk6RuURwJC0V7lS2bptX7UzoBhZhQrNH7jqVt4cV7r4njykzJDxrovRAbaP5AKrnW9YW7W3aMwY6QBu10t4najRlFzg3u45jQn7Dls/aa7q1gbc3TbdHcrSBSk5FJyssSuB5QUPUHx+tTSgTPk4qyEurjsYNZDWqN2WgZRzf3I3PDErUbQsXZlzlMrXvaZYnSEvSTdrzIJ4Pc+OBgGUeL+9FbfJboPcPNm9+P3Y8UY9/kH/wRsO4/X8ZRdj+s39VZAH8gsAdPl81dt3KVX05UurgM59byvo7hUsF+mJPyUr7WKegWISZK5cDlGiVeTp2XXbEv0PL4InYBFRS8LbQJFwqbo6NZQwKYCEJxVuGsYl7ncJHdzAfUonP+BX4gdclUE4O9ZJjPuAknwKwWsxmg79n3oME+PB04JVdJH+bBp8HbVmq4FqoyATx0SGPQXw7oY7YZCJczIeSsax21qENu7zbug/bu4Be85CTGs78+PXkALcl022U2q2PjHZZuDvb69ARTYsTUq2ED9tbUlAik5Z0uDNUidi14CJuvz/aFe4QG539UhGzHVz/wySi7bB2gVJiNEMUu+w3j9ev8t7WJm5wp3CJVWfT9C58JYCyUpkNHgqIm5KmqHsKV91CSs1lFMX8WRTbkx1DYT5PSIqRLrCO9P610yOLxbIE9McuuoVOgCnZqzR8zkMYN52zKjQUdY8odUl5XqOXXU8JNCVqATGAjCTQ40l1WeqPe1KVBNz/k7Q+vfKZcwCEI5QQl0E0MKatK4hqShDpvKezcKuprihJKB+jLbQrauupB2UXeJVGCNkqi2aL0jEvxi2Nh0kjQ6plAxnPX1R8V6LpGeFDCu8CEs/bXv/+jBddWjXMdMLcCT1MMSrsHQjLtHMOjxq2hxBNQdSHC+UD/6+olgNCR0FwWKq0FyTycx08ojM3U56J/S6vf8UyVZKjg1+eticMZa7xaachWJIOSHuNKxBduhLGtzJsQH7t+PvwASMekBQOpISjVyPNy0Rbw5n1RrUxH+UGim7VVX4NrssArqy41FEI+7J5qe8esqg+CyqqCW5GwMJUZdHPx3BNMkOuCfRlAQ268Fko/2SKqON2lkglcCnkJ16AfoOB9X8fzpHyBzG3nALINWyCSu86afKk5prh2aNK6nSgrsA3lIZoH7hF1k+1ytyEZ+MFdJZRzW0zwMd89B6Oo0cGhGluyawx9LtaUfxftbanPyNgYDYf/n22p/eHnY0sdDD8jW+o5AuvdqPcfQNv0m41nR3AL3z3gnSKnDTl07+6JXtZlXDuxNxG4EYfx0v3XmH/h3L/HJHQ2Y+PW9eZMQIbIMB4O8X8rh2Cn4gQqt3U1inzxpyh+uE/57j1wn9GLfRexvs7G35lSFkmGNCvAmO5JvmHIPQi06SZkLiRcBqJcjofDy8PI0ftgE3HeqAJsRloV6tNzrbAwRJkDph5YvWB8xoVkuLx+RFqB1vdx1ftBdhcRDobDy1FNhMN1IryUFPBORUhO1RXI3xfT9vLWLY+g3hR5I9qRcJ2oPeog2/7ukDSQVFrYRXR0dhvd7PJS7Lr2o7OL5QVync0UvraUyhDE3GbRUbS39vhCVWDQtX92G5GJF4Ujz3CZYjTB2rHHS7F3PRqMomW8OmbjMXlHf6h233eIsXwm5Oy+cRcNjd7gPrqt6lCqUQVL8RdAXdBvRLtXHAnknww46vxIemSPH5onqxdhk8Nj0qb3oWYzV198woNP5w1n9bra8CrTepQ5Cy8i9MhRv3FEDUJR/Q6Bf9a68FnDsrUTP+idI1LYxgcHpNk8G5EKsP+cbteDp8sLR+CW146CQ9uuJxcH0fGh+E9dn0IUrdjwHUN61Y7eatNuMWn9kiumWw3IJovpsGOobKBWuGi7tMJIAaTV/pBodTAkWj0fdu54j2EzQ3NT03Vc38Z05bZvXLxWL5D/hJwqYl7PUa9LkG/Q4YWHCzH/mmYGeaKKusBFGPDr3/9BY4I57BwLOMOfMIDidaVZqeagsaYTVq6Y5nAj0PDDQVBQm6HnPAp75kUOxuAbn7QwcwWbMAkOPWzeh5Pwkk9ELvDkdKG9FCPYOnzNgP2YAT67Y9MX2uUEXkOOB25tOrdKU7G50ldTLH8VM84mWPgGnScgMy4T56dxpwD5G9BwRB9YqYXBej4aoRYONiWt5ollBZd8Rg6DuEOqFHKBRyXTaoJuTKPyyjnqLBe50i6iixCiJ3eKQnlxU2ITqZbo4dKQId9ee2+diZ231Am4rwg1Qcd0ibCIBMhpUclcYfEmdHBXec5KZZ3TGTXYNow43GouDaqdDpawBzXBvCMNjA97fmsAd/iVkFeu4MguO6t56keYGGGhm464KntPumO+Ffa7aoLljJQRVulFM3ombFZN6KhuT1L/cDN9Gwp+tQ7iZo5UJWaDLq4Ss4eZk3tvwCKHmL3jk5d01T9hv/7tf9gr4FqyTM0dtyaVhnzR1BajUly0845s9U1NrlpeYT0vS0wqZ+H1IFDwx4zbX//2v4Z9D3N0WaEIOULu7JxUk1wkdd02s7Nz5Gq3tSqyddOnXFA7+s85K93oXMirATuWC/L4uWcGZAb8TuM6aJD3e0uttLpCWgMR+ZgM5NdArkSsoDMBBqlwrxJaVTO3WhsYj1w3vh9xO05TVq7E+KM/qwHHuWzoOYA73w1WONuQFtCJv+9W5gGZUg0uc8RSzae2mT9eCfynF4K1TyFnIJAj9tO0iuQhJT3G9dcBhbOsKBHds1bDFDQuaDql63gpPDudBbZk3Tzf92drZ7tJyxNSYcMFyUux0eOLFcjM6+kb0NciAa9RbZHoPeq8F8VRLhLwhqS/u46/PXnFrvcHwyhuqWYPEO69Vy+/efH9mxcIDB6kjmCjwXAwJH+XMrbgsrWSl5PTRldaiWypFfi+NmJfG7GvjdjXRuxrI/a1EfvaiH1txL42Yl8bcQ2pvjZiXxuxr43Y10bsayP2tRH7JPW+NmJfG7GvjdjXRuxrI/a1EfvaiH1txL42Yl8bsa+N2NdG7GsjPqo7sq+N2NdG7Gsj9rURe7dTXxuxr43Y10bsayP2tRH72oh9bcS+NmJfGxGDyVspRXtlzgVl/vlaKy5p72y1YuJFHGWY1Xd0Ft3eIge+1flyiZ9/riiB6ewijq65Fhi5RQmBcchfwySmK1hgbLULRNs9xfVjt+EUPL6SB4kJeG7EMdHgzr7txMOT129Oozia+KqOhUopkZjPMemJz13eVyszir7dRjmXs4qyqiI359IV3si6+XpXlK/n/2ilZnG5aEHYTeRzaOC/iNTGAbe3Lhdwuaz7u6atIzxhQ2/cv4vlcvl/AS0rmw==",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 y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/9c9cb35e.ad7d3608.js b/assets/js/9c9cb35e.ad7d3608.js deleted file mode 100644 index 993de2093..000000000 --- a/assets/js/9c9cb35e.ad7d3608.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4240],{19068:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,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":"eJztPNtyHLdyv4IzlSpbzHC5uyQlmXkJbSu2chSLZVFxJSQPjZ3p3YE4A4wBDJdr1lbl4fxB/uB8mr8k1Q1gLnshKYm2pdT4QeYObo2+AN2N7r6NLJ+Z6OgsOoWizLkFE13EUQom0aK0QsnoKDrNgIVm9o0Gjt/Z8clLxvNczQ2rDGjDrGIJNgJLKmNVIX7lkxyYDRPHbJ6JJGMG9DUwbtgkr6DUQlrDpkqzGUjQ3Ao5Y6lKqgKwYS5sxkoNKUyFhJQZq6vEVhrMgL0tlWSmShIwZlrl9UoODKFkzGwGBKgGW2lpGGeVFL9UwHZ2Qu9Lke7sMJtxyxIu2QRwOynuxgMELXAmHNuUpIlNCYmYCuzs5xqcy3N5Ksoj9rbMFU/ZQlWanXz7b/UUOC9+O9vZ+RYm1Yy9fbmzc/FlZm1pjvb2eFkOVAnSiJnM+cQMElXspdixTKdPEIOgAWclWIEbkS8YT1M2F+kMrKEdS5aocsESpXQqpEN9yWfAZFVMQJuYcZmyQmlgQjLONPB0sWvVbmWA/fub1z8gOQpuB+wkr0xcL5cKDYnNF256xEDY1RcOM08PkD5CzmJW8CskpLDsl0okV7htA5LQ6mlCuNrZeVOVpdIWUvaT28LRzg62fA25mjOugfonqiiUZCXXvABL3IYEw2YNv1RCQ+pYhed5wMXRudxFOi9KONrZYS9lKhJEBk2IX5ma+r4D1xWRhF3feMK6ri3UIeUdEyNO5tzRs8x54sDUgDxhxTV0J76J2QIn/hakChBkSotflbQ8J3Jcg7Yi4XmbbAggMZrlmuSiVELa8NWvwP7LkwepR0TxfIWgpYisQkhqMcCueV6B8VDNY5YhVD9CqcEQf/t5EZEyZRmIWbZ1PZ6+q4ztTMwqg2C2ofBrBSoReoHQNuW5ASamHVwW/ApaqzFFhxDPB+zrBUthyqvcxkwgx1ldwYD9oCzjZZmLhE4bPEhQeDieEbtEZc8OHhDJC6LxiVbXIgU8ElIxnYJG4cRGmsKPCdAhn5U0ALdHkmMzLpmSK4ROVK70OgvR5y4eWaKkBWkH7Piai5yAd5s1TMgkr1Jgk5wnVzGdkzHTkDrBXQCeurHjd+qCh6nDOeGHGciRC5VE+KXyywvTnFgDdpoJ08gTNgZU0yLCtLHqpXaqcGVEQRAxBgUXeUyIi9k7NWFW2BxiFNiSy0XMUm4hZhZu7ETdxCzJILmivzRPhWKTylo8qHHNVKsyVXPpcTlV0hrx6waJDC3vj9FxzA5i9jRmz2M2GsZsNI7Z6CBmo6cxGz2P2XgYs/E4ZuODmI2fOrDGzz2ueY3gNgCjscOy/Xywi+fuK2FIsvHANPUZPO+cwaMB29mppQm//fzzz+fy9lwydh6hcJ1HR+w8qrucR7FrwzMT20b+9w3+2B8/8z8X+PPp+Ln/OaeuowP/M8Of49G5XPoFz+WYILG8KO+AApsfFQL/yzMRfqNF8Vs4z/AjHkRxaEBadeDBhmV7L/u4FyGFFTw327cTenxCO2pAWtvUAW6K2HX7jqj5E9pOGx5soWPSNdGx2moKAk9QjNd2fzjwN8v2zbtlP5m9t8D5uK0/xa3j0XSKR9P2/den1yeEhFWYPg4TzwakANDJvB0PvsMnhIUuRB+Hg+eIA7yUtiMAWz+h3bfAwQZ/w7u24cHu6HB3PBwfdDCAtpHrUBS7abq7WCweA3uo8/jlUeUJGqrT7NAMnWpVbDA/yDpoenmdiP4OKvt/oKI+CTospGj3dS3YYPG1tWyrUr74wripwtBaOcP+jWq2aIFJTQgHWb9JpkTigcc+QSWboIE3QBzsEib30nSvhUn8mKa7RbG78hF/7hLiWx+LYpCmg5Wea9RxHwuWpjFb/7zxe5qyoii2fHbfO5/3imJ9F4Oi8LCR8vXVgNwPpLNtlxPf4Y8SlUYiugvfKUboOVAyp7XJnNssRyuXTSakb/BMxVY6aJhVOddwg3apEUq63o8vY0HEGs2e7FgyAclL4FDBvnzttfcnnv1xC90J8Mv949Z2hpMce4cZ0zCDG1Zya0FLmuya5yJ1/rZd+gA3vCjRBNj72/l5+s//tEcOCLTxLUNKsFTMBPqB9v52drz73xcbelRlCTrhBlgOuJKJGdhkwM4yyMvGFTWfzwfzfZNkSuXOD/XOaJi6fy/V5N0lgVsOuCmfbNqpY42WwY+ss2rvG7AdjHHDwsgNJj/xGMnQaEi3rbd37rhufY9P6MZZAQkbnfcEm8/Oo4KTQoKsDM3fymagz6OLeowz8iG9Z+zFA4Q1EynkfAL5etODBa3+nPOFqrx8B6dWd6ueo1t4w4ZCyNpvQdsZxq1GfrPS6NqWG+TbIaQtneHKCeIZKMByYYLnpovO9mjv2iKHowTnGp4ACwPYpObSj5aCGrCHiYE7iTzt7lkC+zHqWLsVw2r3rNAhTBsxOEchpCiqovaPTutZA8oKr3u08YUj8dEgrNCm7toK/OaeFbzbfssC53JEfozg/7hDM/U9PqGzYgWku8X4Q06Rzj39SBfs/QIYttUWwA3XMnZ1F3ItfGa79A3Ya7ze0CfrBqGXLUmgtOiR+1jRrEF+8A1FPqu2H24757V7fULctwGs35kDfb/Hvn0+iEnbu/+MGLUD9oOZ1TklCz67w3Kn5k+IPT08a06InZ0TDVOR560nRRY+hZcdfNKBHAr/7OUfE/GqI0e4kFahWRCebScwpfdSS88oGW8eHN0940jafhN1r9BKs4wbp3+Two+kwgdbm0Gx4ooPoDXueCED3EiV0ePZjeOvhm06jZ4eduh0OOzQabiNTneYjUhBUyppal8bNE0tuSYSh+/rV8uq2IZJkaQvJL6tBOvBCYOq8pTl4opeVVJhypwvkKpBSj2Uq89132RKmaaHfzH70m/4qPsSpzQ+xj0Z1A8TD3F4rRCjRYvRs/0WKQ6fP+9KTEdgHmK/N+utU2F4sDc63HMerc0OrcYNs/0QvkMTYOwh9CI/0YPoRT0bgvVupw91Oz0Ou+8/ptU9ejbuXBb7ww+9LB7duG5LzT1m9WMYz49mxbbF7YH26x9mR3489x38Hhr16Nl+mwufjR7BhbpFcf5YTlzTjx+N99hjKcebGPAB2vGdKvFHM2gb2N+dSQ8fR5MeDTsa2lcdBe2rcZspDw8fxJTtRVc46zwS//n16x/nw79+N1PHx8fHP7x5m714Ozs+Pi7w92Aw2GhEbaI2LYOaq48I9Pcy3fFbVhkMBojClFt+RMP3Sjn7Fzc+3j5m4F+ffyfPzuFjPKZscOB8/ClQd/3zvDW/n5x/nAQy/9+5jOJIlRRQrOTLNDqKXHByCNWNYjIxwdivVbqIjm4jHz6Gf/rgLBy6985gEPRtZJIMCo5/BdMUw6anIsepMAIKtIniiOIJMIYauS86itTkHSQ2ivGtq0SHBBicg8Yd3YZeLmw2ir0yHh1FjvujOPIvPvUnBjJR+IZbptNoGRa8a6r6SzOVoT/quGWcByNTP3AaGrpcCRv/oJnaMywbtDaTca35IlqNUA8hqeE90Y2rY+7yRbgkhEWXSB0nSd2iOBIWivYqW4im1ftjOgGFO6FYo/cdS2ThxXuviePKTMkPGui9EBtw/kAsudb1hbskO8ZgR0iDdrrbRO3GjCLnBvdxTOhPu+Wz9prurWBtzdNt0dytIFKTkUnKyxK4HlBQ9QfH61NKBM+TirIS6uOxs7Ma1Hpno2Uc3dy/mRuWqN0QKs6+zGFq3dMuS5SWoJ+040U+mc2NDw6WcbS4f3uLz3J7z5B48/t39xPF2Df5B38GrPvPl3GU3Q/r93UWwJ8I7MHTZXPXrVzllxOVLi7DubW8r2O4VLAf5qS8lK91CrqFiIlSOXC5homXU+dlV+wLtDy+iF1ABQVvC23ChcLm6GjWkAAmglCcVTirmNc5XGQ38wG16Jx/gR9IXTLVxGAvGeYzbsIJMKvFbAboe/Y9aLAPTwdOyVXSh3nwafC2lRquhapMAA8d0hj0lwP6mG0GwuVMCDnrWkct7JDbu733QZs6+AUvOYnx7K9PTx6ASzLddpnN6th4t0s3B3t9eoIpMWLq1bABe2tqTATU8k4XhmoRuxY8hM3XZ/vCPUKD8z8q2mzHVz/wySi7bB2gVJiNEMUu+w3j9ev8t7WJm5wpJJGqLPr+hc8EMBZK08EjQVEj8lRVD+HKezDJ2ayimD+LIhvyYyjsp0lpEdIl1pHen1Y6ZPF4tsCemGXX4ClgBTu15o8ZSOOGczblxoKOMeUOMa8r1PLrKeGmBC1AJrARBRoc6i4rvVFv6uKgmx/y9sdXPlMu7CEI5QQl0E0MKatK4hqShDpvKVBudetrihJKB+jLbQrauupB2UXeJVGCNkqi2aL0jEvxq2Nh0kjQ6plAxnPX1R8V6LpGeFDCu8CEs/a3v/+jBddWjXMdMLcCT1MMSrsHQjLtHMOjxq2hxBNQdSHC+UD/6+olgNCR0FwWKq0FyTycx08ojM3U56J/S6vf8UyVZKjg1+eticMZa7xaachWJIOSHuNK3C/cCGNbmTchPnb9fPgREI9JCwZSQ1Cqkefloi3gzfuiWpmO8oNEN2urvgbXZIFXVl1qKIR82D3V9o5ZVR8ElVUFtyJhYSoz6ObiuSeYINcF+zKAhtx4LZR+skVUcbpLJRO4FPISrkE/QMH7oY7nSfkCmdvOAWQbtoAkd501+VJzTHHt4KR1O1FWYBvKQzQP3CPqJtvlbkMy8IO7SijntpjgY757DkZRo4NDNbZk1xj6XKwp/y7a21KfkbExGg7/P9tS+8PPx5Y6GH5GttRzBNa7Ue8/gLbpNxvPjuAWvnvAO0VOG3Lo3t0TvazLuHZib0JwIw7jpfuvMf/CuX+PSehsxsat682ZsBlCw3g4xP+tHIKdihOo3NbVKPLFX6L44T7lu2ngPqMX+y5kfZ2NvzelLJIMcVaAMd2TfMOQezbQxpuQuZBwGZByOR4OLw8jh++DTch5owqwGWlVqE/PtcLCEGUOmHpg9YLxGReS4fL6EXEFWt/HVe8H2V1IOBgOL0c1Eg7XkfBSUsA7FSE5VVcg/9idtpe3bnkE9abIG9GOhOtE7VFns+3vbpMGkkoLu4iOzm6jm11eil3XfnR2sbxArrOZwteWUhmCmNssOor21h5fqAoMuvbPbiMy8aJw5BkuU4wmWDv2eCn2rkeDUbSMV8dsPCbv6A/V7vsOMZbPhJzdN+6iwdEbpKMjVQdTjSpYir8C6oKeEO1ecSSQfzLgqPMj6pE9fmyerF4EIofHpE3vQw0xV198woNP5w1n9bra8CrTepQ5Cy8i9MhRv3FEzYai+h0C/6x14bOGZWsnftA7R6SwjQ8OSLN5NiIVYP853a4HT5cXDsEtrx0Fh7ZdTy4OouND8Z+6PoUoWrHhO4b0qh291abdYtL6JVdMtxqQTRbTYcdQ2YCtcNF2cYWRAoir/SHh6mBIuHo+7NzxfofNDM1NTddxfRvTldu+cfFavUD+E3KqiHk9R70uQb5BhxceLsT8a5oZ5Ikq6gIXYcBvf/8HjQnmsHMs4Ax/wQCK15VmpZqDxppOWLlimsONQMMPB0FBbYae8yjsmRc5GINvfNLCzBVswiQ49LB5H07CSz4RucCT04X2Uoxg6/A1A/ZTBvjsjk1faJcTeA05Hri16dwqTcXmSl9NsfxVzDibYOEbdJ6AzLhMnJ/GnQLkb0DDEX1gpRYG6/lohFo42JS0mieWFVzyGTkM4g6qUsgFHpVMqwm6MY3KK+eos1zkSruILtoQPblTFMqLmxKbSLVED5eGDPn22nvrTOy8pU7AfUWoCTqmS4RFJEBOi0rmCos3oYO7ynNWKuuczqjBtmHE4VZzaVDtdLAEGtQI8440MD7s+a0BpPArIa9cwZFddlbz1E8wMcJCNx1xVfaedMd8J+z31QTLGSkjrNKLZvRM2Kya0FHdnqT+4Wb6LhT8ah3EzRypSswGXVwlZg8zJ/fegEUOMXvHJy/pqn/Cfvuf/2WvgGvJMjV33JpUGvJFU1uMSnER5R3a6puaXLW8wnpelphUzsLrQY3BkiJfhRMej8OTapKLpD7oj9gxK7ufQsJU0PkQBB/Sjt5zznIhrwbsWC7I0edeF5AH8DsN9nXeaCBivhUoT5aksAP2vZrjuRY3zkKskQOpCAmfHhhhDeRTCv7oxugfbY7ZR/+LT2HfGp/vC63RyuhHggWN5XVdIO/fa0rugEypuJY5YqnmU9vUfItXIvrJ9b/2KSQDhG3FfppW9TvE1golzMAFqqyoB91TVMMUNK5oOkXpeCk8o5wFhmPdDN73Z1hnlUnLE1JOw9XHS7HRl4u1xczr6RvQ1yIBryttkdU96rwXxVEuEvAmor+Vjr87ecWu2f5gGMUtresBcrv36uU3L3548wKhwTPSYWw0GA6G5MpSxhZctpb6xnHuaaMGrQSt1Lp5X/awL3vYlz3syx72ZQ/7sod92cO+7GFf9rAve7i2qb7sYV/2sC972Jc97Mse9mUP+/zzvuxhX/awL3vYlz3syx72ZQ/7sod92cO+7GFf9rAve9iXPezLHj6qO7Ive9iXPezLHvZlD3u3U1/2sC972Jc97Mse9mUP+7KHfdnDvuxhX/YQo8lb2UJ7Zc4FJfX5MiouH+9stRjiRRxlmLB3dBbd3iIHvtX5comff6koN+nsIo6uuRYYuUW5fnFITcP8pCtYYGy1C0TbPcX1Y0dwih5fSXHE3Do34phwcGffdk7hyes3p1EcTXzBxkKllCPM55jPxOcupauV9ETfbqOcy1lFCVORm3Ppampk3VS8K0rF83+0sq64XLQg7ObouW3gv7ipjQNub12a33JZ93dNW0d4xIbeSL+L5XL5f844HFQ=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"},"next":{"title":"Public Template","permalink":"/docs/API-docs/v1.1/publictemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyHLdyv4IzlSpbzHC5uyQlmXkJbSu2chSLZVFxJSQPjZ3p3YE4A4wBDJdr1lbl4fxB/uB8mr8k1Q1gLnshKYm2pdT4QeYObo2+AN2N7r6NLJ+Z6OgsOoWizLkFE13EUQom0aK0QsnoKDrNgIVm9o0Gjt/Z8clLxvNczQ2rDGjDrGIJNgJLKmNVIX7lkxyYDRPHbJ6JJGMG9DUwbtgkr6DUQlrDpkqzGUjQ3Ao5Y6lKqgKwYS5sxkoNKUyFhJQZq6vEVhrMgL0tlWSmShIwZlrl9UoODKFkzGwGBKgGW2lpGGeVFL9UwHZ2Qu9Lke7sMJtxyxIu2QRwOynuxgMELXAmHNuUpIlNCYmYCuzs5xqcy3N5Ksoj9rbMFU/ZQlWanXz7b/UUOC9+O9vZ+RYm1Yy9fbmzc/FlZm1pjvb2eFkOVAnSiJnM+cQMElXspdixTKdPEIOgAWclWIEbkS8YT1M2F+kMrKEdS5aocsESpXQqpEN9yWfAZFVMQJuYcZmyQmlgQjLONPB0sWvVbmWA/fub1z8gOQpuB+wkr0xcL5cKDYnNF256xEDY1RcOM08PkD5CzmJW8CskpLDsl0okV7htA5LQ6mlCuNrZeVOVpdIWUvaT28LRzg62fA25mjOugfonqiiUZCXXvABL3IYEw2YNv1RCQ+pYhed5wMXRudxFOi9KONrZYS9lKhJEBk2IX5ma+r4D1xWRhF3feMK6ri3UIeUdEyNO5tzRs8x54sDUgDxhxTV0J76J2QIn/hakChBkSotflbQ8J3Jcg7Yi4XmbbAggMZrlmuSiVELa8NWvwP7LkwepR0TxfIWgpYisQkhqMcCueV6B8VDNY5YhVD9CqcEQf/t5EZEyZRmIWbZ1PZ6+q4ztTMwqg2C2ofBrBSoReoHQNuW5ASamHVwW/ApaqzFFhxDPB+zrBUthyqvcxkwgx1ldwYD9oCzjZZmLhE4bPEhQeDieEbtEZc8OHhDJC6LxiVbXIgU8ElIxnYJG4cRGmsKPCdAhn5U0ALdHkmMzLpmSK4ROVK70OgvR5y4eWaKkBWkH7Piai5yAd5s1TMgkr1Jgk5wnVzGdkzHTkDrBXQCeurHjd+qCh6nDOeGHGciRC5VE+KXyywvTnFgDdpoJ08gTNgZU0yLCtLHqpXaqcGVEQRAxBgUXeUyIi9k7NWFW2BxiFNiSy0XMUm4hZhZu7ETdxCzJILmivzRPhWKTylo8qHHNVKsyVXPpcTlV0hrx6waJDC3vj9FxzA5i9jRmz2M2GsZsNI7Z6CBmo6cxGz2P2XgYs/E4ZuODmI2fOrDGzz2ueY3gNgCjscOy/Xywi+fuK2FIsvHANPUZPO+cwaMB29mppQm//fzzz+fy9lwydh6hcJ1HR+w8qrucR7FrwzMT20b+9w3+2B8/8z8X+PPp+Ln/OaeuowP/M8Of49G5XPoFz+WYILG8KO+AApsfFQL/yzMRfqNF8Vs4z/AjHkRxaEBadeDBhmV7L/u4FyGFFTw327cTenxCO2pAWtvUAW6K2HX7jqj5E9pOGx5soWPSNdGx2moKAk9QjNd2fzjwN8v2zbtlP5m9t8D5uK0/xa3j0XSKR9P2/den1yeEhFWYPg4TzwakANDJvB0PvsMnhIUuRB+Hg+eIA7yUtiMAWz+h3bfAwQZ/w7u24cHu6HB3PBwfdDCAtpHrUBS7abq7WCweA3uo8/jlUeUJGqrT7NAMnWpVbDA/yDpoenmdiP4OKvt/oKI+CTospGj3dS3YYPG1tWyrUr74wripwtBaOcP+jWq2aIFJTQgHWb9JpkTigcc+QSWboIE3QBzsEib30nSvhUn8mKa7RbG78hF/7hLiWx+LYpCmg5Wea9RxHwuWpjFb/7zxe5qyoii2fHbfO5/3imJ9F4Oi8LCR8vXVgNwPpLNtlxPf4Y8SlUYiugvfKUboOVAyp7XJnNssRyuXTSakb/BMxVY6aJhVOddwg3apEUq63o8vY0HEGs2e7FgyAclL4FDBvnzttfcnnv1xC90J8Mv949Z2hpMce4cZ0zCDG1Zya0FLmuya5yJ1/rZd+gA3vCjRBNj72/l5+s//tEcOCLTxLUNKsFTMBPqB9v52drz73xcbelRlCTrhBlgOuJKJGdhkwM4yyMvGFTWfzwfzfZNkSuXOD/XOaJi6fy/V5N0lgVsOuCmfbNqpY42WwY+ss2rvG7AdjHHDwsgNJj/xGMnQaEi3rbd37rhufY9P6MZZAQkbnfcEm8/Oo4KTQoKsDM3fymagz6OLeowz8iG9Z+zFA4Q1EynkfAL5etODBa3+nPOFqrx8B6dWd6ueo1t4w4ZCyNpvQdsZxq1GfrPS6NqWG+TbIaQtneHKCeIZKMByYYLnpovO9mjv2iKHowTnGp4ACwPYpObSj5aCGrCHiYE7iTzt7lkC+zHqWLsVw2r3rNAhTBsxOEchpCiqovaPTutZA8oKr3u08YUj8dEgrNCm7toK/OaeFbzbfssC53JEfozg/7hDM/U9PqGzYgWku8X4Q06Rzj39SBfs/QIYttUWwA3XMnZ1F3ItfGa79A3Ya7ze0CfrBqGXLUmgtOiR+1jRrEF+8A1FPqu2H24757V7fULctwGs35kDfb/Hvn0+iEnbu/+MGLUD9oOZ1TklCz67w3Kn5k+IPT08a06InZ0TDVOR560nRRY+hZcdfNKBHAr/7OUfE/GqI0e4kFahWRCebScwpfdSS88oGW8eHN0940jafhN1r9BKs4wbp3+Two+kwgdbm0Gx4ooPoDXueCED3EiV0ePZjeOvhm06jZ4eduh0OOzQabiNTneYjUhBUyppal8bNE0tuSYSh+/rV8uq2IZJkaQvJL6tBOvBCYOq8pTl4opeVVJhypwvkKpBSj2Uq89132RKmaaHfzH70m/4qPsSpzQ+xj0Z1A8TD3F4rRCjRYvRs/0WKQ6fP+9KTEdgHmK/N+utU2F4sDc63HMerc0OrcYNs/0QvkMTYOwh9CI/0YPoRT0bgvVupw91Oz0Ou+8/ptU9ejbuXBb7ww+9LB7duG5LzT1m9WMYz49mxbbF7YH26x9mR3489x38Hhr16Nl+mwufjR7BhbpFcf5YTlzTjx+N99hjKcebGPAB2vGdKvFHM2gb2N+dSQ8fR5MeDTsa2lcdBe2rcZspDw8fxJTtRVc46zwS//n16x/nw79+N1PHx8fHP7x5m714Ozs+Pi7w92Aw2GhEbaI2LYOaq48I9Pcy3fFbVhkMBojClFt+RMP3Sjn7Fzc+3j5m4F+ffyfPzuFjPKZscOB8/ClQd/3zvDW/n5x/nAQy/9+5jOJIlRRQrOTLNDqKXHByCNWNYjIxwdivVbqIjm4jHz6Gf/rgLBy6985gEPRtZJIMCo5/BdMUw6anIsepMAIKtIniiOIJMIYauS86itTkHSQ2ivGtq0SHBBicg8Yd3YZeLmw2ir0yHh1FjvujOPIvPvUnBjJR+IZbptNoGRa8a6r6SzOVoT/quGWcByNTP3AaGrpcCRv/oJnaMywbtDaTca35IlqNUA8hqeE90Y2rY+7yRbgkhEWXSB0nSd2iOBIWivYqW4im1ftjOgGFO6FYo/cdS2ThxXuviePKTMkPGui9EBtw/kAsudb1hbskO8ZgR0iDdrrbRO3GjCLnBvdxTOhPu+Wz9prurWBtzdNt0dytIFKTkUnKyxK4HlBQ9QfH61NKBM+TirIS6uOxs7Ma1Hpno2Uc3dy/mRuWqN0QKs6+zGFq3dMuS5SWoJ+040U+mc2NDw6WcbS4f3uLz3J7z5B48/t39xPF2Df5B38GrPvPl3GU3Q/r93UWwJ8I7MHTZXPXrVzllxOVLi7DubW8r2O4VLAf5qS8lK91CrqFiIlSOXC5homXU+dlV+wLtDy+iF1ABQVvC23ChcLm6GjWkAAmglCcVTirmNc5XGQ38wG16Jx/gR9IXTLVxGAvGeYzbsIJMKvFbAboe/Y9aLAPTwdOyVXSh3nwafC2lRquhapMAA8d0hj0lwP6mG0GwuVMCDnrWkct7JDbu733QZs6+AUvOYnx7K9PTx6ASzLddpnN6th4t0s3B3t9eoIpMWLq1bABe2tqTATU8k4XhmoRuxY8hM3XZ/vCPUKD8z8q2mzHVz/wySi7bB2gVJiNEMUu+w3j9ev8t7WJm5wpJJGqLPr+hc8EMBZK08EjQVEj8lRVD+HKezDJ2ayimD+LIhvyYyjsp0lpEdIl1pHen1Y6ZPF4tsCemGXX4ClgBTu15o8ZSOOGczblxoKOMeUOMa8r1PLrKeGmBC1AJrARBRoc6i4rvVFv6uKgmx/y9sdXPlMu7CEI5QQl0E0MKatK4hqShDpvKVBudetrihJKB+jLbQrauupB2UXeJVGCNkqi2aL0jEvxq2Nh0kjQ6plAxnPX1R8V6LpGeFDCu8CEs/a3v/+jBddWjXMdMLcCT1MMSrsHQjLtHMOjxq2hxBNQdSHC+UD/6+olgNCR0FwWKq0FyTycx08ojM3U56J/S6vf8UyVZKjg1+eticMZa7xaachWJIOSHuNK3C/cCGNbmTchPnb9fPgREI9JCwZSQ1Cqkefloi3gzfuiWpmO8oNEN2urvgbXZIFXVl1qKIR82D3V9o5ZVR8ElVUFtyJhYSoz6ObiuSeYINcF+zKAhtx4LZR+skVUcbpLJRO4FPISrkE/QMH7oY7nSfkCmdvOAWQbtoAkd501+VJzTHHt4KR1O1FWYBvKQzQP3CPqJtvlbkMy8IO7SijntpjgY757DkZRo4NDNbZk1xj6XKwp/y7a21KfkbExGg7/P9tS+8PPx5Y6GH5GttRzBNa7Ue8/gLbpNxvPjuAWvnvAO0VOG3Lo3t0TvazLuHZib0JwIw7jpfuvMf/CuX+PSehsxsat682ZsBlCw3g4xP+tHIKdihOo3NbVKPLFX6L44T7lu2ngPqMX+y5kfZ2NvzelLJIMcVaAMd2TfMOQezbQxpuQuZBwGZByOR4OLw8jh++DTch5owqwGWlVqE/PtcLCEGUOmHpg9YLxGReS4fL6EXEFWt/HVe8H2V1IOBgOL0c1Eg7XkfBSUsA7FSE5VVcg/9idtpe3bnkE9abIG9GOhOtE7VFns+3vbpMGkkoLu4iOzm6jm11eil3XfnR2sbxArrOZwteWUhmCmNssOor21h5fqAoMuvbPbiMy8aJw5BkuU4wmWDv2eCn2rkeDUbSMV8dsPCbv6A/V7vsOMZbPhJzdN+6iwdEbpKMjVQdTjSpYir8C6oKeEO1ecSSQfzLgqPMj6pE9fmyerF4EIofHpE3vQw0xV198woNP5w1n9bra8CrTepQ5Cy8i9MhRv3FEzYai+h0C/6x14bOGZWsnftA7R6SwjQ8OSLN5NiIVYP853a4HT5cXDsEtrx0Fh7ZdTy4OouND8Z+6PoUoWrHhO4b0qh291abdYtL6JVdMtxqQTRbTYcdQ2YCtcNF2cYWRAoir/SHh6mBIuHo+7NzxfofNDM1NTddxfRvTldu+cfFavUD+E3KqiHk9R70uQb5BhxceLsT8a5oZ5Ikq6gIXYcBvf/8HjQnmsHMs4Ax/wQCK15VmpZqDxppOWLlimsONQMMPB0FBbYae8yjsmRc5GINvfNLCzBVswiQ49LB5H07CSz4RucCT04X2Uoxg6/A1A/ZTBvjsjk1faJcTeA05Hri16dwqTcXmSl9NsfxVzDibYOEbdJ6AzLhMnJ/GnQLkb0DDEX1gpRYG6/lohFo42JS0mieWFVzyGTkM4g6qUsgFHpVMqwm6MY3KK+eos1zkSruILtoQPblTFMqLmxKbSLVED5eGDPn22nvrTOy8pU7AfUWoCTqmS4RFJEBOi0rmCos3oYO7ynNWKuuczqjBtmHE4VZzaVDtdLAEGtQI8440MD7s+a0BpPArIa9cwZFddlbz1E8wMcJCNx1xVfaedMd8J+z31QTLGSkjrNKLZvRM2Kya0FHdnqT+4Wb6LhT8ah3EzRypSswGXVwlZg8zJ/fegEUOMXvHJy/pqn/Cfvuf/2WvgGvJMjV33JpUGvJFU1uMSnER5R3a6puaXLW8wnpelphUzsLrQY3BkiJfhRMej8OTapKLpD7oj9gxK7ufQsJU0PkQBB/Sjt5zznIhrwbsWC7I0edeF5AH8DsN9nXeaCBivhUoT5aksAP2vZrjuRY3zkKskQOpCAmfHhhhDeRTCv7oxugfbY7ZR/+LT2HfGp/vC63RyuhHggWN5XVdIO/fa0rugEypuJY5YqnmU9vUfItXIvrJ9b/2KSQDhG3FfppW9TvE1golzMAFqqyoB91TVMMUNK5oOkXpeCk8o5wFhmPdDN73Z1hnlUnLE1JOw9XHS7HRl4u1xczr6RvQ1yIBryttkdU96rwXxVEuEvAmor+Vjr87ecWu2f5gGMUtresBcrv36uU3L3548wKhwTPSYWw0GA6G5MpSxhZctpb6xnHuaaMGrQSt1Lp5X/awL3vYlz3syx72ZQ/7sod92cO+7GFf9rAve7i2qb7sYV/2sC972Jc97Mse9mUP+/zzvuxhX/awL3vYlz3syx72ZQ/7sod92cO+7GFf9rAve9iXPezLHj6qO7Ive9iXPezLHvZlD3u3U1/2sC972Jc97Mse9mUP+7KHfdnDvuxhX/YQo8lb2UJ7Zc4FJfX5MiouH+9stRjiRRxlmLB3dBbd3iIHvtX5comff6koN+nsIo6uuRYYuUW5fnFITcP8pCtYYGy1C0TbPcX1Y0dwih5fSXHE3Do34phwcGffdk7hyes3p1EcTXzBxkKllCPM55jPxOcupauV9ETfbqOcy1lFCVORm3Ppampk3VS8K0rF83+0sq64XLQg7ObouW3gv7ipjQNub12a33JZ93dNW0d4xIbeSL+L5XL5f844HFQ=",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={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.56e55e5e.js b/assets/js/9cd612ce.56e55e5e.js new file mode 100644 index 000000000..31b06e194 --- /dev/null +++ b/assets/js/9cd612ce.56e55e5e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>w,contentTitle:()=>h,default:()=>j,frontMatter:()=>m,metadata:()=>n,toc:()=>I});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":"eJy9V81uJLcRfpVaXuIVWjMjrewkfYpgK2vZglewZAiIdiCwu6u7abFJmqye0WAwgA95g5xyzaPtkwTF/pkZ/WwiO8hFmq5i/X+sKq4FySqI9Fb81eoCvZgnosCQe+VIWSNScV0jFKiRELojcHp5DlJruwywsi2QHfhl5E9EIqxDL1nBeSFS0bE7rkiEk142SOjZ7loY2aBIRce+U4VIhGLDTlItHntjs58xp/MCbAmjQo+/tMpjIVLyLSYi0EqzyqAap1EkAh+ctgWKtJQ68IG8xkaKdC1o5eJJ8spUIhGl9Y2kXQo+yKglFdn3R3lZHNcuE5vNnM0GZ03AwIqOZzP+t+9taPMcQyhbDWNGRCJyawgN8XnpnFZ5ZEx/Diy0fupdFzRnzrMaUp3JIRevjePb+3D8ncPluRObpC9OcUrPqdkKHc+O3x0ezQ5nf7w++io9+XP65VeT2Wz2N5GIh0azbF/HQhKyXlKkt987BGW0Mng3ZO/ueDa7OzoWmw0fOnkujYd9qUEFMJYAG0erBDiNUpkAhc3bBg2B9QMGP5pDuLINUq1MBUtmLr01VQJOowwI5FcgK6kMaEno33z8XYWxBj+UEc37JULvrf98Yl8dGmcq+Q2GXpUONjJ/uWYns9ndu7FkJ09L1kfFIZW2NcXkfwf7F0P9HOaf+vM5SJ7MTu7+NIb35dPwzs1CalXEVkj2Hs2b/0N822ieMc+u7l9E1R2KfLEX7C69CzJg3npFqwjhh0Pp1GHHT2/njANGjt228tjEqRapmHaJna7H9r0RrM4vhvbeei1SURO5kE6nQZoisw8T69AEVRktszDJbTOVTk0XR5Mjwdjel5HOveo8toevFQkkK2Wq/yQ332bqiqvZFWwvX2PZpFPf40okQzl2T/UTrkbJA4wLoExpo3BfpA8OzZWqTCxxNP54Et6gzm2DPH6pRhgEPv39X1FmaBwRg1HDm4/mo/nQenB2iZ5nkjQFlBofVKYxCmETeeNcDygbjSHoFShDWHlJCIWqFEkNnCPuJrl0MlNaMX75mGVpDztXIEzgpkaq0TPrDx5BQoEL1Ax7kC3ZRhKrGrvd0vr7kjeMBCRkbVAGQwA0tTQ5HxyqkHBflAbQEHrnVUAI5Nlr1flmDXmZEzTSyApZd7KXqgK1YqiCt1kbCILVbXQZSCptPRYwBGQQizDhJJ7xOuERmJrbxnmsGTILhKpVBQbu3wVCiNeVQzAFZBgIHPuicgystDXa5vexeGWrNTjL3UNJzbvNro8sTl6awA2u82WowZgw5y1vGtg5eHDwU0Cu8IUy9yE9OOBxeDti6gazoAjnXwzwXy6XT2D/dl/mvaJv2wx+RGeDIutXW+lKUd1m8arsKhk/Ok3v0WDEz85F2OoobB6e3jymTmvUbnqFxAgJ09PL82sWfQuffv0HXKD0Bmq77NCatx71CqrBFGeuq3yXtrFfQmkj8GrOeN6Bj7dIDDRk8KaW9OnXfwb4AZeguivUJfLg4LLNtMrhGhvH4zIcHKTwtUc2SQMNqJYEuTSQIYRaMpQWSoIE10lrZe4ncGpW0Ab0sFRURzAwPcrthcF5GcsdIJMBC7AmSgw2J1uPmN4E1AsMrIvnXoaAhSJGdO1tW3XWdp3pg/NYKq3hRhUVUozttCjA9eRlR45r/9YdLPlCUI0rkB4hoKEJXD4SiZzWOevZC9U5X1p+SnAB0BTOKkMhhcLLkrb6ky3Qc06zsuYZUpdCOaYj6dWMJeluYh/xSJ3E1e9RE9/vtR5L9Gwwhr2ti1M9nG4HWAKj9ffAmid13P7yuEhgI5XupslfHuuJQx19Ez6UV+gXKsd+or1wo6fx8FQkQqscTcCdZeH0/eUFLN5NZiLZGY3/xeWeXpx/ffbD1Rk7w420S9jRZDaZMcnZQI00O5a+2X1LPp5q6+0S9dsenv3wJXygqdNSxc0nBrTuV5ZbMb4b0+2bc56I2gZi9nrNl+snrzcbJv/Soue9aJ6IhfRKZjyfb9eiUIF/F+Oj8sVAvvixf5++hWefr8/6PGwRhleIhdQtf4lE3ONq77G8mW+SYZFgtzr+aZ6jox3JJwvp3lb3zdnF2fWZSAS3xP0d5j7uMP0PNvCsY/vLTecD/+VN61mB9brbjzab8XzHelGij3E4zVmabzabfwPvNeFU","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/v1.1/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/v1.1/folderlist"}}');var l=o(74848),r=o(28453),i=o(33617),d=o.n(i),s=o(17543),a=o.n(s),p=o(86013),c=o.n(p),f=o(63723),u=o.n(f),b=(o(18766),o(79329),o(9303));const m={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:"eJy9V81uJLcRfpVaXuIVWjMjrewkfYpgK2vZglewZAiIdiCwu6u7abFJmqye0WAwgA95g5xyzaPtkwTF/pkZ/WwiO8hFmq5i/X+sKq4FySqI9Fb81eoCvZgnosCQe+VIWSNScV0jFKiRELojcHp5DlJruwywsi2QHfhl5E9EIqxDL1nBeSFS0bE7rkiEk142SOjZ7loY2aBIRce+U4VIhGLDTlItHntjs58xp/MCbAmjQo+/tMpjIVLyLSYi0EqzyqAap1EkAh+ctgWKtJQ68IG8xkaKdC1o5eJJ8spUIhGl9Y2kXQo+yKglFdn3R3lZHNcuE5vNnM0GZ03AwIqOZzP+t+9taPMcQyhbDWNGRCJyawgN8XnpnFZ5ZEx/Diy0fupdFzRnzrMaUp3JIRevjePb+3D8ncPluRObpC9OcUrPqdkKHc+O3x0ezQ5nf7w++io9+XP65VeT2Wz2N5GIh0azbF/HQhKyXlKkt987BGW0Mng3ZO/ueDa7OzoWmw0fOnkujYd9qUEFMJYAG0erBDiNUpkAhc3bBg2B9QMGP5pDuLINUq1MBUtmLr01VQJOowwI5FcgK6kMaEno33z8XYWxBj+UEc37JULvrf98Yl8dGmcq+Q2GXpUONjJ/uWYns9ndu7FkJ09L1kfFIZW2NcXkfwf7F0P9HOaf+vM5SJ7MTu7+NIb35dPwzs1CalXEVkj2Hs2b/0N822ieMc+u7l9E1R2KfLEX7C69CzJg3npFqwjhh0Pp1GHHT2/njANGjt228tjEqRapmHaJna7H9r0RrM4vhvbeei1SURO5kE6nQZoisw8T69AEVRktszDJbTOVTk0XR5Mjwdjel5HOveo8toevFQkkK2Wq/yQ332bqiqvZFWwvX2PZpFPf40okQzl2T/UTrkbJA4wLoExpo3BfpA8OzZWqTCxxNP54Et6gzm2DPH6pRhgEPv39X1FmaBwRg1HDm4/mo/nQenB2iZ5nkjQFlBofVKYxCmETeeNcDygbjSHoFShDWHlJCIWqFEkNnCPuJrl0MlNaMX75mGVpDztXIEzgpkaq0TPrDx5BQoEL1Ax7kC3ZRhKrGrvd0vr7kjeMBCRkbVAGQwA0tTQ5HxyqkHBflAbQEHrnVUAI5Nlr1flmDXmZEzTSyApZd7KXqgK1YqiCt1kbCILVbXQZSCptPRYwBGQQizDhJJ7xOuERmJrbxnmsGTILhKpVBQbu3wVCiNeVQzAFZBgIHPuicgystDXa5vexeGWrNTjL3UNJzbvNro8sTl6awA2u82WowZgw5y1vGtg5eHDwU0Cu8IUy9yE9OOBxeDti6gazoAjnXwzwXy6XT2D/dl/mvaJv2wx+RGeDIutXW+lKUd1m8arsKhk/Ok3v0WDEz85F2OoobB6e3jymTmvUbnqFxAgJ09PL82sWfQuffv0HXKD0Bmq77NCatx71CqrBFGeuq3yXtrFfQmkj8GrOeN6Bj7dIDDRk8KaW9OnXfwb4AZeguivUJfLg4LLNtMrhGhvH4zIcHKTwtUc2SQMNqJYEuTSQIYRaMpQWSoIE10lrZe4ncGpW0Ab0sFRURzAwPcrthcF5GcsdIJMBC7AmSgw2J1uPmN4E1AsMrIvnXoaAhSJGdO1tW3XWdp3pg/NYKq3hRhUVUozttCjA9eRlR45r/9YdLPlCUI0rkB4hoKEJXD4SiZzWOevZC9U5X1p+SnAB0BTOKkMhhcLLkrb6ky3Qc06zsuYZUpdCOaYj6dWMJeluYh/xSJ3E1e9RE9/vtR5L9Gwwhr2ti1M9nG4HWAKj9ffAmid13P7yuEhgI5XupslfHuuJQx19Ez6UV+gXKsd+or1wo6fx8FQkQqscTcCdZeH0/eUFLN5NZiLZGY3/xeWeXpx/ffbD1Rk7w420S9jRZDaZMcnZQI00O5a+2X1LPp5q6+0S9dsenv3wJXygqdNSxc0nBrTuV5ZbMb4b0+2bc56I2gZi9nrNl+snrzcbJv/Soue9aJ6IhfRKZjyfb9eiUIF/F+Oj8sVAvvixf5++hWefr8/6PGwRhleIhdQtf4lE3ONq77G8mW+SYZFgtzr+aZ6jox3JJwvp3lb3zdnF2fWZSAS3xP0d5j7uMP0PNvCsY/vLTecD/+VN61mB9brbjzab8XzHelGij3E4zVmabzabfwPvNeFU",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,w={},I=[];function k(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,l.jsx)(d(),{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)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(a(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,l.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_12"}}}},400:{description:"- folder is not empty, contains document or folder.\n- Something went wrong, please try again later!\n",content:{"application/json":{schema:{type:"object",oneOf:[{properties:{error:{type:"string",example:"folder is not empty, contains document or folder."}}},{properties:{error:{type:"string",example:"Something went wrong, please try again later!"}}}],title:"inline_response_400_3"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/9cd612ce.b85a286f.js b/assets/js/9cd612ce.b85a286f.js deleted file mode 100644 index 43b49fec8..000000000 --- a/assets/js/9cd612ce.b85a286f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4372],{84121:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>u,default:()=>x,frontMatter:()=>f,metadata:()=>n,toc:()=>w});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":"eJy9V11uIzcSvkoNXzYzaEuyx8km/RRj451xYuwYsYMB4hEMdrNaXTGb5JBsyYIgYB9yg9xgj5aTLIqtbkn+mcRJkBdbTbL+P1Z9XIkoZ0Hk1+LfViv0YpoJhaH05CJZI3JxVSMo1BgRuiNwcnEGUmu7CLC0LUTb71dpfyQyYR16yQrOlMhFt93tikw46WWDET3bXQkjGxS56LZvSIlMEBt2Mtbivje2+AnLeKbAVjAo9PixJY9K5NG3mIkQl5pVBmqcRpEJvHPaKhR5JXXgA2WNjRT5SsSlSyejJzMTmaisb2TcXcE7mbTkovjusKzUUe0KsV5P2Wxw1gQMrOhoMuF/+96GtiwxhKrVMGREZKK0JqKJfF46p6lMG+OfAgutHnrXBc2Z86wmUmeyz8Vz43h7G46+dbg4c2KdbYqjTuJjarZCR5Oj1weHk4PJP68Ov8iPv8o//2I0mUx+FJm4azTLbuqoZETWGynq7ffOAhlNBm/67N0cTSY3h0diveZDx4+l8WBTaqAAxkbAxsVlBpxGSSaAsmXboIlgfY/BD+YALm2DsSYzgwVvLrw1swycRhkQol+CnEkyoGVE/+LDnyqMNfiuSmjeLxF6b/2nE/vs0DhT2R8w9Kx0sJHp0zU7nkxuXg8lO35Ysk1UHFJlW6NGfx3snwz1U5h/6M+nIHk8Ob75cgjv84fhnZm51KRSK4z2Fs2LvyG+bTSPmGdX9y8idYfSvtgLdne9CzJg2XqKywThuwPp6KDbz6+njANGjt228tTEYy1yMe4SO14N7XstWJ2f9+299Vrkoo7RhXw8DtKowt6NrEMTaGa0LMKotM1YOhrPD0eHgrG9LyOde9Z5bA+eKxKinJGZ/ZbcdJupS65mV7C9fA1lk46+w6XI+nLsntpMuBolDzAuAJnKJuFNkd45NJc0M6nEyfj9SfgedWkb5PEba4Re4Nef/5dk+saRMJg0vPhgPph3rQdnF+h5JkmjoNJ4R4XGJIRN2hvmekDZaAxBL4FMxJmXEUHRjKLUwDniblJKJwvSxPjlY5alPexcgTCC9zXGGj1v/cMjSFA4R82wB9lG28jIqoZut7D+tmKGkYGEog1kMARAU0tT8sG+Chn3RWkATUTvPAWEED17TZ1v1kQvywiNNHKGrDvbS5VCTQxV8LZoQ4RgdZtchihJW48K+oAMogojTuIp0wmPwKulbZzHmiEzR5i1pDBw/1YIIV1XDsEoKDBEcOwLlRhYaWu0LW9T8apWa3CWuwdJzdxm10cWj16awA2u86WvwZAw5y0zDewcfPXqh4Bc4XMytyF/9YrH4fWAqfdYBIo4/ayH/2KxeAD7l/sybyi+bQv4Hp0NFK1fbqVnFOu2SFdlV8nw0Wl6gwYTfnYuwlaHsmV4ePN4dVyjduNLjIyQMD65OLti0Zfw639/gXOU3kBtFx1ay9ajXsKsN8WZ6yrfpW3ol1DZBLyaM1524GMWiSEOGXTMXIC6y7PJ4UVbaCohYuN4TuZwAm5/CUppoEAoPcqIKrkQaslAmpMECZrM7QhOzBLagB4WFOuEAV5Pwp1kJ8iZl9sqV942QHEEb+0C5+izpCOwWCIPimLSNThDMaCuEhu68FiR1rAgNcOY3/sOID0CNgUqhYqj3jFbYMVwp8gsJfAKw5ctj+CqxmWSlXNJWnInIdOB2vIbgTOLRjlLJoYclJdVHDSHbGskhU3WPLLUJUkOYWUbNf335ordq0QYQSJ199rzfhf1WKFni+lKboHjaAOU6x5wwDj8M4DlGZx4XZkoAjaSdDcnvr6vJ41r9E14V12in1OJm1n1xF0dp8NjkQlNJZqAOzTg5M3FOczh9Wgisp2p9zvu7fj87F+n/7k8ZW+4R3YZOxxNRhNecjbERpodU9/sPhPvD6zVlh/9sTflZq5GvItjpyUlUpMCWm3YyLUYnoT59jk5zURtQ+Tt1aqQAX/wer3m5Y8teqY800zMpScGb6IsigL/VsN78clAPvt+8/R8CY++TB/1uScIhtnBXOqWv0QmbnG59w5eT9dZzxHYrW7/pCzRxR3JB1xzj7B9c3p+enUqMsHdbp+e3CZ6svnBBh51bJ+3dD7wXyZRjwqsVh31Wa+H893WkxKbGPvTnKXper3+P9EJ0g0=","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),d=o(33617),i=o.n(d),r=o(17543),a=o.n(r),p=o(86013),c=o.n(p),m=o(63723),h=o.n(m),b=(o(18766),o(79329),o(9303));const f={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:"eJy9V11uIzcSvkoNXzYzaEuyx8km/RRj451xYuwYsYMB4hEMdrNaXTGb5JBsyYIgYB9yg9xgj5aTLIqtbkn+mcRJkBdbTbL+P1Z9XIkoZ0Hk1+LfViv0YpoJhaH05CJZI3JxVSMo1BgRuiNwcnEGUmu7CLC0LUTb71dpfyQyYR16yQrOlMhFt93tikw46WWDET3bXQkjGxS56LZvSIlMEBt2Mtbivje2+AnLeKbAVjAo9PixJY9K5NG3mIkQl5pVBmqcRpEJvHPaKhR5JXXgA2WNjRT5SsSlSyejJzMTmaisb2TcXcE7mbTkovjusKzUUe0KsV5P2Wxw1gQMrOhoMuF/+96GtiwxhKrVMGREZKK0JqKJfF46p6lMG+OfAgutHnrXBc2Z86wmUmeyz8Vz43h7G46+dbg4c2KdbYqjTuJjarZCR5Oj1weHk4PJP68Ov8iPv8o//2I0mUx+FJm4azTLbuqoZETWGynq7ffOAhlNBm/67N0cTSY3h0diveZDx4+l8WBTaqAAxkbAxsVlBpxGSSaAsmXboIlgfY/BD+YALm2DsSYzgwVvLrw1swycRhkQol+CnEkyoGVE/+LDnyqMNfiuSmjeLxF6b/2nE/vs0DhT2R8w9Kx0sJHp0zU7nkxuXg8lO35Ysk1UHFJlW6NGfx3snwz1U5h/6M+nIHk8Ob75cgjv84fhnZm51KRSK4z2Fs2LvyG+bTSPmGdX9y8idYfSvtgLdne9CzJg2XqKywThuwPp6KDbz6+njANGjt228tTEYy1yMe4SO14N7XstWJ2f9+299Vrkoo7RhXw8DtKowt6NrEMTaGa0LMKotM1YOhrPD0eHgrG9LyOde9Z5bA+eKxKinJGZ/ZbcdJupS65mV7C9fA1lk46+w6XI+nLsntpMuBolDzAuAJnKJuFNkd45NJc0M6nEyfj9SfgedWkb5PEba4Re4Nef/5dk+saRMJg0vPhgPph3rQdnF+h5JkmjoNJ4R4XGJIRN2hvmekDZaAxBL4FMxJmXEUHRjKLUwDniblJKJwvSxPjlY5alPexcgTCC9zXGGj1v/cMjSFA4R82wB9lG28jIqoZut7D+tmKGkYGEog1kMARAU0tT8sG+Chn3RWkATUTvPAWEED17TZ1v1kQvywiNNHKGrDvbS5VCTQxV8LZoQ4RgdZtchihJW48K+oAMogojTuIp0wmPwKulbZzHmiEzR5i1pDBw/1YIIV1XDsEoKDBEcOwLlRhYaWu0LW9T8apWa3CWuwdJzdxm10cWj16awA2u86WvwZAw5y0zDewcfPXqh4Bc4XMytyF/9YrH4fWAqfdYBIo4/ayH/2KxeAD7l/sybyi+bQv4Hp0NFK1fbqVnFOu2SFdlV8nw0Wl6gwYTfnYuwlaHsmV4ePN4dVyjduNLjIyQMD65OLti0Zfw639/gXOU3kBtFx1ay9ajXsKsN8WZ6yrfpW3ol1DZBLyaM1524GMWiSEOGXTMXIC6y7PJ4UVbaCohYuN4TuZwAm5/CUppoEAoPcqIKrkQaslAmpMECZrM7QhOzBLagB4WFOuEAV5Pwp1kJ8iZl9sqV942QHEEb+0C5+izpCOwWCIPimLSNThDMaCuEhu68FiR1rAgNcOY3/sOID0CNgUqhYqj3jFbYMVwp8gsJfAKw5ctj+CqxmWSlXNJWnInIdOB2vIbgTOLRjlLJoYclJdVHDSHbGskhU3WPLLUJUkOYWUbNf335ordq0QYQSJ199rzfhf1WKFni+lKboHjaAOU6x5wwDj8M4DlGZx4XZkoAjaSdDcnvr6vJ41r9E14V12in1OJm1n1xF0dp8NjkQlNJZqAOzTg5M3FOczh9Wgisp2p9zvu7fj87F+n/7k8ZW+4R3YZOxxNRhNecjbERpodU9/sPhPvD6zVlh/9sTflZq5GvItjpyUlUpMCWm3YyLUYnoT59jk5zURtQ+Tt1aqQAX/wer3m5Y8teqY800zMpScGb6IsigL/VsN78clAPvt+8/R8CY++TB/1uScIhtnBXOqWv0QmbnG59w5eT9dZzxHYrW7/pCzRxR3JB1xzj7B9c3p+enUqMsHdbp+e3CZ6svnBBh51bJ+3dD7wXyZRjwqsVh31Wa+H893WkxKbGPvTnKXper3+P9EJ0g0=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,j={},w=[];function J(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(b.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)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(a(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,l.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_12"}}}},400:{description:"- folder is not empty, contains document or folder.\n- Something went wrong, please try again later!\n",content:{"application/json":{schema:{type:"object",oneOf:[{properties:{error:{type:"string",example:"folder is not empty, contains document or folder."}}},{properties:{error:{type:"string",example:"Something went wrong, please try again later!"}}}],title:"inline_response_400_3"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(J,{...e})}):J(e)}}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.8c0b1fd9.js b/assets/js/ac7da374.8c0b1fd9.js deleted file mode 100644 index 460f6fd99..000000000 --- a/assets/js/ac7da374.8c0b1fd9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>j,contentTitle:()=>f,default:()=>g,frontMatter:()=>v,metadata:()=>p,toc:()=>y});const p=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":"eJzNV11u3EYSvkqlXzY2qJmRrXgRPkW7FmxhhdiIFBhYeSD0kMVhRc3uTndxRoMBgX3YG+QGOVpOsqjmcP4kOzF2EeyLNGzW71fVVR/XivU8qvxW3WDjjWaMapqpEmMRyDM5q3J1UyO8RoOMMEjB+ftL8MEtqMQIK9fCkrgGrhH0jAzxCthBwMYtEDREjwVVVAAP+lVwTRIfTuIILivQOwmKYB0YZ+cYwCKWWKpMOY9BS1yXpcpVmaIaglKZ8jroBhmD5LRWVjeocjXYvCMxQZKT11yr40QvX4OrDqICrjUn71ESmiH0LsVOwJ9bCliqnEOLmYq8MuItUuONBIMP3rgSVV5pE0WgqLHRKl8rXvkkyYHsXGWqcqHRvDvpuqnYj97ZiFE0Xkwm8u+oMEOUm6AgtkWBMVatMauvVKYKZxkti6b23lCRoBv/FEV9/TggN/sJCxYcgwDN1DvvjwXxx6Hjg07p5upvD/ULHf1b/1J12aY05Tl/XunF5MXLk9PJyeSvN6ev8rNv829ejSaTyT9Vph4aI7qbGpZS4C5TTGx2z90jseT2QHBz0onw2VMwXrsGuSY7hyVahmVwdp6BN6gjAocV6LkmC4J0+B+iiiG48Hl0viyybi9rsoYs3g09dHc2mdydbkE4+0wvWcdQudaWf26qT/n/fEJnd6+2CX3zOKFLu9CGyjSpbtw92j83n3333Lt/3K3UC6X36iDZ/fM+yYhFG4hXabA9nGhPJ/37/HYq40I6xe2GYhqGXKtcjYdhNl7vDcJOicmwGEZlG4zKVc3sYz4eR23LmXsYOY820twaPYujwjVj7Wm8OB2dqi471tHef5E8tidfqhJZz8nOf09vukPrWiraF+0As23ptKd/4EplQ0n2pTa7okZdYkjlI1u5pLwp1DuP9prmNpU5OT/eKR/QFK5B2R6yWAaF3/79a9IpXdE2aDn1YbLw1Uf70b5rA3i3xFC1BrQtoTL4QDPTL15s0rt+8bKDiLoxGKNZAVnGeUg7gebE2oBgJBOk0L5fzYRRxJxoB9i7BnEEH2rkGoO8+kuQzV3iAo20PuiWXaNZTA1Bw9KF+8q4ZcxAw6yNZDFGQFtrW4jgUIUMXABtAS1j8IEiQuQgUVMfm7McdMHQaKvnKLazA6hKNCStCsHN2sgQnWlTyMCajAtYwpBQWtYjAfFC9m9AkNPCNT5gLS2zQJi3wlsyKFyJENOVlRRsCTOMDF5ioQLTzm+tccV9Kp7sVfBOJghpI1xhP0ZR56BtlG3exzLUYAuYD04WNPYBPn/+Y0Sp8BXZ+5g/f/7RnsDttqc+4CwS4/Trof2Xy+Wjtn92qPOG+G07gx/Qu0jswmqnPSeu21m6KvtGtg+9pTdoMfXP3kXY2ShdER/fPDkd12j8+BpZOiSOz99fpqH7DH771y9whTpYqN2y79aiDWhWMB9cCXJ95XvYtjMTKpcarxbEi775hHZh5C2Cvkxssb88GwzftzOzxzZzOAd/eASFtkLnioBamJOEEGstjbQgDRoM2fsRnNsVtBHDjt7KeVLuNXtFQV7vqpzILfEI3rolLjBkyUYUNdluWBIfskziiKYapdADVmQMLKmcI+dHzxF0QMBmhmWJpWS953aGlbQ7sXDnKCfSvuJ5BDc1rpKuXmgyWiYJ2b6pnTFuKciiLb0jyzGHMuiKt5ZjtnOS0iZnnzjqQdpR+GxjZkvx+yt2VIk4go8yao/G8+EUDVhhEI/pSu4ax9OmUW6HhgPpw/+mYWUPyzzSRaIJ2Ggy/Z747thOWtkYmviuusawoAI3u+oTd3WchMcqU4YKtBH3qMD5m/dXsICXo4nK9rbeH7i346vLv198f30h0ciM7BE7HU1GEznyLnKj7Z6ro2+545W13rGk/6tPv83CZnzgsTeaEmNKSK03VOd2+6WnMpXvf/VNM1W7yCKyXs90xB+D6To5/rnFIJxqmqmFDiQ3I/GhkqL8Lrdfb5/E6OsfNh+Cz+DLPiCfTGigJVY4yUKbVp5Upu5xdfQl2027bOAmEnEvcV4U6HlP9xHPPSCLry+uLm4uVKZkyh7SovtEizY/xMGToR3ypT4G+Svk7UmF9bqnXF23le9ffVJjk+MgLThNu677D+Bu4Do=","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 a=i(74848),n=i(28453),s=i(33617),o=i.n(s),l=i(17543),d=i.n(l),m=i(86013),r=i.n(m),c=i(63723),h=i.n(c),u=(i(18766),i(79329),i(9303));const v={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:"eJzNV11u3EYSvkqlXzY2qJmRrXgRPkW7FmxhhdiIFBhYeSD0kMVhRc3uTndxRoMBgX3YG+QGOVpOsqjmcP4kOzF2EeyLNGzW71fVVR/XivU8qvxW3WDjjWaMapqpEmMRyDM5q3J1UyO8RoOMMEjB+ftL8MEtqMQIK9fCkrgGrhH0jAzxCthBwMYtEDREjwVVVAAP+lVwTRIfTuIILivQOwmKYB0YZ+cYwCKWWKpMOY9BS1yXpcpVmaIaglKZ8jroBhmD5LRWVjeocjXYvCMxQZKT11yr40QvX4OrDqICrjUn71ESmiH0LsVOwJ9bCliqnEOLmYq8MuItUuONBIMP3rgSVV5pE0WgqLHRKl8rXvkkyYHsXGWqcqHRvDvpuqnYj97ZiFE0Xkwm8u+oMEOUm6AgtkWBMVatMauvVKYKZxkti6b23lCRoBv/FEV9/TggN/sJCxYcgwDN1DvvjwXxx6Hjg07p5upvD/ULHf1b/1J12aY05Tl/XunF5MXLk9PJyeSvN6ev8rNv829ejSaTyT9Vph4aI7qbGpZS4C5TTGx2z90jseT2QHBz0onw2VMwXrsGuSY7hyVahmVwdp6BN6gjAocV6LkmC4J0+B+iiiG48Hl0viyybi9rsoYs3g09dHc2mdydbkE4+0wvWcdQudaWf26qT/n/fEJnd6+2CX3zOKFLu9CGyjSpbtw92j83n3333Lt/3K3UC6X36iDZ/fM+yYhFG4hXabA9nGhPJ/37/HYq40I6xe2GYhqGXKtcjYdhNl7vDcJOicmwGEZlG4zKVc3sYz4eR23LmXsYOY820twaPYujwjVj7Wm8OB2dqi471tHef5E8tidfqhJZz8nOf09vukPrWiraF+0As23ptKd/4EplQ0n2pTa7okZdYkjlI1u5pLwp1DuP9prmNpU5OT/eKR/QFK5B2R6yWAaF3/79a9IpXdE2aDn1YbLw1Uf70b5rA3i3xFC1BrQtoTL4QDPTL15s0rt+8bKDiLoxGKNZAVnGeUg7gebE2oBgJBOk0L5fzYRRxJxoB9i7BnEEH2rkGoO8+kuQzV3iAo20PuiWXaNZTA1Bw9KF+8q4ZcxAw6yNZDFGQFtrW4jgUIUMXABtAS1j8IEiQuQgUVMfm7McdMHQaKvnKLazA6hKNCStCsHN2sgQnWlTyMCajAtYwpBQWtYjAfFC9m9AkNPCNT5gLS2zQJi3wlsyKFyJENOVlRRsCTOMDF5ioQLTzm+tccV9Kp7sVfBOJghpI1xhP0ZR56BtlG3exzLUYAuYD04WNPYBPn/+Y0Sp8BXZ+5g/f/7RnsDttqc+4CwS4/Trof2Xy+Wjtn92qPOG+G07gx/Qu0jswmqnPSeu21m6KvtGtg+9pTdoMfXP3kXY2ShdER/fPDkd12j8+BpZOiSOz99fpqH7DH771y9whTpYqN2y79aiDWhWMB9cCXJ95XvYtjMTKpcarxbEi775hHZh5C2Cvkxssb88GwzftzOzxzZzOAd/eASFtkLnioBamJOEEGstjbQgDRoM2fsRnNsVtBHDjt7KeVLuNXtFQV7vqpzILfEI3rolLjBkyUYUNdluWBIfskziiKYapdADVmQMLKmcI+dHzxF0QMBmhmWJpWS953aGlbQ7sXDnKCfSvuJ5BDc1rpKuXmgyWiYJ2b6pnTFuKciiLb0jyzGHMuiKt5ZjtnOS0iZnnzjqQdpR+GxjZkvx+yt2VIk4go8yao/G8+EUDVhhEI/pSu4ax9OmUW6HhgPpw/+mYWUPyzzSRaIJ2Ggy/Z747thOWtkYmviuusawoAI3u+oTd3WchMcqU4YKtBH3qMD5m/dXsICXo4nK9rbeH7i346vLv198f30h0ciM7BE7HU1GEznyLnKj7Z6ro2+545W13rGk/6tPv83CZnzgsTeaEmNKSK03VOd2+6WnMpXvf/VNM1W7yCKyXs90xB+D6To5/rnFIJxqmqmFDiQ3I/GhkqL8Lrdfb5/E6OsfNh+Cz+DLPiCfTGigJVY4yUKbVp5Upu5xdfQl2027bOAmEnEvcV4U6HlP9xHPPSCLry+uLm4uVKZkyh7SovtEizY/xMGToR3ypT4G+Svk7UmF9bqnXF23le9ffVJjk+MgLThNu677D+Bu4Do=",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,j={},y=[];function Y(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,a.jsx)(o(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,a.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,a.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,a.jsx)(r(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(Y,{...e})}):Y(e)}}}]); \ No newline at end of file diff --git a/assets/js/ac7da374.b0aacfe5.js b/assets/js/ac7da374.b0aacfe5.js new file mode 100644 index 000000000..ff11d1a1a --- /dev/null +++ b/assets/js/ac7da374.b0aacfe5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2043],{27845:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>f,contentTitle:()=>v,default:()=>x,frontMatter:()=>u,metadata:()=>a,toc:()=>D});const a=JSON.parse('{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/v1.1/delete-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-template","permalink":"/docs/API-docs/v1.1/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV81uHDcSfpUKL4mF1szIVhxsn6KNBUdYIRYiBQJWHgic7upuRmySIatnNBg0kEPeYE973UfzkyyKnJ4/yU6MLIK9SNPF+v2qWFVcCZJ1EPmduMHWaUkYxDQTJYbCK0fKGpGLmwbhDWokhIELzq4uwHk7VyUGWNoOFooaoAZBzpRWtASy4LG1cwQJwWGhKlUADfKVt21kHyhhBBcVyC2HCmAsaGtq9GAQSyxFJqxDL9mvi1LkooxeDU6JTDjpZYuEnmNaCSNbFLkYdN4rVqE4JiepEYeBXrwBW+15BdRIitYDBzRDSCZZj8dfOuWxFDn5DjMRaKnZWlCt0+wMPjptSxR5JXVghqLBVop8JWjpIid5ZWqRicr6VtKW0vdT1h+cNQEDS7ycTPjfQWIGL9dOQeiKAkOoOq2XX4hMFNYQGmJJ6ZxWRYRu/HNg8dVTh+zsZyyIcfQMNKlkPJEZ8aeu46OM4ebi74/NSxnc9+6V6LN1asoz+rTQy8nLV8cnk+PJNzcnr/PTv+Vfvx5NJpN/ikw8tppl1zksOcF9JkiR3n73T9ii2T3GNaVn5tPnYLy2LVKjTA0LNAQLb02dgdMoAwL5JchaKgOMtP8fooreW/9pdD7Ps34namW0Mng/1ND96WRyf7IB4fQTtWQsQWU7U/61oT5n/9MBnd6/3gT09dOALsxcalXGTnVjH9D8tfHsmqdk/mm1qsQUz8VesLv0FGTAovOKlrGxPR5Lp47TeX435XbBlWK3TTE2Q2pELsZDMxuvdhphL1ilnw+tsvNa5KIhciEfj4M05cw+jqxDE1RttJyFUWHbsXRqPD8ZnYg+O5SRzn0WP3bHnysSSNbK1L8nN92idc0ZTUnbw2yTOunUP3ApsiElu1zrWdGgLNHH9ClT2Si8TtQ7h+Za1SamORo/nCm3qAvbIk8PHiyDwIff/hNlSlt0LRqKdRg1fPHevDfvOg/OLtBXnQZpSqg0PqqZToMX23iWBi9ZCChbjSHoJShDWPs4E1StSGpgjLiDFNKl0awwMJtlaQ871yCM4LZBatDz0ZeeJ3eJc9Rc+iA7sq0kVjU4DQvrHyptFyEDCbMuKIMhAJpGmoIZhyxkYD1IA2gIvfMqIATy7LVKvllDXhYErTSyRtad7UFVolZcquDtrAsEweouugwklbYeSxgCisN6xCCe8/z1CEwtbOs8Nlwyc4S6470lg8KWCCFeWQ7BlDDDQODYF1VgnPmd0bZ4iMnjuQrOcgdRUvOusOsji5OXJvA0T74MOdgA5rzlAY3JwaOjnwJyhi+VeQj50dF7cwx3m5q6xVlQhNOvhvJfLBZPyv7FvsxbRd93M/gRnQ2KrF9upWtFTTeLV2VXyeYjaXqLBmP97FyErY7SFuHpzWPquEHtxtdIXCFhfHZ1EZvuC/jw67/gEqU30NhFqtai86iXUA+mGLmU+QTbpmdCZWPhNYx4kYqP1y4MNCB420j68Ou/A/yAC1DpCiUgj46uuplWxWZpDUdHOXznMe51Ay1teIU0vNyFRnIpzZUECS5Ja2UeRnBmltAF9Ns9l+lRbi8MxmWT7gAzGbAEa/aWytHWI6a3AfUcA+vi2TdDwFLxNkeNt12drO06sw7OY6W0hltV1kgxtrOyBLcmLxKZAd9xByu+ENTgEqRHCGhoBFcHIvGkc8569kIl5yurtV1wAtCUzipDIYfSy4q2+rNtoRcMs7LmGVKCcLvpZ2s1m5Skm7iOePs+eM8N+aCJ7/dajxV6NhjD3ubFqXU53Q1lCVytf6aseVpz15JFXCawlUqnafLtoZ442NG34V11jX6uClxPtI/c6HFkHotMaFWgCbizMJy9vbqE+avRRGQ7o/EPXO7x5cV35z9cn7Mz3EgTYCejyWjCJGcDtdLsWDp48B3OtdV2lfq/eh+upzrhI42dliquVRGp1Xofuts8B0Um8t2n4TQTjQ3ELKsV39yfvO57Jv/SoefFa5qJufRKznj4361EqQL/LjdPvI9i9NWP69fiC/i8V+azAQ27i+HFZS51x18iEw+4PHju9tM+GxYY9jhxnBUFOtqRfbIM722Ub84vz2/ORSa4Fe/vTg9xd1r/YAPPura/VCUf+C9veM8KrFZpL+v7DX86+qjEOsaBm3Ga9n3/X9wt74E=","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 n=i(74848),l=i(28453),s=i(33617),p=i.n(s),o=i(17543),d=i.n(o),c=i(86013),r=i.n(c),m=i(63723),h=i.n(m),y=(i(18766),i(79329),i(9303));const u={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:"eJzNV81uHDcSfpUKL4mF1szIVhxsn6KNBUdYIRYiBQJWHgic7upuRmySIatnNBg0kEPeYE973UfzkyyKnJ4/yU6MLIK9SNPF+v2qWFVcCZJ1EPmduMHWaUkYxDQTJYbCK0fKGpGLmwbhDWokhIELzq4uwHk7VyUGWNoOFooaoAZBzpRWtASy4LG1cwQJwWGhKlUADfKVt21kHyhhBBcVyC2HCmAsaGtq9GAQSyxFJqxDL9mvi1LkooxeDU6JTDjpZYuEnmNaCSNbFLkYdN4rVqE4JiepEYeBXrwBW+15BdRIitYDBzRDSCZZj8dfOuWxFDn5DjMRaKnZWlCt0+wMPjptSxR5JXVghqLBVop8JWjpIid5ZWqRicr6VtKW0vdT1h+cNQEDS7ycTPjfQWIGL9dOQeiKAkOoOq2XX4hMFNYQGmJJ6ZxWRYRu/HNg8dVTh+zsZyyIcfQMNKlkPJEZ8aeu46OM4ebi74/NSxnc9+6V6LN1asoz+rTQy8nLV8cnk+PJNzcnr/PTv+Vfvx5NJpN/ikw8tppl1zksOcF9JkiR3n73T9ii2T3GNaVn5tPnYLy2LVKjTA0LNAQLb02dgdMoAwL5JchaKgOMtP8fooreW/9pdD7Ps34namW0Mng/1ND96WRyf7IB4fQTtWQsQWU7U/61oT5n/9MBnd6/3gT09dOALsxcalXGTnVjH9D8tfHsmqdk/mm1qsQUz8VesLv0FGTAovOKlrGxPR5Lp47TeX435XbBlWK3TTE2Q2pELsZDMxuvdhphL1ilnw+tsvNa5KIhciEfj4M05cw+jqxDE1RttJyFUWHbsXRqPD8ZnYg+O5SRzn0WP3bHnysSSNbK1L8nN92idc0ZTUnbw2yTOunUP3ApsiElu1zrWdGgLNHH9ClT2Si8TtQ7h+Za1SamORo/nCm3qAvbIk8PHiyDwIff/hNlSlt0LRqKdRg1fPHevDfvOg/OLtBXnQZpSqg0PqqZToMX23iWBi9ZCChbjSHoJShDWPs4E1StSGpgjLiDFNKl0awwMJtlaQ871yCM4LZBatDz0ZeeJ3eJc9Rc+iA7sq0kVjU4DQvrHyptFyEDCbMuKIMhAJpGmoIZhyxkYD1IA2gIvfMqIATy7LVKvllDXhYErTSyRtad7UFVolZcquDtrAsEweouugwklbYeSxgCisN6xCCe8/z1CEwtbOs8Nlwyc4S6470lg8KWCCFeWQ7BlDDDQODYF1VgnPmd0bZ4iMnjuQrOcgdRUvOusOsji5OXJvA0T74MOdgA5rzlAY3JwaOjnwJyhi+VeQj50dF7cwx3m5q6xVlQhNOvhvJfLBZPyv7FvsxbRd93M/gRnQ2KrF9upWtFTTeLV2VXyeYjaXqLBmP97FyErY7SFuHpzWPquEHtxtdIXCFhfHZ1EZvuC/jw67/gEqU30NhFqtai86iXUA+mGLmU+QTbpmdCZWPhNYx4kYqP1y4MNCB420j68Ou/A/yAC1DpCiUgj46uuplWxWZpDUdHOXznMe51Ay1teIU0vNyFRnIpzZUECS5Ja2UeRnBmltAF9Ns9l+lRbi8MxmWT7gAzGbAEa/aWytHWI6a3AfUcA+vi2TdDwFLxNkeNt12drO06sw7OY6W0hltV1kgxtrOyBLcmLxKZAd9xByu+ENTgEqRHCGhoBFcHIvGkc8569kIl5yurtV1wAtCUzipDIYfSy4q2+rNtoRcMs7LmGVKCcLvpZ2s1m5Skm7iOePs+eM8N+aCJ7/dajxV6NhjD3ubFqXU53Q1lCVytf6aseVpz15JFXCawlUqnafLtoZ442NG34V11jX6uClxPtI/c6HFkHotMaFWgCbizMJy9vbqE+avRRGQ7o/EPXO7x5cV35z9cn7Mz3EgTYCejyWjCJGcDtdLsWDp48B3OtdV2lfq/eh+upzrhI42dliquVRGp1Xofuts8B0Um8t2n4TQTjQ3ELKsV39yfvO57Jv/SoefFa5qJufRKznj4361EqQL/LjdPvI9i9NWP69fiC/i8V+azAQ27i+HFZS51x18iEw+4PHju9tM+GxYY9jhxnBUFOtqRfbIM722Ub84vz2/ORSa4Fe/vTg9xd1r/YAPPura/VCUf+C9veM8KrFZpL+v7DX86+qjEOsaBm3Ga9n3/X9wt74E=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,f={},D=[];function T(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,n.jsx)(p(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,n.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(r(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.26bd5237.js b/assets/js/b2e6bd40.26bd5237.js new file mode 100644 index 000000000..a5200a262 --- /dev/null +++ b/assets/js/b2e6bd40.26bd5237.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7960],{48597:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>v,default:()=>q,frontMatter:()=>g,metadata:()=>i,toc:()=>N});const i=JSON.parse('{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/v1.1/resendrequestmail.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/resendrequestmail","permalink":"/docs/API-docs/v1.1/resendrequestmail","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar_label":"Resend request mail","hide_title":true,"hide_table_of_contents":true,"api":"eJztWM1uIzcSfpUKL7Mx2pI8O7kIXiNeZzAxdpAxxg6MhccQqO5qNWM2yfBHsiIIyCFvsKe97qPNkyyK7D/JykxmB7sLBLkYcpFVrPqqWPU1N8zzhWPTO/aNzkONyjt2n7ECXW6F8UIrNmVv0aEqwOKPAZ2HmgsJXkNwaKHUFpxYKKEWUDQmRu8Uy5g2aDlZuCw6G40JssAy1vz3V12s2XTDcq08Kk8/uTFS5FF7/IMjJzbM5RXWnH6RnrBYkNvtmTNRsIxhtHyfMb82yKZMz3/A3LOMGUvueIGODAyVppt2s/NWqAVZeeS1kSQyVi9FgV1kIAq2bY85oLmLW6sdgYqolVbXES60jiC0ePwE2oRe7wNpf938O8p13TkwcyGF91FHLoLzzcHcB4vdedEONHZAKPD46MeVryUltuZ+BBdcgVC5DAVCqaXUK0r1klvB5xIdwGbTwemFl7jdwmZDUaGdKV7jdpv1AjpvR2AqrZotFnMUyx2tToS9YicbqOKjEXY9K7hvBLmuDVfroQOpSGfBNnaUps2jHaz3HIeKuxYrLGCtAyWNLB2Ius/LvCnoz0oKGfkjI+zUnH0rDrhyOjZnp+bsFqHSBsFXwjXAlUIVLuZqhVKO4NR5q9XibA+C03EjP5xki0uBK+CqSPnurexj2xkaNT79XQc7SKtwkNuQCx6bprE6RyxgJXwFvkJQ+OjBeTQOuAPhUzctBcYYLPCFRYy9h3zhwVfaip9ia2wPPOVQWSz/8mwP02dn1+R6hRZPx/ys2X1ZxhgrvkTgag0xcKGVA21BkW9lsL5CC7nkVpRNH87ASOQOgdo0z310PiHa+nFTcfXgstO5PbtBXsMbg4o8eP/Lv2gH224zFkFjU2bjPOivy5YW+8bubcAocEYrl7r288kkNu+dW8Sy3z43PjwULLogDzbTdPEOT4jUQCk9LuQ5OlcGKdejnViFkkLhrA1m9nwymZ1MKORtxl78d6NCa7X91KCudY2+oq6yoshWVN4fDunFZDJ73kX04mlEx/0MVdpDqYMqQJTDyUo3hdZybS3mxCKO0+jcUWiGapGW0pVvFE0sqjjH0owFKZwH3Z8SR+v/E9kDIGi7F+XHkH4xO+mQ/uop0pdqyaUo4PzqEm70A6ov/gcx9xEOj/fpeHL1sY6EiXpvDCpuiutsJ9ihPAXpMA9W+DWb3m3Y4zE34jitT+/ut/cZo1LVRDGNdtFj7is2ZeO+wzAyYpdoXbQRrGRTVnlv3HQ8dlwVc/040gYVVY3kc0c0a8yNGC9PRidsm+3rcGM+aT+G409VcZ4vhFp8TO++x+eacpjStINSlyxuxN9wzbI2CcNdGRNUOxXyAm1MGJXG256gv2wTvMeeD1LkjiE/Ja9PuOvnca5dyvUHW/g9sQWqyVLHAm7aQ7slNpd4AfZJ9S3KXNdI2NGJA5tRp81G9DFa+OKdeqfeBAtGr9CWQUbgSomPYi4xKmEd11xXi8hric5J4uceF5Z7hEIshOey+xbOueFzIQV1Ttqmm/z0zdeN4LbCCN1ah2cWgUOBS5TUcCl1uuZ++FkNK20fSqlXLgMO8+CEQucAVcVVThvbTpBRbrgCVB6tscIhOG/Ja5F808pbSkrNFV/Ecsl2oCpQ0u1xYPU8OA9Oy5CS7rmQ2mIBbUBUAm5EIL58NLQEJCWyb7GitrVEWARRoMsg1wWCi72AQlAFzOl7x5AvIsf4RRyU1PlDTB4xKTCa5hZdB13u+Ejq3nLlaNwmX9ocdIDF6+McJgePjr53SBl+LdSDmx4dEcG462rqFudOeLz/U9uCV6vVk9b75a7OK+G/DXN4i0Y74bVd99oL4aswj+16aKT7J1l6hQpj/QyacW+j0Ll72v1JOq5QmvE1eqoQNz6/uoyj/kt4//M/4DVyq6DSq1StebAo17BojyLkUuYTbN2kjo851DMI8TwVX9PqWgRvK+7f//xPB9/hingWXaEE5NHRVZhLkcMN1kZyj+7oaAoXFulI38rAV9xDzhXMEVzFqZSWggMHk7SlUA8jOFfrRIq6xkfyqLcTRmy2bbodzLnDArSKGu2Zo94jktcO5RId2SLGNUfAQlAr95XVYZFOGzrTBGexFFLCrSgW6GNs50VBlDOKV0lMgA/cwZIuhK9wDdzG/udHcLWnEleCMdqSFyI533/XoyqMFsq7KRSWl763n/WFnhPMse0+ESUIeQdH1pjpUpJuYhNxJ02vUHtEYrfXWizR0oEx7D4vRjTldNeWJVC1fk5Z0zBoJkmkoQ274EZ8vW8n0km0tXtTXqNdihwbVvUrN3ocN49ZxqTIUTkc0NTzV1evYfnn0YRlA3r2Gy73+PXlxcvvrl+SM9RIE2Ano8loQiJiqjVXg5MOPLHuz7bBA+l/+CLb8MD4omQkF5F6x7g2DWu+G3yX0zNqRZR6esc2G7pa3xNNIPGPAS3x8fuMtc9OkY1nLYEkmv2AxMguks/HN3Q2bZchcdG9jxBiwEnjPM/R+A/uHbL+qzfXNyxj7ZtbrYv4vMBX9MDMV+ljWkcM02c+yTZMcrUIfEF7k03ivNT7dgnzQyTMzQ+Kql1S64GHu0w6hUF/KaiDCptNIuORwab9aelXNRpg292Uu/vtdvtvFy2NrQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var s=n(74848),o=n(28453),r=n(33617),a=n.n(r),d=n(17543),c=n.n(d),l=n(86013),p=n.n(l),u=n(63723),m=n.n(u),y=(n(18766),n(79329),n(9303));const g={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJztWM1uIzcSfpUKL7Mx2pI8O7kIXiNeZzAxdpAxxg6MhccQqO5qNWM2yfBHsiIIyCFvsKe97qPNkyyK7D/JykxmB7sLBLkYcpFVrPqqWPU1N8zzhWPTO/aNzkONyjt2n7ECXW6F8UIrNmVv0aEqwOKPAZ2HmgsJXkNwaKHUFpxYKKEWUDQmRu8Uy5g2aDlZuCw6G40JssAy1vz3V12s2XTDcq08Kk8/uTFS5FF7/IMjJzbM5RXWnH6RnrBYkNvtmTNRsIxhtHyfMb82yKZMz3/A3LOMGUvueIGODAyVppt2s/NWqAVZeeS1kSQyVi9FgV1kIAq2bY85oLmLW6sdgYqolVbXES60jiC0ePwE2oRe7wNpf938O8p13TkwcyGF91FHLoLzzcHcB4vdedEONHZAKPD46MeVryUltuZ+BBdcgVC5DAVCqaXUK0r1klvB5xIdwGbTwemFl7jdwmZDUaGdKV7jdpv1AjpvR2AqrZotFnMUyx2tToS9YicbqOKjEXY9K7hvBLmuDVfroQOpSGfBNnaUps2jHaz3HIeKuxYrLGCtAyWNLB2Ius/LvCnoz0oKGfkjI+zUnH0rDrhyOjZnp+bsFqHSBsFXwjXAlUIVLuZqhVKO4NR5q9XibA+C03EjP5xki0uBK+CqSPnurexj2xkaNT79XQc7SKtwkNuQCx6bprE6RyxgJXwFvkJQ+OjBeTQOuAPhUzctBcYYLPCFRYy9h3zhwVfaip9ia2wPPOVQWSz/8mwP02dn1+R6hRZPx/ys2X1ZxhgrvkTgag0xcKGVA21BkW9lsL5CC7nkVpRNH87ASOQOgdo0z310PiHa+nFTcfXgstO5PbtBXsMbg4o8eP/Lv2gH224zFkFjU2bjPOivy5YW+8bubcAocEYrl7r288kkNu+dW8Sy3z43PjwULLogDzbTdPEOT4jUQCk9LuQ5OlcGKdejnViFkkLhrA1m9nwymZ1MKORtxl78d6NCa7X91KCudY2+oq6yoshWVN4fDunFZDJ73kX04mlEx/0MVdpDqYMqQJTDyUo3hdZybS3mxCKO0+jcUWiGapGW0pVvFE0sqjjH0owFKZwH3Z8SR+v/E9kDIGi7F+XHkH4xO+mQ/uop0pdqyaUo4PzqEm70A6ov/gcx9xEOj/fpeHL1sY6EiXpvDCpuiutsJ9ihPAXpMA9W+DWb3m3Y4zE34jitT+/ut/cZo1LVRDGNdtFj7is2ZeO+wzAyYpdoXbQRrGRTVnlv3HQ8dlwVc/040gYVVY3kc0c0a8yNGC9PRidsm+3rcGM+aT+G409VcZ4vhFp8TO++x+eacpjStINSlyxuxN9wzbI2CcNdGRNUOxXyAm1MGJXG256gv2wTvMeeD1LkjiE/Ja9PuOvnca5dyvUHW/g9sQWqyVLHAm7aQ7slNpd4AfZJ9S3KXNdI2NGJA5tRp81G9DFa+OKdeqfeBAtGr9CWQUbgSomPYi4xKmEd11xXi8hric5J4uceF5Z7hEIshOey+xbOueFzIQV1Ttqmm/z0zdeN4LbCCN1ah2cWgUOBS5TUcCl1uuZ++FkNK20fSqlXLgMO8+CEQucAVcVVThvbTpBRbrgCVB6tscIhOG/Ja5F808pbSkrNFV/Ecsl2oCpQ0u1xYPU8OA9Oy5CS7rmQ2mIBbUBUAm5EIL58NLQEJCWyb7GitrVEWARRoMsg1wWCi72AQlAFzOl7x5AvIsf4RRyU1PlDTB4xKTCa5hZdB13u+Ejq3nLlaNwmX9ocdIDF6+McJgePjr53SBl+LdSDmx4dEcG462rqFudOeLz/U9uCV6vVk9b75a7OK+G/DXN4i0Y74bVd99oL4aswj+16aKT7J1l6hQpj/QyacW+j0Ll72v1JOq5QmvE1eqoQNz6/uoyj/kt4//M/4DVyq6DSq1StebAo17BojyLkUuYTbN2kjo851DMI8TwVX9PqWgRvK+7f//xPB9/hingWXaEE5NHRVZhLkcMN1kZyj+7oaAoXFulI38rAV9xDzhXMEVzFqZSWggMHk7SlUA8jOFfrRIq6xkfyqLcTRmy2bbodzLnDArSKGu2Zo94jktcO5RId2SLGNUfAQlAr95XVYZFOGzrTBGexFFLCrSgW6GNs50VBlDOKV0lMgA/cwZIuhK9wDdzG/udHcLWnEleCMdqSFyI533/XoyqMFsq7KRSWl763n/WFnhPMse0+ESUIeQdH1pjpUpJuYhNxJ02vUHtEYrfXWizR0oEx7D4vRjTldNeWJVC1fk5Z0zBoJkmkoQ274EZ8vW8n0km0tXtTXqNdihwbVvUrN3ocN49ZxqTIUTkc0NTzV1evYfnn0YRlA3r2Gy73+PXlxcvvrl+SM9RIE2Ano8loQiJiqjVXg5MOPLHuz7bBA+l/+CLb8MD4omQkF5F6x7g2DWu+G3yX0zNqRZR6esc2G7pa3xNNIPGPAS3x8fuMtc9OkY1nLYEkmv2AxMguks/HN3Q2bZchcdG9jxBiwEnjPM/R+A/uHbL+qzfXNyxj7ZtbrYv4vMBX9MDMV+ljWkcM02c+yTZMcrUIfEF7k03ivNT7dgnzQyTMzQ+Kql1S64GHu0w6hUF/KaiDCptNIuORwab9aelXNRpg292Uu/vtdvtvFy2NrQ==",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,x={},N=[];function k(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,s.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(c(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["document_id","email"],type:"object",properties:{document_id:{type:"string",example:"provide document id"},email:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"},email_subject:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"}},title:"resendmail_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",format:"string",example:"mail sent successfully."}},title:"inline_response_200_10"}}}},400:{description:"",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Something went wrong."}},title:"inline_response_400_2"}}}},404:{description:"- document not found if document id is not correct.\n- user not found if provided user email is not present in signer list of document\n",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"document not found or user not found."}},title:"inline_response_404_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function q(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/b2e6bd40.8c485554.js b/assets/js/b2e6bd40.8c485554.js deleted file mode 100644 index d27e0bc03..000000000 --- a/assets/js/b2e6bd40.8c485554.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7960],{48597:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>g,default:()=>K,frontMatter:()=>f,metadata:()=>n,toc:()=>k});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":"eJztWO9uG7kRf5U5fkkvWEtOmn4RXOPcNEiMBo0R+xAUjiFQu7Nanrkkj8OVrAoC+qFv0Dfoo92TFEPuP8m65NKgLVDcF8PicoYzvxn++CO3Isglidmt+KPNmxpNIHGXiQIp98oFZY2YifdIaArw+GODFKCWSkOw0BB6KK0HUkujzBKK1sXkoxGZsA69ZA+XRe+jdcEeRCbaX3+wxUbMtiK3JqAJ/K90Tqs8Wk9/IA5iKyivsJb8H9spjwWH3a05V4XIBEbPd5kIG4diJuziB8yDyITzHE5QSOxgbDTbdpMpeGWW7OVB1k7zkPN2pQrsMwNViF23zBHLfdw66whURK30to5woSeG0OPJI2gTekMMbP1d+3OS27oPYE5NSu+zgbxsKLQLy9B47NeLfqD1A8pAwIcwrUKtubC1DBN4KQ0ok+umQCit1nbNpV5Jr+RCIwFstz2cQQWNux1st5wV+rmRNe522TDA6+0NuMqadorHHNVqz6ofwsGwHxuZ4oNTfjMvZGgHcls7aTbjAFKTzhvf+jGWJ0/2sD4IHCpJHVZYwMY2XDT2dCTroS6LtqG/qijs5NeKiDN3/kYdCeVs6s7P3PkHhMo6hFApaoErlSko1mqNWk/gjIK3Znl+AMHZtB0/XmSPK4VrkKZI9R68HGLbO5q0Mf3FNn5UVkWQ+yZXMpKm8zZHLGCtQgWhQjD4EIACOgJJoEJi01JhzMGDXHrEyD0ci2xCZb36a6TGbsEzCZXH8vdPDjB9cn7NoVfo8Wwqz9vZl2XMsZIrBGk2EBNX1hBYD4ZjKxsfKvSQa+lV2fJwBk6jJASmaZmHGHxCtIvjppLmnrKzhT+/QVnDO4eGI/jp7//kGWK3y0QETcyEj+fBsF12/HEg9uAbjAPkrKHE2s9PTyN57+0ikf3yc+PTh4JHavRRMk0b7/gJkQiUy0NNniNR2Wi9mezlqoxWBuddMvPnp6fzZ6ec8i4TL/6zWaH31n9pUte2xlAxq6w5szW396dTenF6On/eZ/TicUYnwxlqbIDSNqYAVY5PVt4p/C233mPOKuIkHZ17Bu2hWqRPacu3hi42VTzH0hkLWlEAO6wSj9b/JbJHQLD+IMvPIf1i/qxH+nePkb40K6lVARdXl3Bj79F881/IechwvHxIy3OoD3UUTMy9Mak4KX4Xe8mOx1OShHnjVdiI2e1WPJxIp07S99nt3e4uE9yqliWmsxQjlqESMzEdGEawE79CT9FH47WYiSoER7PplKQpFvZhYh0a7hotF8Qyayqdmq6eTZ6JXXZoI537ovnYnHypCQW5VGb5Obu7AZ9rrmEq0x5KfbGkU3/Cjci6IoxnZUJx71QoC/SxYNwa7weB/qor8IF6PiqRe4X8WLw+0q5fp7n2JdevauH/SS1wT5Y2NnBLD92USC5xAxyK6g+oc1sjY8crjnxGm64aMcbo4ZuP5qN513hwdo2+bHQErtT4oBYaoxHW8Rv1vYiy1kikWZ8HXHoZEAq1VEHq/i6cSycXSitmTp5m2/oM5EsT+FBhhG5jmyceQUKBK9RMuFw6W8swvlbD2vr7Uts1ZSBh0ZAySARoKmlyntgxQca1kQbQBPTOK0Kg4DlqlWKzJnguSi2NXMZ2yfagKlDz7iHwdtFQALK6SUUPUmnrsYAuIW4BmjCIrx4cfwIeZbHvsWLaWiEsG1UgZZDbAoEiF3AKpoAF33ccx6JyjDfixmib38fisZICZ/nc4u1gy70Y2Tx4aYiP2xRLV4MesLh9iDAF+PTp94Rc4bfK3NPs6VMWGLd9T33ABamAd7/pKHi9Xj+i3m/3bV6r8KZZwHt0llSwfjNYL1WomkWk67GT/kfy9BoNxv4ZkfHgo7A5PWZ/Hp1WqN30GgN3CE0vri7jUf8t/PS3f8BblN5AZdepW/PGo97AsluKkUuVT7D1J3V8zGHOYMTz1Hwt1fUIOr7RscLizdNieNUstMohYO20DDiDC3D7Q5BLAwuE3KNk2oxEWUlupJWSIEErcz+BC7NJWqjnOx6PxslyYFg5VDk+qqgwgTd2jSv0WfRBbMaaCguV6KcPRgVCXUZ9eeWxVFrDWhVLDLOD3wTSI2C9wIIVp9pbdoElt7sKzNlRd7ZvYjSBmwo30VaupNJ8LY9X+Wp8YUdTOKtMoBkUXpah90zZsEhMO/Lpo6EEkuzTylo33e92ix1UgiYQRfCBRNhnUY8lel4xbsmhcZxqG+W2azjgPvyahmWab8+IKDBb3SCd+u7QTxSK6Gt6V16jX6kcW730M3t1GidPRSa0ytEQjgToxeurt7CC305ORTZSXr9g307fXr589efrVxwNc2RC7NnkdHLKQyxCa2lGSx15PT08tkZvn//mY2sr8eJjkdNSRVUd89q2gvh2dOXmF9KK1fLsVmy3C0n4PSsAHv6xQc9S+y4T3YtSFNpZpw1ZQd8ji62XKeaTG16bp+smycyD+wWL22RxkefowifnjgX91bvrG5GJ7jmttkV8OZBrfjuW63RPthHDdIPnsa3Q0iwbueS5ySfLWaa1fS18H7Vw+w9n1X0ym1GE+yI5pcF/OamjBttt0tlRnKb56dPPWrTAdrO5dne73e5fjAJ+Zg==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1.1/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/v1.1/drafttemplate"}}');var s=i(74848),o=i(28453),r=i(33617),a=i.n(r),d=i(17543),p=i.n(d),l=i(86013),c=i.n(l),m=i(63723),u=i.n(m),x=(i(18766),i(79329),i(9303));const f={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:"eJztWO9uG7kRf5U5fkkvWEtOmn4RXOPcNEiMBo0R+xAUjiFQu7Nanrkkj8OVrAoC+qFv0Dfoo92TFEPuP8m65NKgLVDcF8PicoYzvxn++CO3Isglidmt+KPNmxpNIHGXiQIp98oFZY2YifdIaArw+GODFKCWSkOw0BB6KK0HUkujzBKK1sXkoxGZsA69ZA+XRe+jdcEeRCbaX3+wxUbMtiK3JqAJ/K90Tqs8Wk9/IA5iKyivsJb8H9spjwWH3a05V4XIBEbPd5kIG4diJuziB8yDyITzHE5QSOxgbDTbdpMpeGWW7OVB1k7zkPN2pQrsMwNViF23zBHLfdw66whURK30to5woSeG0OPJI2gTekMMbP1d+3OS27oPYE5NSu+zgbxsKLQLy9B47NeLfqD1A8pAwIcwrUKtubC1DBN4KQ0ok+umQCit1nbNpV5Jr+RCIwFstz2cQQWNux1st5wV+rmRNe522TDA6+0NuMqadorHHNVqz6ofwsGwHxuZ4oNTfjMvZGgHcls7aTbjAFKTzhvf+jGWJ0/2sD4IHCpJHVZYwMY2XDT2dCTroS6LtqG/qijs5NeKiDN3/kYdCeVs6s7P3PkHhMo6hFApaoErlSko1mqNWk/gjIK3Znl+AMHZtB0/XmSPK4VrkKZI9R68HGLbO5q0Mf3FNn5UVkWQ+yZXMpKm8zZHLGCtQgWhQjD4EIACOgJJoEJi01JhzMGDXHrEyD0ci2xCZb36a6TGbsEzCZXH8vdPDjB9cn7NoVfo8Wwqz9vZl2XMsZIrBGk2EBNX1hBYD4ZjKxsfKvSQa+lV2fJwBk6jJASmaZmHGHxCtIvjppLmnrKzhT+/QVnDO4eGI/jp7//kGWK3y0QETcyEj+fBsF12/HEg9uAbjAPkrKHE2s9PTyN57+0ikf3yc+PTh4JHavRRMk0b7/gJkQiUy0NNniNR2Wi9mezlqoxWBuddMvPnp6fzZ6ec8i4TL/6zWaH31n9pUte2xlAxq6w5szW396dTenF6On/eZ/TicUYnwxlqbIDSNqYAVY5PVt4p/C233mPOKuIkHZ17Bu2hWqRPacu3hi42VTzH0hkLWlEAO6wSj9b/JbJHQLD+IMvPIf1i/qxH+nePkb40K6lVARdXl3Bj79F881/IechwvHxIy3OoD3UUTMy9Mak4KX4Xe8mOx1OShHnjVdiI2e1WPJxIp07S99nt3e4uE9yqliWmsxQjlqESMzEdGEawE79CT9FH47WYiSoER7PplKQpFvZhYh0a7hotF8Qyayqdmq6eTZ6JXXZoI537ovnYnHypCQW5VGb5Obu7AZ9rrmEq0x5KfbGkU3/Cjci6IoxnZUJx71QoC/SxYNwa7weB/qor8IF6PiqRe4X8WLw+0q5fp7n2JdevauH/SS1wT5Y2NnBLD92USC5xAxyK6g+oc1sjY8crjnxGm64aMcbo4ZuP5qN513hwdo2+bHQErtT4oBYaoxHW8Rv1vYiy1kikWZ8HXHoZEAq1VEHq/i6cSycXSitmTp5m2/oM5EsT+FBhhG5jmyceQUKBK9RMuFw6W8swvlbD2vr7Uts1ZSBh0ZAySARoKmlyntgxQca1kQbQBPTOK0Kg4DlqlWKzJnguSi2NXMZ2yfagKlDz7iHwdtFQALK6SUUPUmnrsYAuIW4BmjCIrx4cfwIeZbHvsWLaWiEsG1UgZZDbAoEiF3AKpoAF33ccx6JyjDfixmib38fisZICZ/nc4u1gy70Y2Tx4aYiP2xRLV4MesLh9iDAF+PTp94Rc4bfK3NPs6VMWGLd9T33ABamAd7/pKHi9Xj+i3m/3bV6r8KZZwHt0llSwfjNYL1WomkWk67GT/kfy9BoNxv4ZkfHgo7A5PWZ/Hp1WqN30GgN3CE0vri7jUf8t/PS3f8BblN5AZdepW/PGo97AsluKkUuVT7D1J3V8zGHOYMTz1Hwt1fUIOr7RscLizdNieNUstMohYO20DDiDC3D7Q5BLAwuE3KNk2oxEWUlupJWSIEErcz+BC7NJWqjnOx6PxslyYFg5VDk+qqgwgTd2jSv0WfRBbMaaCguV6KcPRgVCXUZ9eeWxVFrDWhVLDLOD3wTSI2C9wIIVp9pbdoElt7sKzNlRd7ZvYjSBmwo30VaupNJ8LY9X+Wp8YUdTOKtMoBkUXpah90zZsEhMO/Lpo6EEkuzTylo33e92ix1UgiYQRfCBRNhnUY8lel4xbsmhcZxqG+W2azjgPvyahmWab8+IKDBb3SCd+u7QTxSK6Gt6V16jX6kcW730M3t1GidPRSa0ytEQjgToxeurt7CC305ORTZSXr9g307fXr589efrVxwNc2RC7NnkdHLKQyxCa2lGSx15PT08tkZvn//mY2sr8eJjkdNSRVUd89q2gvh2dOXmF9KK1fLsVmy3C0n4PSsAHv6xQc9S+y4T3YtSFNpZpw1ZQd8ji62XKeaTG16bp+smycyD+wWL22RxkefowifnjgX91bvrG5GJ7jmttkV8OZBrfjuW63RPthHDdIPnsa3Q0iwbueS5ySfLWaa1fS18H7Vw+w9n1X0ym1GE+yI5pcF/OamjBttt0tlRnKb56dPPWrTAdrO5dne73e5fjAJ+Zg==",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={},k=[];function j(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,s.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(p(),{parameters:void 0}),"\n",(0,s.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["document_id","email"],type:"object",properties:{document_id:{type:"string",example:"provide document id"},email:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"},email_subject:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"}},title:"resendmail_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",format:"string",example:"mail sent successfully."}},title:"inline_response_200_10"}}}},400:{description:"",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Something went wrong."}},title:"inline_response_400_2"}}}},404:{description:"- document not found if document id is not correct.\n- user not found if provided user email is not present in signer list of document\n",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"document not found or user not found."}},title:"inline_response_404_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function K(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.81affa8f.js b/assets/js/b93339ed.81affa8f.js deleted file mode 100644 index 0fa97e4e8..000000000 --- a/assets/js/b93339ed.81affa8f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>v,default:()=>R,frontMatter:()=>u,metadata:()=>a,toc:()=>b});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":"eJy9WO9u5LYRf5UJvzR3kHfXjpOm+hQ3uN45OeSMsw8H1LcwKGkkMaZIhqRWXiwE9EPfoG/QR8uTBENKWq3tc2q06Rd7l+QMZ37zmz/cHfO8ciy9Zn/TskDL1gkr0OVWGC+0Yim7qhE+mIJ7hHgEzi7OgUupOwdb3YLX0OqwX8Z9xRsE7qBDKem/4RaVj8LnxYIlTBu0nPSfFyxlbdAehVnCDLe8QY+WzNox0sZSFrdvRMESJsguw33N7hurs58x9+cF6BImhRZ/aYXFgqXetpgw57eSVDrRGIksYXhnpC6QpSWXjg7kNTacpTvmtyac9FaoiiWs1Lbhfr6CdzxoSVn243FeFie1yVjfr+O16PxfdbElVYeGXli9EQVChlJ3MLlMYOYW92CyhOVaeVSedHBjpMgDcsufHSnazYzd+3k9wBWwWyejGxEdgthSBLxAR3Lx7E8B5+e5rLAb7exD4GZxfq4u1vcJ88LLWbQzwq7vaceiM1q5aPHJavUQUtfmOTpXthImfj0HvqdBGpn1XLfe3LqTHwx254YgilQvzvxjavZCJ6uTr46OV0erP18df5Oe/iX9+pvFarX6O0vYXSNJdsgK0sZmuMXvswWhpFB4M6J3c7Ja3RwfD5iePgbjpW7Q10JV0KHy0FmtqgSMRO4QvN0Cr7hQILlH+8X/Dl+0VtunUXmeZU+hcEooTCCcPgRhrGTaQ6lbFYrWH+3oUyx6aM/T7p3efDu59/VD987VhktRhEru9S2q/28gH7meTD2ktoiHwj47cHa+Hp10mLdW+G1oGHdH3IijuJ9er6kUE280tRrTBoOpdaRsGVFd7qbe0jPSZTdj72mtZCmrvTcuXS4dV0Wm7xbaoHKiUpJnbpHrZsmNWG6OF8esT+7LcGOedR7bo+eKOM8roarfk1vvYbqkUMZoHYA1xYwb8SNuWTLGYn5qaL818lD2+4QRQ97vm92rMc6HnWXeLB72CkYhFqrUwYoh1O8MqktRqUCU4MX9fv8RZa4bpLbpa4RR4Nd//jvIFDpvG1Q+MDlo+OKT+qTetRaM7tBSr+CqgFLincgkBiFswt403DjkjUTn5BaE8lhZ6s6FqITnEghsqkg5NzwTUlAW0DFN0hZmieQW8LFGX6OlrT9ZBA4FblBS8gBvvW64J1Wj0dBpe1vSmJUAh6x1QqFzgKrmKqeDYzgT0Ba4AlQerbHCIThvyWoRbdPKW557aLjiFZLu5ACqAqUgzoPVWes8OC3bYDJ4LqS2WMDokEIs3IJAfEVDk0Wg1Vw3xmJN3NsgVK0o0CWQ6wLBBTKQC6qADJ0HQ7aIHF2YHJXU+W0IXtlKCUZTDRJc0gQ3t5HEveXKUZmMtowxmAAzVtMEgNHAly8/OKQIvxXq1qUvX35SR3A9ceojZk54XH855lHXdQ/y58WhzGvh37QZvEejnfDabvfSlfB1m4WcmyuZvkRNr1Fh4M8so/Y6Cp27hylMq8sapVleoieGuOXZxfkVib6AX//xL3iL3CqodRfZmrcW5Raq8SpCLkY+wjZVXSh1IF5NiOeRfMPQOiEYB38Rk2fA8KLNpMjBY2Oo16ZwBuZwCXKuIMNhlC2CCa7mRKSN4MBBCnW7gDO1hdahhU74OnCA1oPwMAQHQUKe76NcWt2A8At4ozvcoE2CDkdi1B+xED7omowR3qEsF8F0i6WQEjpRVOjTe98dcIuATYZFgQV5Pbs2w5LoLjwIB45WiL508wKuatwGWb7hQnKqJEJFUmt6KBGyqAqjhfIuhcLy0k+aXbK/JLgttHpkKYLEJ7eSQc34fUixe5FwC/hENftenT+sohZLtHRjSMk9cYwYiHI9Eg6Ih/8NYanMUz3ieRg0sOFCxobz3X09oemjbdy78hLtRuQ4NL3P5OoyHF6yhEmRo3I4GybOXl+8hQ18tVixZNY+/4O8Xb49//7VT5evyBqqkRGx48VqsQpvHu18w9XsqoO38v2GtdtPWX/Iw3ro3x7v/NJILsLkFPzdDVPP+DRkCUv3b+p1wmrtPG3vdhl3+MHKvqflX1q0NFetE7bhVhC3w2hUCEefi+nR/Fk/v3w/vEtfwKPP80dtHgcRRVPIhss2PBETdovbgx8D+nWfjLMImRX3v4+XH12Rlr38g7GWhqkocZbnaPyTZ+dz5MWHK5awbHjaN+HHA2Z5R7828C6aqgMWYcoKazsmuapaXtHZqJKmJyrAh6PXbRi9hg/k1KNgHM5k0Qv6Sz49KrDbxbGu76fzceuzEgOu42mKzLrv+98Ar/9frg==","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 r=o(74848),d=o(28453),s=o(33617),i=o.n(s),n=o(17543),l=o.n(n),p=o(86013),c=o.n(p),h=o(63723),m=o.n(h),f=(o(18766),o(79329),o(9303));const u={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:"eJy9WO9u5LYRf5UJvzR3kHfXjpOm+hQ3uN45OeSMsw8H1LcwKGkkMaZIhqRWXiwE9EPfoG/QR8uTBENKWq3tc2q06Rd7l+QMZ37zmz/cHfO8ciy9Zn/TskDL1gkr0OVWGC+0Yim7qhE+mIJ7hHgEzi7OgUupOwdb3YLX0OqwX8Z9xRsE7qBDKem/4RaVj8LnxYIlTBu0nPSfFyxlbdAehVnCDLe8QY+WzNox0sZSFrdvRMESJsguw33N7hurs58x9+cF6BImhRZ/aYXFgqXetpgw57eSVDrRGIksYXhnpC6QpSWXjg7kNTacpTvmtyac9FaoiiWs1Lbhfr6CdzxoSVn243FeFie1yVjfr+O16PxfdbElVYeGXli9EQVChlJ3MLlMYOYW92CyhOVaeVSedHBjpMgDcsufHSnazYzd+3k9wBWwWyejGxEdgthSBLxAR3Lx7E8B5+e5rLAb7exD4GZxfq4u1vcJ88LLWbQzwq7vaceiM1q5aPHJavUQUtfmOTpXthImfj0HvqdBGpn1XLfe3LqTHwx254YgilQvzvxjavZCJ6uTr46OV0erP18df5Oe/iX9+pvFarX6O0vYXSNJdsgK0sZmuMXvswWhpFB4M6J3c7Ja3RwfD5iePgbjpW7Q10JV0KHy0FmtqgSMRO4QvN0Cr7hQILlH+8X/Dl+0VtunUXmeZU+hcEooTCCcPgRhrGTaQ6lbFYrWH+3oUyx6aM/T7p3efDu59/VD987VhktRhEru9S2q/28gH7meTD2ktoiHwj47cHa+Hp10mLdW+G1oGHdH3IijuJ9er6kUE280tRrTBoOpdaRsGVFd7qbe0jPSZTdj72mtZCmrvTcuXS4dV0Wm7xbaoHKiUpJnbpHrZsmNWG6OF8esT+7LcGOedR7bo+eKOM8roarfk1vvYbqkUMZoHYA1xYwb8SNuWTLGYn5qaL818lD2+4QRQ97vm92rMc6HnWXeLB72CkYhFqrUwYoh1O8MqktRqUCU4MX9fv8RZa4bpLbpa4RR4Nd//jvIFDpvG1Q+MDlo+OKT+qTetRaM7tBSr+CqgFLincgkBiFswt403DjkjUTn5BaE8lhZ6s6FqITnEghsqkg5NzwTUlAW0DFN0hZmieQW8LFGX6OlrT9ZBA4FblBS8gBvvW64J1Wj0dBpe1vSmJUAh6x1QqFzgKrmKqeDYzgT0Ba4AlQerbHCIThvyWoRbdPKW557aLjiFZLu5ACqAqUgzoPVWes8OC3bYDJ4LqS2WMDokEIs3IJAfEVDk0Wg1Vw3xmJN3NsgVK0o0CWQ6wLBBTKQC6qADJ0HQ7aIHF2YHJXU+W0IXtlKCUZTDRJc0gQ3t5HEveXKUZmMtowxmAAzVtMEgNHAly8/OKQIvxXq1qUvX35SR3A9ceojZk54XH855lHXdQ/y58WhzGvh37QZvEejnfDabvfSlfB1m4WcmyuZvkRNr1Fh4M8so/Y6Cp27hylMq8sapVleoieGuOXZxfkVib6AX//xL3iL3CqodRfZmrcW5Raq8SpCLkY+wjZVXSh1IF5NiOeRfMPQOiEYB38Rk2fA8KLNpMjBY2Oo16ZwBuZwCXKuIMNhlC2CCa7mRKSN4MBBCnW7gDO1hdahhU74OnCA1oPwMAQHQUKe76NcWt2A8At4ozvcoE2CDkdi1B+xED7omowR3qEsF8F0i6WQEjpRVOjTe98dcIuATYZFgQV5Pbs2w5LoLjwIB45WiL508wKuatwGWb7hQnKqJEJFUmt6KBGyqAqjhfIuhcLy0k+aXbK/JLgttHpkKYLEJ7eSQc34fUixe5FwC/hENftenT+sohZLtHRjSMk9cYwYiHI9Eg6Ih/8NYanMUz3ieRg0sOFCxobz3X09oemjbdy78hLtRuQ4NL3P5OoyHF6yhEmRo3I4GybOXl+8hQ18tVixZNY+/4O8Xb49//7VT5evyBqqkRGx48VqsQpvHu18w9XsqoO38v2GtdtPWX/Iw3ro3x7v/NJILsLkFPzdDVPP+DRkCUv3b+p1wmrtPG3vdhl3+MHKvqflX1q0NFetE7bhVhC3w2hUCEefi+nR/Fk/v3w/vEtfwKPP80dtHgcRRVPIhss2PBETdovbgx8D+nWfjLMImRX3v4+XH12Rlr38g7GWhqkocZbnaPyTZ+dz5MWHK5awbHjaN+HHA2Z5R7828C6aqgMWYcoKazsmuapaXtHZqJKmJyrAh6PXbRi9hg/k1KNgHM5k0Qv6Sz49KrDbxbGu76fzceuzEgOu42mKzLrv+98Ar/9frg==",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={},b=[];function q(e){const t={p:"p",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,r.jsx)(i(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,r.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,r.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,r.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function R(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(q,{...e})}):q(e)}}}]); \ No newline at end of file diff --git a/assets/js/b93339ed.c3230296.js b/assets/js/b93339ed.c3230296.js new file mode 100644 index 000000000..45c2d238e --- /dev/null +++ b/assets/js/b93339ed.c3230296.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8749],{74289:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>j,contentTitle:()=>y,default:()=>W,frontMatter:()=>g,metadata:()=>r,toc:()=>u});const r=JSON.parse('{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/v1.1/updatefolder.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/updatefolder","permalink":"/docs/API-docs/v1.1/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WM1u5DYSfpUKL5sx5O6242R3dYp3MDtxMpgxxh4YWE/DoKSSxJgiGZLqdqMhIIe8QU655tHmSRZFSmq17XHW2M1e7G6SVfzqq1/2lnleOZZes39qWaBly4QV6HIrjBdasZRd1ggfTME9QjwCp+dnwKXUawcb3YLX0OqwX8Z9xRsE7mCNUtJ/wy0qH4XPihlLmDZoOek/K1jK2qA9CrOEGW55gx4twdoy0sZSFrdvRMESJgiX4b5m98Hq7EfM/VkBuoRRocWfWmGxYKm3LSbM+Y0klU40RiJLGN4ZqQtkacmlowN5jQ1n6Zb5jQknvRWqYgkrtW24n67gHQ9aUpb9cJSXxXFtMtZ1y3gtOv8PXWxI1T7Qc6tXokDIUOo1jCYTmbnFHZksYblWHpUnHdwYKfLA3PxHR4q2E7A7O697ugJ3y2QwI7JDFFvygBfoSC6efRt4fp7JCtcDzi44buLn5+piXZcwL7yceDsj7rqOdiw6o5WLiI8Xi4eUujbP0bmylTDG13Poe5qkIbKea9Z3t+74e4PrM0MUxVAvTv1janZCx4vjrw6PFoeLv14efZOe/D39+pvZYrH4F0vYXSNJts8K0sYmvMXvkwWhpFB4M7B3c7xY3Bwd9ZyePEbjhW7Q10JVsEblYW21qhIwErlD8HYDvOJCgeQe7Rf/O37RWm2fZuV5yJ5i4YRYGEk4eUjCUMm0h1K3KhStP9vQp6LoIZ6nzTu5+dto3tcPzTtTKy5FESq517eo/r+OfOR6grof2iIeCvtsz9jpejTSYd5a4TehYdwdciMO4356vaRSTHGjqdWYNgCm1pGyeWR1vh17S8dIl10Nvae1kqWs9t64dD53XBWZvptpg8qJSkmeuVmumzk3Yr46mh2xLrkvw4151nlsD58r4jyvhKr+SG65o+mCXBm9tUfW6DNuxA+4Ycngi+mpvv3WyEPZ7xJGEfJ+1+xeDX7e7yzTZvGwVzBysVClDih6V78zqC5EpUKgBCvu9/srlLlukNqmrxEGgU+//B5kCp23DSofIjlo+OKj+qjetRaMXqOlXsFVAaXEO5FJDELYhL1xuHHIG4nOyQ0I5bGy1J0LUQnPJRDZVJFybngmpKAsoGOapC1MEsnN4KpGX6Olrb9YBA4FrlBS8gBvvW64J1UDaFhre1vSmJUAh6x1QqFzgKrmKqeDgzsT0Ba4AlQerbHCIThvCbWI2LTyluceGq54haQ72aOqQCko5sHqrHUenJZtgAyeC6ktFjAYpBALNyMSX9HQZBFoNdeNsVhT7K0QqlYU6BLIdYHgQjCQCaqADJ0HQ1hEji5Mjkrq/DY4r2ylBKOpBgkuaYKbYiRxb7lyVCYjlsEHI2HGapoAMAI8OPjgkDz8Rqhblx4cfFSHcD3G1BVmTnhcfjnk0Xq9fpA/L/ZlXgv/XZvBezTaCa/tZiddCV+3Wci5qZLxS9T0GhWG+Jlk1E5HoXP3MIVpdV6jNPML9BQhbn56fnZJoi/g08+/whvkVkGt1zFa89ai3EA1XEXMRc9H2saqC6UOgVcT43kMvn5oHRi8qrn/9PNvDt7iGkRMoUjkwcF5m0mRwyU2hlquOzhI4WWcXf2wBr7mHnKuIENwNadQWgkOHEyUlkLdzuBUbaB1aGEtfB2CgdaD3J4ZxMvobgcZd1iAVkFiuHO2Q0TrjUO5Qke6qHtmCFgITxFdW91W8bYpmN44i6WQEq5EUaEPtp0WBZh+eR2XifAJHCwpIXyNG+AWwaHyMzi/JxJ2WmO0JRQigi81vafIAagKo4XyLoXC8tLv9Ce7QA9PBKHVI0uRQj7SkfRqRpfETOwtHldnH6my3+sG+7XWYomWLgxm7/xiRB9O10NYAkXrfxPW1AyoavE8jCPYcCFjW/r2vp4wGqBt3LvyAu1K5Ni3xs9k9DwcnrOESZGjcjgZOU5fn7+B1VezBUsmPfY/SO75m7OXr95evCIwVEgjYUezxWwRHkba+YaryU17D+r7XW27G8X+lNd33+Q93vm5kVyE8SrYu+1Ho+H9yBKW7h7ey4TV2nna3m4p9z5Y2XW0/FOLloavZcJW3AqeUfu+3rJCOPpcjC/rz9r55fv+8foCHn3DP4p5mFYUjSorLtvwjkzYLW72fjHoll0yDCwEK+6/jJcfXpKWnfyD2Zcmrihxmudo/JNnp8Pm+YdLlrCsf/834RcGZvmafpLg6whVBy7CKBbWtkxyVbW8orNRJY1YVKX357PbMJ/1H8ioR8nYH9yiFfSXbHpUYLuNs1/Xjefj1mclel6H0+SZZdd1/wbGM271","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 a=o(74848),n=o(28453),d=o(33617),l=o.n(d),i=o(17543),p=o.n(i),s=o(86013),c=o.n(s),m=o(63723),f=o.n(m),v=(o(18766),o(79329),o(9303));const g={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:"eJy9WM1u5DYSfpUKL5sx5O6242R3dYp3MDtxMpgxxh4YWE/DoKSSxJgiGZLqdqMhIIe8QU655tHmSRZFSmq17XHW2M1e7G6SVfzqq1/2lnleOZZes39qWaBly4QV6HIrjBdasZRd1ggfTME9QjwCp+dnwKXUawcb3YLX0OqwX8Z9xRsE7mCNUtJ/wy0qH4XPihlLmDZoOek/K1jK2qA9CrOEGW55gx4twdoy0sZSFrdvRMESJgiX4b5m98Hq7EfM/VkBuoRRocWfWmGxYKm3LSbM+Y0klU40RiJLGN4ZqQtkacmlowN5jQ1n6Zb5jQknvRWqYgkrtW24n67gHQ9aUpb9cJSXxXFtMtZ1y3gtOv8PXWxI1T7Qc6tXokDIUOo1jCYTmbnFHZksYblWHpUnHdwYKfLA3PxHR4q2E7A7O697ugJ3y2QwI7JDFFvygBfoSC6efRt4fp7JCtcDzi44buLn5+piXZcwL7yceDsj7rqOdiw6o5WLiI8Xi4eUujbP0bmylTDG13Poe5qkIbKea9Z3t+74e4PrM0MUxVAvTv1janZCx4vjrw6PFoeLv14efZOe/D39+pvZYrH4F0vYXSNJts8K0sYmvMXvkwWhpFB4M7B3c7xY3Bwd9ZyePEbjhW7Q10JVsEblYW21qhIwErlD8HYDvOJCgeQe7Rf/O37RWm2fZuV5yJ5i4YRYGEk4eUjCUMm0h1K3KhStP9vQp6LoIZ6nzTu5+dto3tcPzTtTKy5FESq517eo/r+OfOR6grof2iIeCvtsz9jpejTSYd5a4TehYdwdciMO4356vaRSTHGjqdWYNgCm1pGyeWR1vh17S8dIl10Nvae1kqWs9t64dD53XBWZvptpg8qJSkmeuVmumzk3Yr46mh2xLrkvw4151nlsD58r4jyvhKr+SG65o+mCXBm9tUfW6DNuxA+4Ycngi+mpvv3WyEPZ7xJGEfJ+1+xeDX7e7yzTZvGwVzBysVClDih6V78zqC5EpUKgBCvu9/srlLlukNqmrxEGgU+//B5kCp23DSofIjlo+OKj+qjetRaMXqOlXsFVAaXEO5FJDELYhL1xuHHIG4nOyQ0I5bGy1J0LUQnPJRDZVJFybngmpKAsoGOapC1MEsnN4KpGX6Olrb9YBA4FrlBS8gBvvW64J1UDaFhre1vSmJUAh6x1QqFzgKrmKqeDgzsT0Ba4AlQerbHCIThvCbWI2LTyluceGq54haQ72aOqQCko5sHqrHUenJZtgAyeC6ktFjAYpBALNyMSX9HQZBFoNdeNsVhT7K0QqlYU6BLIdYHgQjCQCaqADJ0HQ1hEji5Mjkrq/DY4r2ylBKOpBgkuaYKbYiRxb7lyVCYjlsEHI2HGapoAMAI8OPjgkDz8Rqhblx4cfFSHcD3G1BVmTnhcfjnk0Xq9fpA/L/ZlXgv/XZvBezTaCa/tZiddCV+3Wci5qZLxS9T0GhWG+Jlk1E5HoXP3MIVpdV6jNPML9BQhbn56fnZJoi/g08+/whvkVkGt1zFa89ai3EA1XEXMRc9H2saqC6UOgVcT43kMvn5oHRi8qrn/9PNvDt7iGkRMoUjkwcF5m0mRwyU2hlquOzhI4WWcXf2wBr7mHnKuIENwNadQWgkOHEyUlkLdzuBUbaB1aGEtfB2CgdaD3J4ZxMvobgcZd1iAVkFiuHO2Q0TrjUO5Qke6qHtmCFgITxFdW91W8bYpmN44i6WQEq5EUaEPtp0WBZh+eR2XifAJHCwpIXyNG+AWwaHyMzi/JxJ2WmO0JRQigi81vafIAagKo4XyLoXC8tLv9Ce7QA9PBKHVI0uRQj7SkfRqRpfETOwtHldnH6my3+sG+7XWYomWLgxm7/xiRB9O10NYAkXrfxPW1AyoavE8jCPYcCFjW/r2vp4wGqBt3LvyAu1K5Ni3xs9k9DwcnrOESZGjcjgZOU5fn7+B1VezBUsmPfY/SO75m7OXr95evCIwVEgjYUezxWwRHkba+YaryU17D+r7XW27G8X+lNd33+Q93vm5kVyE8SrYu+1Ho+H9yBKW7h7ey4TV2nna3m4p9z5Y2XW0/FOLloavZcJW3AqeUfu+3rJCOPpcjC/rz9r55fv+8foCHn3DP4p5mFYUjSorLtvwjkzYLW72fjHoll0yDCwEK+6/jJcfXpKWnfyD2Zcmrihxmudo/JNnp8Pm+YdLlrCsf/834RcGZvmafpLg6whVBy7CKBbWtkxyVbW8orNRJY1YVKX357PbMJ/1H8ioR8nYH9yiFfSXbHpUYLuNs1/Xjefj1mclel6H0+SZZdd1/wbGM271",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},y=void 0,j={},u=[];function h(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,a.jsx)(l(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,a.jsx)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(p(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,a.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,a.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function W(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.5e9d7258.js b/assets/js/c195e1f1.5e9d7258.js new file mode 100644 index 000000000..13f07f82d --- /dev/null +++ b/assets/js/c195e1f1.5e9d7258.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,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":"eJztW1FvGzmS/ivcfklitCXZSWZnjVywniQ7Y2wwMRJng4VlaKjukpoJm+wl2ZI1hoB92H+wT/e6P21+yaGK7G62LFt2ZoDdu/NgMGOxyapisapY/Iq8Shyf2+ToPHmts7oE5WxykSY52MyIygmtkqPkrAD2ygB3wJpebGZ0yRyUlcTm49MTxqXUS8tWumZOszkoMPhJwZLlDW02XbHPtXWsMnohcqHmLY2JyJlQ1gHPmZ6xupKaUwdOJGZCwmOhmCuAzbQpsc+UW/jmGdOGTYXiZvWEwQLMijlRAsmhAHIUJvPC81aQATsLbC1SYwYq7JHLFast5MTNsowrNoUwOvdTri0YJpQDM+MZMO7Y+d7ea5jWc/bxZG/v4nHhXGWPhkNeVQNdgbJiriSf2kGmy2GOHat89gSFri3Nv1PuWaTOwViN1V91TUJ4bQHLYcZr6diCy5rUgEpnS5HPAXXLUXRNOhKGKV5C77utq0obx+Ayg8oxFIy72kDKrONllTKhhBNc2pSJks9hMFYHA7a3ByUXcm9vrH766aexuhorxsYJUh8nR2yc0Odxkvp2AzzXSq7w24xLC6E9iB4N+SNc8rKSgIoZJ2O1DgzG6hC5IoObmfq/7sPzs4Y+l6fI5bOesjPh5C2ssIvDLvfjl4Hu83uG/DJdVlytbuYWOtxTn16TrFo4Jl3e5/sc+ebc3TJF/Ho/jgcH+6Pn+4ejw+d9Zt8gMweXbqovb+YXOtyPZbliOK7P7/ek1AKyL7cybHrch+P5ONEUAfcPx8lFx3Qf1em7He3tscZHC74AphWgZ5faAHMFV9TgvdUV3FFAshiRpsAsSMgwrkxXjWOT039L62V0leulumXNQo/7KdHP6KCvxD8gR8Nzodm0dk7fwpV6/QYs9/ZODcyElOyTj06oyqapCVjcAAMJfucg/WGLUBYM6k0op6OYzqYwQ70Lx4RltuAGcrYUrmCcovaAvVNyRfG2HUKhXRtWcMsqMKWwVmAA1YznOXYtaUlwyQ3YSisLXlAfj5FWtLq20LXMcTORuDfgV7gU1mGYb4YP/OzfCutwC9uIzTSrRg+4Cge7/WmbO3le9JGr3MCSTaEX/g7vGhSuUWTjZPRsePB8eDg6fBaTfPrVrtjRPh8nJadIy8bJDPzfke89u6elhl5beTWsOuoUKWnru5ksfd6uafGX7969X47+/P1cHx8fH//44WPx5uP8+Pi4xN+DwSDwCqS/+Wo/j+fQKKmbRZImusLcS2h1kidHSchfgs2jRzQ5l8iTNKm44SU4MJgGXhHn5CiJ0rIkTQSmgRV3RbKZG+rpZ8jcCeVsTf6SpImBv9XCQJ4cOVNDmli3kkjWCtyokjSBy0rqHJIjHzcSmxVQ8uToKnGrino6I9Q8SRPM9riLW8J2hyL9cDAtssOimibr9YVnC9Z9p/MVksq0cqAc/smrSoqMlDL8bFH0q4hnJ+55gnkRKuMibUTxc0RVGdSsE2BJUEwK7ivxj1E67NOKayo9VszHTC5ZuzjMVpCJ2apJGWkopYD4S8FSrtpEtctyT2ZMl8I5yFM/KqzQL3//bxtILDHiTsHnvb2tKFmnrTK6WXJj+ApNwkEZt9+gJKO366jTyHGW6doprhwypNTwVqVSh5jAZw1xLolUvBHfxvWzBoyJ2LkqtNrR++DwKf779AD7h5j99TrZLV2I6BPi1+yy0ZCp1hK4iseQH63TZu+9nX7Ipab6Mlmv08aSNyJFFAImH7wdTJq5r+81jJjMtMzBYES6TTIyOlD5ZNMQuilvHk6FjdykfwoNTsOWBbgCDDUvuXKMqHeZGPqiZsHYBwwPvP2zlrCYtpoaxgl5Vbfza/zREyHqy7jKmdLsEfGb2JoM4tEw/J7qfPWoG+kzHi+zQD8OIlDn1ndtz2UH454VINvGixp22xTe1+Gr2jpdMmITBlFoaY+ILATWAXvFFRMqk3VIf2YaFY5RiV1dNSYwIctYr9nVFa4lmAma/Hqddg3Iq9dAXuhbDGQgFr1RbRN0A9u2aChcVsKsJpi7+IZwnooFEHMl1HxSm0BHaew86JnhhuCUIAYdQN5al5irLbNuwxit7521f03ZYd2RyP8bvb+oXv4gtojyYli9fFG9/ASs0BV4j/PqmQmVe39fgpQD9sI6o9X85YYKXgxD+/alNLAQsCR3pVXtqGzqtiU0CDL9VdexpwjLMlNngkukWxmdQXMO8Tv1pWPWQWUZt3hWIbXMBNAcDONzA3TiIVl47QptxM+UtzQMX3BWGJj916MNnT56ieGWFWDgxZC/DL1PZjRHOp5ytWI0caGVxYMqAWSz2lBwzCQ3YhaSpJRVErgFhjkUzxwJ7zXayHFWcPXFpi+m5uUZ8JK9q0ChBL/841/Yo4nkJ+qdycHcIZSfzJgFisSPMI49SpluTmwzYawLAdrHv2AhXq4bXCcAWnI1YG/agG/rqcVeqqHXBVRnxHwOeG4MPWhw6lcPeFb4rYKk4jOM9ci9QuPRtW3EQwND85eABubBuLBQA/Zdm2GlLNIOHVnjuQ+2RHXENc/0q0D6NV/FuYaqyymYazolLBQh0DCK5XxlkRvle/iBy6wm1NH7MEMfxl2NzLGx/jgBazm18h08x5Cn+FTCu7PTO6w0Tojtezf2ua5fA0+DvTs7ZQvojHHAPtp2nZqF570uLNM5sIXgfulTtixERi63YiUizqBovULUjlGAgccu2D67LlAu7FaJUp9oYPytSbRthFkuDGROrsiAdO0QVRAhs6cYMNiWwXklnOn6Lj6zQ5OczWuR00rXpt3Twdg0guARdjd15qNCXpvmjBGM1gcxazs9NVrBThH9lIGyfjhnM24dmJTVitByU1foDQ1JuKzACFAZbFVBFLp375+YrRHYrX1eVoGxWmF402bOVYieCIwvC20x7S+49F1DmLBsCigVend/P2oQ/F/+8a+kk+vGQ8p1wTwHnucGrN0hIYFI3pwQUUQcacWc7kuE9MD8cbO0gNKRSU5Knbdmau9uQacIfznbxsSAgbX4m62zAresNtbauGBAFQSb4pTwYEFVCF3hfFsErIG6xE3e9x5Qj1kkA1Vc0GfQotQqdp8OF9Qb5OhAIKxvjZP4rZaGlZ7dK4kgb8lXbSEGaYfqEyiMPDk7ff0nKhv5bGILAoiHzCiK+uHXzj68dnpioBTqbnvmB79p0CI63bp97XTJnchYQ8oOWOjq1e107MUle9yoCr1jIbR5slVdntxEqwwmQk2o3rZ7E/qRmtEaaPeZglsCqFi2ZtH81uqxGpRtWYBiPZ1EOyVOuiclbkOVB0+3ncKvr2lcXGvs028c+AXKKWIiHlZG16fA2JwTrx3rfzUu4L/ussVj9HLIvU1btn+tkDfYAUG1J3/E/uawe/kwjmFPpsI6qm53DWprsG9eVcDNAKMYwx3n64qjvbSkPWoPdiQh6zS53D2ZS5bpfW1yoZD4Ywkzx+qqwvxXGwXmiY86foL/OZMbjdZpcgdXW/2vnN5TnN1y9+w+idwVXd3k3yLrM5S12C3rDyDmhfs3C/stCuvzwt8SmPSwpK9D7MRZsXOmpTa390T4nWBC5az4eWtY6tzhcO3/6UDIJu7fDExOYmSSoBki0C9VRBMjlRyORvi//tK+7tUPMa2tM8yQZ7WUq98l6d0LD7evR1NcuW+RofgsDn++zBaHpw2GXxv59fvSbkx+G8S8ccUDJelLcbepBOeojdx3eh/nst/mekQ2Wm+hpFAwaRZwkuts0swe+5VgbX/Hu5MM7XLT6b+/1jvYJ95In22zogiZUY/obNhVvgMOhUkw5svNxSCEbLRrU5amC5eaEmyPMQnDsOpCI8nMfzN7BGO2e/Ft2jv1OJIFV1fdTDzhXRp8NhpNsk6Jz7coUS24FDndQDvTX0D9hu5343S7ycXsnWePol6WsounifCd6HvSm23c7idpIauNcCuqxV7u80rs++9H5xdY4SzBFRqrupW2JDEWZY+SYT/UDa+iWLdOkKxZNBVe8sLWsSxX+VRfXt95eCWGi4MBlqA2x2zdqW7pD/X+fYdYx+dCzXeNu+g09gFX1S9cT29d1KvEnwG9ISxL3CuUuAvgeOzChUBjed+Vk980S97WfbeXctuC6XlT+4wLnG1981rRspWqKUy2dcmo+BjVHuNKfVMrjEuFoazeVgN7JT+ypK4elyT9mpsv2W/UkH5dSaRfEXmA+f8PwfwbKL83nm1Q9cHzHkgcLDRGO5u7IDH614PgNhG4G9GwG8CwwMCDPmj2G3BL+L4d5XjeAxdiTwwBpvGv5lx9QAfSg9GITm5PR3TEeTai08O3o15e3vflJM6uKYVuM2hKk+MsGVPhCwxYQs10HJ6adaK9iaLltdMUyEz78gAue7SwNKZxCQ9OIoXf4eWld7VhlV6CmdWSrHcm4VIgWIODoKRvXQUeeCnBWrmiW9NzuhOei7lwiIEHNDjjFZ8KKXDj9df6vJN0e7cdsE9dDf+RocvcsACJ+3ULd6l5F5CX2nyZ4V2AlHE2xbvWCMCCKrjKPNbrtw3CLBHsQZS6MgJTFWdQauFl08oZ9IySKz4nn017qspBYgizzOgpFhqslrX3PMeF1MaXWWhCdP2TbgC+wetPxh8HsTRjoEALXgQ83aa+nmFpg8ApKASi6OI8z5zIgIDPWkmdffEFslpKVmnni1Z46oxlxOHOcGXp6ryv7IQ1aBUWUH6w4YriRwu4wm+F+oK3M/EW5HlrU59gaoWD7vC6XC6v7dNP+mO+F+6HesreQ6WtcNqsutFz4Yp6Snt7TKT94Sl937wpiHbujkauM7vl/KwzOyxAVsMP4NBC7PD49IQyxSfsl7//k70FbhQr9NJba1YbkKvu+QJqzq+8V1ub6Pnr97UrUOMZD5c8Kew2GvxUcEc3rTBTEN6FvCL39k7rqRRZ9wxhb++oeQbQXfSggkB4hRAutGKFi7PKj5ZCfRmwY7XyzxLa3QfbaVxvGrTjRU8xoucCLc/4YQTiwhbkwr+EwHPHFBjkwlc1ja7nnlssTJhc/24vzu04z1m1cb8XMehOHA+zUsGOe7zVDbZeCe7dle3fhQCVV1ooZ49YbvjMdfTTjUu/tPdda2ruCzfqSAOZdkm8J4YZt63+Es5G1tmPtQZmQOVU23sdwysRzOm8MUuG1vprzNrjLbSdR6d3TH+3Vo0cmNK+m30AsxBZc+S+waOH1HmYpIkUGQTwJ+xdx9+fvmWLp4NRkka5/B2ce/j25NWbHz+8QWEwkHqFHQxGgxFh1Nq6kquI09a3SNHl057mo1ugDw+ZHh4yPTxkenjI9PCQ6eEh08NDpoeHTA8Pmf7THzJFwMqwklyoqIrkke/zjSJfkiZH8dulizQpECk/Ok+urjCx+IgYGjb/rSZU5/wiTRbcCEShCMwJ12LyCEO9IZ18/D6UDp+wG55BbZW/gaMVYtHkdR6L+gKrjYdX6wssNXtMGkXzPV55AfbPkE5H4VqlA0F1P+I4w0Tp1r5xaeH03YezJE2a2+slvdNKDF8iLsWXXtoIvKK2q0RyNa8J+Eo8zbW/z1T0MfgvhMGHPyL0rK+PPjjvp4H/xUltHXB15fF9Apt9f//pxhFBsU1vXJyL9Xr9P16p0kI=","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(33617),a=n.n(o),l=n(17543),d=n.n(l),p=n(86013),c=n.n(p),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const x={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:"eJztW1FvGzmS/ivcfklitCXZSWZnjVywniQ7Y2wwMRJng4VlaKjukpoJm+wl2ZI1hoB92H+wT/e6P21+yaGK7G62LFt2ZoDdu/NgMGOxyapisapY/Iq8Shyf2+ToPHmts7oE5WxykSY52MyIygmtkqPkrAD2ygB3wJpebGZ0yRyUlcTm49MTxqXUS8tWumZOszkoMPhJwZLlDW02XbHPtXWsMnohcqHmLY2JyJlQ1gHPmZ6xupKaUwdOJGZCwmOhmCuAzbQpsc+UW/jmGdOGTYXiZvWEwQLMijlRAsmhAHIUJvPC81aQATsLbC1SYwYq7JHLFast5MTNsowrNoUwOvdTri0YJpQDM+MZMO7Y+d7ea5jWc/bxZG/v4nHhXGWPhkNeVQNdgbJiriSf2kGmy2GOHat89gSFri3Nv1PuWaTOwViN1V91TUJ4bQHLYcZr6diCy5rUgEpnS5HPAXXLUXRNOhKGKV5C77utq0obx+Ayg8oxFIy72kDKrONllTKhhBNc2pSJks9hMFYHA7a3ByUXcm9vrH766aexuhorxsYJUh8nR2yc0Odxkvp2AzzXSq7w24xLC6E9iB4N+SNc8rKSgIoZJ2O1DgzG6hC5IoObmfq/7sPzs4Y+l6fI5bOesjPh5C2ssIvDLvfjl4Hu83uG/DJdVlytbuYWOtxTn16TrFo4Jl3e5/sc+ebc3TJF/Ho/jgcH+6Pn+4ejw+d9Zt8gMweXbqovb+YXOtyPZbliOK7P7/ek1AKyL7cybHrch+P5ONEUAfcPx8lFx3Qf1em7He3tscZHC74AphWgZ5faAHMFV9TgvdUV3FFAshiRpsAsSMgwrkxXjWOT039L62V0leulumXNQo/7KdHP6KCvxD8gR8Nzodm0dk7fwpV6/QYs9/ZODcyElOyTj06oyqapCVjcAAMJfucg/WGLUBYM6k0op6OYzqYwQ70Lx4RltuAGcrYUrmCcovaAvVNyRfG2HUKhXRtWcMsqMKWwVmAA1YznOXYtaUlwyQ3YSisLXlAfj5FWtLq20LXMcTORuDfgV7gU1mGYb4YP/OzfCutwC9uIzTSrRg+4Cge7/WmbO3le9JGr3MCSTaEX/g7vGhSuUWTjZPRsePB8eDg6fBaTfPrVrtjRPh8nJadIy8bJDPzfke89u6elhl5beTWsOuoUKWnru5ksfd6uafGX7969X47+/P1cHx8fH//44WPx5uP8+Pi4xN+DwSDwCqS/+Wo/j+fQKKmbRZImusLcS2h1kidHSchfgs2jRzQ5l8iTNKm44SU4MJgGXhHn5CiJ0rIkTQSmgRV3RbKZG+rpZ8jcCeVsTf6SpImBv9XCQJ4cOVNDmli3kkjWCtyokjSBy0rqHJIjHzcSmxVQ8uToKnGrino6I9Q8SRPM9riLW8J2hyL9cDAtssOimibr9YVnC9Z9p/MVksq0cqAc/smrSoqMlDL8bFH0q4hnJ+55gnkRKuMibUTxc0RVGdSsE2BJUEwK7ivxj1E67NOKayo9VszHTC5ZuzjMVpCJ2apJGWkopYD4S8FSrtpEtctyT2ZMl8I5yFM/KqzQL3//bxtILDHiTsHnvb2tKFmnrTK6WXJj+ApNwkEZt9+gJKO366jTyHGW6doprhwypNTwVqVSh5jAZw1xLolUvBHfxvWzBoyJ2LkqtNrR++DwKf779AD7h5j99TrZLV2I6BPi1+yy0ZCp1hK4iseQH63TZu+9nX7Ipab6Mlmv08aSNyJFFAImH7wdTJq5r+81jJjMtMzBYES6TTIyOlD5ZNMQuilvHk6FjdykfwoNTsOWBbgCDDUvuXKMqHeZGPqiZsHYBwwPvP2zlrCYtpoaxgl5Vbfza/zREyHqy7jKmdLsEfGb2JoM4tEw/J7qfPWoG+kzHi+zQD8OIlDn1ndtz2UH454VINvGixp22xTe1+Gr2jpdMmITBlFoaY+ILATWAXvFFRMqk3VIf2YaFY5RiV1dNSYwIctYr9nVFa4lmAma/Hqddg3Iq9dAXuhbDGQgFr1RbRN0A9u2aChcVsKsJpi7+IZwnooFEHMl1HxSm0BHaew86JnhhuCUIAYdQN5al5irLbNuwxit7521f03ZYd2RyP8bvb+oXv4gtojyYli9fFG9/ASs0BV4j/PqmQmVe39fgpQD9sI6o9X85YYKXgxD+/alNLAQsCR3pVXtqGzqtiU0CDL9VdexpwjLMlNngkukWxmdQXMO8Tv1pWPWQWUZt3hWIbXMBNAcDONzA3TiIVl47QptxM+UtzQMX3BWGJj916MNnT56ieGWFWDgxZC/DL1PZjRHOp5ytWI0caGVxYMqAWSz2lBwzCQ3YhaSpJRVErgFhjkUzxwJ7zXayHFWcPXFpi+m5uUZ8JK9q0ChBL/841/Yo4nkJ+qdycHcIZSfzJgFisSPMI49SpluTmwzYawLAdrHv2AhXq4bXCcAWnI1YG/agG/rqcVeqqHXBVRnxHwOeG4MPWhw6lcPeFb4rYKk4jOM9ci9QuPRtW3EQwND85eABubBuLBQA/Zdm2GlLNIOHVnjuQ+2RHXENc/0q0D6NV/FuYaqyymYazolLBQh0DCK5XxlkRvle/iBy6wm1NH7MEMfxl2NzLGx/jgBazm18h08x5Cn+FTCu7PTO6w0Tojtezf2ua5fA0+DvTs7ZQvojHHAPtp2nZqF570uLNM5sIXgfulTtixERi63YiUizqBovULUjlGAgccu2D67LlAu7FaJUp9oYPytSbRthFkuDGROrsiAdO0QVRAhs6cYMNiWwXklnOn6Lj6zQ5OczWuR00rXpt3Twdg0guARdjd15qNCXpvmjBGM1gcxazs9NVrBThH9lIGyfjhnM24dmJTVitByU1foDQ1JuKzACFAZbFVBFLp375+YrRHYrX1eVoGxWmF402bOVYieCIwvC20x7S+49F1DmLBsCigVend/P2oQ/F/+8a+kk+vGQ8p1wTwHnucGrN0hIYFI3pwQUUQcacWc7kuE9MD8cbO0gNKRSU5Knbdmau9uQacIfznbxsSAgbX4m62zAresNtbauGBAFQSb4pTwYEFVCF3hfFsErIG6xE3e9x5Qj1kkA1Vc0GfQotQqdp8OF9Qb5OhAIKxvjZP4rZaGlZ7dK4kgb8lXbSEGaYfqEyiMPDk7ff0nKhv5bGILAoiHzCiK+uHXzj68dnpioBTqbnvmB79p0CI63bp97XTJnchYQ8oOWOjq1e107MUle9yoCr1jIbR5slVdntxEqwwmQk2o3rZ7E/qRmtEaaPeZglsCqFi2ZtH81uqxGpRtWYBiPZ1EOyVOuiclbkOVB0+3ncKvr2lcXGvs028c+AXKKWIiHlZG16fA2JwTrx3rfzUu4L/ussVj9HLIvU1btn+tkDfYAUG1J3/E/uawe/kwjmFPpsI6qm53DWprsG9eVcDNAKMYwx3n64qjvbSkPWoPdiQh6zS53D2ZS5bpfW1yoZD4Ywkzx+qqwvxXGwXmiY86foL/OZMbjdZpcgdXW/2vnN5TnN1y9+w+idwVXd3k3yLrM5S12C3rDyDmhfs3C/stCuvzwt8SmPSwpK9D7MRZsXOmpTa390T4nWBC5az4eWtY6tzhcO3/6UDIJu7fDExOYmSSoBki0C9VRBMjlRyORvi//tK+7tUPMa2tM8yQZ7WUq98l6d0LD7evR1NcuW+RofgsDn++zBaHpw2GXxv59fvSbkx+G8S8ccUDJelLcbepBOeojdx3eh/nst/mekQ2Wm+hpFAwaRZwkuts0swe+5VgbX/Hu5MM7XLT6b+/1jvYJ95In22zogiZUY/obNhVvgMOhUkw5svNxSCEbLRrU5amC5eaEmyPMQnDsOpCI8nMfzN7BGO2e/Ft2jv1OJIFV1fdTDzhXRp8NhpNsk6Jz7coUS24FDndQDvTX0D9hu5343S7ycXsnWePol6WsounifCd6HvSm23c7idpIauNcCuqxV7u80rs++9H5xdY4SzBFRqrupW2JDEWZY+SYT/UDa+iWLdOkKxZNBVe8sLWsSxX+VRfXt95eCWGi4MBlqA2x2zdqW7pD/X+fYdYx+dCzXeNu+g09gFX1S9cT29d1KvEnwG9ISxL3CuUuAvgeOzChUBjed+Vk980S97WfbeXctuC6XlT+4wLnG1981rRspWqKUy2dcmo+BjVHuNKfVMrjEuFoazeVgN7JT+ypK4elyT9mpsv2W/UkH5dSaRfEXmA+f8PwfwbKL83nm1Q9cHzHkgcLDRGO5u7IDH614PgNhG4G9GwG8CwwMCDPmj2G3BL+L4d5XjeAxdiTwwBpvGv5lx9QAfSg9GITm5PR3TEeTai08O3o15e3vflJM6uKYVuM2hKk+MsGVPhCwxYQs10HJ6adaK9iaLltdMUyEz78gAue7SwNKZxCQ9OIoXf4eWld7VhlV6CmdWSrHcm4VIgWIODoKRvXQUeeCnBWrmiW9NzuhOei7lwiIEHNDjjFZ8KKXDj9df6vJN0e7cdsE9dDf+RocvcsACJ+3ULd6l5F5CX2nyZ4V2AlHE2xbvWCMCCKrjKPNbrtw3CLBHsQZS6MgJTFWdQauFl08oZ9IySKz4nn017qspBYgizzOgpFhqslrX3PMeF1MaXWWhCdP2TbgC+wetPxh8HsTRjoEALXgQ83aa+nmFpg8ApKASi6OI8z5zIgIDPWkmdffEFslpKVmnni1Z46oxlxOHOcGXp6ryv7IQ1aBUWUH6w4YriRwu4wm+F+oK3M/EW5HlrU59gaoWD7vC6XC6v7dNP+mO+F+6HesreQ6WtcNqsutFz4Yp6Snt7TKT94Sl937wpiHbujkauM7vl/KwzOyxAVsMP4NBC7PD49IQyxSfsl7//k70FbhQr9NJba1YbkKvu+QJqzq+8V1ub6Pnr97UrUOMZD5c8Kew2GvxUcEc3rTBTEN6FvCL39k7rqRRZ9wxhb++oeQbQXfSggkB4hRAutGKFi7PKj5ZCfRmwY7XyzxLa3QfbaVxvGrTjRU8xoucCLc/4YQTiwhbkwr+EwHPHFBjkwlc1ja7nnlssTJhc/24vzu04z1m1cb8XMehOHA+zUsGOe7zVDbZeCe7dle3fhQCVV1ooZ49YbvjMdfTTjUu/tPdda2ruCzfqSAOZdkm8J4YZt63+Es5G1tmPtQZmQOVU23sdwysRzOm8MUuG1vprzNrjLbSdR6d3TH+3Vo0cmNK+m30AsxBZc+S+waOH1HmYpIkUGQTwJ+xdx9+fvmWLp4NRkka5/B2ce/j25NWbHz+8QWEwkHqFHQxGgxFh1Nq6kquI09a3SNHl057mo1ugDw+ZHh4yPTxkenjI9PCQ6eEh08NDpoeHTA8Pmf7THzJFwMqwklyoqIrkke/zjSJfkiZH8dulizQpECk/Ok+urjCx+IgYGjb/rSZU5/wiTRbcCEShCMwJ12LyCEO9IZ18/D6UDp+wG55BbZW/gaMVYtHkdR6L+gKrjYdX6wssNXtMGkXzPV55AfbPkE5H4VqlA0F1P+I4w0Tp1r5xaeH03YezJE2a2+slvdNKDF8iLsWXXtoIvKK2q0RyNa8J+Eo8zbW/z1T0MfgvhMGHPyL0rK+PPjjvp4H/xUltHXB15fF9Apt9f//pxhFBsU1vXJyL9Xr9P16p0kI=",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,f={},b=[];function y(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.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.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"7",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"8",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"9",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n"]}),"\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.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.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.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",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_template_id_body"}}},required:!0}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c195e1f1.9efeca49.js b/assets/js/c195e1f1.9efeca49.js deleted file mode 100644 index c7ea6a2a6..000000000 --- a/assets/js/c195e1f1.9efeca49.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6192],{19115:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>g,default:()=>j,frontMatter:()=>f,metadata:()=>r,toc:()=>y});const r=JSON.parse('{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/v1.1/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/createdocumentwithtemplateid","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztW19vGzmS/yq1/ZLEaEuyk8zNGblgPUl2YmwwMRLngoVlaKjukppJN9lLsiVrDAH7sN/gnu51P9p8kkMV2f9k2bIzA+zenQeDGYtNVhWLVcXir8iryIm5jY7Oo9c6qQpUzkYXcZSiTYwsndQqOorOMoRXBoVDqHvBzOgCHBZlTs3Hpycg8lwvLax0BU7DHBUa+qRwCWlNG6Yr+FJZB6XRC5lKNW9oTGQKUlmHIgU9g6rMteAOgknMZI6PpQKXIcy0KajPVFj87hloA1OphFk9AVygWYGTBbIcCjElYRIvvGgEGcBZYGuJGhgsqUear6CymDI3C4lQMMUwOvVTriwakMqhmYkEQTg439t7jdNqDp9O9vYuHmfOlfZoOBRlOdAlKivnKhdTO0h0MUypY5nOnpDQleX5t8o966hzMFZj9RddsRBeWwgpzkSVO1iIvGI1kNJhKdM5km4Fia5ZR9KAEgX2vtuqLLVxgJcJlg5IMOEqgzFYJ4oyBqmkkyK3MchCzHEwVgcD2NvDQsh8b2+sfv7557G6GiuAcUTUx9ERjCP+PI5i325QpFrlK/o2E7nF0B5E7wz5I16KosyRFDOOxmodGIzVIXElBjcz9X/dh+cXjX0uT4nLFz2FM+nyW1hRF0dd7scvQd3n94z4JboohVrdzC10uKc+vSahXDjIXdrn+5z4psLdMkX6ej+OBwf7o+f7h6PD531m3xEzh5duqi9v5hc63I9lsQIa1+f3b6zUDJOvtzKse9yH4/k40hwB9w/H0UXLdJ/U6bsd7e1B7aOZWCBoheTZhTYILhOKG7y3ukw4DkiWItIUwWKOCcWV6ap2bHb673m9jC5TvVS3rFnocT8l+hkd9JX478TRiFRqmFbO6Vu4cq/fgeXe3qnBmcxz+OyjE6mybqoDljAImKPfOVh/1CKVRUN6k8rpTkyHKc5I79KBtGAzYTCFpXQZCI7aA3iv8hXH22YIh3ZtIBMWSjSFtFZSANUg0pS6FrwktOQGbamVRS+oj8dEq7O6NtNVntJmktPeQF/xUlpHYb4ePvCzfyetoy1sIzbzrGo90Coc7Panbe7kefFHoVKDS5hiL/wd3jUoXKMI42j0bHjwfHg4OnzWJfn0m12xpX0+jgrBkRbG0Qz93x3fe3ZPSw29tvKqWbXUOVLy1nczWf68XdPyP394/2E5+vOPc318fHz808dP2ZtP8+Pj44J+DwaDwCuQ/u6b/bw7h1pJ7SyiONIl5V5Sq5M0OopC/hJsnjyizrlkGsVRKYwo0KGhNPCKOUdHUScti+JIUhpYCpdFm7mhnn7BxJ1wzlbnL1EcGfxrJQ2m0ZEzFcaRdaucyFpJG1UUR3hZ5jrF6MjHjcgmGRYiOrqK3Krkns5INY/iiLI94botYbsjkd4eTLPkMCun0Xp94dmidT/odEWkEq0cKkd/irLMZcJKGX6xJPpVh2cr7nlEeREp4yKuRfFzJFUZ0qyTaFlQSgruK/FPnXTYpxXXVHqswMdMkUOzOGBLTORsVaeMPJRTQPqlcJmvmkS1zXJPZqAL6RymsR8VVujXv/23DSSWFHGn6PPe3lYUreNGGe0shTFiRSbhsOi236Ako7frqNXIcZLoyimhHDHk1PBWpXKHLoEvGru5JFHxRnwb1y8aKSZS5zLTakfvg8On9O/TA+ofYva362S3dCGiT5hfvct2hky1zlGo7hj2o3Vc77230w+51FRfRut1XFvyRqTohIDJR28Hk3ru63sNYyYznadoKCLdJhkbHap0smkI7ZQ3D6fSdtykfwoNTgPLDF2GhpuXQjlg6m0mRr6oIRj7AOjA2z9rSUtpq6lwHLFXtTu/ph89ETp9QagUlIZHzG9iKzaIR8Pwe6rT1aN2pM94vMyS/DiIwJ0b37U9lx2Me1ZAbGsvqtltU3hfh68q63QBzCYM4tDSHBEhBNYBvBIKpEryKqQ/M00Kp6gEV1e1CUzYMtZruLqitUQzIZNfr+O2gXj1GtgLfYvBBOWiN6ppwnZg09YZipelNKsJ5S6+IZynugLIuZJqPqlMoKM0dR70zHBDcE4Qgw4wbaxLztWWWTdhjNf3ztq/puyw7kTk/43eX5Qv38otorwYli9flC8/I2S6RO9xXj0zqVLv70vM8wG8sM5oNX+5oYIXw9C+fSkNLiQu2V15VVsqm7ptCA2CTH/RVddTpIXEVIkUOdEtjU6wPof4nfrSgXVYWhCWziqslplEnoMBMTfIJx6WRVQu00b+wnlLzfCFgMzg7D8ebej00UsKt5ChwRdD8TL0PpnxHPl4KtQKeOJSK0sHVQbIZpXh4JjkwshZSJJiKHMUFoFyKJE4Ft5rtJbjLBPqq41fTM3LMxQFvC9RkQS//v0f1KOO5CfqvUnR3CGUn8zAIkfiRxTHHsWg6xPbTBrrQoD28S9YiJfrBtcJgFa+GsCbJuDbamqpl6rptQHVGTmfI50bQw8eHPvVQ5FkfqtgqcSMYj1xL8l4dGVr8cjAyPxzJAPzYFxYqAH80GRYMXS0w0fW7twHW6I64Zpn+lUg/VqsurmGqoopmms6ZSyUINAwClKxssSN8z36IPKkYtTR+zCQD9OuxuZYW383AWs4NfIdPKeQp8Q0x/dnp3dYaZoQ7Hs39rmuXwNPA96fncICW2McwCfbrFO98KLXBRKdIiyk8EsfwzKTCbvcCgpCnFHxeoWo3UUBBh67gH24LlAq7VaJYp9oUPytWLRthCGVBhOXr9iAdOUIVZAhs+cYMNiWwXklnOnqLj6zQ5MC5pVMeaUr0+zpaGzcgeAJdjdV4qNCWpn6jBGM1gcxa1s91VqhTh36MaCyfriAmbAOTQyVYrTcVCV5Q00SL0s0ElWCW1XQCd2790/K1hjs1j4vK9FYrSi8aTMXKkRPAsaXmbaU9mci911DmLAwRZKKvLu/H9UI/q9//0fUynXjIeW6YJ6DSFOD1u6QkEEkb06EKBKOtAKn+xIRPTR/3CwtkHRskpNCp42Z2rtb0CnBX842MTFgYA3+Zqskoy2ribW2WzDgCoKNaUp0sOAqhC5pvg0CVkNd8ibv+4Ckx6QjA1dcyGfIotSq6z4tLqg3yPGBQFrf2k3it1oaVXp2rySBvIVYNYUYoh2qT6go8qRw+vpPXDby2cQWBJAOmZ0o6odfO/uIyumJwUKqu+2ZH/2mwYvodOP2ldOFcDKBmpQdQOjq1e1014sLeFyrirxjIbV5slVdntxEqwQnUk243rZ7E/qJm8kaePeZolsiqq5s9aL5rdVjNSTbMkMFPZ10dkqadE9K2oZKD55uO4VfX9Nuca22T79x0BcspoSJeFiZXJ8DY31OvHas/824gP+6yxaPycsx9TZtYf9aIW+wA4JqTv6E/c1x9/JRHKOeoMI6qnZ3DWqrsW9RlijMgKIY0I7zbcXRXlrSHLUHO5KQdRxd7p7MJSR6X5tUKiL+OMeZg6osKf/VRqF54qOOn+C/zuRGo3Uc3cHVVv8rp/eUZrfcPbvPMnVZWzf5p8j6jGTNdsv6FuU8c/9kYb8nYX1e+HsCkx6W9HWInTgrdU50rs3tPQl+Z5hQOSt/2RqWWnc4XPt/WhCyjvs3A5OTLjLJ0AwT6JcqOhNjlRyORvS//tK+7tUPKa2tEsqQZ1Wer/4QxXcvPNy+HnVx5b5FhuyLPPzlMlkcntYYfmXyb9+XdmPy2yDmjSseJElfirtNJThHZfJ9p/dpLvtNrsdkO+stVS4VTuoFnKQ6mdSzp34FWtvf8e4kQ7PcfPrvr/UO9pE30mfbrKiDzKhHfDZsK98Bh6IkmPLl+mIQQTbaNSlL3UXkmhNsjzFJA1R14ZFs5r+bPaIx2734Nu2dehzJoqvKdiae8C4NPhuNJkmrxOdblKgWIpcp30A7019R/Y7ud+N028l12TvPnkS9LPI2nkbSd+LvUW+23XY/SYtJZaRbcS32cl+Uct9/Pzq/oApngS7TVNUttWWJqSh7FA37oW541Yl164jImkVd4WUvbBzLCpVO9eX1nUeUcrg4GFAJanPM1p3qlv5Y7d93iHViLtV817iLVmMfaVX9wvX01ka9Uv4ZyRvCsnR7hRJ3hoKOXbQQZCwf2nLym3rJm7rv9lJuUzA9r2uf3QJnU9+8VrRspKoLk01dslN87NQeu5X6ulbYLRWGsnpTDeyV/NiS2npcFPVrbr5kv1FD+m0lkX5F5AHm/z8E82+g/N54tkHVB897IHGw0C7aWd8F6aJ/PQhuE4G7EQ27AQwLDDzoQ2a/AbeE79tRjuc9cKHriSHA1P5Vn6sP+EB6MBrxye3piI84z0Z8evh+1MvL+74cdbNrTqGbDJrT5G6WTKnwBQUsqWa6G57qdeK9iaPltdMU5on25QFa9s7C8pjaJTw4SRT+QJeX3lcGSr1EM6tytt5ZjpeSwBoahAV/ayvwKIocrc1XfGt6znfCUzmXjjDwgAYnohRTmUvaeP21Pu8k7d5tB/C5reE/MnyZGxeY037dwF1q3gbkpTZfZ3QXIAYBU7prTQAsqkyoxGO9fttgzJLAHkKpSyMpVXGGpJZeNq2cIc8ohBJz9tm4p6oUcwphFoyeUqHB6rzynueEzLXxZRaeEF//5BuAb+j6k/HHQSrNGMzIghcBT7exr2dY3iBoCoqAKL44LxInE2Tgs1K5Tr76AlmV51Bq54tWdOrsykjDnRHK8tV5X9kJa9AoLKD8aMMVxU8WaYXfSfWVbmfSLcjzxqY+49RKh+3hdblcXtunn/TH/Cjd22oKH7DUVjptVu3ouXRZNeW9vUuk+eEp/Vi/Kejs3C2NVCd2y/lZJ3aYYV4OP6IjC7HD49MTzhSfwK9/+y94h8IoyPTSW2tSGcxX7fMF0pxfea+2JtHz1+8rl5HGExEueXLYbTRYci1NeucJOjytprlMmkT4CI6h7Ddtvjvg3cpfZ6X6loBcqq8DOFYr/xqh2XSonQfX7x3qba5zSZbRH+kG8FYvKa7FbcGBThaYSte7KQbSWcxnAxa9dz/3aPt9XcJMU3+P9ca7ueG+DXPm2zYrHisWQuYM+zYPPeoiG6q01FI5ewSpETPXPimJN27z8qZ2ram+CFxPKw5kmks13sU2VsIOgK/XbOST/ShqcIZcKLW9dy+ilMFQzmuDA7LD32KwHknhjbpzLqfEdms9yKEp7PvZRzQLmdSH6Rt8dcidh1Ec5TLBAOuEXen4x9N3sICng1EUd9L0O/jt8N3Jqzc/fXxD0lCM9Bo7GIwGI4aftXWFUB1WW58Zde6V9lTfueD58Ebp4Y3SwxulhzdKD2+UHt4oPbxRenij9PBG6V/9jVIHMxmWuZCqUyDyoPb5Rv0uiqOj7rOkizjKCAQ/Oo+uriix+ETwGDX/tWLA5vwijhbCSDpSME4TbrykHXj0hnTy8YdQFXwCN7xw2ip/jTQrgpnZ6zzM9BVXG2+q1hdURfZwM4nme7zyAuyfEZ2WwrUiBuHlfsRxQonSrX27VYPT9x/PojiqL6YX/AQrMmJJkJNYemk7uBS3XUW5UPOKMa3I01z7q0pZH17/yvB6+KMDjPX10cfd/TTovzSprQOurjx0zziy7+8/3TgiKLbuTYtzsV6v/wcx9sL7","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),s=n(28453),o=n(33617),a=n.n(o),l=n(17543),d=n.n(l),p=n(86013),c=n.n(p),m=n(63723),h=n.n(m),u=(n(18766),n(79329),n(9303));const f={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztW19vGzmS/yq1/ZLEaEuyk8zNGblgPUl2YmwwMRLngoVlaKjukppJN9lLsiVrDAH7sN/gnu51P9p8kkMV2f9k2bIzA+zenQeDGYtNVhWLVcXir8iryIm5jY7Oo9c6qQpUzkYXcZSiTYwsndQqOorOMoRXBoVDqHvBzOgCHBZlTs3Hpycg8lwvLax0BU7DHBUa+qRwCWlNG6Yr+FJZB6XRC5lKNW9oTGQKUlmHIgU9g6rMteAOgknMZI6PpQKXIcy0KajPVFj87hloA1OphFk9AVygWYGTBbIcCjElYRIvvGgEGcBZYGuJGhgsqUear6CymDI3C4lQMMUwOvVTriwakMqhmYkEQTg439t7jdNqDp9O9vYuHmfOlfZoOBRlOdAlKivnKhdTO0h0MUypY5nOnpDQleX5t8o966hzMFZj9RddsRBeWwgpzkSVO1iIvGI1kNJhKdM5km4Fia5ZR9KAEgX2vtuqLLVxgJcJlg5IMOEqgzFYJ4oyBqmkkyK3MchCzHEwVgcD2NvDQsh8b2+sfv7557G6GiuAcUTUx9ERjCP+PI5i325QpFrlK/o2E7nF0B5E7wz5I16KosyRFDOOxmodGIzVIXElBjcz9X/dh+cXjX0uT4nLFz2FM+nyW1hRF0dd7scvQd3n94z4JboohVrdzC10uKc+vSahXDjIXdrn+5z4psLdMkX6ej+OBwf7o+f7h6PD531m3xEzh5duqi9v5hc63I9lsQIa1+f3b6zUDJOvtzKse9yH4/k40hwB9w/H0UXLdJ/U6bsd7e1B7aOZWCBoheTZhTYILhOKG7y3ukw4DkiWItIUwWKOCcWV6ap2bHb673m9jC5TvVS3rFnocT8l+hkd9JX478TRiFRqmFbO6Vu4cq/fgeXe3qnBmcxz+OyjE6mybqoDljAImKPfOVh/1CKVRUN6k8rpTkyHKc5I79KBtGAzYTCFpXQZCI7aA3iv8hXH22YIh3ZtIBMWSjSFtFZSANUg0pS6FrwktOQGbamVRS+oj8dEq7O6NtNVntJmktPeQF/xUlpHYb4ePvCzfyetoy1sIzbzrGo90Coc7Panbe7kefFHoVKDS5hiL/wd3jUoXKMI42j0bHjwfHg4OnzWJfn0m12xpX0+jgrBkRbG0Qz93x3fe3ZPSw29tvKqWbXUOVLy1nczWf68XdPyP394/2E5+vOPc318fHz808dP2ZtP8+Pj44J+DwaDwCuQ/u6b/bw7h1pJ7SyiONIl5V5Sq5M0OopC/hJsnjyizrlkGsVRKYwo0KGhNPCKOUdHUScti+JIUhpYCpdFm7mhnn7BxJ1wzlbnL1EcGfxrJQ2m0ZEzFcaRdaucyFpJG1UUR3hZ5jrF6MjHjcgmGRYiOrqK3Krkns5INY/iiLI94botYbsjkd4eTLPkMCun0Xp94dmidT/odEWkEq0cKkd/irLMZcJKGX6xJPpVh2cr7nlEeREp4yKuRfFzJFUZ0qyTaFlQSgruK/FPnXTYpxXXVHqswMdMkUOzOGBLTORsVaeMPJRTQPqlcJmvmkS1zXJPZqAL6RymsR8VVujXv/23DSSWFHGn6PPe3lYUreNGGe0shTFiRSbhsOi236Ako7frqNXIcZLoyimhHDHk1PBWpXKHLoEvGru5JFHxRnwb1y8aKSZS5zLTakfvg8On9O/TA+ofYva362S3dCGiT5hfvct2hky1zlGo7hj2o3Vc77230w+51FRfRut1XFvyRqTohIDJR28Hk3ru63sNYyYznadoKCLdJhkbHap0smkI7ZQ3D6fSdtykfwoNTgPLDF2GhpuXQjlg6m0mRr6oIRj7AOjA2z9rSUtpq6lwHLFXtTu/ph89ETp9QagUlIZHzG9iKzaIR8Pwe6rT1aN2pM94vMyS/DiIwJ0b37U9lx2Me1ZAbGsvqtltU3hfh68q63QBzCYM4tDSHBEhBNYBvBIKpEryKqQ/M00Kp6gEV1e1CUzYMtZruLqitUQzIZNfr+O2gXj1GtgLfYvBBOWiN6ppwnZg09YZipelNKsJ5S6+IZynugLIuZJqPqlMoKM0dR70zHBDcE4Qgw4wbaxLztWWWTdhjNf3ztq/puyw7kTk/43eX5Qv38otorwYli9flC8/I2S6RO9xXj0zqVLv70vM8wG8sM5oNX+5oYIXw9C+fSkNLiQu2V15VVsqm7ptCA2CTH/RVddTpIXEVIkUOdEtjU6wPof4nfrSgXVYWhCWziqslplEnoMBMTfIJx6WRVQu00b+wnlLzfCFgMzg7D8ebej00UsKt5ChwRdD8TL0PpnxHPl4KtQKeOJSK0sHVQbIZpXh4JjkwshZSJJiKHMUFoFyKJE4Ft5rtJbjLBPqq41fTM3LMxQFvC9RkQS//v0f1KOO5CfqvUnR3CGUn8zAIkfiRxTHHsWg6xPbTBrrQoD28S9YiJfrBtcJgFa+GsCbJuDbamqpl6rptQHVGTmfI50bQw8eHPvVQ5FkfqtgqcSMYj1xL8l4dGVr8cjAyPxzJAPzYFxYqAH80GRYMXS0w0fW7twHW6I64Zpn+lUg/VqsurmGqoopmms6ZSyUINAwClKxssSN8z36IPKkYtTR+zCQD9OuxuZYW383AWs4NfIdPKeQp8Q0x/dnp3dYaZoQ7Hs39rmuXwNPA96fncICW2McwCfbrFO98KLXBRKdIiyk8EsfwzKTCbvcCgpCnFHxeoWo3UUBBh67gH24LlAq7VaJYp9oUPytWLRthCGVBhOXr9iAdOUIVZAhs+cYMNiWwXklnOnqLj6zQ5MC5pVMeaUr0+zpaGzcgeAJdjdV4qNCWpn6jBGM1gcxa1s91VqhTh36MaCyfriAmbAOTQyVYrTcVCV5Q00SL0s0ElWCW1XQCd2790/K1hjs1j4vK9FYrSi8aTMXKkRPAsaXmbaU9mci911DmLAwRZKKvLu/H9UI/q9//0fUynXjIeW6YJ6DSFOD1u6QkEEkb06EKBKOtAKn+xIRPTR/3CwtkHRskpNCp42Z2rtb0CnBX842MTFgYA3+Zqskoy2ribW2WzDgCoKNaUp0sOAqhC5pvg0CVkNd8ibv+4Ckx6QjA1dcyGfIotSq6z4tLqg3yPGBQFrf2k3it1oaVXp2rySBvIVYNYUYoh2qT6go8qRw+vpPXDby2cQWBJAOmZ0o6odfO/uIyumJwUKqu+2ZH/2mwYvodOP2ldOFcDKBmpQdQOjq1e1014sLeFyrirxjIbV5slVdntxEqwQnUk243rZ7E/qJm8kaePeZolsiqq5s9aL5rdVjNSTbMkMFPZ10dkqadE9K2oZKD55uO4VfX9Nuca22T79x0BcspoSJeFiZXJ8DY31OvHas/824gP+6yxaPycsx9TZtYf9aIW+wA4JqTv6E/c1x9/JRHKOeoMI6qnZ3DWqrsW9RlijMgKIY0I7zbcXRXlrSHLUHO5KQdRxd7p7MJSR6X5tUKiL+OMeZg6osKf/VRqF54qOOn+C/zuRGo3Uc3cHVVv8rp/eUZrfcPbvPMnVZWzf5p8j6jGTNdsv6FuU8c/9kYb8nYX1e+HsCkx6W9HWInTgrdU50rs3tPQl+Z5hQOSt/2RqWWnc4XPt/WhCyjvs3A5OTLjLJ0AwT6JcqOhNjlRyORvS//tK+7tUPKa2tEsqQZ1Wer/4QxXcvPNy+HnVx5b5FhuyLPPzlMlkcntYYfmXyb9+XdmPy2yDmjSseJElfirtNJThHZfJ9p/dpLvtNrsdkO+stVS4VTuoFnKQ6mdSzp34FWtvf8e4kQ7PcfPrvr/UO9pE30mfbrKiDzKhHfDZsK98Bh6IkmPLl+mIQQTbaNSlL3UXkmhNsjzFJA1R14ZFs5r+bPaIx2734Nu2dehzJoqvKdiae8C4NPhuNJkmrxOdblKgWIpcp30A7019R/Y7ud+N028l12TvPnkS9LPI2nkbSd+LvUW+23XY/SYtJZaRbcS32cl+Uct9/Pzq/oApngS7TVNUttWWJqSh7FA37oW541Yl164jImkVd4WUvbBzLCpVO9eX1nUeUcrg4GFAJanPM1p3qlv5Y7d93iHViLtV817iLVmMfaVX9wvX01ka9Uv4ZyRvCsnR7hRJ3hoKOXbQQZCwf2nLym3rJm7rv9lJuUzA9r2uf3QJnU9+8VrRspKoLk01dslN87NQeu5X6ulbYLRWGsnpTDeyV/NiS2npcFPVrbr5kv1FD+m0lkX5F5AHm/z8E82+g/N54tkHVB897IHGw0C7aWd8F6aJ/PQhuE4G7EQ27AQwLDDzoQ2a/AbeE79tRjuc9cKHriSHA1P5Vn6sP+EB6MBrxye3piI84z0Z8evh+1MvL+74cdbNrTqGbDJrT5G6WTKnwBQUsqWa6G57qdeK9iaPltdMU5on25QFa9s7C8pjaJTw4SRT+QJeX3lcGSr1EM6tytt5ZjpeSwBoahAV/ayvwKIocrc1XfGt6znfCUzmXjjDwgAYnohRTmUvaeP21Pu8k7d5tB/C5reE/MnyZGxeY037dwF1q3gbkpTZfZ3QXIAYBU7prTQAsqkyoxGO9fttgzJLAHkKpSyMpVXGGpJZeNq2cIc8ohBJz9tm4p6oUcwphFoyeUqHB6rzynueEzLXxZRaeEF//5BuAb+j6k/HHQSrNGMzIghcBT7exr2dY3iBoCoqAKL44LxInE2Tgs1K5Tr76AlmV51Bq54tWdOrsykjDnRHK8tV5X9kJa9AoLKD8aMMVxU8WaYXfSfWVbmfSLcjzxqY+49RKh+3hdblcXtunn/TH/Cjd22oKH7DUVjptVu3ouXRZNeW9vUuk+eEp/Vi/Kejs3C2NVCd2y/lZJ3aYYV4OP6IjC7HD49MTzhSfwK9/+y94h8IoyPTSW2tSGcxX7fMF0pxfea+2JtHz1+8rl5HGExEueXLYbTRYci1NeucJOjytprlMmkT4CI6h7Ddtvjvg3cpfZ6X6loBcqq8DOFYr/xqh2XSonQfX7x3qba5zSZbRH+kG8FYvKa7FbcGBThaYSte7KQbSWcxnAxa9dz/3aPt9XcJMU3+P9ca7ueG+DXPm2zYrHisWQuYM+zYPPeoiG6q01FI5ewSpETPXPimJN27z8qZ2ram+CFxPKw5kmks13sU2VsIOgK/XbOST/ShqcIZcKLW9dy+ilMFQzmuDA7LD32KwHknhjbpzLqfEdms9yKEp7PvZRzQLmdSH6Rt8dcidh1Ec5TLBAOuEXen4x9N3sICng1EUd9L0O/jt8N3Jqzc/fXxD0lCM9Bo7GIwGI4aftXWFUB1WW58Zde6V9lTfueD58Ebp4Y3SwxulhzdKD2+UHt4oPbxRenij9PBG6V/9jVIHMxmWuZCqUyDyoPb5Rv0uiqOj7rOkizjKCAQ/Oo+uriix+ETwGDX/tWLA5vwijhbCSDpSME4TbrykHXj0hnTy8YdQFXwCN7xw2ip/jTQrgpnZ6zzM9BVXG2+q1hdURfZwM4nme7zyAuyfEZ2WwrUiBuHlfsRxQonSrX27VYPT9x/PojiqL6YX/AQrMmJJkJNYemk7uBS3XUW5UPOKMa3I01z7q0pZH17/yvB6+KMDjPX10cfd/TTovzSprQOurjx0zziy7+8/3TgiKLbuTYtzsV6v/wcx9sL7",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,x={},y=[];function b(e){const t={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(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.ol,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"2",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"3",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"5",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"6",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"7",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"8",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.ol,{start:"9",children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them."]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"response:"})," Provide the value that should replace the existing response."]}),"\n"]}),"\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.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.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.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{title:{type:"string",format:"string",example:"New document title",description:"An optional parameter specifying the title for the newly created document. If omitted, the template\u2019s title will be used by default.\n"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"{{sender_name}} has requested you to sign {{document_title}}"},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}, {{note}}.",example:"

Hi {{receiver_name}},

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

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

Sign here

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

Thanks,
Team OpenSign\u2122

"},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",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_template_id_body"}}},required:!0}}),"\n",(0,i.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"If you haven't add widgets and signers in template or not provide signers along with their roles in body",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please setup template properly!"}},title:"inline_response_400_cc"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.13bfbdc1.js b/assets/js/c4fbe420.13bfbdc1.js new file mode 100644 index 000000000..1d2d8b362 --- /dev/null +++ b/assets/js/c4fbe420.13bfbdc1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/v1.1/drafttemplate.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/drafttemplate","permalink":"/docs/API-docs/v1.1/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztPNtyG7eSv4IztVWJuUOKpC6WtS+rOIojx5a0lnyVdBRwBuTAmgHGAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrTj2LvMQi4Nbo9Hd6G5091Vg6EgHW8fBEcvylBqmg9MwiJmOFM8NlyLYCo4SRnwz+VnRoeFiRLYPdgkTdJAyTQrNlCZGkkgx6BQV2siMf4RWYvzMIdFMXcBYqskgLViuuDCaDKUiIyaYojhxLKMiY9Aw5iYhuWIxG3LBYqKNKiJTKKY75GUuBdFFFDGth0VqV+ZSEDkktFwzJCZhCKpiplBCE0oKwT8UjLRacvCeRWY3brXIjzHTfCSoYTEA54ef8fhBSMYJjxISUUEGDLYaw04dwKwG7oBCmxS4ps5ZxIccOrvJOmQ7jjnASNN0EhJKWq1Cpa0W4ZrkSl7wmMV+NTkcAkopopZwYZga0oghrhjMIka4jJ+cUBGTIY14yk0TjSTm2ig+KGDlzok4EUc83yIv81TSmExkocjBz79U3Y0k8O241fqZDYoRebnbap3+mBiT662VFZrnHZkzAdhK6UB3IpmtxNAxj4eIK6YYzIr4YlTzdEJoHJMxj0fMaDwQQSKZT0gkpYq5sKSR0xEjosgGTOkQd5NJxQgXhBLFaDxpG9kuNCNPD/f3AA0ZNR1ykBY6LJeLuWKRSSd2ekCP39UP9nQ21oCGuBiFJKPngCVuyIeCR+ewbc0EHq0jGcRVq/Ua4C2xw7Wj8ZgQk3BNxmyQSHlO2AU0j3maEqP4aMRUq3Uifv/99xNxdSIIOQmwx0mwRU4CN8VJENomM8mZbfl5//HL5zt7R2dHbw92ynZPqVN9dn8uewx5Oj3DyxfPymZBs+nmve3n1QJCGtd+kDKqGVHsgrMxngMctd2rx0I5rCYn7OiyBQYxpeHrMXwh5Mr+04TmcPfJ3s6LOiy2B8soTxtddp5v7z5r9MkTKZrTHPy6v9ecp1C1WXb3nlik2PZr+OfUwetOZNsd0NHu853Do+3nB9D52p0jUMNhkedSwfG/tgS9Bcd8In5iqRwTqhhSTySzTAqSU0UzZlA2JtRgs2IfCq5YbIUbTVPPGVsnok1aLSCFrVaL7IqYR8Aals0nOQPJZvt2bFdgGeh66ESN7VpjJJBFVpwAh4yp5e48BUECXRUDKWX4BWtOfBmSCUz8MwO6sNMmUvGPUhiaIlFcMGV4RNM6EwOAKPoMVSiCcsmF8V/dCuStY1bgZWRRJ2UAtBiQlXGBLZqRC5oWTDuoxiFJAKoXLFdMo8R18wIiRUwSxkfJwvVo/L7QpjExKbSXox4Kt5Y/JUQvQ7QNaaoZ4cMGLjN6zmqrEZlb+d4hP01IzIa0SE1IOMgfowrWIXvSEJrnKY/wbgRxbi+eQrE2nrIjBwcIsAoAcWDvB7gRYg53A0gbaMQp3BgPHdCZvVBgeyhHTUIFkWLqoCOZSjVLQvi5iUcSSWGYMB2yfUF5isDbzWrCRZQWMSODlEbnId7sIVFwl8GpTFiaynFo6R274A2LOEf8EM1SoEIpAH4h3fJcV3dohxyB/Cn5CRo9qnERrutYdTJ8KGFlQIFnMYJyJUTEheS9HBDDTcpCYNiciklIYqs0sEszkJchiRIWneNfisZckkFhjBR2Y7GSeSzHwuFyKIXR/OMcjvQtn47RfkjWQrIRks2Q9Loh6fVD0lsLSW8jJL3NkPS7Ien3Q9JfC0l/w4LV33S4piWC6wD0+hbL5vvBLsjdZ1wjZ4PA1KUMHjdkcK9DWq2Sm6av3+qOLbuUtxXITGjrud+X8GO1/9D9nMDPjf6m+znGrr019zOBn/1e/Z7oIySGZvkNUEDzvULglQVLRPDN3bkngZdn8BEEUegbqqvYwQMN1/W9rMJeuOCG01Qv3o7v8Q3tqAJpZlNrsCkk18U7cjrIN7OdOjyosoCYtE0oVmtNnuERiv7M7tc77mZZvHm77Dez9xo4X7b1Ddg6iKYjEE2L919Kr28ICdMwfRkmHnZQAUDJvBgPrsM3hIUmRF+Gg03AAVxKixEArd/Q7mvgWAMMb3jb1l1r99bb/W5/rYEBsJRthyxrx3F7MpncB/ZA53HLg8rjNVSr2YFHYqhkNsf8QOug6uV0Ivzbq+zPQVEfsNIpAl6Apk/F2/91LdvImE5+0HYqP7RUzqB/pZpNamBiE8CBvpAokTxywEMfr5INwMDrAA7aiMmVOF6pYRI+xnE7y9pTH+FnGxFf+5hlnTjuTPWcOR37MSNxHJLZz3O/xzHJsmzBZ/u98Xkly2Z30ckyBxsqX4+ASZzOtphPXIevxSoVRzQXvpGNwI8kRYprozk3n4+mLpuEe7eNIyoy1UGxUZFSxS7BLtXTvpB75DHPYpVmj3YsmoDWGYioID/uO+39gSN/2EJzAvhy+7iZncEk2869SxQbsUuSU2OYEjjZBU15bN2wbeuqvKRZDibAyt9PTuJ//7cVdECAjW8InASJ+YiDV3Dl78fb7Xenc3oUec5UBD6plMFKOiTMRB1ynLA0rxyT4/G4M17VUSJlar2S77ViQ/v/Mzl4f4bg5h2q8wfzdmpJo2bwA+lM2/uamQbGqCZ+5ByTH2kMeajXxdvW2Ts3XLeuxzd040yBBI3We2J9e0FGUSEBUmbV39IkTJ0Ep+UYa+Sz+Jaxp3dg1oTHLKUDls423ZnRys8pncjC8bd3ajW36ii6hjdoyLgo/Ra4nW7N7ZjRy6nGk8rlOMXfFiF17vRXjmdPfwIk5dp7bprorI92ri10OApmHysGjPgBZFBS6RdzQQnY3djASiJ3drcsAf0Idizdin61W1ZoHEwdMTBHxgXPiqz0jw7LWT3KMqd71PEFI+Edxq9QP92ZFejlLSu4h6QFC5yIHvoxvP/jBs3U9fiGZMUUSDez8edIkcY9fU8X7O0M6LdVZ8A51zJ0tRdyyXx6Mfd1yD5cb+CTtYPAyxZFLDfgkftS1ixBvvMNhT6ruh9uMeXVe31D1DcHrD+ZAl2/+759PotI67v/jgi1AfadidU6JTM6usFyx+ZviDwdPDNOiFbrQLEhPBxXT4rEf/IvO/Ckw1KWuWcv95gIVx06wrkwEswC/0w9YEN8PccHa53Q6sHR3jP2SOsv5PZZWyqSUG31b1T44ajg+d4kLJtyxXvQKnc8Fx5uOJXe/dmN/Ufd+jn1NtYb57TebZxTd9E53WA2wgnqXApd+tpY1VTja1W+2s+9WqbZ1k8KR7oDQRyl9WCZQRZpTFJ+jq8qMdd5Sidwqp5LHZTTz3WPEyl11cO9mP3oNrzVfImTCh7jHnTKh4m7OLymDqN2Fr2Hq7WjWN/cbHJMg2HuYr9X682eQndtpbe+Yj1a8x1alRtmsRC+QRMg5C7nhX6iO50X9qwObOl2+ly30/2Q++p9Wt29h/3GZbHa/dzL4t6N6zrX3GJW34fxfG9WbJ3d7mi/fjU78supb+3P0Kh7D1frVPiwdw8u1AWK85dS4ox+fG+0R+5LOZ5HgHfQjm9Uib+YQOvA/ulEun4/mnSv29DQHjUUtEf9OlGur9+JKOuLTlHWScBf/bT/Ytz97clIbm9vb+8dvkx2Xo62t7cz+N3pdOYaUfNOG5cBzdXFh7p7Ge/4Bat0Oh1AYUwN3cLhK7kY/YcdHy4e03Gvz3+SZ2f9Ph5T5jhwvlwKlF3/Om/Nn8fnX8qBQRjIHEPfpdiNg60ghgB7H9YdhGhZMm1+kvEk2LoKXNQY/OlismDkynsNofpXgY4SllH4y1ukENwP0cFB6INygzDAMAKI9AeiC7ZcgHEQwhNXDn4IpmEOHLd15XvZ2OkgdDp4sBVYog/CwD30lJ8IE5GEp9s8HgbXfsGbpiq/VFNp/KOMcYd5ICD1M6fBoddTyQ2fNVN9husKrdVkVCk6CabzKHwkqn9GtOPKULt04u8GbsATUoZHYrcgDLhhWX2VBYem5KdjOmISdoIhRp86Fo+FZp+8JozDGO7PGeicD3Nwfkcs2dbZhZtHtg0xjiz2Smm7CtYNCQbMdW6jGN8fd0tH9TXtE8HMmkeLgrhrsaM6QUuU5jmjqoOx1J+dtIF5OzSNCswjKaViY2clqOXOetdhcHn7Zi5JJNs+Qpz8mLKhsS+6JJJKMPWgHibyzWyuv7Z2HQaT27c3+S639xAOb3z77l5jaH2VdvBXwLq6eR0Gye2w/loG//+FwK5tXFd3ncspKXPJBjKenHm5dX1bR3+pQD9ITNoV+ypmqoaIgZQpo2IGE7tD61yX5AcwOH4IbRwFxmxzpf2FYnOVFIsY5H9geJWXVcTpHDagm7g4WvDJ78AH1JJ0MdDQS/j5tJ1wwHz+EyTs2R7cJryhA5rRKIFMKxfdQYfeyZZDypEstAcP/NAQ65cycC2bhHGbKsHFqGkU1bCD3u763jv104EvcMlh0uL+0cEdcIkWW9tmP9l72u7SzkH2jw4gE4YPnRrWIS91iQmPWtroQkAtIhec+mj5UrZP7Nszs25H6fOuKhd9x+WgtMksQDHXcyEKIWLehumXSZozE1eJc3BEsjDg8neZikQblusGHhGKEpFHsrgLVd6CSUpGBYb6GWBZnxaD0T5VJgsXNgMU1f24UD55x5EF9IR00ApPHivQqTZ/SJjQdjglQ6oNUyGkhQLmVQHKfTklu8yZ4kxEbC4KFLOoOyvUXL2piYNmWsjLF89cuqTfg2fKAXCgnZjFpMiRapATynQlf3LTW59RlIA7mDpbpKDNqh6YVOQ8ETlTGlJqFZFqRAX/6FJsQSMBY2fAEprark5UgMca4AEObwLjZe0f//xXDa6FGucsYHYFGscQi3YLhGjRWYIHjVuxHCSgbEIE8zH1n9OXAECHTHOWybhkJH13Gj/A6DVdykX3hFY+3+kiSkDBL+WtDr2M1U6t1Ggioh2Jb3A57Jddcm1qCTc+LHZWPrxggMeoBgOqIcDVQPNiUmfw6llRTk2HaUG8maxVXoMzvEALI88Uy7i42z1Vd4oZWQqCwsiMGh4RP5XuNFPw7MuL5+sMcrctaECNF1yqBwtYFaY7kyJiZ1ycsQum7qDg7ZVhPDGdAHGbMWOiDptHkr3OqjSpMeQNN3BSu50wGbAO5TqYB/btdJ7tcrMh6emhSlRn2QDe8O0rMLAaCg5Z2ZJNY+h7sabcc+jSlvqOjI1et/t/2ZZa7X4/ttRa9zuypTYBWOc9vV0ALdJv5soO7w2+ecB7iU4b9OPe3BO8rNdh6bueh+CKHfrX9r/K/PNy/xaT0NqMlVvXmTN+M4iGfrcL/0wJQV8jxFeuqMqmpJO/BeHdfco3n4GvUnEzsn5K+r/qXGRRAjhboDdX3W8msbqvfIVNniaDJxHf5093X37c7e3xXb0rXqxHj3c3ds/zN68eP33UYZOnvaj/avKm/8q8fZ3q3feSR78+Td6JV3rweL14++adevtmV719/cLQ1+vbA5GIwZNfeDRZfz/od/mzx0+77173xoMnv3TfvXqUv8PJf+m+Oz/vRtne44HYhj752zf/xfff76w+/7jz8fnRzuXzj+mjDt378P7xZfTo+fnORvvdrmo/3x/89v6DyV+sx6t7b/jGJnvOXouj7rOoQQ1cpFywM3/UZ7jvMzhsS0lr8479UGbMJKgvYmkSJaHuSW7rexg1IXREuSCAOnWPVMCUuo1fPg2ymxCx1u2e9UokrM8iYVdgBD+WADqS50x83Z3Wlzd2eQD1MksroRVw2wnbg8Zm69/tJjWLCsXNJNg6vgou2zTnbdu+dXx6fRoGgFgJz0i51AgxNUmwFaxMvypBJSZ8szi+sjxYMpqmIoboiBlmozlfueh1esF1OD1mLnPe0J8V7U8dog0dcTG6bdxphaJDOEZ7Ug1EVTpuzn9joOS6c6j3CgMO5JMwCsYMYB6o40X1Frfjz9i/ks17+KrOcvopy79kNR6npu/hOc9NtdemY//Ug6835eNNUG0oKB9Y4M9SyT+uKLZ8nfAKdQ810f7aGqpsD3uo26xuotqwtnF9ahFcc0disGvdp2bjOhrOIfep6SwJginnRMNDMO0gWGisL7DV3ZJTNmkJyDxTcL1hgc3BltcgmriCyAfA1WoXcbXWRVxtdhvKi9thNUOlgqCeUaoZqEvUVQnQF06B/rgYSiReR1H7OROH4MkD2YLEP6NysjSSWVmwww/445//wjHezrceE5jhbxAQsl8okssxU1BVDauKpeySg0WLFd8ybNP4Tolh3DRLmdbweCkMG9mSaJDUB65D55yKaE4HUJkMXF8YqowxjzXZqzvkdcIgjACaflA2x/GCpSBvS59AvarZWKrzYSrHUCyMDKCQD3iFmEioiKwDykoBdKSARQzOvVxxDfWJFEDNLWxSGEUjQzIq6Ag9IWEDVTFLOYhKouQA/LNapoX1QBrKU6lshBpuCEMIMKpm5zKHJtSZwXWnWAJ0e+HckDq0bmDL4K7e2QA87jnAwiOG3phCpBJKk4HnvkhTkktjvemgmtdhhOFGUaFBn7aw+DMoEeY8hEy7MO6XmsEJP+Pi3BZQaZPjkqZes4HmhjXTK6d570FzzBNufi0GUJ5Jam6kmlSjR9wkxQBFdX2S8oed6YkvqVcTxNUcsYz0HA1QRnoFMkFXDpkBCtEr2we7eNM/IH/847/JM0aVIIkcW2qNCsXSSVW9DwvN4clbtJUXNfqgaQHV6gwSqRj5ZxFdVoaj5o9//I8me2wMvjhgIYvIVuugGKQ8Kssm6lZrizy2xRHLeojNdDAbpA8PA5TkdnTKxXmHbIuJrQKI7ydADPAdxzW2gW79BdUIqxqER7XVWaZZesHQRwoVgQYMawvic4uSxciuVgfGba6ZrwB7245jkk/lLICjrgLH+qLwnYNapxTU75uT5tDIJ2hWGmIixppieougQlPNH04lMuDTx8wnnwNRlYe009RKVAIm3Y7LrzZMZ0qJaMpaxYZMwYK6URyS5tyR07EnS9LMW/50srZGqTA0Qg3WX5A053Nd2VBRTe8PD6H0ZuQtqgUcvYKdV4IwSHnEnIXs7q7tJwfPyMVqpxuENdXsDsy98mz38c7e4Q4AA4LUIqzX6Xa66MiT2mRU1FbCEqMloU5fa7UQqGVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVlUrKsTLqsTPqV9r6sTLqsTLqsTLqsTLqsTLqsTLqsTLqsTLqsTPr17ttlZdJlZdJlZdJlZdJlZdLvqODjsjLp16DAZWXSZWXSZWXSZWXSZWXSZWXSZWXSZWXST3ZeLSuTLiuTLiuTLiuTLiuTLiuTLiuT/j+tTFpLfFvJU8pFLWXbZpYeT9UrPQ2DBDJPt46DqysgvJcqvb6Gzx8KzLI7Pg2DC6o4BGxh0mrokywh0+6cTYKt4LGNP2sfwfKhPWfMcJjK1YUsUTtiG7d+Y996cuzB/uFREAYDV1M1kzGm8dMxZObRsU1OrKXv4berIKViVGDqX2DnvLZlb5JmUuk5JpW6P2r5g1RMahA2s03tNuD/sKm5A66ubMLq9XXZ3zYtHOEQ63vD8Z1eX1//LxOiJQc=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var i=t(74848),r=t(28453),o=t(33617),l=t.n(o),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),u=(t(18766),t(79329),t(9303));const x={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyG7eSv4IztVWJuUOKpC6WtS+rOIojx5a0lnyVdBRwBuTAmgHGAEYUrVLVeTh/sE/7ej4tX7LVDWAuvEiyrTj2LvMQi4Nbo9Hd6G5091Vg6EgHW8fBEcvylBqmg9MwiJmOFM8NlyLYCo4SRnwz+VnRoeFiRLYPdgkTdJAyTQrNlCZGkkgx6BQV2siMf4RWYvzMIdFMXcBYqskgLViuuDCaDKUiIyaYojhxLKMiY9Aw5iYhuWIxG3LBYqKNKiJTKKY75GUuBdFFFDGth0VqV+ZSEDkktFwzJCZhCKpiplBCE0oKwT8UjLRacvCeRWY3brXIjzHTfCSoYTEA54ef8fhBSMYJjxISUUEGDLYaw04dwKwG7oBCmxS4ps5ZxIccOrvJOmQ7jjnASNN0EhJKWq1Cpa0W4ZrkSl7wmMV+NTkcAkopopZwYZga0oghrhjMIka4jJ+cUBGTIY14yk0TjSTm2ig+KGDlzok4EUc83yIv81TSmExkocjBz79U3Y0k8O241fqZDYoRebnbap3+mBiT662VFZrnHZkzAdhK6UB3IpmtxNAxj4eIK6YYzIr4YlTzdEJoHJMxj0fMaDwQQSKZT0gkpYq5sKSR0xEjosgGTOkQd5NJxQgXhBLFaDxpG9kuNCNPD/f3AA0ZNR1ykBY6LJeLuWKRSSd2ekCP39UP9nQ21oCGuBiFJKPngCVuyIeCR+ewbc0EHq0jGcRVq/Ua4C2xw7Wj8ZgQk3BNxmyQSHlO2AU0j3maEqP4aMRUq3Uifv/99xNxdSIIOQmwx0mwRU4CN8VJENomM8mZbfl5//HL5zt7R2dHbw92ynZPqVN9dn8uewx5Oj3DyxfPymZBs+nmve3n1QJCGtd+kDKqGVHsgrMxngMctd2rx0I5rCYn7OiyBQYxpeHrMXwh5Mr+04TmcPfJ3s6LOiy2B8soTxtddp5v7z5r9MkTKZrTHPy6v9ecp1C1WXb3nlik2PZr+OfUwetOZNsd0NHu853Do+3nB9D52p0jUMNhkedSwfG/tgS9Bcd8In5iqRwTqhhSTySzTAqSU0UzZlA2JtRgs2IfCq5YbIUbTVPPGVsnok1aLSCFrVaL7IqYR8Aals0nOQPJZvt2bFdgGeh66ESN7VpjJJBFVpwAh4yp5e48BUECXRUDKWX4BWtOfBmSCUz8MwO6sNMmUvGPUhiaIlFcMGV4RNM6EwOAKPoMVSiCcsmF8V/dCuStY1bgZWRRJ2UAtBiQlXGBLZqRC5oWTDuoxiFJAKoXLFdMo8R18wIiRUwSxkfJwvVo/L7QpjExKbSXox4Kt5Y/JUQvQ7QNaaoZ4cMGLjN6zmqrEZlb+d4hP01IzIa0SE1IOMgfowrWIXvSEJrnKY/wbgRxbi+eQrE2nrIjBwcIsAoAcWDvB7gRYg53A0gbaMQp3BgPHdCZvVBgeyhHTUIFkWLqoCOZSjVLQvi5iUcSSWGYMB2yfUF5isDbzWrCRZQWMSODlEbnId7sIVFwl8GpTFiaynFo6R274A2LOEf8EM1SoEIpAH4h3fJcV3dohxyB/Cn5CRo9qnERrutYdTJ8KGFlQIFnMYJyJUTEheS9HBDDTcpCYNiciklIYqs0sEszkJchiRIWneNfisZckkFhjBR2Y7GSeSzHwuFyKIXR/OMcjvQtn47RfkjWQrIRks2Q9Loh6fVD0lsLSW8jJL3NkPS7Ien3Q9JfC0l/w4LV33S4piWC6wD0+hbL5vvBLsjdZ1wjZ4PA1KUMHjdkcK9DWq2Sm6av3+qOLbuUtxXITGjrud+X8GO1/9D9nMDPjf6m+znGrr019zOBn/1e/Z7oIySGZvkNUEDzvULglQVLRPDN3bkngZdn8BEEUegbqqvYwQMN1/W9rMJeuOCG01Qv3o7v8Q3tqAJpZlNrsCkk18U7cjrIN7OdOjyosoCYtE0oVmtNnuERiv7M7tc77mZZvHm77Dez9xo4X7b1Ddg6iKYjEE2L919Kr28ICdMwfRkmHnZQAUDJvBgPrsM3hIUmRF+Gg03AAVxKixEArd/Q7mvgWAMMb3jb1l1r99bb/W5/rYEBsJRthyxrx3F7MpncB/ZA53HLg8rjNVSr2YFHYqhkNsf8QOug6uV0Ivzbq+zPQVEfsNIpAl6Apk/F2/91LdvImE5+0HYqP7RUzqB/pZpNamBiE8CBvpAokTxywEMfr5INwMDrAA7aiMmVOF6pYRI+xnE7y9pTH+FnGxFf+5hlnTjuTPWcOR37MSNxHJLZz3O/xzHJsmzBZ/u98Xkly2Z30ckyBxsqX4+ASZzOtphPXIevxSoVRzQXvpGNwI8kRYprozk3n4+mLpuEe7eNIyoy1UGxUZFSxS7BLtXTvpB75DHPYpVmj3YsmoDWGYioID/uO+39gSN/2EJzAvhy+7iZncEk2869SxQbsUuSU2OYEjjZBU15bN2wbeuqvKRZDibAyt9PTuJ//7cVdECAjW8InASJ+YiDV3Dl78fb7Xenc3oUec5UBD6plMFKOiTMRB1ynLA0rxyT4/G4M17VUSJlar2S77ViQ/v/Mzl4f4bg5h2q8wfzdmpJo2bwA+lM2/uamQbGqCZ+5ByTH2kMeajXxdvW2Ts3XLeuxzd040yBBI3We2J9e0FGUSEBUmbV39IkTJ0Ep+UYa+Sz+Jaxp3dg1oTHLKUDls423ZnRys8pncjC8bd3ajW36ii6hjdoyLgo/Ra4nW7N7ZjRy6nGk8rlOMXfFiF17vRXjmdPfwIk5dp7bprorI92ri10OApmHysGjPgBZFBS6RdzQQnY3djASiJ3drcsAf0Idizdin61W1ZoHEwdMTBHxgXPiqz0jw7LWT3KMqd71PEFI+Edxq9QP92ZFejlLSu4h6QFC5yIHvoxvP/jBs3U9fiGZMUUSDez8edIkcY9fU8X7O0M6LdVZ8A51zJ0tRdyyXx6Mfd1yD5cb+CTtYPAyxZFLDfgkftS1ixBvvMNhT6ruh9uMeXVe31D1DcHrD+ZAl2/+759PotI67v/jgi1AfadidU6JTM6usFyx+ZviDwdPDNOiFbrQLEhPBxXT4rEf/IvO/Ckw1KWuWcv95gIVx06wrkwEswC/0w9YEN8PccHa53Q6sHR3jP2SOsv5PZZWyqSUG31b1T44ajg+d4kLJtyxXvQKnc8Fx5uOJXe/dmN/Ufd+jn1NtYb57TebZxTd9E53WA2wgnqXApd+tpY1VTja1W+2s+9WqbZ1k8KR7oDQRyl9WCZQRZpTFJ+jq8qMdd5Sidwqp5LHZTTz3WPEyl11cO9mP3oNrzVfImTCh7jHnTKh4m7OLymDqN2Fr2Hq7WjWN/cbHJMg2HuYr9X682eQndtpbe+Yj1a8x1alRtmsRC+QRMg5C7nhX6iO50X9qwObOl2+ly30/2Q++p9Wt29h/3GZbHa/dzL4t6N6zrX3GJW34fxfG9WbJ3d7mi/fjU78supb+3P0Kh7D1frVPiwdw8u1AWK85dS4ox+fG+0R+5LOZ5HgHfQjm9Uib+YQOvA/ulEun4/mnSv29DQHjUUtEf9OlGur9+JKOuLTlHWScBf/bT/Ytz97clIbm9vb+8dvkx2Xo62t7cz+N3pdOYaUfNOG5cBzdXFh7p7Ge/4Bat0Oh1AYUwN3cLhK7kY/YcdHy4e03Gvz3+SZ2f9Ph5T5jhwvlwKlF3/Om/Nn8fnX8qBQRjIHEPfpdiNg60ghgB7H9YdhGhZMm1+kvEk2LoKXNQY/OlismDkynsNofpXgY4SllH4y1ukENwP0cFB6INygzDAMAKI9AeiC7ZcgHEQwhNXDn4IpmEOHLd15XvZ2OkgdDp4sBVYog/CwD30lJ8IE5GEp9s8HgbXfsGbpiq/VFNp/KOMcYd5ICD1M6fBoddTyQ2fNVN9husKrdVkVCk6CabzKHwkqn9GtOPKULt04u8GbsATUoZHYrcgDLhhWX2VBYem5KdjOmISdoIhRp86Fo+FZp+8JozDGO7PGeicD3Nwfkcs2dbZhZtHtg0xjiz2Smm7CtYNCQbMdW6jGN8fd0tH9TXtE8HMmkeLgrhrsaM6QUuU5jmjqoOx1J+dtIF5OzSNCswjKaViY2clqOXOetdhcHn7Zi5JJNs+Qpz8mLKhsS+6JJJKMPWgHibyzWyuv7Z2HQaT27c3+S639xAOb3z77l5jaH2VdvBXwLq6eR0Gye2w/loG//+FwK5tXFd3ncspKXPJBjKenHm5dX1bR3+pQD9ITNoV+ypmqoaIgZQpo2IGE7tD61yX5AcwOH4IbRwFxmxzpf2FYnOVFIsY5H9geJWXVcTpHDagm7g4WvDJ78AH1JJ0MdDQS/j5tJ1wwHz+EyTs2R7cJryhA5rRKIFMKxfdQYfeyZZDypEstAcP/NAQ65cycC2bhHGbKsHFqGkU1bCD3u763jv104EvcMlh0uL+0cEdcIkWW9tmP9l72u7SzkH2jw4gE4YPnRrWIS91iQmPWtroQkAtIhec+mj5UrZP7Nszs25H6fOuKhd9x+WgtMksQDHXcyEKIWLehumXSZozE1eJc3BEsjDg8neZikQblusGHhGKEpFHsrgLVd6CSUpGBYb6GWBZnxaD0T5VJgsXNgMU1f24UD55x5EF9IR00ApPHivQqTZ/SJjQdjglQ6oNUyGkhQLmVQHKfTklu8yZ4kxEbC4KFLOoOyvUXL2piYNmWsjLF89cuqTfg2fKAXCgnZjFpMiRapATynQlf3LTW59RlIA7mDpbpKDNqh6YVOQ8ETlTGlJqFZFqRAX/6FJsQSMBY2fAEprark5UgMca4AEObwLjZe0f//xXDa6FGucsYHYFGscQi3YLhGjRWYIHjVuxHCSgbEIE8zH1n9OXAECHTHOWybhkJH13Gj/A6DVdykX3hFY+3+kiSkDBL+WtDr2M1U6t1Ggioh2Jb3A57Jddcm1qCTc+LHZWPrxggMeoBgOqIcDVQPNiUmfw6llRTk2HaUG8maxVXoMzvEALI88Uy7i42z1Vd4oZWQqCwsiMGh4RP5XuNFPw7MuL5+sMcrctaECNF1yqBwtYFaY7kyJiZ1ycsQum7qDg7ZVhPDGdAHGbMWOiDptHkr3OqjSpMeQNN3BSu50wGbAO5TqYB/btdJ7tcrMh6emhSlRn2QDe8O0rMLAaCg5Z2ZJNY+h7sabcc+jSlvqOjI1et/t/2ZZa7X4/ttRa9zuypTYBWOc9vV0ALdJv5soO7w2+ecB7iU4b9OPe3BO8rNdh6bueh+CKHfrX9r/K/PNy/xaT0NqMlVvXmTN+M4iGfrcL/0wJQV8jxFeuqMqmpJO/BeHdfco3n4GvUnEzsn5K+r/qXGRRAjhboDdX3W8msbqvfIVNniaDJxHf5093X37c7e3xXb0rXqxHj3c3ds/zN68eP33UYZOnvaj/avKm/8q8fZ3q3feSR78+Td6JV3rweL14++adevtmV719/cLQ1+vbA5GIwZNfeDRZfz/od/mzx0+77173xoMnv3TfvXqUv8PJf+m+Oz/vRtne44HYhj752zf/xfff76w+/7jz8fnRzuXzj+mjDt378P7xZfTo+fnORvvdrmo/3x/89v6DyV+sx6t7b/jGJnvOXouj7rOoQQ1cpFywM3/UZ7jvMzhsS0lr8479UGbMJKgvYmkSJaHuSW7rexg1IXREuSCAOnWPVMCUuo1fPg2ymxCx1u2e9UokrM8iYVdgBD+WADqS50x83Z3Wlzd2eQD1MksroRVw2wnbg8Zm69/tJjWLCsXNJNg6vgou2zTnbdu+dXx6fRoGgFgJz0i51AgxNUmwFaxMvypBJSZ8szi+sjxYMpqmIoboiBlmozlfueh1esF1OD1mLnPe0J8V7U8dog0dcTG6bdxphaJDOEZ7Ug1EVTpuzn9joOS6c6j3CgMO5JMwCsYMYB6o40X1Frfjz9i/ks17+KrOcvopy79kNR6npu/hOc9NtdemY//Ug6835eNNUG0oKB9Y4M9SyT+uKLZ8nfAKdQ810f7aGqpsD3uo26xuotqwtnF9ahFcc0disGvdp2bjOhrOIfep6SwJginnRMNDMO0gWGisL7DV3ZJTNmkJyDxTcL1hgc3BltcgmriCyAfA1WoXcbXWRVxtdhvKi9thNUOlgqCeUaoZqEvUVQnQF06B/rgYSiReR1H7OROH4MkD2YLEP6NysjSSWVmwww/445//wjHezrceE5jhbxAQsl8okssxU1BVDauKpeySg0WLFd8ybNP4Tolh3DRLmdbweCkMG9mSaJDUB65D55yKaE4HUJkMXF8YqowxjzXZqzvkdcIgjACaflA2x/GCpSBvS59AvarZWKrzYSrHUCyMDKCQD3iFmEioiKwDykoBdKSARQzOvVxxDfWJFEDNLWxSGEUjQzIq6Ag9IWEDVTFLOYhKouQA/LNapoX1QBrKU6lshBpuCEMIMKpm5zKHJtSZwXWnWAJ0e+HckDq0bmDL4K7e2QA87jnAwiOG3phCpBJKk4HnvkhTkktjvemgmtdhhOFGUaFBn7aw+DMoEeY8hEy7MO6XmsEJP+Pi3BZQaZPjkqZes4HmhjXTK6d570FzzBNufi0GUJ5Jam6kmlSjR9wkxQBFdX2S8oed6YkvqVcTxNUcsYz0HA1QRnoFMkFXDpkBCtEr2we7eNM/IH/847/JM0aVIIkcW2qNCsXSSVW9DwvN4clbtJUXNfqgaQHV6gwSqRj5ZxFdVoaj5o9//I8me2wMvjhgIYvIVuugGKQ8Kssm6lZrizy2xRHLeojNdDAbpA8PA5TkdnTKxXmHbIuJrQKI7ydADPAdxzW2gW79BdUIqxqER7XVWaZZesHQRwoVgQYMawvic4uSxciuVgfGba6ZrwB7245jkk/lLICjrgLH+qLwnYNapxTU75uT5tDIJ2hWGmIixppieougQlPNH04lMuDTx8wnnwNRlYe009RKVAIm3Y7LrzZMZ0qJaMpaxYZMwYK6URyS5tyR07EnS9LMW/50srZGqTA0Qg3WX5A053Nd2VBRTe8PD6H0ZuQtqgUcvYKdV4IwSHnEnIXs7q7tJwfPyMVqpxuENdXsDsy98mz38c7e4Q4AA4LUIqzX6Xa66MiT2mRU1FbCEqMloU5fa7UQqGVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVl0mVlUrKsTLqsTPqV9r6sTLqsTLqsTLqsTLqsTLqsTLqsTLqsTLqsTPr17ttlZdJlZdJlZdJlZdJlZdLvqODjsjLp16DAZWXSZWXSZWXSZWXSZWXSZWXSZWXSZWXST3ZeLSuTLiuTLiuTLiuTLiuTLiuTLiuT/j+tTFpLfFvJU8pFLWXbZpYeT9UrPQ2DBDJPt46DqysgvJcqvb6Gzx8KzLI7Pg2DC6o4BGxh0mrokywh0+6cTYKt4LGNP2sfwfKhPWfMcJjK1YUsUTtiG7d+Y996cuzB/uFREAYDV1M1kzGm8dMxZObRsU1OrKXv4berIKViVGDqX2DnvLZlb5JmUuk5JpW6P2r5g1RMahA2s03tNuD/sKm5A66ubMLq9XXZ3zYtHOEQ63vD8Z1eX1//LxOiJQc=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,j={},f=[];function y(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,i.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/c4fbe420.663bc6a4.js b/assets/js/c4fbe420.663bc6a4.js deleted file mode 100644 index 7818d6d04..000000000 --- a/assets/js/c4fbe420.663bc6a4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3795],{7258:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>j});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":"eJztPNtyG7mOv8LTtVUz8bZkSb7E8b6sJ+NJnIkvGztX28eH6qbUtLvJDsm2rLhctQ/nD/YPzqfNl2wBJPuii+0knkyyq3mYWM0bCAIgAAK4Dgwd6mDzODhiWZ5Sw3RwGgYx05HiueFSBJvBUcKIbya/KjowXAzJ1sEOYYL2U6ZJoZnSxEgSKQadokIbmfFP0EqMnzkkmqlLGEs16acFyxUXRpOBVGTIBFMUJ45lVGQMGkbcJCRXLGYDLlhMtFFFZArFdJu8zqUguogipvWgSO3KXAoiB4SWa4bEJAxBVcwUSmhCSSH4x4KRpSXZP2eR2YmXlsjPMdN8KKhhMQDnh5/x+FFIRgmPEhJRQfoMthrDTh3ArAZun0KbFLimzlnEBxw6u8naZCuOOcBI03QcEkqWlgqVLi0Rrkmu5CWPWexXk4MBoJQiagkXhqkBjRjiisEsYojL+MkJFTEZ0Iin3DTRSGKujeL9AlZun4gTccTzTfI6TyWNyVgWihz8+lvV3UgC346Xln5l/WJIXu8sLZ3+nBiT683lZZrnbZkzAdhKaV+3I5ktx9AxjweIK6YYzIr4YlTzdExoHJMRj4fMaDwQQSKZj0kkpYq5sKSR0yEjosj6TOkQd5NJxQgXhBLFaDxuGdkqNCMvDvf3AA0ZNW1ykBY6LJeLuWKRScd2ekCP39VP9nTWV4GGuBiGJKMXgCVuyMeCRxewbc0EHq0jGcTV0tJbgLfEDteOxmNCTMI1GbF+IuUFYZfQPOJpSoziwyFTS0sn4h//+MeJuD4RhJwE2OMk2CQngZviJAhtkxnnzLb8uv/09e723tHZ0fuD7bLdU+pEn51fyx4Dnk7O8PrVy7JZ0GyyeW9rt1pASOPaD1JGNSOKXXI2wnOAo7Z79Vgoh9XkhB1dtsAgpjR8PYYvhFzbf5rQHO4829t+VYfF9mAZ5Wmjy/bu1s7LRp88kaI5zcHz/b3mPIWqzbKz98wixbbfwD+nDl53IlvugI52drcPj7Z2D6DzjTtHoIbDIs+lguN/awl6E475RPzCUjkiVDGknkhmmRQkp4pmzKBsTKjBZsU+Flyx2Ao3mqaeMzZPRIssLQEpbC4tkR0R8whYw7L5OGcg2Wzftu0KLANdD52osV1rjASyyIoT4JARtdydpyBIoKtiIKUMv2TNia9CMoaJf2VAF3baRCr+SQpDUySKS6YMj2haZ2IAEEWfoQpFUC65MP6rW4G8d8wKvIws6qQMgBYDsjIusEUzcknTgmkH1SgkCUD1iuWKaZS4bl5ApIhJwvgwmbsejc8LbRoTk0J7OeqhcGv5U0L0MkTbgKaaET5o4DKjF6y2GpG5le9t8suYxGxAi9SEhIP8MapgbbInDaF5nvII70YQ5/biKRRr4Sk7cnCAAKsAEAf2foAbIeZwN4C0gUacwo3x0AGd2QsFtody1CRUECkmDjqSqVTTJISfm3gkkRSGCdMmW5eUpwi83awmXERpETPST2l0EeLNHhIFdxmcypilqRyFlt6xC96wiHPED9EsBSqUAuAX0i3PdXWHtskRyJ+Sn6DRoxoX4bqOVSfDBxJWBhR4FiMoV0JEXEjOZZ8YblIWAsPmVIxDElulgV2ZvrwKSZSw6AL/UjTmkvQLY6SwG4uVzGM5Eg6XAymM5p9mcKRv+XyM9kKyGpL1kGyEpNsJSbcXku5qSLrrIeluhKTXCUmvF5Leakh66xas3obDNS0RXAeg27NYNj8OdkHuvuQaORsEpi5l8Kghg7ttsrRUctPk9VvdsWWX8rYCmQltXff7Cn6s9B67n2P4ud7bcD9H2LW76n4m8LPXrd8TPYTE0Cy/BQpoflAIvLJgiQi+uTv3JPDyDD6CIAp9Q3UVO3ig4aa+lxXYCxfccJrq+dvxPb6jHVUgTW1qFTaF5Dp/R04H+W62U4cHVRYQk7YJxWqtyTM8QtGb2v1a290s8zdvl/1u9l4D5+u2vg5bB9F0BKJp/v5L6fUdIWESpq/DxOM2KgAomefjwXX4jrDQhOjrcLABOIBLaT4CoPU72n0NHGuA4Q1v2zqrre5aq9fprTYwAJay7ZBlrThujcfjh8Ae6DxueVB5vIZqNTvwSAyUzGaYH2gdVL2cToR/e5V9FxT1PiudIuAFaPpUvP1f17KNjOn4J22n8kNL5Qz6V6rZuAYmNgEc6AuJEskjBzz08SpZHwy8NuCghZhcjuPlGibhYxy3sqw18RF+thDxtY9Z1o7j9kTPqdOxHzMSxyGZ/jzzexyTLMvmfLbfG5+Xs2x6F+0sc7Ch8vUEmMTpbPP5xHX4VqxScURz4VvZCPxIUqS4Nppzs/lo4rJJuHfbOKIiEx0UGxYpVewK7FI96Qt5QB7zLFZp9mjHoglonYGICvLzvtPeHznyhy00J4Avd4+b2hlMsuXcu0SxIbsiOTWGKYGTXdKUx9YN27Kuyiua5WACLP/95CT+939bRgcE2PiGwEmQmA85eAWX/3681fpwOqNHkedMReCTShmspEPCTNQmxwlL88oxORqN2qMVHSVSptYrea4VG9j/n8n++RmCm7epzh/N2qkljZrBD6Qzae9rZhoYo5r4kTNMfqQx5KFuB29bZ+/cct26Ht/RjTMBEjRa74n17QUZRYUESJlVf0uTMHUSnJZjrJHP4jvGnt6DWRMes5T2WTrddG9GKz+ndCwLx9/eqdXcqqPoGt6gIeOi9Fvgdjo1t2NGryYaTyqX4wR/W4TUudNfOZ49/QmQlGvvuWmisz7aubbQ4SiYfazoM+IHkH5JpV/NBSVg92MDK4nc2d2xBPQj2LF0K/rV7lihcTB1xMAcGRc8K7LSPzooZ/Uoy5zuUccXjIR3GL9C/XSnVqBXd6zgHpLmLHAiuujH8P6PWzRT1+M7khUTIN3Oxl8iRRr39ANdsHczoN9WnQFnXMvQ1V7IJfPp+dzXJvtwvYFP1g4CL1sUsdyAR+5rWbME+d43FPqs6n64+ZRX7/UdUd8MsP5kCnT9Hvr2+SIire/+ByLUBtj3JlbrlMzo8BbLHZu/I/J08Ew5IZaWDhQbwMNx9aRI/Cf/sgNPOixlmXv2co+JcNWhI5wLI8Es8M/UfTbA13N8sNYJrR4c7T1jj7T+Qm6ftaUiCdVW/0aFH44Knu9NwrIJV7wHrXLHc+HhhlPpPpzd2HvSqZ9Td32tcU5rncY5dead0y1mI5ygzqXQpa+NVU01vlblq/3Mq2WSbf2kcKTbEMRRWg+WGWSRxiTlF/iqEnOdp3QMp+q51EE5+Vz3NJFSVz3ci9nPbsObzZc4qeAx7lG7fJi4j8Nr4jBqZ9F9vFI7irWNjSbHNBjmPvZ7td70KXRWl7try9ajNduhVblh5gvhWzQBQu5zXugnutd5Yc/qwBZupy91Oz0Mua88pNXdfdxrXBYrnS+9LB7cuK5zzR1m9UMYzw9mxdbZ7Z726zezI7+e+lb/DI26+3ilToWPuw/gQp2jOH8tJU7pxw9Ge+ShlONZBHgP7fhWlfirCbQO7J9OpGsPo0l3Ow0N7UlDQXvSqxPl2tq9iLK+6ARlnQT8zS/7r0ad358N5dbW1tbe4etk+/Vwa2srg9/tdnumETXrtHEZ0FxdfKi7l/GOn7NKu90GFMbU0E0cvpyL4X/Y8eH8MW33+vwneXbWHuIxZYYD5+ulQNn1r/PW/Hl8/rUcGISBzDH0XYqdONgMYgiw92HdQYiWJdPmFxmPg83rwEWNwZ8uJgtGLp9rCNW/DnSUsIzCX94iheB+iA4OQh+UG4QBhhFApD8QXbDpAoyDEJ64cvBDMA1z4LjNa9/Lxk4HodPBg83AEn0QBu6hp/xEmIgkPN3m8SC48QveNlX5pZpK4x9ljDvMAwGpXzgNDr2ZSG74opnqM9xUaK0mo0rRcTCZR+EjUf0zoh1XhtqlY383cAOekDI8ErsFYcANy+qrzDk0JT8f0xGTsBMMMfrcsXgsNPvsNWEcxnB/yUDnfJiB83tiybZOL9w8si2IcWSxV0pbVbBuSDBgrn0Xxfj+uFs6rK9pnwim1jyaF8Rdix3VCVqiNM8ZVW2Mpf7ipA3M26FpVGAeSSkVGzsrQS131r0Jg6u7N3NFItnyEeLk55QNjH3RJZFUgqlH9TCR72ZzvdXVmzAY37298Q+5vcdweKO7d/cWQ+urtIO/AtaVjZswSO6G9XkZ/P8XAru6flPddS6npMwl68t4fObl1s1dHf2lAv0gMWlH7KuYqRoi+lKmjIopTOwMrHNdkp/A4PgptHEUGLPNlfYXis1VUixikP+B4VVeVhGnc9iAbuLiaMEnvw0fUEvSRV9DL+Hn03bCPvP5T5CwZ3twm/CGDmhGowQyrVx0Bx14J1sOKUey0B488ENDrF/KwLVsEsZtqgQXw6ZRVMMOervre2/XTwe+wCWHSYv7Rwf3wCVabC2b/WTvabtLOwfZPzqATBg+cGpYm7zWJSY8ammjCwG1iFxy6qPlS9k+tm/PzLodpc+7qlz0bZeD0iLTAMVcz4QohIh5G6ZfJmlOTVwlzsERycKAy99lKhJtWK4beEQoSkQeyeI+VHkHJikZFhjqZ4BlfVoMRvtUmSxc2AxQVPfjQvnkHUcW0BPSQSs8eaxAp9r8IWFC2+GUDKg2TIWQFgqYVwUo9+WU7CpnijMRsZkoUMyi7qxQM/WmJg6aaSGvX7106ZJ+D54p+8CBdmIWkyJHqkFOKNOV/MlNbn1KUQLuYOpsnoI2rXpgUpHzRORMaUipVUSqIRX8k0uxBY0EjJ0+S2hquzpRAR5rgAc4vAmMl7V//PNfNbjmapzTgNkVaBxDLNodEKJFZwkeNG7FcpCAsgkRzMfUf05eAgAdMs1ZJuOSkfT9afwAo9d0KRfdE1r5fKeLKAEFv5S3OvQyVju1UqOJiHYkvsHlsF92xbWpJdz4sNhp+fCKAR6jGgyohgBXA82LcZ3Bq2dFOTEdpgXxZrJWeQ1O8QItjDxTLOPifvdU3SlmZCkICiMzanhE/FS63UzBsy8vnq8zyN22oAE1XnKpHs1hVZjuTIqInXFxxi6ZuoeCt1eG8cR0DMRtRoyJOmweSfY6q9KkRpA33MBJ7XbCZMA6lGtgHti301m2y+2GpKeHKlGdZX14w7evwMBqKDhkZUs2jaEfxZpyz6ELW+oHMja6nc7/ZVtqpfPj2FKrnR/IltoAYJ339G4BNE+/mSk7vDf49gHnEp026Me9vSd4WW/C0nc9C8EVO/Ru7H+V+efl/h0mobUZK7euM2f8ZhANvU4H/pkQgr5GiK9cUZVNScd/C8L7+5RvPwNfpeJ2ZP2S9J7rXGRRAjibozdX3W8nsbqvfJmNXyT9ZxHf5y92Xn/a6e7xHb0jXq1FT3fWdy7yd2+evnjSZuMX3aj3Zvyu98a8f5vqnXPJo+cvkg/ije4/XSvev/ug3r/bUe/fvjL07dpWXySi/+w3Ho3Xzvu9Dn/59EXnw9vuqP/st86HN0/yDzj5b50PFxedKNt72hdb0Cd//+6/+P759srup+1Pu0fbV7uf0idtuvfx/OlV9GT3Ynu99WFHtXb3+7+ffzT5q7V4Ze8dX99gu+ytOOq8jBrUwEXKBTvzR32G+z6Dw7aUtDrr2A9lxkyC+iKWJlES6p7ktr6HUWNCh5QLAqhTD0gFTKm7+OXzILsNEaudzlm3RMLaNBJ2BEbwYwmgI3nBxLfdaX15Y5cHUK+ytBJaAbedsD1obLb+3W5Ss6hQ3IyDzePr4KpFc96y7ZvHpzenYQCIlfCMlEuNEFOTBJvB8uSrElRiwjeL42vLgyWjaSpiiI6YYjaa8+XLbrsb3ISTY2Yy5y39WdH63CHa0CEXw7vGnVYoOoRjtCfVQFSl4+b8dwZKrjuHeq8w4EA+CaNgzADmgTpeVW9x2/6M/SvZrIev6iwnn7L8S1bjcWryHp7x3FR7bTr2Tz34elM+3gTVhoLygQX+LJX844piy9cJr1B3URPtra6iyva4i7rNygaqDavrN6cWwTV3JAa71n1qNq6j4Rxyn5rOkiCYcE40PASTDoK5xvocW90tOWGTloDMMgXXGhbYDGx5DaKJK4h8AFytdBBXqx3E1Uanoby4HVYzVCoI6hmlmoG6RF2VAH3hFOiPi4FE4nUUtZ8zcQiePJAtSPxTKidLI5mVBTv8gD/++S8c4+186zGBGf4GASH7hSK5HDEFVdWwqljKrjhYtFjxLcM2je+UGMZNs5RpDY+XwrChLYkGSX3gOnTOqYjmtA+VycD1haHKGPNYk726Td4mDMIIoOknZXMcL1kK8rb0CdSrmo2kuhikcgTFwkgfCvmAV4iJhIrIOqCsFEBHCljE4NzLFddQn0gB1NzCJoVRNDIko4IO0RMSNlAVs5SDqCRK9sE/q2VaWA+koTyVykao4YYwhACjaravcmhCnRlcd4olQLeXzg2pQ+sGtgzu6p31weOeAyw8YuiNKUQqoTQZeO6LNCW5NNabDqp5HUYYbhQVGvRpC4s/gxJhzkPItAvjfq0ZnPBLLi5sAZUWOS5p6i3ra25YM71ykvceNcc84+Z50YfyTFJzI9W4Gj3kJin6KKrrk5Q/7EzPfEm9miCu5ohlpGdogDLSy5AJunzIDFCIXt462MGb/hH547//h7xkVAmSyJGl1qhQLB1X1fuw0ByevEVbeVGjD5oWUK3OIJGKoX8WKTGYYyQvt8zjcHhQ9FMelYJ+k2yRvPnJJ4B5bRxrrNkQfXgWoCTl4qJNtsTYFv/DZxOgAfiOg12VxbI4Wy3wH01kbtrkuRyBXAsrLyjU/IHSgc26gdxolg4wmKWZc7A5OwcBHEsuJX9uvoErI4grg4OMjXEsLescOcdlVUKIiRiLhelNgppKVVUxnMhQwDeNqU8+uaGq+2inqdWeBGxNnIRuEwzAmVAPmlJUsQFTsKJulH2kOXeEcuwJjjQzkj+fYK25KQyNUDf1Vx/N+UwnNdRK0/uDQyiqGXlbaQ6vLmPn5SAMUh4xZ/u6W2nr2cFLcklW2p0grGld9+Db5Zc7T7f3DrcBGpCRFmPddqfdQR+d1CajorYUVg8ti4lO3li16KZF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0VGyKDq6KDr6jfa+KDq6KDq6KDq6KDq6KDq6KDq6KDq6KDq6KDr67e7bRdHRRdHRRdHRRdHRRdHRH6iW46Lo6LegwEXR0UXR0UXR0UXR0UXR0UXR0UXR0UXR0c92Xi2Kji6Kji6Kji6Kji6Kji6Kji6Kjv4/LTpay2lbzlPKRS0b2yaNHk+UIj0NgwSSSjePg+trILzXKr25gc8fC0ygOz4Ng0uqOARsYT5q6PMnIYnugo2DzeCpjT9rHcHyoT1nTHGYSMOFBFA7Ygu3fmvfet7rwf7hURAGfVcuNZMxZujTESTd0ZHNO6xl5uG36yClYlhgVl9g57yxFW2SZr7oBeaLuj9qqYFUjGsQNhNJ7Tbg/7CpmQOur20u6s1N2d82zR3hEOt7w/Gd3tzc/C+ZkBXA","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/v1.1/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/v1.1/createtemplate"}}');var s=t(74848),r=t(28453),l=t(33617),o=t.n(l),d=t(17543),a=t.n(d),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const x={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztPNtyG7mOv8LTtVUz8bZkSb7E8b6sJ+NJnIkvGztX28eH6qbUtLvJDsm2rLhctQ/nD/YPzqfNl2wBJPuii+0knkyyq3mYWM0bCAIgAAK4Dgwd6mDzODhiWZ5Sw3RwGgYx05HiueFSBJvBUcKIbya/KjowXAzJ1sEOYYL2U6ZJoZnSxEgSKQadokIbmfFP0EqMnzkkmqlLGEs16acFyxUXRpOBVGTIBFMUJ45lVGQMGkbcJCRXLGYDLlhMtFFFZArFdJu8zqUguogipvWgSO3KXAoiB4SWa4bEJAxBVcwUSmhCSSH4x4KRpSXZP2eR2YmXlsjPMdN8KKhhMQDnh5/x+FFIRgmPEhJRQfoMthrDTh3ArAZun0KbFLimzlnEBxw6u8naZCuOOcBI03QcEkqWlgqVLi0Rrkmu5CWPWexXk4MBoJQiagkXhqkBjRjiisEsYojL+MkJFTEZ0Iin3DTRSGKujeL9AlZun4gTccTzTfI6TyWNyVgWihz8+lvV3UgC346Xln5l/WJIXu8sLZ3+nBiT683lZZrnbZkzAdhKaV+3I5ktx9AxjweIK6YYzIr4YlTzdExoHJMRj4fMaDwQQSKZj0kkpYq5sKSR0yEjosj6TOkQd5NJxQgXhBLFaDxuGdkqNCMvDvf3AA0ZNW1ykBY6LJeLuWKRScd2ekCP39VP9nTWV4GGuBiGJKMXgCVuyMeCRxewbc0EHq0jGcTV0tJbgLfEDteOxmNCTMI1GbF+IuUFYZfQPOJpSoziwyFTS0sn4h//+MeJuD4RhJwE2OMk2CQngZviJAhtkxnnzLb8uv/09e723tHZ0fuD7bLdU+pEn51fyx4Dnk7O8PrVy7JZ0GyyeW9rt1pASOPaD1JGNSOKXXI2wnOAo7Z79Vgoh9XkhB1dtsAgpjR8PYYvhFzbf5rQHO4829t+VYfF9mAZ5Wmjy/bu1s7LRp88kaI5zcHz/b3mPIWqzbKz98wixbbfwD+nDl53IlvugI52drcPj7Z2D6DzjTtHoIbDIs+lguN/awl6E475RPzCUjkiVDGknkhmmRQkp4pmzKBsTKjBZsU+Flyx2Ao3mqaeMzZPRIssLQEpbC4tkR0R8whYw7L5OGcg2Wzftu0KLANdD52osV1rjASyyIoT4JARtdydpyBIoKtiIKUMv2TNia9CMoaJf2VAF3baRCr+SQpDUySKS6YMj2haZ2IAEEWfoQpFUC65MP6rW4G8d8wKvIws6qQMgBYDsjIusEUzcknTgmkH1SgkCUD1iuWKaZS4bl5ApIhJwvgwmbsejc8LbRoTk0J7OeqhcGv5U0L0MkTbgKaaET5o4DKjF6y2GpG5le9t8suYxGxAi9SEhIP8MapgbbInDaF5nvII70YQ5/biKRRr4Sk7cnCAAKsAEAf2foAbIeZwN4C0gUacwo3x0AGd2QsFtody1CRUECkmDjqSqVTTJISfm3gkkRSGCdMmW5eUpwi83awmXERpETPST2l0EeLNHhIFdxmcypilqRyFlt6xC96wiHPED9EsBSqUAuAX0i3PdXWHtskRyJ+Sn6DRoxoX4bqOVSfDBxJWBhR4FiMoV0JEXEjOZZ8YblIWAsPmVIxDElulgV2ZvrwKSZSw6AL/UjTmkvQLY6SwG4uVzGM5Eg6XAymM5p9mcKRv+XyM9kKyGpL1kGyEpNsJSbcXku5qSLrrIeluhKTXCUmvF5Leakh66xas3obDNS0RXAeg27NYNj8OdkHuvuQaORsEpi5l8Kghg7ttsrRUctPk9VvdsWWX8rYCmQltXff7Cn6s9B67n2P4ud7bcD9H2LW76n4m8LPXrd8TPYTE0Cy/BQpoflAIvLJgiQi+uTv3JPDyDD6CIAp9Q3UVO3ig4aa+lxXYCxfccJrq+dvxPb6jHVUgTW1qFTaF5Dp/R04H+W62U4cHVRYQk7YJxWqtyTM8QtGb2v1a290s8zdvl/1u9l4D5+u2vg5bB9F0BKJp/v5L6fUdIWESpq/DxOM2KgAomefjwXX4jrDQhOjrcLABOIBLaT4CoPU72n0NHGuA4Q1v2zqrre5aq9fprTYwAJay7ZBlrThujcfjh8Ae6DxueVB5vIZqNTvwSAyUzGaYH2gdVL2cToR/e5V9FxT1PiudIuAFaPpUvP1f17KNjOn4J22n8kNL5Qz6V6rZuAYmNgEc6AuJEskjBzz08SpZHwy8NuCghZhcjuPlGibhYxy3sqw18RF+thDxtY9Z1o7j9kTPqdOxHzMSxyGZ/jzzexyTLMvmfLbfG5+Xs2x6F+0sc7Ch8vUEmMTpbPP5xHX4VqxScURz4VvZCPxIUqS4Nppzs/lo4rJJuHfbOKIiEx0UGxYpVewK7FI96Qt5QB7zLFZp9mjHoglonYGICvLzvtPeHznyhy00J4Avd4+b2hlMsuXcu0SxIbsiOTWGKYGTXdKUx9YN27Kuyiua5WACLP/95CT+939bRgcE2PiGwEmQmA85eAWX/3681fpwOqNHkedMReCTShmspEPCTNQmxwlL88oxORqN2qMVHSVSptYrea4VG9j/n8n++RmCm7epzh/N2qkljZrBD6Qzae9rZhoYo5r4kTNMfqQx5KFuB29bZ+/cct26Ht/RjTMBEjRa74n17QUZRYUESJlVf0uTMHUSnJZjrJHP4jvGnt6DWRMes5T2WTrddG9GKz+ndCwLx9/eqdXcqqPoGt6gIeOi9Fvgdjo1t2NGryYaTyqX4wR/W4TUudNfOZ49/QmQlGvvuWmisz7aubbQ4SiYfazoM+IHkH5JpV/NBSVg92MDK4nc2d2xBPQj2LF0K/rV7lihcTB1xMAcGRc8K7LSPzooZ/Uoy5zuUccXjIR3GL9C/XSnVqBXd6zgHpLmLHAiuujH8P6PWzRT1+M7khUTIN3Oxl8iRRr39ANdsHczoN9WnQFnXMvQ1V7IJfPp+dzXJvtwvYFP1g4CL1sUsdyAR+5rWbME+d43FPqs6n64+ZRX7/UdUd8MsP5kCnT9Hvr2+SIire/+ByLUBtj3JlbrlMzo8BbLHZu/I/J08Ew5IZaWDhQbwMNx9aRI/Cf/sgNPOixlmXv2co+JcNWhI5wLI8Es8M/UfTbA13N8sNYJrR4c7T1jj7T+Qm6ftaUiCdVW/0aFH44Knu9NwrIJV7wHrXLHc+HhhlPpPpzd2HvSqZ9Td32tcU5rncY5dead0y1mI5ygzqXQpa+NVU01vlblq/3Mq2WSbf2kcKTbEMRRWg+WGWSRxiTlF/iqEnOdp3QMp+q51EE5+Vz3NJFSVz3ci9nPbsObzZc4qeAx7lG7fJi4j8Nr4jBqZ9F9vFI7irWNjSbHNBjmPvZ7td70KXRWl7try9ajNduhVblh5gvhWzQBQu5zXugnutd5Yc/qwBZupy91Oz0Mua88pNXdfdxrXBYrnS+9LB7cuK5zzR1m9UMYzw9mxdbZ7Z726zezI7+e+lb/DI26+3ilToWPuw/gQp2jOH8tJU7pxw9Ge+ShlONZBHgP7fhWlfirCbQO7J9OpGsPo0l3Ow0N7UlDQXvSqxPl2tq9iLK+6ARlnQT8zS/7r0ad358N5dbW1tbe4etk+/Vwa2srg9/tdnumETXrtHEZ0FxdfKi7l/GOn7NKu90GFMbU0E0cvpyL4X/Y8eH8MW33+vwneXbWHuIxZYYD5+ulQNn1r/PW/Hl8/rUcGISBzDH0XYqdONgMYgiw92HdQYiWJdPmFxmPg83rwEWNwZ8uJgtGLp9rCNW/DnSUsIzCX94iheB+iA4OQh+UG4QBhhFApD8QXbDpAoyDEJ64cvBDMA1z4LjNa9/Lxk4HodPBg83AEn0QBu6hp/xEmIgkPN3m8SC48QveNlX5pZpK4x9ljDvMAwGpXzgNDr2ZSG74opnqM9xUaK0mo0rRcTCZR+EjUf0zoh1XhtqlY383cAOekDI8ErsFYcANy+qrzDk0JT8f0xGTsBMMMfrcsXgsNPvsNWEcxnB/yUDnfJiB83tiybZOL9w8si2IcWSxV0pbVbBuSDBgrn0Xxfj+uFs6rK9pnwim1jyaF8Rdix3VCVqiNM8ZVW2Mpf7ipA3M26FpVGAeSSkVGzsrQS131r0Jg6u7N3NFItnyEeLk55QNjH3RJZFUgqlH9TCR72ZzvdXVmzAY37298Q+5vcdweKO7d/cWQ+urtIO/AtaVjZswSO6G9XkZ/P8XAru6flPddS6npMwl68t4fObl1s1dHf2lAv0gMWlH7KuYqRoi+lKmjIopTOwMrHNdkp/A4PgptHEUGLPNlfYXis1VUixikP+B4VVeVhGnc9iAbuLiaMEnvw0fUEvSRV9DL+Hn03bCPvP5T5CwZ3twm/CGDmhGowQyrVx0Bx14J1sOKUey0B488ENDrF/KwLVsEsZtqgQXw6ZRVMMOervre2/XTwe+wCWHSYv7Rwf3wCVabC2b/WTvabtLOwfZPzqATBg+cGpYm7zWJSY8ammjCwG1iFxy6qPlS9k+tm/PzLodpc+7qlz0bZeD0iLTAMVcz4QohIh5G6ZfJmlOTVwlzsERycKAy99lKhJtWK4beEQoSkQeyeI+VHkHJikZFhjqZ4BlfVoMRvtUmSxc2AxQVPfjQvnkHUcW0BPSQSs8eaxAp9r8IWFC2+GUDKg2TIWQFgqYVwUo9+WU7CpnijMRsZkoUMyi7qxQM/WmJg6aaSGvX7106ZJ+D54p+8CBdmIWkyJHqkFOKNOV/MlNbn1KUQLuYOpsnoI2rXpgUpHzRORMaUipVUSqIRX8k0uxBY0EjJ0+S2hquzpRAR5rgAc4vAmMl7V//PNfNbjmapzTgNkVaBxDLNodEKJFZwkeNG7FcpCAsgkRzMfUf05eAgAdMs1ZJuOSkfT9afwAo9d0KRfdE1r5fKeLKAEFv5S3OvQyVju1UqOJiHYkvsHlsF92xbWpJdz4sNhp+fCKAR6jGgyohgBXA82LcZ3Bq2dFOTEdpgXxZrJWeQ1O8QItjDxTLOPifvdU3SlmZCkICiMzanhE/FS63UzBsy8vnq8zyN22oAE1XnKpHs1hVZjuTIqInXFxxi6ZuoeCt1eG8cR0DMRtRoyJOmweSfY6q9KkRpA33MBJ7XbCZMA6lGtgHti301m2y+2GpKeHKlGdZX14w7evwMBqKDhkZUs2jaEfxZpyz6ELW+oHMja6nc7/ZVtqpfPj2FKrnR/IltoAYJ339G4BNE+/mSk7vDf49gHnEp026Me9vSd4WW/C0nc9C8EVO/Ru7H+V+efl/h0mobUZK7euM2f8ZhANvU4H/pkQgr5GiK9cUZVNScd/C8L7+5RvPwNfpeJ2ZP2S9J7rXGRRAjibozdX3W8nsbqvfJmNXyT9ZxHf5y92Xn/a6e7xHb0jXq1FT3fWdy7yd2+evnjSZuMX3aj3Zvyu98a8f5vqnXPJo+cvkg/ije4/XSvev/ug3r/bUe/fvjL07dpWXySi/+w3Ho3Xzvu9Dn/59EXnw9vuqP/st86HN0/yDzj5b50PFxedKNt72hdb0Cd//+6/+P759srup+1Pu0fbV7uf0idtuvfx/OlV9GT3Ynu99WFHtXb3+7+ffzT5q7V4Ze8dX99gu+ytOOq8jBrUwEXKBTvzR32G+z6Dw7aUtDrr2A9lxkyC+iKWJlES6p7ktr6HUWNCh5QLAqhTD0gFTKm7+OXzILsNEaudzlm3RMLaNBJ2BEbwYwmgI3nBxLfdaX15Y5cHUK+ytBJaAbedsD1obLb+3W5Ss6hQ3IyDzePr4KpFc96y7ZvHpzenYQCIlfCMlEuNEFOTBJvB8uSrElRiwjeL42vLgyWjaSpiiI6YYjaa8+XLbrsb3ISTY2Yy5y39WdH63CHa0CEXw7vGnVYoOoRjtCfVQFSl4+b8dwZKrjuHeq8w4EA+CaNgzADmgTpeVW9x2/6M/SvZrIev6iwnn7L8S1bjcWryHp7x3FR7bTr2Tz34elM+3gTVhoLygQX+LJX844piy9cJr1B3URPtra6iyva4i7rNygaqDavrN6cWwTV3JAa71n1qNq6j4Rxyn5rOkiCYcE40PASTDoK5xvocW90tOWGTloDMMgXXGhbYDGx5DaKJK4h8AFytdBBXqx3E1Uanoby4HVYzVCoI6hmlmoG6RF2VAH3hFOiPi4FE4nUUtZ8zcQiePJAtSPxTKidLI5mVBTv8gD/++S8c4+186zGBGf4GASH7hSK5HDEFVdWwqljKrjhYtFjxLcM2je+UGMZNs5RpDY+XwrChLYkGSX3gOnTOqYjmtA+VycD1haHKGPNYk726Td4mDMIIoOknZXMcL1kK8rb0CdSrmo2kuhikcgTFwkgfCvmAV4iJhIrIOqCsFEBHCljE4NzLFddQn0gB1NzCJoVRNDIko4IO0RMSNlAVs5SDqCRK9sE/q2VaWA+koTyVykao4YYwhACjaravcmhCnRlcd4olQLeXzg2pQ+sGtgzu6p31weOeAyw8YuiNKUQqoTQZeO6LNCW5NNabDqp5HUYYbhQVGvRpC4s/gxJhzkPItAvjfq0ZnPBLLi5sAZUWOS5p6i3ra25YM71ykvceNcc84+Z50YfyTFJzI9W4Gj3kJin6KKrrk5Q/7EzPfEm9miCu5ohlpGdogDLSy5AJunzIDFCIXt462MGb/hH547//h7xkVAmSyJGl1qhQLB1X1fuw0ByevEVbeVGjD5oWUK3OIJGKoX8WKTGYYyQvt8zjcHhQ9FMelYJ+k2yRvPnJJ4B5bRxrrNkQfXgWoCTl4qJNtsTYFv/DZxOgAfiOg12VxbI4Wy3wH01kbtrkuRyBXAsrLyjU/IHSgc26gdxolg4wmKWZc7A5OwcBHEsuJX9uvoErI4grg4OMjXEsLescOcdlVUKIiRiLhelNgppKVVUxnMhQwDeNqU8+uaGq+2inqdWeBGxNnIRuEwzAmVAPmlJUsQFTsKJulH2kOXeEcuwJjjQzkj+fYK25KQyNUDf1Vx/N+UwnNdRK0/uDQyiqGXlbaQ6vLmPn5SAMUh4xZ/u6W2nr2cFLcklW2p0grGld9+Db5Zc7T7f3DrcBGpCRFmPddqfdQR+d1CajorYUVg8ti4lO3li16KZF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0dFF0VGyKDq6KDr6jfa+KDq6KDq6KDq6KDq6KDq6KDq6KDq6KDq6KDr67e7bRdHRRdHRRdHRRdHRRdHRH6iW46Lo6LegwEXR0UXR0UXR0UXR0UXR0UXR0UXR0UXR0c92Xi2Kji6Kji6Kji6Kji6Kji6Kji6Kjv4/LTpay2lbzlPKRS0b2yaNHk+UIj0NgwSSSjePg+trILzXKr25gc8fC0ygOz4Ng0uqOARsYT5q6PMnIYnugo2DzeCpjT9rHcHyoT1nTHGYSMOFBFA7Ygu3fmvfet7rwf7hURAGfVcuNZMxZujTESTd0ZHNO6xl5uG36yClYlhgVl9g57yxFW2SZr7oBeaLuj9qqYFUjGsQNhNJ7Tbg/7CpmQOur20u6s1N2d82zR3hEOt7w/Gd3tzc/C+ZkBXA",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},j=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," A custom regex pattern for validation - for example, /^\\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. ",(0,s.jsx)(n.a,{href:"https://www.w3schools.com/jsref/jsref_obj_regexp.asp",children:"help"})," (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "layout": "vertical",\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12,\n "layout": "vertical"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Prefill Widgets:"})," Prefill widgets are elements that are inserted into a document 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 "name": "textbox",\n "response": "joe",\n "color": "red",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the text you would like to display inside the textbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date"\n "page": 1\n "x": 173\n "y": 588\n "w": 114\n "h": 21\n "options": {\n "name": "date"\n "response": "04/15/2024"\n "format": "mm/dd/yyyy"\n "color": "black"\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Enter the date you would like to display inside the date box."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd/mm/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd.mm.yyyy".'}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 172,\n "y": 630,\n "w": 114,\n "h": 21,\n "options": {\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "response": ["male", "female"],\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide values that need to be selected."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 173,\n "y": 718,\n "w": 114,\n "h": 21,\n "options": {\n "name": "radio button",\n "values": ["male", "female", "other"],\n "response": "male",\n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n } \n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the radio button. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 100,\n "y": 95,\n "w": 92,\n "h": 55,\n "options": {\n "name": "image",\n "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data",":image","/png;base64,iVBORw0KGgoAAAANSUhEUgA...."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 528,\n "w": 114,\n "h": 21,\n "options": {\n "name": "dropdown",\n "values": ["male", "female", "other"],\n "response": "female",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"response:"})," Provide the value that needs to be selected. Only one value is accepted."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Choose the text color (options: black, blue, or red)."]}),"\n"]}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5},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",description:"Allowed values - signature, stamp.",format:"string",example:"textbox"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:100},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:30},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:40},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:80},options:{type:"object",properties:{name:{type:"string",example:"textbox"},response:{type:"string",example:"joe"},color:{type:"string",example:"red"},fontsize:{type:"number",example:12}}}}}}},title:"prefill"}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.786c2d78.js b/assets/js/c7e3ab5f.786c2d78.js new file mode 100644 index 000000000..dabb9a6c9 --- /dev/null +++ b/assets/js/c7e3ab5f.786c2d78.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>y,default:()=>b,frontMatter:()=>u,metadata:()=>n,toc:()=>A});const n=JSON.parse('{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1.1/deletecontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletecontact","permalink":"/docs/API-docs/v1.1/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV19v4zYS/ypTvrQbKLaTTVucni63DbbBBd2gSRGgWSOgxLHEmiJZkrJjGAL60G9wT/d6H20/yWFISbaT7F4XdyhwL4k1nL+/Gc4MtyzwyrP8nr0xOvAyeDbPmEBfOmmDNJrl7LZG+A4VBoSeCc6vL4ErZdYeNqaFYMBhY1YIHMqeZeFMQ4duoBTGLCdwuYgS2oAyukIHGlEAB8tdkGWr+Mj/pQepF8Y1nPzIINTSR8MNX6IHGQC535BtkZwLNUoHDkvjxIRlzFh0UfZSsJwlpl43y5jljjcY0FH0W6Z5gyxn/fmDFCxjkqK3PNTsKSTXzqykQDDFL1iGSwFmMQY+OsQy5vDXVjoULA+uxYz5sFFkxsvGKmLAR6uMQJYvuPLEUNbYcJZvWdjYyBmc1BXLWEJin4KPPGrJma1Pi/qUe8G6bk5WvTXaoyc9p7MZ/Tv0f8hjclSAb8sSvV+0Sm2+YFmEAXUgQW6tkmXEcfqLJ+ntcy8TDoSqI9SDTLYHeF6KZ+f93x7Jd/u9fc26rM+TOA+fFjqdnb4+Ppkdz769PfkmP/tL/vU3k9ls9jPL2GOjSLbPqOABSW+QQe2+u2dsKWX7jD2lI+azl1C8MQ2GWuoK1qgDrJ3RVQZWIfcIwW2AV1xqUDyg+x+iis4Z92l0Ps+zbi9qqZXU+DCU0MPZbPZwMoJw9vFS0ibAwrRa/LmRvmD+0+GcPZyO4Xz9PJxLveJKithobs0S9Z8bzr75kMw/r1WZmOI5Owh2n56C9Fi2ToZNbHKPx9zK43Se38+pV1CdmF1/jI0x1Cxn076fTbe7ntgxUuhWQ9NsnWI5q0OwPp9OPdeiMI8TY1F7WWnFCz8pTTPlVk5XJ5MT1mVPZbi1n8WP7fHnivjAK6mr/yQ332F1Q/lMKTtAbEwct/LvuGHZkJB9rn5s1MgFupg8mmJRuE/TO4v6RlY6Jjkafzpe7lCVpkEaJaFGGAQ+/P6vKCNM2TaoQ6zCqOGL9/q9ftc6sGaNbtEq4FrAQuGjLBRGIWzi2TiwPfJGofdqA1IHrBwPCEJWMnAFhBF1j5JbXkglqYKJzaSJvncJ/ATuagw1Ojr60tEKIHCFigofeBsMzW9djU7D2rjlglaHDDgUrZcavQfUNdclMQ5ZyMA44BpQB3TWSY/ggyOvZfLN6ODo6jdc8wpJd3YAlUAlqVTBmaL1AbxRbXQZApfKOBQwBERLiJ8QiBc0kB1CWlwa67CmklkhVK0U6DMojUDw8cJSCFpAgT6AJV9kiZ6UtlqZchmTRzMVrKH+IbmiRWHfRxIPjmtP4z35MuRgBMw6Q8MZk4NHRz95pAxfSb30+dHRe30M92NN3WHhZcD5V0P5r9frZ2X/6lDmrQzftwX8iNZ4GYzb7KQrGeq2iFdlX8n4kTS9RY2xfvYuwk6HMKV/fvOIOq1R2ekNBqoQPz2/vowt9xV8+O0fcIXcaajNOlVr2TpUG6gGU4RcynyCbeyYsDCx8GpCvEzFR3sY+jAgeFfz8OG3f3r4Adcg0xVKQB4dXbeFkiXcYmNpPPqjoxzeOCSTYaBBqHmAkmsoEHzNqZRWktMam6SV1MsJnOsNtB4drGWoYzEQPcodhEG4jOn2UHCPAoyOEoPNyc4jojce1Qo96aLJVyCgkLTJhdqZtkrW9p3pg3O4kErBnRQVhhjbuRBge/I6keMKu3MHF3QhQo0b4A7Bow4TuH4iEk9aa40jL2RyfmHojUAJQC2skTr4HITji7DTn+0KvSSY467/jJQg5CMcWa9mTEm6iX3EI3XynhrykyZ+2GsdLtCRwRj2Li9W9uV0P5QlULX+N2VNs3p4gNA60HCp0jT561M9cayja/y7xQ26lSyxn2gfudHTyDxlGVOyRO1xb104f3t9BavXkxnL9kbjH7jc06vLNxc/3FyQM9RIE2Ank9lkRiRrfGi43rN0+Ep8Ota2uz3q//ZN2S8AAR/D1Cou4/4VQd32i9M9270x873n5DxjtfGBGLZbuuI/OdV1RP61RUf72TxjK+4kL2hLuN8yIT39FuPj8KNofvVj/858BX/0ZfpiIMN6o2m3WXHV0hfL2BI3h2/jbt5lw4pDriaG87JEG/ZEny3LBxvndxdXF7cXLGPUrA+3q2XcrvofZOBFzw7XruQD/aUd8EWB7TZtbl038qejj0r0MQ7cBNO867p/A0zVDXo=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/v1.1/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/v1.1/contactlist"}}');var a=o(74848),c=o(28453),i=o(33617),r=o.n(i),l=o(17543),s=o.n(l),d=o(86013),p=o.n(d),m=o(63723),j=o.n(m),f=(o(18766),o(79329),o(9303));const u={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:"eJzVV19v4zYS/ypTvrQbKLaTTVucni63DbbBBd2gSRGgWSOgxLHEmiJZkrJjGAL60G9wT/d6H20/yWFISbaT7F4XdyhwL4k1nL+/Gc4MtyzwyrP8nr0xOvAyeDbPmEBfOmmDNJrl7LZG+A4VBoSeCc6vL4ErZdYeNqaFYMBhY1YIHMqeZeFMQ4duoBTGLCdwuYgS2oAyukIHGlEAB8tdkGWr+Mj/pQepF8Y1nPzIINTSR8MNX6IHGQC535BtkZwLNUoHDkvjxIRlzFh0UfZSsJwlpl43y5jljjcY0FH0W6Z5gyxn/fmDFCxjkqK3PNTsKSTXzqykQDDFL1iGSwFmMQY+OsQy5vDXVjoULA+uxYz5sFFkxsvGKmLAR6uMQJYvuPLEUNbYcJZvWdjYyBmc1BXLWEJin4KPPGrJma1Pi/qUe8G6bk5WvTXaoyc9p7MZ/Tv0f8hjclSAb8sSvV+0Sm2+YFmEAXUgQW6tkmXEcfqLJ+ntcy8TDoSqI9SDTLYHeF6KZ+f93x7Jd/u9fc26rM+TOA+fFjqdnb4+Ppkdz769PfkmP/tL/vU3k9ls9jPL2GOjSLbPqOABSW+QQe2+u2dsKWX7jD2lI+azl1C8MQ2GWuoK1qgDrJ3RVQZWIfcIwW2AV1xqUDyg+x+iis4Z92l0Ps+zbi9qqZXU+DCU0MPZbPZwMoJw9vFS0ibAwrRa/LmRvmD+0+GcPZyO4Xz9PJxLveJKithobs0S9Z8bzr75kMw/r1WZmOI5Owh2n56C9Fi2ToZNbHKPx9zK43Se38+pV1CdmF1/jI0x1Cxn076fTbe7ntgxUuhWQ9NsnWI5q0OwPp9OPdeiMI8TY1F7WWnFCz8pTTPlVk5XJ5MT1mVPZbi1n8WP7fHnivjAK6mr/yQ332F1Q/lMKTtAbEwct/LvuGHZkJB9rn5s1MgFupg8mmJRuE/TO4v6RlY6Jjkafzpe7lCVpkEaJaFGGAQ+/P6vKCNM2TaoQ6zCqOGL9/q9ftc6sGaNbtEq4FrAQuGjLBRGIWzi2TiwPfJGofdqA1IHrBwPCEJWMnAFhBF1j5JbXkglqYKJzaSJvncJ/ATuagw1Ojr60tEKIHCFigofeBsMzW9djU7D2rjlglaHDDgUrZcavQfUNdclMQ5ZyMA44BpQB3TWSY/ggyOvZfLN6ODo6jdc8wpJd3YAlUAlqVTBmaL1AbxRbXQZApfKOBQwBERLiJ8QiBc0kB1CWlwa67CmklkhVK0U6DMojUDw8cJSCFpAgT6AJV9kiZ6UtlqZchmTRzMVrKH+IbmiRWHfRxIPjmtP4z35MuRgBMw6Q8MZk4NHRz95pAxfSb30+dHRe30M92NN3WHhZcD5V0P5r9frZ2X/6lDmrQzftwX8iNZ4GYzb7KQrGeq2iFdlX8n4kTS9RY2xfvYuwk6HMKV/fvOIOq1R2ekNBqoQPz2/vowt9xV8+O0fcIXcaajNOlVr2TpUG6gGU4RcynyCbeyYsDCx8GpCvEzFR3sY+jAgeFfz8OG3f3r4Adcg0xVKQB4dXbeFkiXcYmNpPPqjoxzeOCSTYaBBqHmAkmsoEHzNqZRWktMam6SV1MsJnOsNtB4drGWoYzEQPcodhEG4jOn2UHCPAoyOEoPNyc4jojce1Qo96aLJVyCgkLTJhdqZtkrW9p3pg3O4kErBnRQVhhjbuRBge/I6keMKu3MHF3QhQo0b4A7Bow4TuH4iEk9aa40jL2RyfmHojUAJQC2skTr4HITji7DTn+0KvSSY467/jJQg5CMcWa9mTEm6iX3EI3XynhrykyZ+2GsdLtCRwRj2Li9W9uV0P5QlULX+N2VNs3p4gNA60HCp0jT561M9cayja/y7xQ26lSyxn2gfudHTyDxlGVOyRO1xb104f3t9BavXkxnL9kbjH7jc06vLNxc/3FyQM9RIE2Ank9lkRiRrfGi43rN0+Ep8Ota2uz3q//ZN2S8AAR/D1Cou4/4VQd32i9M9270x873n5DxjtfGBGLZbuuI/OdV1RP61RUf72TxjK+4kL2hLuN8yIT39FuPj8KNofvVj/858BX/0ZfpiIMN6o2m3WXHV0hfL2BI3h2/jbt5lw4pDriaG87JEG/ZEny3LBxvndxdXF7cXLGPUrA+3q2XcrvofZOBFzw7XruQD/aUd8EWB7TZtbl038qejj0r0MQ7cBNO867p/A0zVDXo=",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,k={},A=[];function P(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,a.jsx)(r(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(s(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(j(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/c7e3ab5f.9d2164c5.js b/assets/js/c7e3ab5f.9d2164c5.js deleted file mode 100644 index 8f3706edf..000000000 --- a/assets/js/c7e3ab5f.9d2164c5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4833],{86690:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>u,contentTitle:()=>j,default:()=>f,frontMatter:()=>P,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/v1.1/deletecontact.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/deletecontact","permalink":"/docs/API-docs/v1.1/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV91uI7cVfpUT3iS7GEuy10nRuaqbGLtGja4RO1igXsHgDI9mTsQhGZIjWRAE9KJv0Dfoo+VJisP5kWR7t1m0CNAbW0Oe3+/8ciuirILI78X31kRZxiDmmVAYSk8ukjUiF3c1wg+oMSL0RHBxcwVSa7sOsLEtRAseG7tCkFD2JAtvG770w0lh7XICV4vEYSxoayr0YBAVSHDSRypbLUf6rwOQWVjfSLYjg1hTSIobucQAFAFl2LBu1RkXayQPHkvr1URkwjr0ifdKiVx0RL1skQknvWwwomfvt8LIBkUu+vsHUiITxN47GWvxFJIbb1ekEGzxM5bxSoFdjI6PBolMePylJY9K5NG3mIkQN5rVBGqcZgJ8dNoqFPlC6sAEZY2NFPlWxI1LlNGTqUQmOiQOT/BRJim5cPVZUZ/JoMRuN2etwVkTMLCcs9mM/x3bP8SxM1RBaMsSQ1i0Wm++ElmCAU1kRumcpjLhOP05MPf2uZUdDoyqZ9QjdboHeF7yZ2/9nx/ZdvfOvRG7rI+TuoifZzqbnb05OZ2dzP5wd/pdfv7H/NvvJrPZ7G8iE4+NZt4+okpGZLmRot5/756RdSE7JOxPdkx8/hKKt7bBWJOpYI0mwtpbU2XgNMqAEP0GZCXJgJYR/f8QVfTe+s+j82WW7Q68JqPJ4MOQQg/ns9nD6QjC+adTydgIC9sa9ft6+oL6z7tz/nA2uvPtc3euzEpqUqnR3Nklmt/XnUP1sVP/PFepI0r34sjZw/POyYBl6yluUpN7PJGOTrr7/H7OvYLzxO77Y2qMsRa5mPb9bLrd98SdYIF+NTTN1muRizpGF/LpNEijCvs4sQ5NoMpoWYRJaZupdDRdnU5OxS57yiOd+yJ6bE++lCVEWZGp/hPffI/VLcezC9kRYmPgpKO/4EZkQ0AOqfqxUaNU6FPweIol5j5M7x2aW6pMCnJS/nS8fEBd2gZ5lMQaYWD49R//SjzKlm2DJqYsTBK++mg+mvetB2fX6BetBmkULDQ+UqExMWGT7saBHVA2GkPQGyATsfIyIiiqKEoNjBF3j1I6WZAmzmAms91EPyiCMIEPNcYaPV997XkFULhCzYkPso2W57epRqNhbf1ywatDBhKKNpDBEABNLU3JhEMUMrAepAE0Eb3zFBBC9Gw1dbZZEz2XfiONrJBlZ0dQKdTEqQreFm2IEKxuk8kQJWnrUcHgEC8hYcIgXvJA9gjd4tI4jzWnzAqhaklhyKC0CiGkgmUXjIICQwTHtlCJgYW2RttymYLHMxWc5f5BUvOicGgjs0cvTeDx3tkyxGAEzHnLwxk7A1+//ikgR/iazDLkr19/NCdwP+bUBywCRZx/M6T/er1+lvavjnneUnzXFvAjOhsoWr/Zc1cU67ZIpXIoZPzoJL1Fgyl/DgphL0PZMjyvPD6d1qjd9BYjZ0iYXtxcpZb7Cn79+z/hGqU3UNt1l61l61FvoBpUMXJd5DvYxo4JC5sSr2bEyy75eA/DEEcEHW8BQF3x9BjetIWmEiI2judiDhfgjo+glAYKhNKj5K2JTQi15ERakQQJmsxyAhdmA21AD2uKdcoBPk/MHWfHyMjLfZTTvkxxAu/sGlfosyQjMBvPNlQUk6zRGIoB9WKSTPe4IK1hTarCmD/5DiA9AjYFKoWKvT5QW+CC050iUIDAJ5y+rHkCdzVuEq9cSdKSOwmZLqktL/+MLBrlLJkYclBeLuIoOWR7JcnttMQ/O+pAkqNbWS9m+O5L7EkkwgQ+cqt90p6Pu6jHBXrWmEpynziO+kS5HxIOOA//m4TlKTw8LXjQN5J0Nyf+9FROGtjom/B+cYt+RSX2s+oTtTpNxFORCU0lmoAHi8DF25trWMGbyUxkB1PvN9Tt9Prq+8u/3l6yNdwjO8ROJ7PJjI+cDbGR5kDV8QPw6cTa7lek/9vnYj/bIz7GqdOS0mqVQN32O9G92D8f84OX4jwTtQ2RCbbbQgb8yevdjo9/adHz6jXPxEp64hJKi5OiwL/V+O77JJrf/Ng/IV/Bb310vujIsLkYXltWUrf8JTKxxM3xs3c332XD9sKmdgQXZYkuHrA+24OPlskfLq8v7y5FJrgPHy9Oy7Q49T9YwYuWHW9UnQ38l9e7Fxm2224p2+1G+u7qkxy9jwM1wzTf7Xb/BrsS/iQ=","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 i=o(74848),a=o(28453),s=o(33617),c=o.n(s),l=o(17543),r=o.n(l),d=o(86013),p=o.n(d),m=o(63723),k=o.n(m),I=(o(18766),o(79329),o(9303));const P={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:"eJzVV91uI7cVfpUT3iS7GEuy10nRuaqbGLtGja4RO1igXsHgDI9mTsQhGZIjWRAE9KJv0Dfoo+VJisP5kWR7t1m0CNAbW0Oe3+/8ciuirILI78X31kRZxiDmmVAYSk8ukjUiF3c1wg+oMSL0RHBxcwVSa7sOsLEtRAseG7tCkFD2JAtvG770w0lh7XICV4vEYSxoayr0YBAVSHDSRypbLUf6rwOQWVjfSLYjg1hTSIobucQAFAFl2LBu1RkXayQPHkvr1URkwjr0ifdKiVx0RL1skQknvWwwomfvt8LIBkUu+vsHUiITxN47GWvxFJIbb1ekEGzxM5bxSoFdjI6PBolMePylJY9K5NG3mIkQN5rVBGqcZgJ8dNoqFPlC6sAEZY2NFPlWxI1LlNGTqUQmOiQOT/BRJim5cPVZUZ/JoMRuN2etwVkTMLCcs9mM/x3bP8SxM1RBaMsSQ1i0Wm++ElmCAU1kRumcpjLhOP05MPf2uZUdDoyqZ9QjdboHeF7yZ2/9nx/ZdvfOvRG7rI+TuoifZzqbnb05OZ2dzP5wd/pdfv7H/NvvJrPZ7G8iE4+NZt4+okpGZLmRot5/756RdSE7JOxPdkx8/hKKt7bBWJOpYI0mwtpbU2XgNMqAEP0GZCXJgJYR/f8QVfTe+s+j82WW7Q68JqPJ4MOQQg/ns9nD6QjC+adTydgIC9sa9ft6+oL6z7tz/nA2uvPtc3euzEpqUqnR3Nklmt/XnUP1sVP/PFepI0r34sjZw/POyYBl6yluUpN7PJGOTrr7/H7OvYLzxO77Y2qMsRa5mPb9bLrd98SdYIF+NTTN1muRizpGF/LpNEijCvs4sQ5NoMpoWYRJaZupdDRdnU5OxS57yiOd+yJ6bE++lCVEWZGp/hPffI/VLcezC9kRYmPgpKO/4EZkQ0AOqfqxUaNU6FPweIol5j5M7x2aW6pMCnJS/nS8fEBd2gZ5lMQaYWD49R//SjzKlm2DJqYsTBK++mg+mvetB2fX6BetBmkULDQ+UqExMWGT7saBHVA2GkPQGyATsfIyIiiqKEoNjBF3j1I6WZAmzmAms91EPyiCMIEPNcYaPV997XkFULhCzYkPso2W57epRqNhbf1ywatDBhKKNpDBEABNLU3JhEMUMrAepAE0Eb3zFBBC9Gw1dbZZEz2XfiONrJBlZ0dQKdTEqQreFm2IEKxuk8kQJWnrUcHgEC8hYcIgXvJA9gjd4tI4jzWnzAqhaklhyKC0CiGkgmUXjIICQwTHtlCJgYW2RttymYLHMxWc5f5BUvOicGgjs0cvTeDx3tkyxGAEzHnLwxk7A1+//ikgR/iazDLkr19/NCdwP+bUBywCRZx/M6T/er1+lvavjnneUnzXFvAjOhsoWr/Zc1cU67ZIpXIoZPzoJL1Fgyl/DgphL0PZMjyvPD6d1qjd9BYjZ0iYXtxcpZb7Cn79+z/hGqU3UNt1l61l61FvoBpUMXJd5DvYxo4JC5sSr2bEyy75eA/DEEcEHW8BQF3x9BjetIWmEiI2judiDhfgjo+glAYKhNKj5K2JTQi15ERakQQJmsxyAhdmA21AD2uKdcoBPk/MHWfHyMjLfZTTvkxxAu/sGlfosyQjMBvPNlQUk6zRGIoB9WKSTPe4IK1hTarCmD/5DiA9AjYFKoWKvT5QW+CC050iUIDAJ5y+rHkCdzVuEq9cSdKSOwmZLqktL/+MLBrlLJkYclBeLuIoOWR7JcnttMQ/O+pAkqNbWS9m+O5L7EkkwgQ+cqt90p6Pu6jHBXrWmEpynziO+kS5HxIOOA//m4TlKTw8LXjQN5J0Nyf+9FROGtjom/B+cYt+RSX2s+oTtTpNxFORCU0lmoAHi8DF25trWMGbyUxkB1PvN9Tt9Prq+8u/3l6yNdwjO8ROJ7PJjI+cDbGR5kDV8QPw6cTa7lek/9vnYj/bIz7GqdOS0mqVQN32O9G92D8f84OX4jwTtQ2RCbbbQgb8yevdjo9/adHz6jXPxEp64hJKi5OiwL/V+O77JJrf/Ng/IV/Bb310vujIsLkYXltWUrf8JTKxxM3xs3c332XD9sKmdgQXZYkuHrA+24OPlskfLq8v7y5FJrgPHy9Oy7Q49T9YwYuWHW9UnQ38l9e7Fxm2224p2+1G+u7qkxy9jwM1wzTf7Xb/BrsS/iQ=",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,u={},y=[];function x(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Contact"}),"\n",(0,i.jsx)(c(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,i.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,i.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{parameters:[{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,i.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(k(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function f(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/d0524430.17916d14.js b/assets/js/d0524430.17916d14.js deleted file mode 100644 index dfbacb069..000000000 --- a/assets/js/d0524430.17916d14.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>w,contentTitle:()=>I,default:()=>j,frontMatter:()=>M,metadata:()=>i,toc:()=>E});const i=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":"eJztWe9uGzcSf5UJA9xdjbVkpy5Q6FNVV+cI5z+CJSMoLMOhdkda1hS5JbmSBUHAfbg3uDe4R+uTHIbcXa1kR2mSwggCfbG85Mxw/vw4JGeWzPGJZa1b9g5HqdYP7C5iCdrYiMwJrViLDVIEy2cI2kCeJdwhFLTQ7nWBS6nnFhY6B6cDIYd5QXBzfQ7zVMQpCAu5xYRonBGTCRrAGSpnG0M1VK9fv4aO/2zR58HBcQNmAueYtA4OhuoQ3qWogIMVE4XGT1ngkOg4n6JyEbhU2CAQ5kLKco3GUL1//36olkMFMGSeYMhaMGRB+pBFYcYtMgwTv1yd3lx0Lgf3g197nWpej37D2HWTLZruLxXFWMhtCTfX59W04tPt6cv2xXoBpV0x35PILYJBUhG4SrzVwcLS4IqtFqrAXc0EV1kavaURgGX42dSm3z277FzXdQkUOOVCbpB0Ltrd8w2aLNVqU0zv7dVlZ8gCyYp+7gp1gr9/XnxQZEnSLgI06F50+oP2Ra+ajw1y9yzBUK2KQBN23jSgIN0ET+k8wmJB8BnAKTj3yHkp5PyZsO+KMbjU6HySgksREsPHDhxOM0mJrN3r7iHwlUGgRpObmpTu5VlwymdihFLD941whOzIDGEeRovquPkMhAQh3zxAaLAAxsdg8XFQfCQrrOor/wWnxEkDYj3NJO48J2pokLLAg/2clFEu9c1j4us5N9A4MRYxL8087VwPuv/snrYHnQ1HVbH5clD90IAEYyl2ZpiS4gtzTClmj6iXQlTp8Z232JLoy8DEIqYzNJyc0k1Yi9HD6m/h+VW+1CJm8PccrftZJwvWWm6923pGz0SCkBtJr66wKqyZY60cKkeMPMskbRShVfM3S9xLZuMUp5z+o1WEwYReiTdG0guRoMZaBaJYxDJD2jqBlhhyI+mnILLOCDVhERtrM+WuPoKPnLYea7HUucy2ms2Fzs1h8Xo8zI38qSBpxHrKVquIOeE8Q0FzPyLbVyuaMmgzrWzQ4c3R0VOX9PM4RmvHuYTKu5/iid1mG7S5dM9ZvrazfDmHSCZgK43k4tWGgUIRjO5Lo+7fHB3d/1hYevKscXqKLhVqAnOfRIxWkwiysBOdWQCfcKGA7r3m1V9nNRqjzW6jP02zXU44OTq6P66ccPzUCZV/jQQuDfJkAfgorLMva/IuPXYbeHw/rww8eWrgjUUDSjsY61wlL2vU9tq7DTmpzPjhqRldNeNSJL6CNNAPqF7WkvryLixPqj5OfeKik8Wb5In8PNswtT4ejLQY50a4BWvdLtnjIc/EYZhv3d6t7iJGG0BTHs+09Rpzl7IWa86rdGzRzNBYL8An0ConWq6SkX5s6AwVnYiSjyzlwybPRHN23Dhmq2ibh2fZJ9FjfvipLNbxiVCTj/HdrZ3TpwCGGG24qIoUz8S/cMGiMgJ1qogJAk6KPEHjo0W4uF6fgJ0yutuK7j5TSO5YeyWK+F5lqPp0XSF0eCO2S6LvUMZ6ir6YmSKUDH/853+ep7zhePh6Ca/oeniVG8j0HA2dP3QnGkt8FCPpyxCAUz+3rqQin0q0Vi5AKIcTQ6d3IibC8fAQoXwa84yPhBQEfSLTxG2gtntsg66gLkVDU383VJ1NcIaSdgzw3OkpdySquqHOtXkYU003Ag6j3AqF1gKqlKuYCMtoRlQQ5gpQOTSZERbBOkNai6CbVs7w2MGUKz7BUKetuypBKQjyYPQotw6slrlXGRwXUptQLfYGKcQkVIo7jxlNAY3Sxd1gStCbIUxykaCNINYJFawpwmSCSmCE1kFGuogYLQnNldTxgw8eHb2QaUo8gkvQ4w0did0ZrixdXoIuZQwqh2VG0xmOQcGDgxuLFOFzoR5s8Qq4rTD1DkdWOLz7R4nO+Xz+ZPt8t8lzJtzbfATXmGkrnDaLNfdEuDQf+S1XF1J9BElnqNDjp7ah1jISHdunO5hGmynKrNlHRwixzXav63P1d/DHv/8L58iNglTPA1rj3KBcwKRcijwXIh/cVqVaGGsPvJQ8HgfwFRfZyoOhzSDC5il82MtHUsRV7a4Fbcg2hyDmCkZYFf78uyPlBKSZ4MBBCvXQgLZaUC/CwFy4UBWkcc9cXJKrB0vt4TY2egrCNeCtnuOMXmwkwxIbHYmYCOdlVcoIZ1GOG151g2N6081FMkHX2vq2wA0CTkeYJJiQ1bVlRzgmuItQjaARgi+t3IBBigvPy2dcSE6ZRKgAak1dGfIsqiTTghorRe2zlGyj9SLebKHVM0PBSbwyK9oqoRZbbCsStgH+DbOV5jezqMExGlrRb8k1cDJRAOW2BBwQDr8EsJTmKR/x2N8u/MMwnDc/bcvxJz2aqb0a99HMRFw+Tz6wV5ueuMkiJkWMymLtBtE+653DDL5vHLGodij9iX3bPO+edi77HdKGcmTw2HHjqHFEQ3SLmHJVW6pfdOhuNjp02yfXcn3H2vf19jWRfV9v39TZ9/X2ENj39fZ9vX1fb9/X+/qSxr6vt0fUN9bXK2qdDh9dM5Nc+Npy0TILZeHbsrtFrbaUCsatW7ZcjrjFGyNXKxr+PUdD1ea7iM24EfT497XmqKyQUh35AResxU7Dk+9wQAsTucxDsXWrxE4l3sDRjmPM3E7aek27d9UfsIiNijbkVCfEY/icWpR8zlrMtzN9bc83ymhsySRXk5xPiDbIpKIuFYY2K8IPviJc/ENWlVNqUdNws1QczKC/ZNSzDMtlqDavVhV9mPogR+HYkpoCd7darf4PxSYLGw==","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 o=t(74848),s=t(28453),r=t(33617),d=t.n(r),a=t(17543),c=t.n(a),l=t(86013),p=t.n(l),h=t(63723),g=t.n(h),u=(t(18766),t(79329),t(9303));const M={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:"eJztWe9uGzcSf5UJA9xdjbVkpy5Q6FNVV+cI5z+CJSMoLMOhdkda1hS5JbmSBUHAfbg3uDe4R+uTHIbcXa1kR2mSwggCfbG85Mxw/vw4JGeWzPGJZa1b9g5HqdYP7C5iCdrYiMwJrViLDVIEy2cI2kCeJdwhFLTQ7nWBS6nnFhY6B6cDIYd5QXBzfQ7zVMQpCAu5xYRonBGTCRrAGSpnG0M1VK9fv4aO/2zR58HBcQNmAueYtA4OhuoQ3qWogIMVE4XGT1ngkOg4n6JyEbhU2CAQ5kLKco3GUL1//36olkMFMGSeYMhaMGRB+pBFYcYtMgwTv1yd3lx0Lgf3g197nWpej37D2HWTLZruLxXFWMhtCTfX59W04tPt6cv2xXoBpV0x35PILYJBUhG4SrzVwcLS4IqtFqrAXc0EV1kavaURgGX42dSm3z277FzXdQkUOOVCbpB0Ltrd8w2aLNVqU0zv7dVlZ8gCyYp+7gp1gr9/XnxQZEnSLgI06F50+oP2Ra+ajw1y9yzBUK2KQBN23jSgIN0ET+k8wmJB8BnAKTj3yHkp5PyZsO+KMbjU6HySgksREsPHDhxOM0mJrN3r7iHwlUGgRpObmpTu5VlwymdihFLD941whOzIDGEeRovquPkMhAQh3zxAaLAAxsdg8XFQfCQrrOor/wWnxEkDYj3NJO48J2pokLLAg/2clFEu9c1j4us5N9A4MRYxL8087VwPuv/snrYHnQ1HVbH5clD90IAEYyl2ZpiS4gtzTClmj6iXQlTp8Z232JLoy8DEIqYzNJyc0k1Yi9HD6m/h+VW+1CJm8PccrftZJwvWWm6923pGz0SCkBtJr66wKqyZY60cKkeMPMskbRShVfM3S9xLZuMUp5z+o1WEwYReiTdG0guRoMZaBaJYxDJD2jqBlhhyI+mnILLOCDVhERtrM+WuPoKPnLYea7HUucy2ms2Fzs1h8Xo8zI38qSBpxHrKVquIOeE8Q0FzPyLbVyuaMmgzrWzQ4c3R0VOX9PM4RmvHuYTKu5/iid1mG7S5dM9ZvrazfDmHSCZgK43k4tWGgUIRjO5Lo+7fHB3d/1hYevKscXqKLhVqAnOfRIxWkwiysBOdWQCfcKGA7r3m1V9nNRqjzW6jP02zXU44OTq6P66ccPzUCZV/jQQuDfJkAfgorLMva/IuPXYbeHw/rww8eWrgjUUDSjsY61wlL2vU9tq7DTmpzPjhqRldNeNSJL6CNNAPqF7WkvryLixPqj5OfeKik8Wb5In8PNswtT4ejLQY50a4BWvdLtnjIc/EYZhv3d6t7iJGG0BTHs+09Rpzl7IWa86rdGzRzNBYL8An0ConWq6SkX5s6AwVnYiSjyzlwybPRHN23Dhmq2ibh2fZJ9FjfvipLNbxiVCTj/HdrZ3TpwCGGG24qIoUz8S/cMGiMgJ1qogJAk6KPEHjo0W4uF6fgJ0yutuK7j5TSO5YeyWK+F5lqPp0XSF0eCO2S6LvUMZ6ir6YmSKUDH/853+ep7zhePh6Ca/oeniVG8j0HA2dP3QnGkt8FCPpyxCAUz+3rqQin0q0Vi5AKIcTQ6d3IibC8fAQoXwa84yPhBQEfSLTxG2gtntsg66gLkVDU383VJ1NcIaSdgzw3OkpdySquqHOtXkYU003Ag6j3AqF1gKqlKuYCMtoRlQQ5gpQOTSZERbBOkNai6CbVs7w2MGUKz7BUKetuypBKQjyYPQotw6slrlXGRwXUptQLfYGKcQkVIo7jxlNAY3Sxd1gStCbIUxykaCNINYJFawpwmSCSmCE1kFGuogYLQnNldTxgw8eHb2QaUo8gkvQ4w0did0ZrixdXoIuZQwqh2VG0xmOQcGDgxuLFOFzoR5s8Qq4rTD1DkdWOLz7R4nO+Xz+ZPt8t8lzJtzbfATXmGkrnDaLNfdEuDQf+S1XF1J9BElnqNDjp7ah1jISHdunO5hGmynKrNlHRwixzXav63P1d/DHv/8L58iNglTPA1rj3KBcwKRcijwXIh/cVqVaGGsPvJQ8HgfwFRfZyoOhzSDC5il82MtHUsRV7a4Fbcg2hyDmCkZYFf78uyPlBKSZ4MBBCvXQgLZaUC/CwFy4UBWkcc9cXJKrB0vt4TY2egrCNeCtnuOMXmwkwxIbHYmYCOdlVcoIZ1GOG151g2N6081FMkHX2vq2wA0CTkeYJJiQ1bVlRzgmuItQjaARgi+t3IBBigvPy2dcSE6ZRKgAak1dGfIsqiTTghorRe2zlGyj9SLebKHVM0PBSbwyK9oqoRZbbCsStgH+DbOV5jezqMExGlrRb8k1cDJRAOW2BBwQDr8EsJTmKR/x2N8u/MMwnDc/bcvxJz2aqb0a99HMRFw+Tz6wV5ueuMkiJkWMymLtBtE+653DDL5vHLGodij9iX3bPO+edi77HdKGcmTw2HHjqHFEQ3SLmHJVW6pfdOhuNjp02yfXcn3H2vf19jWRfV9v39TZ9/X2ENj39fZ9vX1fb9/X+/qSxr6vt0fUN9bXK2qdDh9dM5Nc+Npy0TILZeHbsrtFrbaUCsatW7ZcjrjFGyNXKxr+PUdD1ea7iM24EfT497XmqKyQUh35AResxU7Dk+9wQAsTucxDsXWrxE4l3sDRjmPM3E7aek27d9UfsIiNijbkVCfEY/icWpR8zlrMtzN9bc83ymhsySRXk5xPiDbIpKIuFYY2K8IPviJc/ENWlVNqUdNws1QczKC/ZNSzDMtlqDavVhV9mPogR+HYkpoCd7darf4PxSYLGw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},I=void 0,w={},E=[{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,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,o.jsx)(d(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,o.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,o.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(c(),{parameters:void 0}),"\n",(0,o.jsx)(p(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,o.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/d0524430.86082012.js b/assets/js/d0524430.86082012.js new file mode 100644 index 000000000..0df727a0c --- /dev/null +++ b/assets/js/d0524430.86082012.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>I,contentTitle:()=>E,default:()=>C,frontMatter:()=>v,metadata:()=>o,toc:()=>g});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":"eJztWc1uGzkSfpUKA+zuCG3JzniAhU6j8WgzwvpHsGUYC8twqO6SmmOK7CHZkgVBwBz2Dfa01320PMmiyO5WS3aUSTIwgkAX/ZBVxfr5WCSrlszxiWXtW3aDo1TrB3YXsQRtbETmhFaszQYpguUzBG0gzxLuEApa6PR7wKXUcwsLnYPTgZDDvCC4vjyFeSriFISF3GJCNM6IyQQN4AyVs82hGqrXr19D1/9t099G46gJM4FzTNqNxlAdwE2KCjhYMVFo/JQFDomO8ykqF4FLhQ0CYS6kLNdoDtW7d++GajlUAEPmCYasDUMWpA9ZFGbcIsMw8fPFyfVZ93xwP/hXv1vN69GvGLteskXT+7miGAu5LeH68rSaVny6PX3eOVsvoLQr5vsSuUUwSCoCV4m3OlhYGlyx1UIVuKuZ4CpLo7c0ArAMX5vaXPXenncv67oECpxyITdIumed3ukGTZZqtSmm/8vFeXfIAsmKvu4KdYK/f1p8UGRJ0ikCNOidda8GnbN+NR8b5O5ZgqFaFYEm7LxpQkG6CZ7SeYTFguAzgFNw7pHzUsj5I2HfFWNwqdH5JAWXIiSGjx04nGaSElmn39tD4CuDQI0mNzUpvfO3wSmfiRFKDd83wxGyIzOEeRgtquPmMxAShHzzAKHBAhgfg8XHQfGRrLCqr/wnnBLHTYj1NJO485yooUHKAg/2c1JGudQ3j4mv59xA48RYxLw086R7Oej9o3fSGXQ3HFXF5stB9UMTEoyl2JlhSoovzDGlmD2iXgpRpcd33mJLoi8DE4uYztBwckovYW1GD6u/hOdX+VKLmMHfcrTuJ50sWHu59W7rGz0TCUJuJL26wqqwZo61cqgcMfIsk7RRhFatXy1xL5mNU5xy+kWrCIMJvRKvjaQXIkGNtQtEsYhlhrR1Ai0x5EbSV0FknRFqwiI21mbKXX0EHzltPdZmqXOZbbdaC52bg+L1eJAb+WNB0oz1lK1WEXPCeYaC5n5Etq9WNGXQZlrZoMObw8OnLrnK4xitHecSKu9+iid2m23Q5tI9Z/nazvLlHCKZgK00kotXGwYKRTC6L426f3N4eP/3wtLjZ43TU3SpUBOY+yRitJpEkIWd6MwC+IQLBXTvNa/+PKvRGG12G/1pmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXGD0/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6JHvODT2Wxjk+EmnyM727tnCsKYIjRhouqSPFM/BMXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQsnw/t//8zzlDcfD10t4RdfDi9xApudo6PyhO9FY4qMYSV+GAJz6uXUlFflUorVyAUI5nBg6vRMxEY6Hhwjl05hnfCSkIOgTmSZuA7XdY5t0BXUpGpr6q6HqbIIzlLRjgOdOT7kjUdUNda7Nw5hquhFwGOVWKLQWUKVcxURYRjOigjBXgMqhyYywCNYZ0loE3bRyhscOplzxCYY6bd1VCUpBkAejR7l1YLXMvcrguJDahGqxN0ghJqFS3H3MaApolC7uBlOC3gxhkosEbQSxTqhgTREmE1QCI7QOMtJFxGhJaK6kjh988OjohUxT4hFcgh5v6EjsznBl6fISdCljUDksM5rOcAwKNhrXFinCp0I92OIVcFth6gZHVji8+1uJzvl8/mT7fLfJ81a4X/IRXGKmrXDaLNbcE+HSfOS3XF1I9SdIeosKPX5qG2otI9GxfbqDabSVosxaV+gIIbbV6fd8rv4O3v/+HzhFbhSkeh7QGucG5QIm5VLkuRD54LYq1cJYe+Cl5PE4gK+4yJYevEm5e//7fy2c4xxE2ELBkY1GPx9JEcOgKOHZRqMNJ+FuW5b1LLiUO4i5ghGCTTlBaSY4cMgCtxTqoQkdtaCmhIG5cKE8SOOeb8MM/3Ypw21hxKmRoZXnKNdsrjWi8alFOUNLsujAHCFgIraLkXVlCuMMjunxdyOSCTpvWydJICuG52GYHF5TB8e0IVyKC+AGwaJyTehvsfiZPMu0IS1EUH6sqXlDAUCVZFpQ/6UokVbyozXQ/RNCaPXMUHAhr9wRbVVai51YWFyNNv1LZ+sw2My1BsdoaEFv9joumSjgdFvCEgitXwJrOgwoa/HY30H88zGcSj9uy/H3ATRTezG+QjMTcfmI+cCObnniFouYFDEqi7V7Rudt/xRm3zcPWVQ7uf7A5m6d9k6651ddUoYSaXDYUfOweUhDdNWYclVb6apo411vtPG2j7fl+iK2b/7tCyf75t++87Nv/u0hsG/+7Zt/++bfvvn39SWNffNvj6hvrPlXFEQdPrpWJrnwBeiirxZqx7dlC4z6cSlVldu3bLmk4sS1kasVDf+Wo6GS9F3EZtwIPqL65u3dKirLqFRsfsAFa7OT8OQ7GNDCRC7zUJHdqsNTHThwdOIYM7eTtl747l9cDVjERkWvcqoT4jF8Tn1MPmdt5nuevgDou2k0tmSSq0nOJ0QbZFLll6pHm2XjB182Ln6QVeWUWtQ03KwnBzPok4x6lmG5DCXp1aqiD1Mf5CgcW1JT4O5Wq9X/AfqGGmI=","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),d=t(33617),r=t.n(d),l=t(17543),a=t.n(l),c=t(86013),h=t.n(c),p=t(63723),u=t.n(p),m=(t(18766),t(79329),t(9303));const v={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:"eJztWc1uGzkSfpUKA+zuCG3JzniAhU6j8WgzwvpHsGUYC8twqO6SmmOK7CHZkgVBwBz2Dfa01320PMmiyO5WS3aUSTIwgkAX/ZBVxfr5WCSrlszxiWXtW3aDo1TrB3YXsQRtbETmhFaszQYpguUzBG0gzxLuEApa6PR7wKXUcwsLnYPTgZDDvCC4vjyFeSriFISF3GJCNM6IyQQN4AyVs82hGqrXr19D1/9t099G46gJM4FzTNqNxlAdwE2KCjhYMVFo/JQFDomO8ykqF4FLhQ0CYS6kLNdoDtW7d++GajlUAEPmCYasDUMWpA9ZFGbcIsMw8fPFyfVZ93xwP/hXv1vN69GvGLteskXT+7miGAu5LeH68rSaVny6PX3eOVsvoLQr5vsSuUUwSCoCV4m3OlhYGlyx1UIVuKuZ4CpLo7c0ArAMX5vaXPXenncv67oECpxyITdIumed3ukGTZZqtSmm/8vFeXfIAsmKvu4KdYK/f1p8UGRJ0ikCNOidda8GnbN+NR8b5O5ZgqFaFYEm7LxpQkG6CZ7SeYTFguAzgFNw7pHzUsj5I2HfFWNwqdH5JAWXIiSGjx04nGaSElmn39tD4CuDQI0mNzUpvfO3wSmfiRFKDd83wxGyIzOEeRgtquPmMxAShHzzAKHBAhgfg8XHQfGRrLCqr/wnnBLHTYj1NJO485yooUHKAg/2c1JGudQ3j4mv59xA48RYxLw086R7Oej9o3fSGXQ3HFXF5stB9UMTEoyl2JlhSoovzDGlmD2iXgpRpcd33mJLoi8DE4uYztBwckovYW1GD6u/hOdX+VKLmMHfcrTuJ50sWHu59W7rGz0TCUJuJL26wqqwZo61cqgcMfIsk7RRhFatXy1xL5mNU5xy+kWrCIMJvRKvjaQXIkGNtQtEsYhlhrR1Ai0x5EbSV0FknRFqwiI21mbKXX0EHzltPdZmqXOZbbdaC52bg+L1eJAb+WNB0oz1lK1WEXPCeYaC5n5Etq9WNGXQZlrZoMObw8OnLrnK4xitHecSKu9+iid2m23Q5tI9Z/nazvLlHCKZgK00kotXGwYKRTC6L426f3N4eP/3wtLjZ43TU3SpUBOY+yRitJpEkIWd6MwC+IQLBXTvNa/+PKvRGG12G/1pmu1ywvHh4f1R5YSjp06o/GskcGmQJwvAR2GdfVmTd+mx28Cj+3ll4PFTA68tGlDawVjnKnlZo7bX3m3IcWXGD0/N6KkZlyLxFaSBfkD1spbUl3dheVL1ceoTF50s3iRP5OfZhqn18WCkxTg3wi1Y+3bJHg94Jg7CfPv2bnUXMdoAmvJ4pq3XmLuUtVlrXqVji2aGxnoBPoFWOdFylYz0Y1NnqOhElHxkKR+2eCZas6PmEVtF2zw8yz6JHvODT2Wxjk+EmnyM727tnCsKYIjRhouqSPFM/BMXLCojUKeKmCDgpMgTND5ahIvL9QnYLaO7rejuM4XkjrVXoojvRYbqiq4rhA5vxHZJ9AZlrKfoi5kpQsnw/t//8zzlDcfD10t4RdfDi9xApudo6PyhO9FY4qMYSV+GAJz6uXUlFflUorVyAUI5nBg6vRMxEY6Hhwjl05hnfCSkIOgTmSZuA7XdY5t0BXUpGpr6q6HqbIIzlLRjgOdOT7kjUdUNda7Nw5hquhFwGOVWKLQWUKVcxURYRjOigjBXgMqhyYywCNYZ0loE3bRyhscOplzxCYY6bd1VCUpBkAejR7l1YLXMvcrguJDahGqxN0ghJqFS3H3MaApolC7uBlOC3gxhkosEbQSxTqhgTREmE1QCI7QOMtJFxGhJaK6kjh988OjohUxT4hFcgh5v6EjsznBl6fISdCljUDksM5rOcAwKNhrXFinCp0I92OIVcFth6gZHVji8+1uJzvl8/mT7fLfJ81a4X/IRXGKmrXDaLNbcE+HSfOS3XF1I9SdIeosKPX5qG2otI9GxfbqDabSVosxaV+gIIbbV6fd8rv4O3v/+HzhFbhSkeh7QGucG5QIm5VLkuRD54LYq1cJYe+Cl5PE4gK+4yJYevEm5e//7fy2c4xxE2ELBkY1GPx9JEcOgKOHZRqMNJ+FuW5b1LLiUO4i5ghGCTTlBaSY4cMgCtxTqoQkdtaCmhIG5cKE8SOOeb8MM/3Ypw21hxKmRoZXnKNdsrjWi8alFOUNLsujAHCFgIraLkXVlCuMMjunxdyOSCTpvWydJICuG52GYHF5TB8e0IVyKC+AGwaJyTehvsfiZPMu0IS1EUH6sqXlDAUCVZFpQ/6UokVbyozXQ/RNCaPXMUHAhr9wRbVVai51YWFyNNv1LZ+sw2My1BsdoaEFv9joumSjgdFvCEgitXwJrOgwoa/HY30H88zGcSj9uy/H3ATRTezG+QjMTcfmI+cCObnniFouYFDEqi7V7Rudt/xRm3zcPWVQ7uf7A5m6d9k6651ddUoYSaXDYUfOweUhDdNWYclVb6apo411vtPG2j7fl+iK2b/7tCyf75t++87Nv/u0hsG/+7Zt/++bfvvn39SWNffNvj6hvrPlXFEQdPrpWJrnwBeiirxZqx7dlC4z6cSlVldu3bLmk4sS1kasVDf+Wo6GS9F3EZtwIPqL65u3dKirLqFRsfsAFa7OT8OQ7GNDCRC7zUJHdqsNTHThwdOIYM7eTtl747l9cDVjERkWvcqoT4jF8Tn1MPmdt5nuevgDou2k0tmSSq0nOJ0QbZFLll6pHm2XjB182Ln6QVeWUWtQ03KwnBzPok4x6lmG5DCXp1aqiD1Mf5CgcW1JT4O5Wq9X/AfqGGmI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},E=void 0,I={},g=[{value:"Events:",id:"events",level:3}];function j(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)(m.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,i.jsx)(r(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,i.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,i.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,i.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{parameters:void 0}),"\n",(0,i.jsx)(h(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function C(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.6bd1b863.js b/assets/js/d480dde9.6bd1b863.js deleted file mode 100644 index 4778e8c76..000000000 --- a/assets/js/d480dde9.6bd1b863.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3230],{94677:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>M,contentTitle:()=>m,default:()=>S,frontMatter:()=>k,metadata:()=>s,toc:()=>P});const s=JSON.parse('{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/v1.1/delete-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/delete-webhook","permalink":"/docs/API-docs/v1.1/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vs1u20YQfpXJXtoYtKSk6aE61WiMxKjRGLUDH2wjWJJDcaLl7nZnqR8IAnroG/QN+mh5kmKWov6cpE1b9GKLs/M/3/ysVNQTVuM7dYt57dxUPWSqRC4C+UjOqrG6qRFeosGIsOGBs6sL0Ma4OSxdC9FB2b3PN+9tMCpTzmPQouSiVGPVsfRWMhWQvbOMrMYr9Xw0kn+Hhq/bokDmqjWwVaUyVTgb0Ubh194bKtLD8D2L0EpxUWOj5VdcelRj5fL3WESVKR9ETaTOZEBuTdzj4xjITlSmcKEbb4TUx9v5XgJvPTLLJ2q9zlSkmDjJGrL4rg/q3fPR6N13ar0WnhejF4+De8sYwLoIlWtt+eS/iwtDcOHzYR3b/lwg4nwfxrePw7iwM22oTIi4cVO0/28k++ZjZ15cXTRG5KxuupASU3pXB6Hu07sgGYs2UFyq8d1KLU61p9PufXz3sH7IVIOxdjs4i8861mqshvMtshnDDAMnFdIJY1XH6Hk8HLK2Ze4WA+fRMk2s0TkPCtcMtafh7NngmVpnxzLa+y/ix/b0S0U46gnZyV/JPezScy0l7Kp0kKRtrbSnH3Gpsr4G+1yZIoFOjbrEkOpFtnJJeFOZNx7tNU1sqmsyfjyUbtEUrkGZPbFG6AU+/PZHkild0TZoYwJe0vDk3t7bN20A7+YYZKZoW0JlcEG5wSSETXrjfqgx6sYgs1kC2YiToCNCSROK2oDkiOwECu11ToYEtMLmRDrAHu55ALc1xhqDPH0VEDSUOEMjWAfdRtfoKKp6p2HuwrQybs4ZaMhbJovMgLbWthDGvgoZuADaAtqIwQdiBI5BvKbON2dj0EWERls9QdGdHaSqREMCVQgubzkCO9MmlyFqMi5gCX1AFrHkgSTxfOHlCYRauMYHrAUyM4RJSyVyBoUrETj1qIRgS8iRI3jxhQpkUdpa44ppKp6MU/BORgZpA6468FHEY9CWKxeazpe+BtuE+eBkLmPn4MnJW0ap8CXZKY9PTu7tKdxtMXWLOVPEh697+M/n80ewf3oo84ri6zaHn9E7pujCcic9oVi3eWqVfSXbj07TK7SY8LPXCDsdpSv4cecJdVij8cNrjIIQHp5dXaQp+xQ+/Po7XKIOFmo379BatAHNEia9KclcV/kubdshCZVLwKsl40UHvoC/tMhxm0FfigrqmmeTw6s2N1RAxMYbHXEMZ+APSVBoCzlCEVDLwhQXuNYCpBlp0GDITgdwZpfQyhKaU6wTBoSehDvJTlAyr3dVroJrgOIAXrs5zjBkSQeLmCwzLCkmXVtnKDKaapBcD1iRMTCncoJxfPTNoAMCNjmWJZYS9Z7ZHCuBO0UgBhaKwFcsD+CmxmWS1TNNRsskIduB2sl9JJlFW3pHNvIYyqCruNXM2c5ICpuc/QipS5LehpVt1PTfmxY7qgQP4F5G7dF4PpyiASsMYjG15A44njZAuesBB4LDfwNYWbwyj3SR7gJsNJluT3x/rCftaAwNv6muMcyowM2u+kSvDhPzUGXKUIGWcW/3n726uoQZfDMYqWxv6/2Nvh1eXvxw/tP1uXgjM7LL2LPBaDASknccG233TB3eyMcba7W7iv75Rb1ZrhEXceiNpnTOpKhWmzvkTs13d3ztOApptco149tg1msh/9JikAPnIVMzHUhQm86brF/JcrhMcSnpKwr0cpnNtGm7vX50zx0cRS/PL89vzlWmZLgcXgPTdA1sfoiB/sku99QfngmdD/JXbpaPCqxW3aWxXm/5u6dPSmxi7Lklhw/r9fpPbLKa7Q==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/v1.1/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/v1.1/createfolder"}}');var n=t(74848),i=t(28453),p=t(33617),l=t.n(p),r=t(17543),d=t.n(r),a=t(86013),c=t.n(a),h=t(63723),u=t.n(h),b=(t(18766),t(79329),t(9303));const k={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u20YQfpXJXtoYtKSk6aE61WiMxKjRGLUDH2wjWJJDcaLl7nZnqR8IAnroG/QN+mh5kmKWov6cpE1b9GKLs/M/3/ysVNQTVuM7dYt57dxUPWSqRC4C+UjOqrG6qRFeosGIsOGBs6sL0Ma4OSxdC9FB2b3PN+9tMCpTzmPQouSiVGPVsfRWMhWQvbOMrMYr9Xw0kn+Hhq/bokDmqjWwVaUyVTgb0Ubh194bKtLD8D2L0EpxUWOj5VdcelRj5fL3WESVKR9ETaTOZEBuTdzj4xjITlSmcKEbb4TUx9v5XgJvPTLLJ2q9zlSkmDjJGrL4rg/q3fPR6N13ar0WnhejF4+De8sYwLoIlWtt+eS/iwtDcOHzYR3b/lwg4nwfxrePw7iwM22oTIi4cVO0/28k++ZjZ15cXTRG5KxuupASU3pXB6Hu07sgGYs2UFyq8d1KLU61p9PufXz3sH7IVIOxdjs4i8861mqshvMtshnDDAMnFdIJY1XH6Hk8HLK2Ze4WA+fRMk2s0TkPCtcMtafh7NngmVpnxzLa+y/ix/b0S0U46gnZyV/JPezScy0l7Kp0kKRtrbSnH3Gpsr4G+1yZIoFOjbrEkOpFtnJJeFOZNx7tNU1sqmsyfjyUbtEUrkGZPbFG6AU+/PZHkild0TZoYwJe0vDk3t7bN20A7+YYZKZoW0JlcEG5wSSETXrjfqgx6sYgs1kC2YiToCNCSROK2oDkiOwECu11ToYEtMLmRDrAHu55ALc1xhqDPH0VEDSUOEMjWAfdRtfoKKp6p2HuwrQybs4ZaMhbJovMgLbWthDGvgoZuADaAtqIwQdiBI5BvKbON2dj0EWERls9QdGdHaSqREMCVQgubzkCO9MmlyFqMi5gCX1AFrHkgSTxfOHlCYRauMYHrAUyM4RJSyVyBoUrETj1qIRgS8iRI3jxhQpkUdpa44ppKp6MU/BORgZpA6468FHEY9CWKxeazpe+BtuE+eBkLmPn4MnJW0ap8CXZKY9PTu7tKdxtMXWLOVPEh697+M/n80ewf3oo84ri6zaHn9E7pujCcic9oVi3eWqVfSXbj07TK7SY8LPXCDsdpSv4cecJdVij8cNrjIIQHp5dXaQp+xQ+/Po7XKIOFmo379BatAHNEia9KclcV/kubdshCZVLwKsl40UHvoC/tMhxm0FfigrqmmeTw6s2N1RAxMYbHXEMZ+APSVBoCzlCEVDLwhQXuNYCpBlp0GDITgdwZpfQyhKaU6wTBoSehDvJTlAyr3dVroJrgOIAXrs5zjBkSQeLmCwzLCkmXVtnKDKaapBcD1iRMTCncoJxfPTNoAMCNjmWJZYS9Z7ZHCuBO0UgBhaKwFcsD+CmxmWS1TNNRsskIduB2sl9JJlFW3pHNvIYyqCruNXM2c5ICpuc/QipS5LehpVt1PTfmxY7qgQP4F5G7dF4PpyiASsMYjG15A44njZAuesBB4LDfwNYWbwyj3SR7gJsNJluT3x/rCftaAwNv6muMcyowM2u+kSvDhPzUGXKUIGWcW/3n726uoQZfDMYqWxv6/2Nvh1eXvxw/tP1uXgjM7LL2LPBaDASknccG233TB3eyMcba7W7iv75Rb1ZrhEXceiNpnTOpKhWmzvkTs13d3ztOApptco149tg1msh/9JikAPnIVMzHUhQm86brF/JcrhMcSnpKwr0cpnNtGm7vX50zx0cRS/PL89vzlWmZLgcXgPTdA1sfoiB/sku99QfngmdD/JXbpaPCqxW3aWxXm/5u6dPSmxi7Lklhw/r9fpPbLKa7Q==",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,M={},P=[];function x(e){const o={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,n.jsx)(l(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,n.jsx)(d(),{parameters:void 0}),"\n",(0,n.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function S(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/d480dde9.9cb61f73.js b/assets/js/d480dde9.9cb61f73.js new file mode 100644 index 000000000..bffabf75a --- /dev/null +++ b/assets/js/d480dde9.9cb61f73.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3230],{94677:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>v,contentTitle:()=>I,default:()=>q,frontMatter:()=>u,metadata:()=>a,toc:()=>m});const a=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/isTXtoIa0lJ00N1qpEYqVEjMWoHPshCwN0d7TLikgyHqwcEATn0H/TUa39afkkxpFYvJ2nTFr3oMZz3fPNYiyArEqOxuMO8tnYmJpkokQqvXFDWiJG4rRFeoMaAsOWB8+tLkFrbBaxsC8FCmd4X2/fWa5EJ69BLVnJZipFILJ2VTHgkZw0hidFaPB0O+evY8E1bFEg0bTXsVIlMFNYENIH5pXNaFfFh8I5YaC2oqLGR/CusHIqRsPk7LILIhPOsJqhk0iO1OhzwUfDKVCITuJSN00zq4k2+l0A7j/TqkdhsMhFUiJzKaGXwbRfU26fD4dsfxGbDPM+Gzx4G94bQg7EBprY15aP/Li703vovh3Vq+0uBsPNdGN8/DOPSzKVWZUTErZ2h+X8jOTQfknl2ddloljOySSFFpvgujkI9pKcgCYvWq7ASo/FaLM+kU2fpfTSebCaZaDDUdg9n9lmGWozEYLFDNqGfo6eogjthJOoQHI0GA5KmzO2ybx0aUpXRMqd+YZuBdGowf9J/IjbZqYx07qv4sT37WhEKslKm+iu5yT49N1zCVKWjJO1qJZ36GVci62pwyJUJxdCpUZboY72UmdoovK3Ma4fmRlUm1jUaPx1Kd6gL2yDPnlAjdAIff/0jypS2aBs0IQIvanh0b+7N69aDswv0PFOkKWGqcalyjVEIm/hG3VAjlI1GIr0CZQJWXgaEUlUqSA2cI2UqKKSTudKKQctslqU9HOCe+nBXY6jR89M3HkFCiXPUjHWQbbCNDKyqcxoW1s+m2i4oAwl5S8ogEaCppSmYsatCBtaDNIAmoHdeEQIFz16r5Js1wcsiQCONrJB1Z0epKlErhip4m7cUgKxuo8sQpNLWYwldQAaxpD4n8WLp+AmYWtjGeawZMnOEqlUlUgaFLREo9iiHYErIkQI49kUVSKy0NdoWs1g8HqfgLI8MJTXY6ZGPLB68NDS1vkm+dDXYJcx5y3MZk4O93htCrvCVMjMa9Xr35gzGO0zdYU4q4OTbDv6LxeIB7B8fy7xU4ac2h1/QWVLB+tVeulKhbvPYKodKdn+SppdoMOLnoBH2Okpb0MPOY+qgRu0GNxgYITQ4v76MU/YxfPzwG1yh9AZqu0hoLVqPegVVZ4ozlyqf0rYbkjC1EXg1Z7xI4PP4vkUKXQbvahk+fvid4BUuQKUWSons9a7bXKsCbrFxWgakXm8Ezz2yydDRINQyQCEN5AhUS4bSXEmQ4JK0VmbWh3Ozgpa30UKFOoKB6VHuKAzOy67cBLkkLMGaKNHZ7O89YnpDqOdIrItXXY6ApeIlHmpv2ypZO3RmG5zHqdIa7lRZYYixnZcluC15kcjx5tm7g1NuiFDjCqRHIDShD9cnIvGldc569kIl56eWzyguAJrSWWUCjaD0chr2+rM90AtOs7LmE6SUQrlLR7ZVsytJ6sRtxDtq/54H8skQP561Hqfo2WAMe18Xp7ZwGnewBEbrv4E1r2eeWrKI1wM2Uum0TX481RM3OfqGXk9v0M9VgduN9pmOHkTmgciEVgUawoML4fzl9RXMv+sPRXawGv9Gcw+uLp9fvLq5YGd4kKaEPekP+0MmOUuhkebA0vEhfbrW1vvT6Z+f3dsNHHAZBk5LFW+eGNV6e6yMxWJ/7NeWApPWa+6qN15vNkx+36LnK2iSibn0Sua8mMeTTdbtbb5uZrji7BUFOj7f5lK3afmfHH1Hl9OLi6uL2wuRCZ5AxyfDLJ4M2x9soHsyqwP1x7dE8oE/+bD5pMB6nc6RzWbHn54+K7GNsePmHE42m82f8GaqNA==","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=t(74848),l=t(28453),d=t(33617),i=t.n(d),n=t(17543),p=t.n(n),r=t(86013),k=t.n(r),c=t(63723),h=t.n(c),b=(t(18766),t(79329),t(9303));const u={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VktvGzcQ/isTXtoIa0lJ00N1qpEYqVEjMWoHPshCwN0d7TLikgyHqwcEATn0H/TUa39afkkxpFYvJ2nTFr3oMZz3fPNYiyArEqOxuMO8tnYmJpkokQqvXFDWiJG4rRFeoMaAsOWB8+tLkFrbBaxsC8FCmd4X2/fWa5EJ69BLVnJZipFILJ2VTHgkZw0hidFaPB0O+evY8E1bFEg0bTXsVIlMFNYENIH5pXNaFfFh8I5YaC2oqLGR/CusHIqRsPk7LILIhPOsJqhk0iO1OhzwUfDKVCITuJSN00zq4k2+l0A7j/TqkdhsMhFUiJzKaGXwbRfU26fD4dsfxGbDPM+Gzx4G94bQg7EBprY15aP/Li703vovh3Vq+0uBsPNdGN8/DOPSzKVWZUTErZ2h+X8jOTQfknl2ddloljOySSFFpvgujkI9pKcgCYvWq7ASo/FaLM+kU2fpfTSebCaZaDDUdg9n9lmGWozEYLFDNqGfo6eogjthJOoQHI0GA5KmzO2ybx0aUpXRMqd+YZuBdGowf9J/IjbZqYx07qv4sT37WhEKslKm+iu5yT49N1zCVKWjJO1qJZ36GVci62pwyJUJxdCpUZboY72UmdoovK3Ma4fmRlUm1jUaPx1Kd6gL2yDPnlAjdAIff/0jypS2aBs0IQIvanh0b+7N69aDswv0PFOkKWGqcalyjVEIm/hG3VAjlI1GIr0CZQJWXgaEUlUqSA2cI2UqKKSTudKKQctslqU9HOCe+nBXY6jR89M3HkFCiXPUjHWQbbCNDKyqcxoW1s+m2i4oAwl5S8ogEaCppSmYsatCBtaDNIAmoHdeEQIFz16r5Js1wcsiQCONrJB1Z0epKlErhip4m7cUgKxuo8sQpNLWYwldQAaxpD4n8WLp+AmYWtjGeawZMnOEqlUlUgaFLREo9iiHYErIkQI49kUVSKy0NdoWs1g8HqfgLI8MJTXY6ZGPLB68NDS1vkm+dDXYJcx5y3MZk4O93htCrvCVMjMa9Xr35gzGO0zdYU4q4OTbDv6LxeIB7B8fy7xU4ac2h1/QWVLB+tVeulKhbvPYKodKdn+SppdoMOLnoBH2Okpb0MPOY+qgRu0GNxgYITQ4v76MU/YxfPzwG1yh9AZqu0hoLVqPegVVZ4ozlyqf0rYbkjC1EXg1Z7xI4PP4vkUKXQbvahk+fvid4BUuQKUWSons9a7bXKsCbrFxWgakXm8Ezz2yydDRINQyQCEN5AhUS4bSXEmQ4JK0VmbWh3Ozgpa30UKFOoKB6VHuKAzOy67cBLkkLMGaKNHZ7O89YnpDqOdIrItXXY6ApeIlHmpv2ypZO3RmG5zHqdIa7lRZYYixnZcluC15kcjx5tm7g1NuiFDjCqRHIDShD9cnIvGldc569kIl56eWzyguAJrSWWUCjaD0chr2+rM90AtOs7LmE6SUQrlLR7ZVsytJ6sRtxDtq/54H8skQP561Hqfo2WAMe18Xp7ZwGnewBEbrv4E1r2eeWrKI1wM2Uum0TX481RM3OfqGXk9v0M9VgduN9pmOHkTmgciEVgUawoML4fzl9RXMv+sPRXawGv9Gcw+uLp9fvLq5YGd4kKaEPekP+0MmOUuhkebA0vEhfbrW1vvT6Z+f3dsNHHAZBk5LFW+eGNV6e6yMxWJ/7NeWApPWa+6qN15vNkx+36LnK2iSibn0Sua8mMeTTdbtbb5uZrji7BUFOj7f5lK3afmfHH1Hl9OLi6uL2wuRCZ5AxyfDLJ4M2x9soHsyqwP1x7dE8oE/+bD5pMB6nc6RzWbHn54+K7GNsePmHE42m82f8GaqNA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},I=void 0,v={},m=[];function f(e){const o={p:"p",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,s.jsx)(i(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,s.jsx)(p(),{parameters:void 0}),"\n",(0,s.jsx)(k(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function q(e={}){const{wrapper:o}={...(0,l.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.3c2250f9.js b/assets/js/da66eb9c.3c2250f9.js deleted file mode 100644 index 8e62340fa..000000000 --- a/assets/js/da66eb9c.3c2250f9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>I,contentTitle:()=>h,default:()=>b,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":"eJzdWO9uG7kRf5U5fmkSrCUl51xRfap7FyRGg0SIbQSoYwjc5ayWZy7JI7mSBUFAP/QN+gZ9tHuSYsjd1epPnKR3aIF+MWTucDjz43DmN7NhgS88m96yn0zR1KiDZ3cZE+gLJ22QRrMpu64QbqzgAaGTgovZJXClzMpD49F5CAZqI2S5Bq4FNEk8VAgCA5fKgymBg7dYyFIWIFpFI3hnoiAPECrpo2Kj1brTHkynjEOJK7Dc8RoDOp/B2jRQcK1NgKLiepEOLKVCMLpAkCFZ0BktPRQOeUAxYhkzFh0nFy8Fm7J0SOcfy9juIDa93TDNa2RT1umaS8EyJgkey0PFDjG7/Ikc3js9+qgRRXQqx9Yv0uPwl0Y6FGwaXIMZ82Gt6DQva6uQZQwfrDIC2bTkypNAUWHN2XTDwtpGyeCkXrCMlcbVPOxWttu7pB99+IsRa9qzb+rMmaUUCDkqM8B3gHzA2ioe0MMTHkAh9wGMxoFs58BTlrHC6EAQTjeMW6tkEUEe/+zptM2x6Sb/GYuIuKMrCRI9fU2Af9lBAodHmKbMxx895GybMW3CN6uZkYsIDpcSVzGevVzoFJ9D3Xs4ftsRfVQMdWxpjxLoKCKP9e12kyRqnit8fz0biObGKOT6KBopquAsOWDiIqykUpB0wPvrGSzR0cOMdzWCm/imo4zDAuWSnt9QBAojEJaSA9ZcqgxWlSwqCvg11I0PgLqNoRY6HDz5GMRwBscGCelPWpSldCD1YpdujhSDkA6LoNawkqEyTQAuhKTtXIEPaP1oiGK0ogfy2jTutyPJYdFIgQKCaRyUxkUrY7Ky8ZmRB1L74JqCNnsQDd1u9INE6bd1pkDvdzh1qJDQQH8GqH3azqHkPqDLoNGSkHeNDSh6lfhg0UnUBZ6EIII7j/m7Bdx/PRYzdLUMvvOUroYLAagw1hPwTVEBT995aBz6DKSWQXLlM/CB19ZnYBwEfKC8AsFYSp74IH0g41dSLDB4kJ+Low9Ib6QY2FA6U8fbJ2z0ehgIvV3BHKi7pkuVvq1aJW9UgCVXzWnMHKZwmzdOnXqt+1hdpcKHSfvNh7ewqtBhf+/oUhzllHaSYqQyGl8aHRy6KOmj/TBcjjIEb4KZO6ylFvg1sX2FIYJC1xpMH9JNMDUPsoBOlR9BK5ouIJhhhNbwpAMvx4ovpXFPPwMgqZtTpZ5LPccluvXASt3UObojI9/FZYoPwdcecgwrRD20rbvGxCJSBSLbVhVq2MOEpPzO6T0rX263GQsy7GXr+aD8z3OqptvtNrrirdE+Fa4Xk8lxke2JU1v06VXQrZWNUuvvfr+qmZa/VD+4Fy/e+Nn5G0tx0pp0ER7f9GLy4vuz55OzyR+vn/8wPf/T9OUPo8lk8jeWsYda7Uo2I21siF78f7AgtZIa5x1q8xeTyfz7FsrzU+i1Bdm2TGXJlRRQSlQC6Ez/OwKIzhn3HxKGR+x7zH1yuXP+/JHQIZ5bmkaL/7W7pyx63MHz+Xnv4stjFy91gozI/7W5R/3f8HDnz/D4kI4nU/ejWiah+J3tOTtcT056LBonwzp2Dg9n3Mqz9H16e0d8vMZQGeo6bJNajVCxKRt32WW8GeSZLSN9btk1IrHcsCoE66fjseda5OZhZCxqKgiK535UmHrMrRwvn4+es212uIdb+03y2Jx96xYf+ELqxZf23e2guqLrTDe2B1h/b9zKv+KaZd19DKXaTqxCTpWOboCi5MOu63nV3XV/nYetQtcpfB35P6xKJ+n8kM0ztsfY2zZuSD3bpZNUrP22TzlI5UGJ7+VOVdaXW4KpNBHTNnjfW9RX5B6FfryTQ88+oipMjR1b6jb8+o9/xT2d46kpIA3ffdKf9PvGgTUrdGWjIoalwgdJVZg2YR2/+djAE5NHXiv0Xq2ByOvCUdMp5EIGIu4tzSm45blUkt41iRna7WCQGvwIPlYYKnT06Q+O6LjAJSpKBz2P0YsdhVoZd1/SmCEDDnnjpUbvAXXFdUGCXXBGesp1amqskx7BB0dWy2Sb0cHxIkDNNV9EfpntQSVQSXrB4ExO3ZE3qkn8n4YjxkVGnxyKE4IRgfiKmn6HQKtEAh1W9JKWbRPgs9SEpUgmF7SAHH0AS7bIAtP0RCtT3KfJSKMUWENZVXJFHGpoI20PjmtPqT/Z0t1BD1jLNTEZ+OzZjUe64bdS3/vps2ef9Bnc9jH1EXMvA9496bLCarU6ygZP9/e8luFNk8MHtMbLYNx6t3shQ9XkMYMMlfT/JE2vUWOMn0F+2OkQpvDHCYlWxxUqO77CQBHixxezy1iInsKvf/8nvEXuNFRmlaK1aByqNSy6owi5dPMJtr6OxA6QN6EixIsUfO0spkcwjVhkejwthrMmV7Lo5y5TuAC7v0RzL2oW2nlWylMVp0CippyDkvp+BBd6HRvm2BHHGKD1uDnt3CU4vrvl2D3JMII3ZkXJI2ub7nbWhqIdrPXGyOBRlaNousOSGpnUtE0P/vfAHQLWOQrqYuXesTmWFO4yJF6uIzGPJxOpx3Xcy5dcqsjn23awNN1kALWwRurgpyAcL0Ov2We7Q6LbcaJwtJRA4r1bWaumH3+lJ3ZwE34EnyjXH1St/SzqsERHJ8YnuQscK9tAue0CDigOf0vAEjehfMSLSJ3ieCaVzz8f6ok0Bl3t35dX6JaywLaEf+atjqPwmGVMyQK1H9bTi9ezt7CE70cTlg3IwFe82/Hbyx9fvbt6RdZQjkyIPR9NRhNassaHmuvBUQez6MOStdkxx//X0XVLiWhgMraKy0hI2zlEIpO3bMBVpsOp9V3GKuMDiWw2Ofd449R2S8u/NJEn3N5lbMmdpEcWGWfb3IueX3wW7icfujkwfNsA/KRDHfHTxPriICaRnntcH0zit3fbrGN/ZHGS+DHZdXZNenYajpoJoq9px0VRoA2Pyg7Z++zmmmUsb6fqdRzQM8dXNNHnq2RsGhJGXhvXNkxxvWj4gmSTym2a1VT7ZPc+kt32Bzl1Eo59Fpy8oL/k08kNm00i0tttL58+fXZHi2snTXdzt91u/w3fv0SW","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 a=n(74848),i=n(28453),s=n(33617),d=n.n(s),p=n(17543),r=n.n(p),l=n(86013),c=n.n(l),u=n(63723),m=n.n(u),f=(n(18766),n(79329),n(9303));const y={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWO9uG7kRf5U5fmkSrCUl51xRfap7FyRGg0SIbQSoYwjc5ayWZy7JI7mSBUFAP/QN+gZ9tHuSYsjd1epPnKR3aIF+MWTucDjz43DmN7NhgS88m96yn0zR1KiDZ3cZE+gLJ22QRrMpu64QbqzgAaGTgovZJXClzMpD49F5CAZqI2S5Bq4FNEk8VAgCA5fKgymBg7dYyFIWIFpFI3hnoiAPECrpo2Kj1brTHkynjEOJK7Dc8RoDOp/B2jRQcK1NgKLiepEOLKVCMLpAkCFZ0BktPRQOeUAxYhkzFh0nFy8Fm7J0SOcfy9juIDa93TDNa2RT1umaS8EyJgkey0PFDjG7/Ikc3js9+qgRRXQqx9Yv0uPwl0Y6FGwaXIMZ82Gt6DQva6uQZQwfrDIC2bTkypNAUWHN2XTDwtpGyeCkXrCMlcbVPOxWttu7pB99+IsRa9qzb+rMmaUUCDkqM8B3gHzA2ioe0MMTHkAh9wGMxoFs58BTlrHC6EAQTjeMW6tkEUEe/+zptM2x6Sb/GYuIuKMrCRI9fU2Af9lBAodHmKbMxx895GybMW3CN6uZkYsIDpcSVzGevVzoFJ9D3Xs4ftsRfVQMdWxpjxLoKCKP9e12kyRqnit8fz0biObGKOT6KBopquAsOWDiIqykUpB0wPvrGSzR0cOMdzWCm/imo4zDAuWSnt9QBAojEJaSA9ZcqgxWlSwqCvg11I0PgLqNoRY6HDz5GMRwBscGCelPWpSldCD1YpdujhSDkA6LoNawkqEyTQAuhKTtXIEPaP1oiGK0ogfy2jTutyPJYdFIgQKCaRyUxkUrY7Ky8ZmRB1L74JqCNnsQDd1u9INE6bd1pkDvdzh1qJDQQH8GqH3azqHkPqDLoNGSkHeNDSh6lfhg0UnUBZ6EIII7j/m7Bdx/PRYzdLUMvvOUroYLAagw1hPwTVEBT995aBz6DKSWQXLlM/CB19ZnYBwEfKC8AsFYSp74IH0g41dSLDB4kJ+Low9Ib6QY2FA6U8fbJ2z0ehgIvV3BHKi7pkuVvq1aJW9UgCVXzWnMHKZwmzdOnXqt+1hdpcKHSfvNh7ewqtBhf+/oUhzllHaSYqQyGl8aHRy6KOmj/TBcjjIEb4KZO6ylFvg1sX2FIYJC1xpMH9JNMDUPsoBOlR9BK5ouIJhhhNbwpAMvx4ovpXFPPwMgqZtTpZ5LPccluvXASt3UObojI9/FZYoPwdcecgwrRD20rbvGxCJSBSLbVhVq2MOEpPzO6T0rX263GQsy7GXr+aD8z3OqptvtNrrirdE+Fa4Xk8lxke2JU1v06VXQrZWNUuvvfr+qmZa/VD+4Fy/e+Nn5G0tx0pp0ER7f9GLy4vuz55OzyR+vn/8wPf/T9OUPo8lk8jeWsYda7Uo2I21siF78f7AgtZIa5x1q8xeTyfz7FsrzU+i1Bdm2TGXJlRRQSlQC6Ez/OwKIzhn3HxKGR+x7zH1yuXP+/JHQIZ5bmkaL/7W7pyx63MHz+Xnv4stjFy91gozI/7W5R/3f8HDnz/D4kI4nU/ejWiah+J3tOTtcT056LBonwzp2Dg9n3Mqz9H16e0d8vMZQGeo6bJNajVCxKRt32WW8GeSZLSN9btk1IrHcsCoE66fjseda5OZhZCxqKgiK535UmHrMrRwvn4+es212uIdb+03y2Jx96xYf+ELqxZf23e2guqLrTDe2B1h/b9zKv+KaZd19DKXaTqxCTpWOboCi5MOu63nV3XV/nYetQtcpfB35P6xKJ+n8kM0ztsfY2zZuSD3bpZNUrP22TzlI5UGJ7+VOVdaXW4KpNBHTNnjfW9RX5B6FfryTQ88+oipMjR1b6jb8+o9/xT2d46kpIA3ffdKf9PvGgTUrdGWjIoalwgdJVZg2YR2/+djAE5NHXiv0Xq2ByOvCUdMp5EIGIu4tzSm45blUkt41iRna7WCQGvwIPlYYKnT06Q+O6LjAJSpKBz2P0YsdhVoZd1/SmCEDDnnjpUbvAXXFdUGCXXBGesp1amqskx7BB0dWy2Sb0cHxIkDNNV9EfpntQSVQSXrB4ExO3ZE3qkn8n4YjxkVGnxyKE4IRgfiKmn6HQKtEAh1W9JKWbRPgs9SEpUgmF7SAHH0AS7bIAtP0RCtT3KfJSKMUWENZVXJFHGpoI20PjmtPqT/Z0t1BD1jLNTEZ+OzZjUe64bdS3/vps2ef9Bnc9jH1EXMvA9496bLCarU6ygZP9/e8luFNk8MHtMbLYNx6t3shQ9XkMYMMlfT/JE2vUWOMn0F+2OkQpvDHCYlWxxUqO77CQBHixxezy1iInsKvf/8nvEXuNFRmlaK1aByqNSy6owi5dPMJtr6OxA6QN6EixIsUfO0spkcwjVhkejwthrMmV7Lo5y5TuAC7v0RzL2oW2nlWylMVp0CippyDkvp+BBd6HRvm2BHHGKD1uDnt3CU4vrvl2D3JMII3ZkXJI2ub7nbWhqIdrPXGyOBRlaNousOSGpnUtE0P/vfAHQLWOQrqYuXesTmWFO4yJF6uIzGPJxOpx3Xcy5dcqsjn23awNN1kALWwRurgpyAcL0Ov2We7Q6LbcaJwtJRA4r1bWaumH3+lJ3ZwE34EnyjXH1St/SzqsERHJ8YnuQscK9tAue0CDigOf0vAEjehfMSLSJ3ieCaVzz8f6ok0Bl3t35dX6JaywLaEf+atjqPwmGVMyQK1H9bTi9ezt7CE70cTlg3IwFe82/Hbyx9fvbt6RdZQjkyIPR9NRhNassaHmuvBUQez6MOStdkxx//X0XVLiWhgMraKy0hI2zlEIpO3bMBVpsOp9V3GKuMDiWw2Ofd449R2S8u/NJEn3N5lbMmdpEcWGWfb3IueX3wW7icfujkwfNsA/KRDHfHTxPriICaRnntcH0zit3fbrGN/ZHGS+DHZdXZNenYajpoJoq9px0VRoA2Pyg7Z++zmmmUsb6fqdRzQM8dXNNHnq2RsGhJGXhvXNkxxvWj4gmSTym2a1VT7ZPc+kt32Bzl1Eo59Fpy8oL/k08kNm00i0tttL58+fXZHi2snTXdzt91u/w3fv0SW",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,I={},g=[];function v(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,a.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,a.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,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(r(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,a.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,a.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/da66eb9c.c63a2c44.js b/assets/js/da66eb9c.c63a2c44.js new file mode 100644 index 000000000..ecee101cc --- /dev/null +++ b/assets/js/da66eb9c.c63a2c44.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>A,contentTitle:()=>g,default:()=>F,frontMatter:()=>f,metadata:()=>o,toc:()=>j});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":"eJzdWF9vG7kR/ypzfGlirCUlca6onurmgsSokQixjQB1DIG7nNXyzCV5JFeyIAi4h36DPvW1Hy2fpBhyV1r9iZP0Di3QF0PmDoczvxlyfjMrFvjMs/Et+8kUTY06eHaXMYG+cNIGaTQbs+sK4cYKHhA6KTifXABXyiw8NB6dh2CgNkKWS+BaQJPEQ4UgMHCpPJgSOHiLhSxlAaJVNIB3JgryAKGSPio2Wi077cF0yjiUuADLHa8xoPMZLE0DBdfaBCgqrmfpwFIqBKMLBBmSBZ3R0kPhkAcUA5YxY9FxcvFCsDFLh3T+sYxtD2Lj2xXTvEY2Zp2uqRQsY5LgsTxUbB+zi5/I4Z3To48aUUSncmz9Ij0Of2mkQ8HGwTWYMR+Wik7zsrYKWcbwwSojkI1LrjwJFBXWnI1XLCxtlAxO6hnLWGlczcN2Zb2+S/rRh78YsaQ9u6ZOnJlLgZCjMj18e8gHrK3iAT084QEUch/AaOzJdg48ZRkrjA4E4XjFuLVKFhHk4c+eTlsdmm7yn7GIiDsKSZDo6WsC/OsOEjg8wjRmPv7YQM7WGdMmfLeaCbmI4HAucRHz2cuZTvnZ172D4/cdscmKvo417VECHWXkob7tbpJEzXOF768nPdHcGIVcH2QjZRWcJgdMXISFVAqSDnh/PYE5OrqYMVYDuIl3Oso4LFDO6fr1RaAwAmEuOWDNpcpgUcmiooRfQt34AKjbHGqhw96Vj0kMp3BokJD+qEVZeg6knm2fmwPFIKTDIqglLGSoTBOACyFpO1fgA1o/6KMYrdgAeW0a99uR5DBrpEABwTQOSuOilfGxsvGakQdS++CagjZ7EA1FN/pBovTbOlOg91ucOlRIqKc/A9Q+bedQch/QZdBoSci7xgYUG5X4YNFJ1AUehSCCO43vdwu4/3YsJuhqGXznKYWGCwGoMNYT8E1RAU/feWgc+gyklkFy5TPwgdfWZ2AcBHygdwWCsfR44oP0gYxfSDHD4EF+KY8+IN2RomdD6Uwdo0/Y6GU/ETZ2BbOn7pqCKn1btUreqABzrprjmDlM6TZtnDp2W3exukqFD5P2mw+XsKjQ4Sbu6FIe5fTsJMVIZTTeNDo4dFmyyfb9dDl4IXgTzNRhLbXAb8ntKwwRFAprMJuUboKpeZAFdKr8AFrRFIBg+hlaw5MOvBwrPpfGPf0CgKRuSpV6KvUU5+iWPSt1U+foDox8F5cpPwRfesgxLBB137YujIlFpApEti0q1LCDCUn5rdM7Vr5crzMWZNh5rae98j/NqZqu1+voirdG+1S4no9Gh0V2Q5zaok+3gqJWNkotf/j9qmZa/lr94F48f+snZ28t5Ulr0nl4fNPz0fMXp89Gp6M/Xj/7cXz2p/HLHwej0ehvLGMPtdqWbEbaWB+9+H9vQWolNU471KbPR6PpixbKs2PotQXZtkxlzpUUUEpUAuhM/zsCiM4Z9x8Shkfse8x9crlz/uyR1CGeW5pGi/+1u8csetzBs+nZxsWXhy5e6AQZkf9rc4/6v+Hh1p/+8SEdT6buZrVMQvE723G2v56c9Fg0ToZl7BweTrmVp+n7+PaO+HiNoTLUddgmtRqhYmM27F6X4ar3zqwZ6XPzrhGJ5YZVIVg/Hg491yI3DwNjUVNBUDz3g8LUQ27lcP5s8Iyts/093Nrvksfm9Hu3+MBnUs++tu9uC9UVhTNFbAewTdy4lX/FJcu6ePSl2k6sQk6VjiJAWfJh2/W87mK9Ced+q9B1Ct9G/ver0lE632fzjO0w9raN61PPdukoFWu/7VIOUrlX4jdyxyrryzXBVJqIaZu87y3qK3KPUj/GZN+zj6gKU2PHlroNn//+r7inczw1BaThh0/6k37fOLBmga5sVMSwVPggqQrTJqzjNx8beGLyyGuF3qslEHmdOWo6hZzJQMS9pTkFtzyXStK9JjFDux30ngY/gI8VhgodffqDIzoucI6KnoMNj9GzLYVaGHdf0pghAw5546VG7wF1xXVBgl1yRnrKdWpqrJMewQdHVstkm9HB8SJAzTWfRX6Z7UAlUEm6weBMTt2RN6pJ/J+GI8ZFRp8cihOCAYH4mpp+h0CrRAIdVnST5m0T4LPUhKVMJhe0gBx9AEu2yALT9EQrU9ynyUijFFhDr6rkijhU30baHhzXnp7+ZEsXgw1gLdfEZODJyY1HivCl1Pd+fHLySZ/C7SanPmLuZcC7J92rsFgsDl6Dp7t73sjwtsnhA1rjZTBuud09k6Fq8viC9JVs/kma3qDGmD+992GrQ5jCHz5ItDqsUNnhFQbKED88n1zEQvQUPv/6D7hE7jRUZpGytWgcqiXMuqMIuRT5BNumjsQOkDehIsSLlHztLKZD8GPFw+df/+nhHS6ow6ErlIA8OZk0uZIFXHfjl5OTMbyKA6zeSCaOlQquqXXwFadUoracg027ldT3AzjXy9g5x9Y4JgOtx307bsS3rgu3h5x7FLEnq7ZnDrYWRcLvUc3Rd5O4HAGFJIobKmeaWTqtb0zrnMOSOp6Pqbsj386FANsud00fNRdbc7A0qWlaAncIPvZtk70t8UtjrXFkRds1lqYbIKAW1kgd/BiE42XY6s+2iR7nhHHwcLCUIOQbOLJWzSYk6Sa2Hm9WB5+oIuzVtt231mGJjg6Mbm/jYmWbTrddWgJl629Ja2Iw9GrxIhKsOMRJRfbP+3oi2UFX+/flFbq5LLAt9F+40cMoPGQZU7JA7ftV9/zN5BLmLwYjlvUYwzdc7uHlxavX765ekzH0kCbAng1GgxEtWeNDzXXvpL2B9X5dW23p5f/rfLvlTTRVGVrFZWSt7bAiMc5b1iM04/5o+y5jlfGBRFYregRunFqvafmXJpKJ27uMzbmTxF8iLW0nAGJDQr4I95MP3bAYvm9KftShjh1qooZxWpOY0T0u98b167t11lFEsjhJvEp2nV6Tnq2Gg46DOG7acV4UaMOjsn2KP7m5ZhnL29F7Haf4zPEFjf35IhmbJomR/Ma1FVNczxo+I9mkcp0GOtUuI76PjLj9QU4dhWOXKicv6C/5dHTDapXY9nq9kU+fvrijxbWTptjcrdfrfwNBkFPd","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"}}');var i=n(74848),s=n(28453),a=n(33617),r=n.n(a),d=n(17543),c=n.n(d),p=n(86013),l=n.n(p),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const f={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWF9vG7kR/ypzfGlirCUlca6onurmgsSokQixjQB1DIG7nNXyzCV5JFeyIAi4h36DPvW1Hy2fpBhyV1r9iZP0Di3QF0PmDoczvxlyfjMrFvjMs/Et+8kUTY06eHaXMYG+cNIGaTQbs+sK4cYKHhA6KTifXABXyiw8NB6dh2CgNkKWS+BaQJPEQ4UgMHCpPJgSOHiLhSxlAaJVNIB3JgryAKGSPio2Wi077cF0yjiUuADLHa8xoPMZLE0DBdfaBCgqrmfpwFIqBKMLBBmSBZ3R0kPhkAcUA5YxY9FxcvFCsDFLh3T+sYxtD2Lj2xXTvEY2Zp2uqRQsY5LgsTxUbB+zi5/I4Z3To48aUUSncmz9Ij0Of2mkQ8HGwTWYMR+Wik7zsrYKWcbwwSojkI1LrjwJFBXWnI1XLCxtlAxO6hnLWGlczcN2Zb2+S/rRh78YsaQ9u6ZOnJlLgZCjMj18e8gHrK3iAT084QEUch/AaOzJdg48ZRkrjA4E4XjFuLVKFhHk4c+eTlsdmm7yn7GIiDsKSZDo6WsC/OsOEjg8wjRmPv7YQM7WGdMmfLeaCbmI4HAucRHz2cuZTvnZ172D4/cdscmKvo417VECHWXkob7tbpJEzXOF768nPdHcGIVcH2QjZRWcJgdMXISFVAqSDnh/PYE5OrqYMVYDuIl3Oso4LFDO6fr1RaAwAmEuOWDNpcpgUcmiooRfQt34AKjbHGqhw96Vj0kMp3BokJD+qEVZeg6knm2fmwPFIKTDIqglLGSoTBOACyFpO1fgA1o/6KMYrdgAeW0a99uR5DBrpEABwTQOSuOilfGxsvGakQdS++CagjZ7EA1FN/pBovTbOlOg91ucOlRIqKc/A9Q+bedQch/QZdBoSci7xgYUG5X4YNFJ1AUehSCCO43vdwu4/3YsJuhqGXznKYWGCwGoMNYT8E1RAU/feWgc+gyklkFy5TPwgdfWZ2AcBHygdwWCsfR44oP0gYxfSDHD4EF+KY8+IN2RomdD6Uwdo0/Y6GU/ETZ2BbOn7pqCKn1btUreqABzrprjmDlM6TZtnDp2W3exukqFD5P2mw+XsKjQ4Sbu6FIe5fTsJMVIZTTeNDo4dFmyyfb9dDl4IXgTzNRhLbXAb8ntKwwRFAprMJuUboKpeZAFdKr8AFrRFIBg+hlaw5MOvBwrPpfGPf0CgKRuSpV6KvUU5+iWPSt1U+foDox8F5cpPwRfesgxLBB137YujIlFpApEti0q1LCDCUn5rdM7Vr5crzMWZNh5rae98j/NqZqu1+voirdG+1S4no9Gh0V2Q5zaok+3gqJWNkotf/j9qmZa/lr94F48f+snZ28t5Ulr0nl4fNPz0fMXp89Gp6M/Xj/7cXz2p/HLHwej0ehvLGMPtdqWbEbaWB+9+H9vQWolNU471KbPR6PpixbKs2PotQXZtkxlzpUUUEpUAuhM/zsCiM4Z9x8Shkfse8x9crlz/uyR1CGeW5pGi/+1u8csetzBs+nZxsWXhy5e6AQZkf9rc4/6v+Hh1p/+8SEdT6buZrVMQvE723G2v56c9Fg0ToZl7BweTrmVp+n7+PaO+HiNoTLUddgmtRqhYmM27F6X4ar3zqwZ6XPzrhGJ5YZVIVg/Hg491yI3DwNjUVNBUDz3g8LUQ27lcP5s8Iyts/093Nrvksfm9Hu3+MBnUs++tu9uC9UVhTNFbAewTdy4lX/FJcu6ePSl2k6sQk6VjiJAWfJh2/W87mK9Ced+q9B1Ct9G/ver0lE632fzjO0w9raN61PPdukoFWu/7VIOUrlX4jdyxyrryzXBVJqIaZu87y3qK3KPUj/GZN+zj6gKU2PHlroNn//+r7inczw1BaThh0/6k37fOLBmga5sVMSwVPggqQrTJqzjNx8beGLyyGuF3qslEHmdOWo6hZzJQMS9pTkFtzyXStK9JjFDux30ngY/gI8VhgodffqDIzoucI6KnoMNj9GzLYVaGHdf0pghAw5546VG7wF1xXVBgl1yRnrKdWpqrJMewQdHVstkm9HB8SJAzTWfRX6Z7UAlUEm6weBMTt2RN6pJ/J+GI8ZFRp8cihOCAYH4mpp+h0CrRAIdVnST5m0T4LPUhKVMJhe0gBx9AEu2yALT9EQrU9ynyUijFFhDr6rkijhU30baHhzXnp7+ZEsXgw1gLdfEZODJyY1HivCl1Pd+fHLySZ/C7SanPmLuZcC7J92rsFgsDl6Dp7t73sjwtsnhA1rjZTBuud09k6Fq8viC9JVs/kma3qDGmD+992GrQ5jCHz5ItDqsUNnhFQbKED88n1zEQvQUPv/6D7hE7jRUZpGytWgcqiXMuqMIuRT5BNumjsQOkDehIsSLlHztLKZD8GPFw+df/+nhHS6ow6ErlIA8OZk0uZIFXHfjl5OTMbyKA6zeSCaOlQquqXXwFadUoracg027ldT3AzjXy9g5x9Y4JgOtx307bsS3rgu3h5x7FLEnq7ZnDrYWRcLvUc3Rd5O4HAGFJIobKmeaWTqtb0zrnMOSOp6Pqbsj386FANsud00fNRdbc7A0qWlaAncIPvZtk70t8UtjrXFkRds1lqYbIKAW1kgd/BiE42XY6s+2iR7nhHHwcLCUIOQbOLJWzSYk6Sa2Hm9WB5+oIuzVtt231mGJjg6Mbm/jYmWbTrddWgJl629Ja2Iw9GrxIhKsOMRJRfbP+3oi2UFX+/flFbq5LLAt9F+40cMoPGQZU7JA7ftV9/zN5BLmLwYjlvUYwzdc7uHlxavX765ekzH0kCbAng1GgxEtWeNDzXXvpL2B9X5dW23p5f/rfLvlTTRVGVrFZWSt7bAiMc5b1iM04/5o+y5jlfGBRFYregRunFqvafmXJpKJ27uMzbmTxF8iLW0nAGJDQr4I95MP3bAYvm9KftShjh1qooZxWpOY0T0u98b167t11lFEsjhJvEp2nV6Tnq2Gg46DOG7acV4UaMOjsn2KP7m5ZhnL29F7Haf4zPEFjf35IhmbJomR/Ma1FVNczxo+I9mkcp0GOtUuI76PjLj9QU4dhWOXKicv6C/5dHTDapXY9nq9kU+fvrijxbWTptjcrdfrfwNBkFPd",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,A={},j=[];function b(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(r(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(c(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(l(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},auto_reminder:{type:"boolean",description:"Set to true to enable automatic reminders. Set to false to disable them (default behavior).",example:!1},remind_once_in_every:{type:"number",description:"Number of days between reminders. This is only applicable when auto_reminder is set to true.",example:5}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function F(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.e02902d6.js b/assets/js/runtime~main.10a1f6ec.js similarity index 88% rename from assets/js/runtime~main.e02902d6.js rename to assets/js/runtime~main.10a1f6ec.js index 9f4e37211..ccb537840 100644 --- a/assets/js/runtime~main.e02902d6.js +++ b/assets/js/runtime~main.10a1f6ec.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"91c9b890",89:"67599f09",108:"b9723cd9",157:"be2f595e",285:"8525544f",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2e9f4f9b",849:"ea176c57",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"9ff4fd96",1665:"49c09fa4",1679:"d0313598",1688:"2582d322",1706:"ef1d6397",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"8c0b1fd9",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"3c2250f9",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"6bd1b863",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"93c9778f",3460:"b41b8b05",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3795:"663bc6a4",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"c9604a6f",4240:"ad7d3608",4372:"b85a286f",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"9d2164c5",4865:"c8c9648e",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"b0ea3081",5373:"d17e846d",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"1dc1445c",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"9efeca49",6235:"17916d14",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"eeca88c9",7054:"cab4fa5c",7068:"b64a0c73",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"5e457a22",7910:"5b11649a",7960:"8c485554",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"eb383529",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"540e438b",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"81affa8f",8901:"c9e66b6d",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"caa1985b",9099:"90f34d82",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"f80b7cac",9426:"4597631d",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=b,t.c=r,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({33:"7ad5624c",89:"3009d411",108:"1b14d97a",157:"8001f939",285:"23f866da",291:"4f7a2d40",300:"833eda7d",419:"e5d81aec",448:"d77fb6a8",490:"ce589067",539:"cfb1e6eb",560:"500027af",636:"eaa24e23",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",930:"05729a5b",956:"19e4dfff",962:"046910c8",1179:"489b8a4d",1235:"a7456010",1440:"277a78f5",1477:"2f6ff211",1640:"c9fa5aa5",1651:"19e5ad2a",1665:"7357a3c5",1679:"138cee78",1688:"9640838e",1706:"18b84479",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2043:"ac7da374",2089:"c7b98810",2131:"299c7a47",2264:"17e5210b",2634:"c4f5d8e4",2661:"8bd80e56",2703:"da66eb9c",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3128:"c674cfb4",3148:"1e1b513c",3230:"d480dde9",3249:"ccc49370",3276:"e5aefb32",3333:"e48228d1",3381:"42f80fc5",3392:"reactPlayerVidyard",3404:"03e06346",3460:"5ce6d213",3633:"b97a0b7b",3637:"f4f34a3a",3694:"8717b14a",3795:"c4fbe420",3841:"56b5f4f8",3891:"8e4d0438",3976:"0e384e19",4001:"d281bdbe",4106:"882238ec",4134:"393be207",4212:"621db11d",4232:"5a144266",4240:"9c9cb35e",4372:"9cd612ce",4466:"56b0ffe9",4584:"f82cd581",4813:"6875c492",4833:"c7e3ab5f",4865:"7ef59f7a",4952:"6bef026b",5277:"8320e026",5305:"87a6df42",5314:"88a819d0",5342:"4227e71a",5373:"02e5f5c4",5506:"01274ace",5510:"02d4f5c5",5524:"21f05a2f",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5752:"6d2e526e",5794:"3b49dc44",5855:"444a2573",5881:"63d7f7ab",5939:"837d4f04",5970:"0f8cf55d",6007:"611db08b",6011:"56f1c106",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6192:"c195e1f1",6235:"d0524430",6288:"eedafdee",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6463:"reactPlayerKaltura",6473:"4c5e977b",6505:"cd2b86eb",6648:"0c0943c7",6653:"f214d5ff",6743:"e226bb09",6841:"f22c5875",6887:"reactPlayerFacebook",6940:"a000203c",6969:"14eb3368",7024:"98334e25",7068:"e92d0461",7098:"a7bd4aaa",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7574:"70276854",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7904:"5144c8d4",7910:"e4f5c862",7960:"b2e6bd40",7968:"489197af",8e3:"54a7b8f4",8025:"5e90a9b3",8046:"6621d3c0",8097:"ab2a161b",8110:"825a5e83",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8168:"6c0cc40d",8209:"01a85c17",8446:"reactPlayerYouTube",8462:"3217192f",8474:"652d83be",8503:"012b45bf",8564:"58abd73c",8609:"925b3f96",8734:"reactPlayerPreview",8737:"7661071f",8749:"b93339ed",8901:"1c57a399",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9070:"851f8f65",9099:"34593b53",9190:"6cb65baf",9239:"0c806540",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9350:"62b755e6",9426:"38ec836e",9490:"02fcf422",9570:"a3008c1e",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9979:"reactPlayerSoundCloud"}[e]||e)+"."+{33:"6ad534f5",89:"67599f09",108:"b9723cd9",157:"be2f595e",285:"89427f12",291:"4d88e708",300:"d5462c6f",419:"26112334",448:"3492c614",490:"a197b5a8",539:"ddb32cf1",560:"183f80db",636:"23fdfdd6",746:"49f86803",841:"2e9f4f9b",849:"ea176c57",850:"3ac080ec",930:"9f35584c",956:"e6fef687",962:"0758599a",1179:"955bead1",1235:"e0fce024",1440:"5dc69857",1463:"6c989e27",1477:"c7a939ea",1640:"d2ce80bf",1651:"f6c81f16",1665:"56289604",1679:"9f7fe758",1688:"2582d322",1706:"23ffef42",1903:"9c2000d9",1924:"fdb8fe31",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2043:"b0aacfe5",2089:"4267cecd",2131:"920ad619",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2661:"881ab85e",2703:"c63a2c44",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"16d5d1b8",3021:"8265c79a",3042:"040aac0d",3073:"cff2425c",3128:"e29762a5",3148:"9a6039c4",3230:"9cb61f73",3249:"d6c50b29",3276:"00ab24d9",3333:"099c2226",3381:"dfcbba2f",3392:"a7951473",3404:"0d5f551b",3460:"4901096f",3633:"d2a8f664",3637:"ffa80471",3694:"4d710693",3795:"13bfbdc1",3841:"cf1c6a97",3891:"c8de3ba8",3976:"2d4c4f66",4001:"183be27c",4106:"d9d3f988",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4232:"686c24b3",4240:"683dbb00",4372:"56e55e5e",4466:"8b9f41be",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4833:"786c2d78",4865:"e7cadeec",4952:"9881366e",5013:"b10f6f78",5277:"b2de11fb",5305:"760fdd56",5314:"2ddf281e",5342:"34e886ef",5373:"2b72627a",5506:"9d141ac4",5510:"92a4db7d",5524:"47dbdaaf",5550:"76bbef59",5557:"dffbf1c4",5597:"3dcd4c42",5742:"ac359952",5752:"89e61fc0",5794:"c75a31d7",5855:"84d22ac9",5881:"3782c030",5939:"07a6668d",5970:"91dc704f",6007:"bc61a38c",6011:"1a38abf2",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6192:"5e9d7258",6235:"86082012",6288:"cb1b5f05",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"c48fddc9",6463:"665cb544",6473:"0243df4f",6505:"c6903d64",6648:"2847553a",6653:"fdbc0c47",6743:"a3fe848c",6841:"50291cb3",6887:"f478ac9c",6940:"fd8689e0",6969:"408561bf",7024:"0914355c",7054:"cab4fa5c",7068:"b64a0c73",7085:"2efbf216",7098:"c920e4e4",7318:"2bd572be",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7574:"d5e60f67",7627:"df6df631",7643:"4bb958af",7696:"d7f04e0f",7757:"13e692a4",7904:"3387244e",7910:"5b11649a",7960:"26bd5237",7968:"14065b3d",8e3:"58f8ce85",8025:"18e81984",8046:"eb383529",8097:"43a7d9e8",8110:"f2fff490",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8168:"11595f0e",8209:"b9e31ef1",8446:"594ab8ca",8462:"d040ed86",8474:"97c5edc0",8503:"45b8fe0a",8564:"fdfdf0e6",8609:"6bdc8628",8734:"1f259505",8737:"f138d21c",8749:"c3230296",8901:"ef3d0d2a",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9070:"069815d8",9099:"9a97a9b7",9190:"dd359a70",9239:"cb86fd3c",9241:"c62c9d6a",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9350:"65eb58f6",9426:"4597631d",9490:"9b8fc054",9570:"4cdcbf30",9611:"6c00e256",9647:"2f22c378",9858:"678dd4bc",9979:"84827225"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="OpenSign-Docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325",70276854:"7574","7ad5624c":"33","3009d411":"89","1b14d97a":"108","8001f939":"157","23f866da":"285","4f7a2d40":"291","833eda7d":"300",e5d81aec:"419",d77fb6a8:"448",ce589067:"490",cfb1e6eb:"539","500027af":"560",eaa24e23:"636",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","05729a5b":"930","19e4dfff":"956","046910c8":"962","489b8a4d":"1179",a7456010:"1235","277a78f5":"1440","2f6ff211":"1477",c9fa5aa5:"1640","19e5ad2a":"1651","7357a3c5":"1665","138cee78":"1679","9640838e":"1688","18b84479":"1706",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",ac7da374:"2043",c7b98810:"2089","299c7a47":"2131","17e5210b":"2264",c4f5d8e4:"2634","8bd80e56":"2661",da66eb9c:"2703","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",c674cfb4:"3128","1e1b513c":"3148",d480dde9:"3230",ccc49370:"3249",e5aefb32:"3276",e48228d1:"3333","42f80fc5":"3381",reactPlayerVidyard:"3392","03e06346":"3404","5ce6d213":"3460",b97a0b7b:"3633",f4f34a3a:"3637","8717b14a":"3694",c4fbe420:"3795","56b5f4f8":"3841","8e4d0438":"3891","0e384e19":"3976",d281bdbe:"4001","882238ec":"4106","393be207":"4134","621db11d":"4212","5a144266":"4232","9c9cb35e":"4240","9cd612ce":"4372","56b0ffe9":"4466",f82cd581:"4584","6875c492":"4813",c7e3ab5f:"4833","7ef59f7a":"4865","6bef026b":"4952","8320e026":"5277","87a6df42":"5305","88a819d0":"5314","4227e71a":"5342","02e5f5c4":"5373","01274ace":"5506","02d4f5c5":"5510","21f05a2f":"5524","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","6d2e526e":"5752","3b49dc44":"5794","444a2573":"5855","63d7f7ab":"5881","837d4f04":"5939","0f8cf55d":"5970","611db08b":"6007","56f1c106":"6011","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173",c195e1f1:"6192",d0524430:"6235",eedafdee:"6288",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353",reactPlayerKaltura:"6463","4c5e977b":"6473",cd2b86eb:"6505","0c0943c7":"6648",f214d5ff:"6653",e226bb09:"6743",f22c5875:"6841",reactPlayerFacebook:"6887",a000203c:"6940","14eb3368":"6969","98334e25":"7024",e92d0461:"7068",a7bd4aaa:"7098",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757","5144c8d4":"7904",e4f5c862:"7910",b2e6bd40:"7960","489197af":"7968","54a7b8f4":"8000","5e90a9b3":"8025","6621d3c0":"8046",ab2a161b:"8097","825a5e83":"8110","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","6c0cc40d":"8168","01a85c17":"8209",reactPlayerYouTube:"8446","3217192f":"8462","652d83be":"8474","012b45bf":"8503","58abd73c":"8564","925b3f96":"8609",reactPlayerPreview:"8734","7661071f":"8737",b93339ed:"8749","1c57a399":"8901",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","851f8f65":"9070","34593b53":"9099","6cb65baf":"9190","0c806540":"9239","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","62b755e6":"9350","38ec836e":"9426","02fcf422":"9490",a3008c1e:"9570","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858",reactPlayerSoundCloud:"9979"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/authors/index.html b/blog/authors/index.html index 8e54f76e8..dd7b4537c 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 918b7b064..d6c1e8090 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 4896c76ca..84ecd4c2f 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 7b0043e09..7a66addf5 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 990bf8b3d..a9f01e093 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 84d65aa68..311df6167 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 8900e7d8f..236cbf75f 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 07ed74fa5..574ed8c51 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 64292b719..ac4bf3f8b 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 57962fc28..331b9fe42 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 e9364ce3d..38061ca12 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 6446d770f..be4449497 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 7f5176b67..26c17a145 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 298989167..881f6cf1d 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 df573b8b7..53595ce0e 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 ae3ec088e..43ef81aaf 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 700f93354..a466995aa 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 a15837271..1a7c1bff6 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 962ac1ed7..e9b6cac11 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 a0df732db..ab2b4fb76 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 6c165cb9f..fea9be4f2 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 3064117ca..bce8e2608 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 a91b2e21a..001f94b93 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 aaae3beca..b2c12ee8c 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 3930b38ae..d60543a1f 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 447c3a7da..24bfb229f 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 3e85bbdb9..304530707 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 62e155166..75777ee7e 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 609f69e46..fd2194627 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 063a162cf..df75a46b4 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/getdocument/index.html b/docs/API-docs/v1.1/getdocument/index.html index 9ceba80cd..5d5b16935 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 98390efc9..8cd499432 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 afd23bdad..842273bb8 100644 --- a/docs/API-docs/v1.1/getfolder/index.html +++ b/docs/API-docs/v1.1/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/v1.1/gettemplatelist/index.html b/docs/API-docs/v1.1/gettemplatelist/index.html index 33fb30fa8..5b15e13c2 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 d21fb3a09..aa6060d6d 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 d2c4718d7..6cf18d19a 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 7c5176332..9b6aaf1f7 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™ - + @@ -20,14 +20,14 @@
  • OpenSign GitHub Repository
  • Generate x-api-token – Learn how to securely generate and manage your API token for authenticating requests.
    • -

    Update in v1.1:

    +

    What’s New in v1.1

      -
    • Public template: A public template can be created and shared via a link. Any user with the link can create and sign a document from it. However, users cannot edit the template itself.
      • -
    • Prefill widget: Prefill widgets are embedded in a document before it is sent to users. They are available in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates.
      • +
    • 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.
      • +
    • 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.

    Authentication​

    Security Scheme Type:

    apiKey

    Header parameter name:

    x-api-token

    -

    License

    AGPL v 3.0

    +

    License

    AGPL v3.0

    \ No newline at end of file diff --git a/docs/API-docs/v1.1/publictemplate/index.html b/docs/API-docs/v1.1/publictemplate/index.html index adfb30da9..22c5a1fa0 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 88b3f2131..fcdef09f9 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 1b48229f7..5bdf2f482 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 4f3d03cb6..7cb7bee07 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 795f9068f..7bb5bb60d 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 be5d64ab5..2ae834a85 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 2a359309d..c0fb299cc 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 23bde2061..df18a347b 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 f745103f9..33279d001 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 1ffbd8c9a..f8bb38372 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 1dd61b872..debdaaf41 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 8235021c9..e73660449 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 b913345ba..3cc81ad26 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 32d1d7eca..cb342f34e 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 6e52d2ca7..e2357c803 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 0a43fd191..4247ade7c 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 af7e64922..be0f44017 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 91078d496..2790e288f 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 be47b86e1..43812503d 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 1545ff4d2..cff06e1ee 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 8bebe17cb..95f157ca0 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 daf83b3bd..4ff288a94 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 718f5eb59..47a441884 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 c300a0925..dfbde1e0e 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 40683307b..bc0d8ba9e 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 663ebf167..a786760ad 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 cd0bf0239..5b427b046 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 e04b3ae77..568196ff4 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 298748c2a..619f03976 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 683958b86..e65601139 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 2aef87bc3..b189b9ab3 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 8d209ecc0..4be961e13 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 4a50343af..ec6a09c67 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 7dcad4f8b..ccf95323e 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 ba966f3d2..fa7593c1c 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 5d4d1c9b6..cc5c35f70 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 266e40b3b..c3f34fb51 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 c7dc717c0..d5a3d1ecd 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 f41179645..e0cd29fca 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 41836efa1..9e1743b82 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 71e1c0a36..2507bce3c 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index bd992445b..b8c2044b4 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 77a33dca3..b6425d7ba 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 b95849004..81ca3a8fe 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 b37864acd..47eb7b043 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 1d029d060..681a26853 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 83f029663..a69769a4d 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 304283c8c..88e3dd8cd 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 3cb4f23af..a33040fa4 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 5bf56a7d1..8cd4f3945 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 0a8f2094a..92a73e6b0 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 ffcbe36fa..b54e4f7f9 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 7a5147d60..54a9df03d 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 ab87bf33b..acb31ddc6 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html index 42a092a94..4e8455933 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index 2c95d5fc3..accb57475 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 3eb9d1eed..9e9ccb814 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 28fd6d16a..66f2eaeb7 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index 1ec627c9e..a0a52e4d7 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 390b4cc1f..39da55e6b 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 037f24973..9aa052bdd 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index a5abd6561..32bcc3820 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 a1961e7ca..82520a4a5 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 92f8cdaad..a5d2e01d7 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 d50a01e57..27dcb9a2c 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 6b627d553..53295ff70 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 54bef8cfb..af0f0a2f5 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 52e849c27..148ad9b8f 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 7ed888383..41e216e3d 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 77d80c5b0..08d67feef 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 3dc6d03f7..fda5ca8f0 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 e0cf1c7f0..4aad4d27a 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 1b94d9d6e..c44d52fc0 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 a710dac17..e988d4248 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 62298313a..a8af194c1 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 101b30ac5..88a9f6bad 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 ed1611dd3..b1ecdee79 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 2001f889a..554d719be 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 6a0d4d282..068787605 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 70c39efd0..e61059eda 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 3744ddfce..1144d209e 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 1137dc5ab..7ec019ef1 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 0a78f31a1..f8672c6f2 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 9c506c190..00347133c 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 d37360c57..e4dede9c5 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 2101829bf..61ebe40ea 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send the Document for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index d0d8333d2..a2d72b539 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index 88c0cd522..e35416bf7 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 21c5daecc..8f85469a9 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 dbe08d8e7..65a3e6dd4 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 44eb5f339..16107f4de 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 087f88428..6fff95d90 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 e3077b794..3d093159b 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 f9fed1bbf..2eb4dbc0e 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 56ca7aa33..78e0f199e 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 b9628f5d4..54e73ee7b 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 91adb4bd7..138c500c2 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 1fecd3669..b50f6713d 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 ea0db4a66..90cc5f894 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 59f774cb2..85fbffe1d 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +