diff --git a/404.html b/404.html index ea8a4359c..1c8943536 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.678503c7.js b/assets/js/0028a090.678503c7.js new file mode 100644 index 000000000..84f66a697 --- /dev/null +++ b/assets/js/0028a090.678503c7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/drafttemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/drafttemplate","permalink":"/docs/API-docs/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO912GzfOr8Kdm7Y6I9lSHDf11bqJmyob/2zs/No+KTUDaRjPkBOSY1nx0d0+yT7aPskegORoJFm2k/bruufTja0hQRIAARAEgevI8pGJdk6jEyjKnFsw0XkcpWASLUorlIx2opMMWOhmzzQfWiFHbPeoz0DyQQ6GVQa0YVaxRAMCJZWxqhBfsJfZMHPMDOhLHMsNG+QVlFpIa9hQaTYCCZrTxKlKqgKwYyxsxkoNKQyFhJQZq6vEVhpMh70ulWSmShIwZljlbmWhJFNDxus1Y2YzIFQ12EpLwzirpPhcAWu11OATJLaftlrs+xSMGEluIUXkwvCPIv0hZuNMJBlLuGQDQFJTpNQjDA10Bxz7lKQ1TQmJGAoE9pN12G6aCsSR5/kkZpy1WpXOWy0mDCu1uhQppGE1NRwiSzmxlglpQQ95AsQrwFnkiJYJkzMuUzbkiciFnWcjS4WxWgwqXLlzJs/kiSh32OsyVzxlE1VpdvTslxm4VQzbTlutZzCoRux1v9U6/z6ztjQ7Gxu8LDuqBIncyvnAdBJVbKQIWKZD4hVowFmJX8CNyCeMpykbi3QE1tCGSJaocsISpXQqpBONko+AyaoYgDYxUVMoDUxIxpkGnk7aVrUrA+zF8eEBsqHgtsOO8srE9XKp0JDYfOKmR/YEqr5zu7O9hTIk5ChmBb9ALgnLPlciuUCyDUjaWi8yxKtW6y3iW3NHGC/jKWM2E4aNYZApdcHgErvHIs+Z1WI0At1qncnffvvtTF6fScbOIoI4i3bYWeSnOIti12UnJbieZ4dPX+/vHZx8PHl/tFf3B0ldgOk/qyGGIl+c4fWrl3W35MVi98Hu/mwBqazvP8qBG2AaLgWMaR9wqx2tgQv1sIadcKPrHhwE2mDrKbYwdu3+zWNz3H9+sPeqiYuDgIKLfA5kb3+3/3IOpsyUnJ/m6NfDg/l5Kt2YpX/w3DHF9U/x37nH1+/Irt+gk/7+3vHJ7v4RAk/9PqI0HFdlqTRu/1sn0Du4zWfyZ8jVmHENJD2JKgolWck1L8CSbcy4pW4NnyuhIXXGjed50IydM9lmrRaKwk6rxfoyFQmqhlPzSQlo2Rxsx4GiyiDosTc1DrShSGiLnDlBDRlzp91ljoYEQTWglbLiEuYnvorZBCd+BigXbtpMafFFSctzEopL0FYkPG8qMSJIps9yTSaoVELa0OpXYO+9sqIuk4p6K4OopcisQkjqMcAueV6B8ViNY5YhVq+g1GDI4vp5kZEyZRmIUbZyPZ5+qoydm5hVJtjRgIVfK+wSsReIbUOeG2BiOMfLgl9AYzWmSmffO+znCUthyKvcxkyg/bG6gg47UJbxssxFQmcjmnN38FQa2rTLXhw8IqgqiMSROx/wREgFng1obbCTpvBjAnYoZ+5AQfLIjtqMS6bkwkYnKld6WYSoeZ6PLFHSgrQdtnvJRU7IO2INEzLJqxTYIOfJRUwne8w0nmW4KxPIczWOnbwTCJ2wxHPiDzOQoxQqifhL5ZcXZnaGdtgJ2p9an7AzsJoWEabJVW/DhwpXRhYEFWNkV2JiXMw+qQGzwuYQo8KWXE5iljqnAa7sQF3FLMkguaBfmqdCsUFlrZKOsFSrMlVj6Xk5VNIa8eUGjQw9X8/RXsy2YrYdsycx627GrNuLWXcrZt3tmHWfxKy3GbNeL2a9rZj1th1avSee17xmcBOBbs9x2f51uIt296UwpNloME1tg8dzNrjbYa1WrU2Lx+/sjK1B6tMKbSb2df33FX486v3oPyf4ud174j/HBNrd8p8Zfva6zXOiR5hYXpS3YIHdfygGwVlwQoRt/sw9i4I9w0Y0RHHomB3FHh/smDZpeYS0CCms4LlZTU6AeEAUzVBaImoLiSJxXU2R90EeDDlNfMhlQTPpusisNrqCwhMWvSXqH3f8ybKaeLfsg6G9gc7vI30bSUfTdIKmaTX9tfV6QExYxOn3ceLHDjkAZJlX88EDPCAuzGP0+3jwBHmAh9JqBmDvA6K+gY67gNEJ7/o2t9rdx+3eZm9rjgN4U3YARdFO0/ZkMvkjuIc+j18eXZ7goTrPDiMSQ62KG64fdDuYQXmfiH4Hl30fHfUB1EERjALMx1TC/b/pZVuV8sl3xk0VhtbOGcLPXLNJA03qQjwoFpJkSiQeeYQJLtkAL3gd5EGbOLmRphsNTmJjmraLor3QiJ9tYnyjsSg6adpZgFzaHddYsDSN2XLzje1pyoqiWNHs2s8icql+QtH3nthq6fcAf5YCzOR8fuFblQOjQ0rmtDZd0m7WjoUjJBMhGONFhS0AaBhVOddwhbdNsxjh+AM1JyjOzF+n2yld7FyIj1jBvj/0PvkPXqiRhPkJsOXucUuUNSfRMIIrmsMFcREZkVJoNcZ4a4a3Nx5cf+T7LGpHXwkvBUYJcrCWWsEmnZuQcLvWuGHjri5esA3YOWK4YWHkDXds2n4S7+4mHW/+gnHL+eYhHpCJX0AJO124wgXTooKTB4BSBrPfymagz6Lzeoy7VUN6x9jze+hRJlLI+QDy5a5760CTFi9PDcZgRyFkHQkgfDcbgbyCXy10ns2CeAu65ShuCnUw4kE1AotZLkyIhczzqznaB4sohCfBhf8HwMIANqjF8HeLeY3Y/eTcWQG/OXcsgXCMAOtAXVjtjhXmNqbJGJyjEFIUVVFHHIf1rIFlhT/Nm/zCkfiyEVZo7u7SCvzqjhX808yKBc5klyIDIaJwi6/nIR6QMVhA6XY9/RYzMXdG/kGH290KGMhqKuANRyKCusOwVj6zWvs67BAPIIxyukEYt0oSKC3GuH6vatYo3/sIoihQM7K1WvKaUA9I+m5A6/9YAj3cnyOFTfL+QpI4h/a9pdHF8Qo+uuWyS90PSP48PgubG8WRKilbQMl+Gu1EKeYkhJfwKKaZwdifVTqJdq4jH2jHnz6MjSM3PhnMbriOTJJBwfFXwAjzIfBBNYrDO2YURxR5weQIZFe0499koxjvDyW+hoHBOWjcznWAcs/NUezv4dFO5N6hoziCK16UCOybGMhE4W2XppiGFW+bq26ZzWXoR50XgPPgI943TkNDpwsJId80U3OG6Yyvs8m41nwSLeaehNe7cElz4+rniXwSlERYVIX6SYnAojgSFormKit2Tauv53QCCimhsOzXjqVt4cVXr4nj6N37Wwb615IbeH5PLrne5YXnt2wXL4eQBre5PXvgjBk9MnTukpgAT9TyUXNN5wQurXmy6uG78d5mMlXlKb5kAdcden/+5kQXynXieVJR7k19OMxRVqNaU9adxtHV3cRcsUS1w6s6+z6HoWVVWYJmidIS9A/N0NqDIa63tTWNo8nd5E3+kuT9iJs3vpu6t5SOMEvV+F/g+ujJNI6yu3H9tU6Y+B8iu7U9nZ11Pg+nzr8bqHTyMdit6V2A4VBBOEzm6stDnYJuMGKgVA5cLnGiP3TelWLfoSvynY9l0Tu30CYcKC6/S0MCmDNDIelgq5h3OtwjOPNvj+iU7WEDOYumGhiEkmE+4yYcQMgZwyRHByFckiC95ANPMsxOsw4rPsRHesr1wTQtVZmAXsYNPbbngP6ozUC49BIhR/POYYM7lGjRpL3T3B1swUOOEj0PT47uwUtyXdsuY8yd045KNwc7PDnC7CEx9H5Yh702NScCa/kcCEO/iF0KHjIMats+cdEFkMQRFXLVZol/HZ+302bLCKXC3IhRPItv1omtSxPPkg1xi1RlMcvRZ3cyY6E0c3wkLGpGnqjqPlJ5Byc5G1X0PGJRZUMqEcVcZ9k/QrqsWbr4pJUOCU9eLBASU2hnfApcQaDG/DEDadxwzobcWNAxptIi53WFF5t6SrgqQQuQCdzIAg2OdR8rfaPfNM+D+VSa169e+hTTQENQygFqoJsYUlaVJDWkCXWKV9i5RdKXHCXUDtAfVzloy64HJWL5oFoJ2mAasmZKj7gUX3xaMnokygAbQMZzB+pNBT4uIT6o4fPIBFv7n3/9u4HXSo9zGTG3Ak9TjPTfgSFdbJ3Ao8etoUQLqOYxwvlA/33xEEDsSGk+FiqtFcncX8aPMO/PmtouWkVZw5CDy60OLw+1vTVxsLHGu5X4AKHpoYBysFWJ9MKVMLaRpBSeEpftwytAPiYNHMgNQa1GmZeTpoLXePlkqNl0lEol5hPc6mNwQRduP87ceTe7k3pTjEmbShrnkfc2N/HfwsaHnPCQqTxLk88nf4vi+1+Ib78OhKzkm0RxJjE/Z71fTSmLJEMhWaHzM/DbXY3mRX8DJi+ywfNEHIoX/ddf+t0D0Td9+epx8rS/3b8o3715+uKnDkxedJPem8m73hv7/m1u+p+USH59kX2Qb8zg6ePq/bsP+v27vn7/9pXlbx/vDmQmB89/Ecnk8adBb1O8fPpi88Pb7njw/JfND29+Kj/Q5L9sfri42EyKg6cDuYsw5ft3/xSHn/Ye7X/Z+7J/sne1/yX/qcMPPn96epX8tH+xt93+0Nft/cPBPz59tuWrx+mjg3di+wnsw1t5svkyiZrSIGQuJHwMW/2R6P6Imz0lodi6aduPVQE2I1mnVHStMM+9dPncVk8YH3EhGbJO/4FSAForffuefh1mtzFia3PzY7dmwuNlJvQlvS9RyceJugD551LaXN665RHVq4Kk3h0okXBA1B/NEdtsd0QaSCot7CTaOb2Ortq8FG3Xv3N6Pj2PI2SswhhYqQxhzG0W7UQbiyExrLyheMvptdPBWtEMlym+AS0pGy/FxmU3msaLI25UzZXQULW/boCxfCTk6PZR5zPWHOP2uR2aY9AsylGKfwCGOTz/m1BxJFBsMuB4UUCOo1S8mgUQ98LehtDejdG62SYuxt9C+G0uorZ4CN4QI2uEyE5DfIpCTnXEKZpRFNVRIfxZx3lOZ6Jah1RCRKVLoYje1hbd2X/s0uX20RO6N25tT88dhxt3KArRNi8CLvI/59H6pnkPL4oWPKo5t2bRq1npYaxwMIJXKeRQ0Z77fTgsQR6j046qeNldvqdDnqiizmYO4P/5179pRDjQaZm/scNKs1KNQWOpGZVa5XAl0E1GYELMUBiSwvS8yMEYjE1KCyNXJSZGlBURfM+El3yAxVro2Qpplcs+apgn02FvM8DHEuz6TrsEkUvI0SSxXCmqX0I/qbKqaFaisbHSF0NECYvMBljkgN6fAQhDQGZcJvh04VSIPCes10JvvtTCAOOiQGCqNxsORSJwYjSkmieWFVzyEblAMcULkAtlKFHQaoCXMqPyyl07sFACwDoS6emkw57hNY8Ix8YULG576m4cJnY3Pm9XfT3YAG/XJS4vEjCzVLIcLkGTyXD39SrPWamsu0OjD9jcW5zIai4NRiQcQmFravb5ewGtkfJJh+H7CZ5h6B2jAORCXrh6ndNazN7CwAgLs1jJeDxeMl8/zI95LmxWDdDTVrNxI2okY9ccXn/8gMYGdGEOh8dYTpkEr2nFmhsEvOGPQZ7QMRiUjZfiRl8+FwlIA41Da/f50Ut2yR51NqO4YbDvgfDGy/7TvYPjPZwXzyCnf93OZmeTArzK2ILLxlJUYlpXnC5qbuM9Z12Zuq5MXVemritT15Wp68rUdWXqujJ1XZm6rkxdV6auK1PZujJ1XZn6J9G+rkxdV6auK1PXlanrytR1Zeq6MnVdmbquTF1Xpq4rU9eVqevK1HVl6roydV2Zuq5M/f9VmeoTrtAr3ChzLmQj69Ul550u1Kuex1GGyXs7p9H1Nb4Fv9b5dIrNnyvQmPl3HkeXXAuMcVPeXxzy1TDD6wIm0U701IXs2ye4fOyknfI7FtIdMd3OjdilXb8VtplfeHR4fBLF0cDX1BYqxTGaj7Helo9dmpdnJlVUciqWyrkcVZRwFrk5McWOVzabz8+7oPw8/6ORt8blpIHhfOKeIwP/IlE3Dri+drl/02kN77pWjvCMDdC4fefT6fS/y6PRig==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"}}');var s=t(74848),r=t(28453),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 f={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO912GzfOr8Kdm7Y6I9lSHDf11bqJmyob/2zs/No+KTUDaRjPkBOSY1nx0d0+yT7aPskegORoJFm2k/bruufTja0hQRIAARAEgevI8pGJdk6jEyjKnFsw0XkcpWASLUorlIx2opMMWOhmzzQfWiFHbPeoz0DyQQ6GVQa0YVaxRAMCJZWxqhBfsJfZMHPMDOhLHMsNG+QVlFpIa9hQaTYCCZrTxKlKqgKwYyxsxkoNKQyFhJQZq6vEVhpMh70ulWSmShIwZljlbmWhJFNDxus1Y2YzIFQ12EpLwzirpPhcAWu11OATJLaftlrs+xSMGEluIUXkwvCPIv0hZuNMJBlLuGQDQFJTpNQjDA10Bxz7lKQ1TQmJGAoE9pN12G6aCsSR5/kkZpy1WpXOWy0mDCu1uhQppGE1NRwiSzmxlglpQQ95AsQrwFnkiJYJkzMuUzbkiciFnWcjS4WxWgwqXLlzJs/kiSh32OsyVzxlE1VpdvTslxm4VQzbTlutZzCoRux1v9U6/z6ztjQ7Gxu8LDuqBIncyvnAdBJVbKQIWKZD4hVowFmJX8CNyCeMpykbi3QE1tCGSJaocsISpXQqpBONko+AyaoYgDYxUVMoDUxIxpkGnk7aVrUrA+zF8eEBsqHgtsOO8srE9XKp0JDYfOKmR/YEqr5zu7O9hTIk5ChmBb9ALgnLPlciuUCyDUjaWi8yxKtW6y3iW3NHGC/jKWM2E4aNYZApdcHgErvHIs+Z1WI0At1qncnffvvtTF6fScbOIoI4i3bYWeSnOIti12UnJbieZ4dPX+/vHZx8PHl/tFf3B0ldgOk/qyGGIl+c4fWrl3W35MVi98Hu/mwBqazvP8qBG2AaLgWMaR9wqx2tgQv1sIadcKPrHhwE2mDrKbYwdu3+zWNz3H9+sPeqiYuDgIKLfA5kb3+3/3IOpsyUnJ/m6NfDg/l5Kt2YpX/w3DHF9U/x37nH1+/Irt+gk/7+3vHJ7v4RAk/9PqI0HFdlqTRu/1sn0Du4zWfyZ8jVmHENJD2JKgolWck1L8CSbcy4pW4NnyuhIXXGjed50IydM9lmrRaKwk6rxfoyFQmqhlPzSQlo2Rxsx4GiyiDosTc1DrShSGiLnDlBDRlzp91ljoYEQTWglbLiEuYnvorZBCd+BigXbtpMafFFSctzEopL0FYkPG8qMSJIps9yTSaoVELa0OpXYO+9sqIuk4p6K4OopcisQkjqMcAueV6B8ViNY5YhVq+g1GDI4vp5kZEyZRmIUbZyPZ5+qoydm5hVJtjRgIVfK+wSsReIbUOeG2BiOMfLgl9AYzWmSmffO+znCUthyKvcxkyg/bG6gg47UJbxssxFQmcjmnN38FQa2rTLXhw8IqgqiMSROx/wREgFng1obbCTpvBjAnYoZ+5AQfLIjtqMS6bkwkYnKld6WYSoeZ6PLFHSgrQdtnvJRU7IO2INEzLJqxTYIOfJRUwne8w0nmW4KxPIczWOnbwTCJ2wxHPiDzOQoxQqifhL5ZcXZnaGdtgJ2p9an7AzsJoWEabJVW/DhwpXRhYEFWNkV2JiXMw+qQGzwuYQo8KWXE5iljqnAa7sQF3FLMkguaBfmqdCsUFlrZKOsFSrMlVj6Xk5VNIa8eUGjQw9X8/RXsy2YrYdsycx627GrNuLWXcrZt3tmHWfxKy3GbNeL2a9rZj1th1avSee17xmcBOBbs9x2f51uIt296UwpNloME1tg8dzNrjbYa1WrU2Lx+/sjK1B6tMKbSb2df33FX486v3oPyf4ud174j/HBNrd8p8Zfva6zXOiR5hYXpS3YIHdfygGwVlwQoRt/sw9i4I9w0Y0RHHomB3FHh/smDZpeYS0CCms4LlZTU6AeEAUzVBaImoLiSJxXU2R90EeDDlNfMhlQTPpusisNrqCwhMWvSXqH3f8ybKaeLfsg6G9gc7vI30bSUfTdIKmaTX9tfV6QExYxOn3ceLHDjkAZJlX88EDPCAuzGP0+3jwBHmAh9JqBmDvA6K+gY67gNEJ7/o2t9rdx+3eZm9rjgN4U3YARdFO0/ZkMvkjuIc+j18eXZ7goTrPDiMSQ62KG64fdDuYQXmfiH4Hl30fHfUB1EERjALMx1TC/b/pZVuV8sl3xk0VhtbOGcLPXLNJA03qQjwoFpJkSiQeeYQJLtkAL3gd5EGbOLmRphsNTmJjmraLor3QiJ9tYnyjsSg6adpZgFzaHddYsDSN2XLzje1pyoqiWNHs2s8icql+QtH3nthq6fcAf5YCzOR8fuFblQOjQ0rmtDZd0m7WjoUjJBMhGONFhS0AaBhVOddwhbdNsxjh+AM1JyjOzF+n2yld7FyIj1jBvj/0PvkPXqiRhPkJsOXucUuUNSfRMIIrmsMFcREZkVJoNcZ4a4a3Nx5cf+T7LGpHXwkvBUYJcrCWWsEmnZuQcLvWuGHjri5esA3YOWK4YWHkDXds2n4S7+4mHW/+gnHL+eYhHpCJX0AJO124wgXTooKTB4BSBrPfymagz6Lzeoy7VUN6x9jze+hRJlLI+QDy5a5760CTFi9PDcZgRyFkHQkgfDcbgbyCXy10ns2CeAu65ShuCnUw4kE1AotZLkyIhczzqznaB4sohCfBhf8HwMIANqjF8HeLeY3Y/eTcWQG/OXcsgXCMAOtAXVjtjhXmNqbJGJyjEFIUVVFHHIf1rIFlhT/Nm/zCkfiyEVZo7u7SCvzqjhX808yKBc5klyIDIaJwi6/nIR6QMVhA6XY9/RYzMXdG/kGH290KGMhqKuANRyKCusOwVj6zWvs67BAPIIxyukEYt0oSKC3GuH6vatYo3/sIoihQM7K1WvKaUA9I+m5A6/9YAj3cnyOFTfL+QpI4h/a9pdHF8Qo+uuWyS90PSP48PgubG8WRKilbQMl+Gu1EKeYkhJfwKKaZwdifVTqJdq4jH2jHnz6MjSM3PhnMbriOTJJBwfFXwAjzIfBBNYrDO2YURxR5weQIZFe0499koxjvDyW+hoHBOWjcznWAcs/NUezv4dFO5N6hoziCK16UCOybGMhE4W2XppiGFW+bq26ZzWXoR50XgPPgI943TkNDpwsJId80U3OG6Yyvs8m41nwSLeaehNe7cElz4+rniXwSlERYVIX6SYnAojgSFormKit2Tauv53QCCimhsOzXjqVt4cVXr4nj6N37Wwb615IbeH5PLrne5YXnt2wXL4eQBre5PXvgjBk9MnTukpgAT9TyUXNN5wQurXmy6uG78d5mMlXlKb5kAdcden/+5kQXynXieVJR7k19OMxRVqNaU9adxtHV3cRcsUS1w6s6+z6HoWVVWYJmidIS9A/N0NqDIa63tTWNo8nd5E3+kuT9iJs3vpu6t5SOMEvV+F/g+ujJNI6yu3H9tU6Y+B8iu7U9nZ11Pg+nzr8bqHTyMdit6V2A4VBBOEzm6stDnYJuMGKgVA5cLnGiP3TelWLfoSvynY9l0Tu30CYcKC6/S0MCmDNDIelgq5h3OtwjOPNvj+iU7WEDOYumGhiEkmE+4yYcQMgZwyRHByFckiC95ANPMsxOsw4rPsRHesr1wTQtVZmAXsYNPbbngP6ozUC49BIhR/POYYM7lGjRpL3T3B1swUOOEj0PT47uwUtyXdsuY8yd045KNwc7PDnC7CEx9H5Yh702NScCa/kcCEO/iF0KHjIMats+cdEFkMQRFXLVZol/HZ+302bLCKXC3IhRPItv1omtSxPPkg1xi1RlMcvRZ3cyY6E0c3wkLGpGnqjqPlJ5Byc5G1X0PGJRZUMqEcVcZ9k/QrqsWbr4pJUOCU9eLBASU2hnfApcQaDG/DEDadxwzobcWNAxptIi53WFF5t6SrgqQQuQCdzIAg2OdR8rfaPfNM+D+VSa169e+hTTQENQygFqoJsYUlaVJDWkCXWKV9i5RdKXHCXUDtAfVzloy64HJWL5oFoJ2mAasmZKj7gUX3xaMnokygAbQMZzB+pNBT4uIT6o4fPIBFv7n3/9u4HXSo9zGTG3Ak9TjPTfgSFdbJ3Ao8etoUQLqOYxwvlA/33xEEDsSGk+FiqtFcncX8aPMO/PmtouWkVZw5CDy60OLw+1vTVxsLHGu5X4AKHpoYBysFWJ9MKVMLaRpBSeEpftwytAPiYNHMgNQa1GmZeTpoLXePlkqNl0lEol5hPc6mNwQRduP87ceTe7k3pTjEmbShrnkfc2N/HfwsaHnPCQqTxLk88nf4vi+1+Ib78OhKzkm0RxJjE/Z71fTSmLJEMhWaHzM/DbXY3mRX8DJi+ywfNEHIoX/ddf+t0D0Td9+epx8rS/3b8o3715+uKnDkxedJPem8m73hv7/m1u+p+USH59kX2Qb8zg6ePq/bsP+v27vn7/9pXlbx/vDmQmB89/Ecnk8adBb1O8fPpi88Pb7njw/JfND29+Kj/Q5L9sfri42EyKg6cDuYsw5ft3/xSHn/Ye7X/Z+7J/sne1/yX/qcMPPn96epX8tH+xt93+0Nft/cPBPz59tuWrx+mjg3di+wnsw1t5svkyiZrSIGQuJHwMW/2R6P6Imz0lodi6aduPVQE2I1mnVHStMM+9dPncVk8YH3EhGbJO/4FSAForffuefh1mtzFia3PzY7dmwuNlJvQlvS9RyceJugD551LaXN665RHVq4Kk3h0okXBA1B/NEdtsd0QaSCot7CTaOb2Ortq8FG3Xv3N6Pj2PI2SswhhYqQxhzG0W7UQbiyExrLyheMvptdPBWtEMlym+AS0pGy/FxmU3msaLI25UzZXQULW/boCxfCTk6PZR5zPWHOP2uR2aY9AsylGKfwCGOTz/m1BxJFBsMuB4UUCOo1S8mgUQ98LehtDejdG62SYuxt9C+G0uorZ4CN4QI2uEyE5DfIpCTnXEKZpRFNVRIfxZx3lOZ6Jah1RCRKVLoYje1hbd2X/s0uX20RO6N25tT88dhxt3KArRNi8CLvI/59H6pnkPL4oWPKo5t2bRq1npYaxwMIJXKeRQ0Z77fTgsQR6j046qeNldvqdDnqiizmYO4P/5179pRDjQaZm/scNKs1KNQWOpGZVa5XAl0E1GYELMUBiSwvS8yMEYjE1KCyNXJSZGlBURfM+El3yAxVro2Qpplcs+apgn02FvM8DHEuz6TrsEkUvI0SSxXCmqX0I/qbKqaFaisbHSF0NECYvMBljkgN6fAQhDQGZcJvh04VSIPCes10JvvtTCAOOiQGCqNxsORSJwYjSkmieWFVzyEblAMcULkAtlKFHQaoCXMqPyyl07sFACwDoS6emkw57hNY8Ix8YULG576m4cJnY3Pm9XfT3YAG/XJS4vEjCzVLIcLkGTyXD39SrPWamsu0OjD9jcW5zIai4NRiQcQmFravb5ewGtkfJJh+H7CZ5h6B2jAORCXrh6ndNazN7CwAgLs1jJeDxeMl8/zI95LmxWDdDTVrNxI2okY9ccXn/8gMYGdGEOh8dYTpkEr2nFmhsEvOGPQZ7QMRiUjZfiRl8+FwlIA41Da/f50Ut2yR51NqO4YbDvgfDGy/7TvYPjPZwXzyCnf93OZmeTArzK2ILLxlJUYlpXnC5qbuM9Z12Zuq5MXVemritT15Wp68rUdWXqujJ1XZm6rkxdV6auK1PZujJ1XZn6J9G+rkxdV6auK1PXlanrytR1Zeq6MnVdmbquTF1Xpq4rU9eVqevK1HVl6roydV2Zuq5M/f9VmeoTrtAr3ChzLmQj69Ul550u1Kuex1GGyXs7p9H1Nb4Fv9b5dIrNnyvQmPl3HkeXXAuMcVPeXxzy1TDD6wIm0U701IXs2ye4fOyknfI7FtIdMd3OjdilXb8VtplfeHR4fBLF0cDX1BYqxTGaj7Helo9dmpdnJlVUciqWyrkcVZRwFrk5McWOVzabz8+7oPw8/6ORt8blpIHhfOKeIwP/IlE3Dri+drl/02kN77pWjvCMDdC4fefT6fS/y6PRig==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.7b36bcdc.js b/assets/js/0028a090.7b36bcdc.js deleted file mode 100644 index f7e51855a..000000000 --- a/assets/js/0028a090.7b36bcdc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4317],{87440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>x,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","source":"@site/docs/API-docs/drafttemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/drafttemplate","permalink":"/docs/API-docs/drafttemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar_label":"Draft Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9122zjOr8LVTWd8ZCd200ybq820mY67zc826W+S06El2GIjkSpJxXFzfLdPso+2T7IHICnLdpxkfr7ZzPl8k1gkSAIgAIIgcB1ZPjLRzml0AkWZcwsmOo+jFEyiRWmFktFOdJIBC93sheZDK+SI7R71GUg+yMGwyoA2zCqWaECgpDJWFeIb9jIbZo6ZAX2JY7lhg7yCUgtpDRsqzUYgQXOaOFVJVQB2jIXNWKkhhaGQkDJjdZXYSoPpsLelksxUSQLGDKvcrSyUZGrIeL1mzGwGhKoGW2lpGGeVFF8rYK2WGnyBxPbTVot9l4IRI8ktpIhcGP5ZpN/HbJyJJGMJl2wASGqKlHqEoYHugGOfkrSmKSERQ4HAfrIO201TgTjyPJ/EjLNWq9J5q8WEYaVWlyKFNKymhkNkKSfWMiEt6CFPgHgFOIsc0TJhcsZlyoY8Ebmw82xkqTBWi0GFK3fO5Jk8EeUOe1vmiqdsoirNjl78NAO3imHbaav1AgbViL3tt1rn32XWlmZnY4OXZUeVIJFbOR+YTqKKjRQBy3RIvAINOCvxC7gR+YTxNGVjkY7AGtoQyRJVTliilE6FdKJR8hEwWRUD0CYmagqlgQnJONPA00nbqnZlgL06PjxANhTcdthRXpm4Xi4VGhKbT9z0yJ5A1SO3O9tbKENCjmJW8AvkkrDsayWSCyTbgKSt9SJDvGq13iO+NXeE8TKeMmYzYdgYBplSFwwusXss8pxZLUYj0K3Wmfzll1/O5PWZZOwsIoizaIedRX6Ksyh2XXZSgut5cfj87f7ewcnnk49He3V/kNQFmP6LGmIo8sUZ3r55XXdLXix2H+zuzxaQyvr+oxy4AabhUsCY9gG32tEauFAPa9gJN7ruwUGgDbaeYgtj1+7fPDbH/ZcHe2+auDgIKLjI50D29nf7r+dgykzJ+WmOfj48mJ+n0o1Z+gcvHVNc/xT/nXt8/Y7s+g066e/vHZ/s7h8h8NTvI0rDcVWWSuP2v3cCvYPbfCZ/hFyNGddA0pOoolCSlVzzAizZxoxb6tbwtRIaUmfceJ4Hzdg5k23WaqEo7LRarC9TkaBqODWflICWzcF2HCiqDIIee1PjQBuKhLbImRPUkDF32l3maEgQVANaKSsuYX7iq5hNcOIXgHLhps2UFt+UtDwnobgEbUXC86YSI4Jk+izXZIJKJaQNrX4F9tErK+oyqai3MohaiswqhKQeA+yS5xUYj9U4Zhli9QZKDYYsrp8XGSlTloEYZSvX4+mXyti5iVllgh0NWPi1wi4Re4HYNuS5ASaGc7ws+AU0VmOqdPa9w36csBSGvMptzATaH6sr6LADZRkvy1wkdDaiOXcHT6WhTbvsxcEjgqqCSBy58wFPhFTg2YDWBjtpCj8mYIdy5g4UJI/sqM24ZEoubHSicqWXRYia5/nIEiUtSNthu5dc5IS8I9YwIZO8SoENcp5cxHSyx0zjWYa7MoE8V+PYyTuB0AlLPCf+MAM5SqGSiL9UfnlhZmdoh52g/an1CTsDq2kRYZpc9TZ8qHBlZEFQMUZ2JSbGxeyLGjArbA4xKmzJ5SRmqXMa4MoO1FXMkgySC/qleSoUG1TWKukIS7UqUzWWnpdDJa0R327QyNDz6znai9lWzLZj9jRm3c2YdXsx627FrLsds+7TmPU2Y9brxay3FbPetkOr99TzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnx+J2dsTVIfVqhzcS+rv++wo/HvR/85wQ/t3tP/eeYQLtb/jPDz163eU70CBPLi/IWLLD7D8UgOAtOiLDNn7lnUbBn2IiGKA4ds6PY44Md0yYtj5EWIYUVPDeryQkQD4iiGUpLRG0hUSSuqynyPsiDIaeJD7ksaCZdF5nVRldQeMKit0T9k44/WVYT75Z9MLQ30Pl9pG8j6WiaTtA0raa/tl4PiAmLOP0+TvzQIQeALPNqPniAB8SFeYx+Hw+eIg/wUFrNAOx9QNQ30HEXMDrhXd/mVrv7pN3b7G3NcQBvyg6gKNpp2p5MJn8E99Dn8cujyxM8VOfZYURiqFVxw/WDbgczKO8T0e/gsu+joz6AOiiCUYD5mEq4/ze9bKtSPnlk3FRhaO2cIfzMNZs00KQuxINiIUmmROKRR5jgkg3wgtdBHrSJkxtputHgJDamabso2guN+Nkmxjcai6KTpp0FyKXdcY0FS9OYLTff2J6mrCiKFc2u/Swil+oZir73xFZLvwf4sxRgJufzC9+qHBgdUjKntemSdrN2LBwhmQjBGC8qbAFAw6jKuYYrvG2axQjHH6g5QXFm/jrdTuli50J8xAr23aH3yb/3Qo0kzE+ALXePW6KsOYmGEVzRHC6Ii8iIlEKrMcZbM7y98eD6I99nUTv6SngpMEqQg7XUCjbp3ISE27XGDRt3dfGCbcDOEcMNCyNvuGPT9pN4dzfpePMXjFvONw/xgEz8AkrY6cIVLpgWFZw8AJQymP1WNgN9Fp3XY9ytGtI7xp7fQ48ykULOB5Avd91bB5q0eHlqMAY7CiHrSADhu9kI5BX8aqHzbBbEW9AtR3FTqIMRD6oRWMxyYUIsZJ5fzdE+WEQhPAku/D8AFgawQS2Gv1vMa8TuJ+fOCvjNuWMJhGMEWAfqwmp3rDC3MU3G4ByFkKKoijriOKxnDSwr/Gne5BeOxJeNsEJzd5dW4Fd3rOCfZlYscCa7FBkIEYVbfD0P8YCMwQJKt+vpbzETc2fkH3S43a2AgaymAt5wJCKoOwxr5TOrta/DDvEAwiinG4RxqySB0mKM6/eqZo3yvY8gigI1I1urJa8J9YCk7wa0/o8l0MP9OVLYJO8vJIlzaN9bGl0cr+CjWy671P2A5M/js7C5URypkrIFlOyn0U6UYk5CeAmPYpoZjP1RpZNo5zrygXb86cPYOHLji8HshuvIJBkUHH8FjDAfAh9Uozi8Y0ZxRJEXTI5AdkU7/k02ivH+UOJrGBicg8btXAco99wcxf4eHu1E7h06iiO44kWJwL6JgUwU3nZpimlY8ba56pbZXIZ+1HkBOA8+4v3GaWjodCEh5DfN1JxhOuPrbDKuNZ9Ei7kn4fUuXNLcuPp5Ip8EJREWVaF+UiKwKI6EhaK5yopd0+rXczoBhZRQWPbXjqVt4cWvXhPH0bv3bxnoX0tu4Pk9ueR6lxee37JdvBxCGtzm9uyBM2b0yNC5S2ICPFHLR801nRO4tObJqofvxnubyVSVp/iSBVx36P35Nye6UK4Tz5OKcm/qw2GOshrVmrLuNI6u7ibmiiWqHV7V2Xc5DC2ryhI0S5SWoL9vhtYeDHG9ra1pHE3uJm/ylyTvB9y88d3Uvad0hFmqxv8C18dPp3GU3Y3rz3XCxP8Q2a3t6eys83k4df7dQKWTz8FuTe8CDIcKwmEyV18e6hR0gxEDpXLgcokT/aHzrhR7hK7IIx/LonduoU04UFx+l4YEMGeGQtLBVjHvdLhHcObfHtEp28MGchZNNTAIJcN8xk04gJAzhkmODkK4JEF6yQeeZJidZh1WfIiP9JTrg2laqjIBvYwbemzPAf1Rm4Fw6SVCjuadwwZ3KNGiSXunuTvYgoccJXoenhzdg5fkurZdxpg7px2Vbg52eHKE2UNi6P2wDntrak4E1vI5EIZ+EbsUPGQY1LZ94qILIIkjKuSqzRL/Oj5vp82WEUqFuRGjeBbfrBNblyaeJRviFqnKYpajz+5kxkJp5vhIWNSMPFHVfaTyDk5yNqroecSiyoZUIoq5zrJ/hHRZs3TxSSsdEp68WCAkptDO+BS4gkCN+WMG0rjhnA25saBjTKVFzusKLzb1lHBVghYgE7iRBRoc6z5X+ka/aZ4H86k0b9+89immgYaglAPUQDcxpKwqSWpIE+oUr7Bzi6QvOUqoHaA/r3LQll0PSsTyQbUStME0ZM2UHnEpvvm0ZPRIlAE2gIznDtSbCnxcQnxQw+eRCbb2P//6dwOvlR7nMmJuBZ6mGOm/A0O62DqBR49bQ4kWUM1jhPOB/vviIYDYkdJ8LlRaK5K5v4wfYd6fNbVdtIqyhiEHl1sdXh5qe2viYGONdyvxAULTQwHlYKsS6YUrYWwjSSk8JS7bhzeAfEwaOJAbglqNMi8nTQWv8fLJULPpKJVKzCe41cfggi7cfpy58252J/WmGJM2lTTOI+9tbuK/hY0POeEhU3mWJp9P/hbF978Q334dCFnJN4niTGJ+zHo/m1IWSYZCskLnZ+C3uxrNi/4GTF5lg5eJOBSv+m+/9bsHom/68s2T5Hl/u39Rfnj3/NWzDkxedZPeu8mH3jv78X1u+l+USH5+lX2S78zg+ZPq44dP+uOHvv74/o3l75/sDmQmBy9/EsnkyZdBb1O8fv5q89P77njw8qfNT++elZ9o8p82P11cbCbFwfOB3EWY8uOHf4rDL3uP97/tfds/2bva/5Y/6/CDr1+eXyXP9i/2ttuf+rq9fzj4x5evtnzzJH188EFsP4V9eC9PNl8nUVMahMyFhM9hqz8T3Z9xs6ckFFs3bfuxKsBmJOuUiq4V5rmXLp/b6gnjIy4kQ9bpP1AKQGulb9/TX4fZbYzY2tz83K2Z8GSZCX1J70tU8nGiLkD+uZQ2l7dueUT1qiCpdwdKJBwQ9UdzxDbbHZEGkkoLO4l2Tq+jqzYvRdv175yeT8/jCBmrMAZWKkMYc5tFO9HGYkgMK28o3nJ67XSwVjTDZYpvQEvKxkuxcdmNpvHiiBtVcyW0sXwk5Kh966jzGaXHuBuO4XP0zoIWpfgHYNTCs7MJFUcCpSADjn4/MhA3+c0sHrgXtipE6m4Mvs32ZDGcFqJpcwGyxTPthpBXI+J1GsJNFEGqA0jRjKKoDvLgzzpsczqTvDpCEgIkXYos9La26Ar+Q5fuqo+f0jVwa3t67jjcuBJRxLXp17tA/pyD6pvmHbYoWnCQ5ryURSdlpcOwwl8ITqKQQ0V77vfhsAR5jD44atZld/naDXmiijo5OYD/51//phHhfKZl/sYOK81KNQaNlWNUOZXDlUCvF4EJMUNRRYq68yIHYzDUKC2MXNGXGFGSQ3AlE17yAdZeoaMqpFUumahhbUyHvc8A3z6w65F2+R6XkKOFYblSVI6Ebk9lVdEsLGNjpS+GiBLWjA2wZgGdOQMQhoDMuEzwJcKpEDlCWH6FznmphQHGRYHAVD42HIpE4MRoFzVPLCu45CPyaGK6/iMXylBxoNUA71hG5ZW7RWDdA4B1JNJLSIe9wFsbEY6NKVjc9tRdIEzsLnDeTPryrgFelktcXiRgZplhOVyCJpPhrt9VnrNSWXclRpeuubc4kdVcGgwwOITC1tTs824+rZHySYfhcwgeSejsogDkQl648pvTWszew8AIC7PQx3g8XjJf38+PeSlsVg3QcVazcSNqJGPXHF5/fI/GBnRhDofHWB2ZBCdoxZobBLzhTzWe0KkWlI2X4kbXPBcJSAONM2j35dFrdskedzajuGGw74Hwxuv+872D4z2cF48Up3/dzmZnk+K1ytiCy8ZSVDFaF5Auam7jeWZdaLouNF0Xmq4LTdeFputC03Wh6brQdF1oui40XReargtN2brQdF1o+ifRvi40XReargtN14Wm60LTdaHputB0XWi6LjRdF5quC03XhabrQtN1oem60HRdaLouNP3/VWjqE67QK9wocy5kI4nV5dqdLpSfnsdRhrl4O6fR9TW+Bb/V+XSKzV8r0JjIdx5Hl1wLjHFTGl8c8tUww+sCJtFO9NyF7NsnuHzspJ3yOxayFzHdzo3YpV2/FbaZLnh0eHwSxdHAl8gWKsUxmo+xfJaPXZqXZyYVSHKqfcq5HFWUcBa5OTHFjlc2m8/Pu6D8PP+jkbfG5aSB4XziniMD/yJRNw64vna5f9NpDe+6Vo7wjA3QuH3n0+n0v+qwwF8=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"},"next":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"}}');var s=t(74848),r=t(28453),a=t(33617),o=t.n(a),l=t(17543),d=t.n(l),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9122zjOr8LVTWd8ZCd200ybq820mY67zc826W+S06El2GIjkSpJxXFzfLdPso+2T7IHICnLdpxkfr7ZzPl8k1gkSAIgAIIgcB1ZPjLRzml0AkWZcwsmOo+jFEyiRWmFktFOdJIBC93sheZDK+SI7R71GUg+yMGwyoA2zCqWaECgpDJWFeIb9jIbZo6ZAX2JY7lhg7yCUgtpDRsqzUYgQXOaOFVJVQB2jIXNWKkhhaGQkDJjdZXYSoPpsLelksxUSQLGDKvcrSyUZGrIeL1mzGwGhKoGW2lpGGeVFF8rYK2WGnyBxPbTVot9l4IRI8ktpIhcGP5ZpN/HbJyJJGMJl2wASGqKlHqEoYHugGOfkrSmKSERQ4HAfrIO201TgTjyPJ/EjLNWq9J5q8WEYaVWlyKFNKymhkNkKSfWMiEt6CFPgHgFOIsc0TJhcsZlyoY8Ebmw82xkqTBWi0GFK3fO5Jk8EeUOe1vmiqdsoirNjl78NAO3imHbaav1AgbViL3tt1rn32XWlmZnY4OXZUeVIJFbOR+YTqKKjRQBy3RIvAINOCvxC7gR+YTxNGVjkY7AGtoQyRJVTliilE6FdKJR8hEwWRUD0CYmagqlgQnJONPA00nbqnZlgL06PjxANhTcdthRXpm4Xi4VGhKbT9z0yJ5A1SO3O9tbKENCjmJW8AvkkrDsayWSCyTbgKSt9SJDvGq13iO+NXeE8TKeMmYzYdgYBplSFwwusXss8pxZLUYj0K3Wmfzll1/O5PWZZOwsIoizaIedRX6Ksyh2XXZSgut5cfj87f7ewcnnk49He3V/kNQFmP6LGmIo8sUZ3r55XXdLXix2H+zuzxaQyvr+oxy4AabhUsCY9gG32tEauFAPa9gJN7ruwUGgDbaeYgtj1+7fPDbH/ZcHe2+auDgIKLjI50D29nf7r+dgykzJ+WmOfj48mJ+n0o1Z+gcvHVNc/xT/nXt8/Y7s+g066e/vHZ/s7h8h8NTvI0rDcVWWSuP2v3cCvYPbfCZ/hFyNGddA0pOoolCSlVzzAizZxoxb6tbwtRIaUmfceJ4Hzdg5k23WaqEo7LRarC9TkaBqODWflICWzcF2HCiqDIIee1PjQBuKhLbImRPUkDF32l3maEgQVANaKSsuYX7iq5hNcOIXgHLhps2UFt+UtDwnobgEbUXC86YSI4Jk+izXZIJKJaQNrX4F9tErK+oyqai3MohaiswqhKQeA+yS5xUYj9U4Zhli9QZKDYYsrp8XGSlTloEYZSvX4+mXyti5iVllgh0NWPi1wi4Re4HYNuS5ASaGc7ws+AU0VmOqdPa9w36csBSGvMptzATaH6sr6LADZRkvy1wkdDaiOXcHT6WhTbvsxcEjgqqCSBy58wFPhFTg2YDWBjtpCj8mYIdy5g4UJI/sqM24ZEoubHSicqWXRYia5/nIEiUtSNthu5dc5IS8I9YwIZO8SoENcp5cxHSyx0zjWYa7MoE8V+PYyTuB0AlLPCf+MAM5SqGSiL9UfnlhZmdoh52g/an1CTsDq2kRYZpc9TZ8qHBlZEFQMUZ2JSbGxeyLGjArbA4xKmzJ5SRmqXMa4MoO1FXMkgySC/qleSoUG1TWKukIS7UqUzWWnpdDJa0R327QyNDz6znai9lWzLZj9jRm3c2YdXsx627FrLsds+7TmPU2Y9brxay3FbPetkOr99TzmtcMbiLQ7Tku278Od9HuvhaGNBsNpqlt8HjOBnc7rNWqtWnx+J2dsTVIfVqhzcS+rv++wo/HvR/85wQ/t3tP/eeYQLtb/jPDz163eU70CBPLi/IWLLD7D8UgOAtOiLDNn7lnUbBn2IiGKA4ds6PY44Md0yYtj5EWIYUVPDeryQkQD4iiGUpLRG0hUSSuqynyPsiDIaeJD7ksaCZdF5nVRldQeMKit0T9k44/WVYT75Z9MLQ30Pl9pG8j6WiaTtA0raa/tl4PiAmLOP0+TvzQIQeALPNqPniAB8SFeYx+Hw+eIg/wUFrNAOx9QNQ30HEXMDrhXd/mVrv7pN3b7G3NcQBvyg6gKNpp2p5MJn8E99Dn8cujyxM8VOfZYURiqFVxw/WDbgczKO8T0e/gsu+joz6AOiiCUYD5mEq4/ze9bKtSPnlk3FRhaO2cIfzMNZs00KQuxINiIUmmROKRR5jgkg3wgtdBHrSJkxtputHgJDamabso2guN+Nkmxjcai6KTpp0FyKXdcY0FS9OYLTff2J6mrCiKFc2u/Swil+oZir73xFZLvwf4sxRgJufzC9+qHBgdUjKntemSdrN2LBwhmQjBGC8qbAFAw6jKuYYrvG2axQjHH6g5QXFm/jrdTuli50J8xAr23aH3yb/3Qo0kzE+ALXePW6KsOYmGEVzRHC6Ii8iIlEKrMcZbM7y98eD6I99nUTv6SngpMEqQg7XUCjbp3ISE27XGDRt3dfGCbcDOEcMNCyNvuGPT9pN4dzfpePMXjFvONw/xgEz8AkrY6cIVLpgWFZw8AJQymP1WNgN9Fp3XY9ytGtI7xp7fQ48ykULOB5Avd91bB5q0eHlqMAY7CiHrSADhu9kI5BX8aqHzbBbEW9AtR3FTqIMRD6oRWMxyYUIsZJ5fzdE+WEQhPAku/D8AFgawQS2Gv1vMa8TuJ+fOCvjNuWMJhGMEWAfqwmp3rDC3MU3G4ByFkKKoijriOKxnDSwr/Gne5BeOxJeNsEJzd5dW4Fd3rOCfZlYscCa7FBkIEYVbfD0P8YCMwQJKt+vpbzETc2fkH3S43a2AgaymAt5wJCKoOwxr5TOrta/DDvEAwiinG4RxqySB0mKM6/eqZo3yvY8gigI1I1urJa8J9YCk7wa0/o8l0MP9OVLYJO8vJIlzaN9bGl0cr+CjWy671P2A5M/js7C5URypkrIFlOyn0U6UYk5CeAmPYpoZjP1RpZNo5zrygXb86cPYOHLji8HshuvIJBkUHH8FjDAfAh9Uozi8Y0ZxRJEXTI5AdkU7/k02ivH+UOJrGBicg8btXAco99wcxf4eHu1E7h06iiO44kWJwL6JgUwU3nZpimlY8ba56pbZXIZ+1HkBOA8+4v3GaWjodCEh5DfN1JxhOuPrbDKuNZ9Ei7kn4fUuXNLcuPp5Ip8EJREWVaF+UiKwKI6EhaK5yopd0+rXczoBhZRQWPbXjqVt4cWvXhPH0bv3bxnoX0tu4Pk9ueR6lxee37JdvBxCGtzm9uyBM2b0yNC5S2ICPFHLR801nRO4tObJqofvxnubyVSVp/iSBVx36P35Nye6UK4Tz5OKcm/qw2GOshrVmrLuNI6u7ibmiiWqHV7V2Xc5DC2ryhI0S5SWoL9vhtYeDHG9ra1pHE3uJm/ylyTvB9y88d3Uvad0hFmqxv8C18dPp3GU3Y3rz3XCxP8Q2a3t6eys83k4df7dQKWTz8FuTe8CDIcKwmEyV18e6hR0gxEDpXLgcokT/aHzrhR7hK7IIx/LonduoU04UFx+l4YEMGeGQtLBVjHvdLhHcObfHtEp28MGchZNNTAIJcN8xk04gJAzhkmODkK4JEF6yQeeZJidZh1WfIiP9JTrg2laqjIBvYwbemzPAf1Rm4Fw6SVCjuadwwZ3KNGiSXunuTvYgoccJXoenhzdg5fkurZdxpg7px2Vbg52eHKE2UNi6P2wDntrak4E1vI5EIZ+EbsUPGQY1LZ94qILIIkjKuSqzRL/Oj5vp82WEUqFuRGjeBbfrBNblyaeJRviFqnKYpajz+5kxkJp5vhIWNSMPFHVfaTyDk5yNqroecSiyoZUIoq5zrJ/hHRZs3TxSSsdEp68WCAkptDO+BS4gkCN+WMG0rjhnA25saBjTKVFzusKLzb1lHBVghYgE7iRBRoc6z5X+ka/aZ4H86k0b9+89immgYaglAPUQDcxpKwqSWpIE+oUr7Bzi6QvOUqoHaA/r3LQll0PSsTyQbUStME0ZM2UHnEpvvm0ZPRIlAE2gIznDtSbCnxcQnxQw+eRCbb2P//6dwOvlR7nMmJuBZ6mGOm/A0O62DqBR49bQ4kWUM1jhPOB/vviIYDYkdJ8LlRaK5K5v4wfYd6fNbVdtIqyhiEHl1sdXh5qe2viYGONdyvxAULTQwHlYKsS6YUrYWwjSSk8JS7bhzeAfEwaOJAbglqNMi8nTQWv8fLJULPpKJVKzCe41cfggi7cfpy58252J/WmGJM2lTTOI+9tbuK/hY0POeEhU3mWJp9P/hbF978Q334dCFnJN4niTGJ+zHo/m1IWSYZCskLnZ+C3uxrNi/4GTF5lg5eJOBSv+m+/9bsHom/68s2T5Hl/u39Rfnj3/NWzDkxedZPeu8mH3jv78X1u+l+USH5+lX2S78zg+ZPq44dP+uOHvv74/o3l75/sDmQmBy9/EsnkyZdBb1O8fv5q89P77njw8qfNT++elZ9o8p82P11cbCbFwfOB3EWY8uOHf4rDL3uP97/tfds/2bva/5Y/6/CDr1+eXyXP9i/2ttuf+rq9fzj4x5evtnzzJH188EFsP4V9eC9PNl8nUVMahMyFhM9hqz8T3Z9xs6ckFFs3bfuxKsBmJOuUiq4V5rmXLp/b6gnjIy4kQ9bpP1AKQGulb9/TX4fZbYzY2tz83K2Z8GSZCX1J70tU8nGiLkD+uZQ2l7dueUT1qiCpdwdKJBwQ9UdzxDbbHZEGkkoLO4l2Tq+jqzYvRdv175yeT8/jCBmrMAZWKkMYc5tFO9HGYkgMK28o3nJ67XSwVjTDZYpvQEvKxkuxcdmNpvHiiBtVcyW0sXwk5Kh966jzGaXHuBuO4XP0zoIWpfgHYNTCs7MJFUcCpSADjn4/MhA3+c0sHrgXtipE6m4Mvs32ZDGcFqJpcwGyxTPthpBXI+J1GsJNFEGqA0jRjKKoDvLgzzpsczqTvDpCEgIkXYos9La26Ar+Q5fuqo+f0jVwa3t67jjcuBJRxLXp17tA/pyD6pvmHbYoWnCQ5ryURSdlpcOwwl8ITqKQQ0V77vfhsAR5jD44atZld/naDXmiijo5OYD/51//phHhfKZl/sYOK81KNQaNlWNUOZXDlUCvF4EJMUNRRYq68yIHYzDUKC2MXNGXGFGSQ3AlE17yAdZeoaMqpFUumahhbUyHvc8A3z6w65F2+R6XkKOFYblSVI6Ebk9lVdEsLGNjpS+GiBLWjA2wZgGdOQMQhoDMuEzwJcKpEDlCWH6FznmphQHGRYHAVD42HIpE4MRoFzVPLCu45CPyaGK6/iMXylBxoNUA71hG5ZW7RWDdA4B1JNJLSIe9wFsbEY6NKVjc9tRdIEzsLnDeTPryrgFelktcXiRgZplhOVyCJpPhrt9VnrNSWXclRpeuubc4kdVcGgwwOITC1tTs824+rZHySYfhcwgeSejsogDkQl648pvTWszew8AIC7PQx3g8XjJf38+PeSlsVg3QcVazcSNqJGPXHF5/fI/GBnRhDofHWB2ZBCdoxZobBLzhTzWe0KkWlI2X4kbXPBcJSAONM2j35dFrdskedzajuGGw74Hwxuv+872D4z2cF48Up3/dzmZnk+K1ytiCy8ZSVDFaF5Auam7jeWZdaLouNF0Xmq4LTdeFputC03Wh6brQdF1oui40XReargtN2brQdF1o+ifRvi40XReargtN14Wm60LTdaHputB0XWi6LjRdF5quC03XhabrQtN1oem60HRdaLouNP3/VWjqE67QK9wocy5kI4nV5dqdLpSfnsdRhrl4O6fR9TW+Bb/V+XSKzV8r0JjIdx5Hl1wLjHFTGl8c8tUww+sCJtFO9NyF7NsnuHzspJ3yOxayFzHdzo3YpV2/FbaZLnh0eHwSxdHAl8gWKsUxmo+xfJaPXZqXZyYVSHKqfcq5HFWUcBa5OTHFjlc2m8/Pu6D8PP+jkbfG5aSB4XziniMD/yJRNw64vna5f9NpDe+6Vo7wjA3QuH3n0+n0v+qwwF8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,y={},b=[];function f(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Template"}),"\n",(0,s.jsx)(o(),{method:"post",path:"/drafttemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,s.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,s.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},url:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}},title:"inline_response_draft_200"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(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/05632a52.6245978a.js b/assets/js/05632a52.6245978a.js new file mode 100644 index 000000000..2d9d4cc35 --- /dev/null +++ b/assets/js/05632a52.6245978a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8669],{72558:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>C,contentTitle:()=>b,default:()=>I,frontMatter:()=>g,metadata:()=>o,toc:()=>f});const o=JSON.parse('{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/getcontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getcontact","permalink":"/docs/API-docs/getcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar_label":"Get Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V+tu2zYUfpVT/lkLKL6kaYfpV4OuyIIVS7FkKLDUCCjpWGJCkSx55AsM/duT7NH2JMOhZEdO3GIZigKGbZHnfvnO0UaQLINIr8Vba0jmFMQsEQWG3CtHyhqRiqsK4QwJego4/XAOUmu7DLC2DZAFj+QVLhAKJKl0AJnZhkBCcJirucoh73hHIhHWoZcs+rwQqSiR+juRCCe9rJHQs0UbYWSNIhX9/Y0qRCIUW+QkVeKhmTa7xZzOC7BzuBfp8XOjPBYiJd9gIgKtNQsNqnYaRSJw5bQtUKRzqQMT5BXWUqQbQWsXKckrU4pEzK2vJQ1PcCWjlFS4X6ZZlR9XLhNtO2O1wVkTMLCg48mEf/bNDU2eYwjzRsMuIiKJzqIhppfOaZXHi/FtYKbNY+s6rzl2nsWQ6lRug/FkP6ppVq2Ob51okz7+TxNwaxEyRGbHWir9P/gzxDf9wSi3NYtylTVPNuVk+nJ6HD8sIvcoCYtTOiTmnul4cvzyaDo5mvx4NX2dnvyUvno9mkwmf4pErOroTV+VhaToJSnSw+fGFd9BT/uQrK/4vgGHDNteaFvmOjlUi5e2RqqUKWGJhmDprSkTcBplQCC/BllKZUBLQv/s2xUpem/918P0NMvagdvKaGXwZtuINyeTyc10F4STx0HYwpuxBHPbmOL7enpA/dfdObk53rnz6rE752YhtSoiWl/ZOzTf152heurUPy5a1RHFe7Hn7PC8czJg3nhF6zgZVkfSqaPuPr2eMeJyndh+osRRQpVIxbiv/vHmfoq0gqX5xXbMNF6LVFRELqTjcZCmyOxqZB2aoEqjZRYYhsbSqfGCoeQhh3TuCdTYHD2NIZAslSm/zjW7D9AlJ7HL016YdtmSTv2Ka7HF9z2qfsBWKAv0MWPKzG1k7nNz4dBcqtLEzC6mj8bwR9S5rZHXAqoQtuT//PV35Chs3tRoKBbeM7hoPDi7RM9zUJoC5hpXKtN4YMsIKGuNIeg1KENYekkIhSoVSQ0cFYaJXDqZKa24VJnMMreHQbWHEXyskCr0fPWDR5BQ4AI1Vzhoa+9YDlmQDdk66uhthqX1d3M2KQEJWROUwRAgIG5Z0FTS5AjbXCRgPUgDaAi98yogSFUz8dx6wPlc5YoFc3F67v5aGlkiK0uA7eYoOG8XqsAA3mZNIAhWN9ER1lgjUueiQSzCCH5WC+wc58NuHmABZcMiEshtgdC3KbthCsgwEDhWr3KMQgNJT6BxgT7WXszkvNEanGX8UFLzljXMLQsiL03gidwZtE3NLnzOW155oo5CrkfwyXwyjPDQBOQC0MrchfSTOYLrXZl9xCwowtnzbT8sl8tHffBin+dMUdVk4NHZe74yHsauGbLvHl6IRBD6OlzML9EvVI59E35B5zgSj3tU5QnLyNjtPNxjbx4yMMJplaMJOMDA07MP72EBL0cTkQw6/z8YPH5//vbdb5fvWC6DWdd/09FkNIk7kw1USzNQNVjiH7bt5n40fOt9v0cdwhWNnZYqIn10dNOj9LW439fTwbY/S0RlAzHBZpPJgH943bZ8/LlBz5NgloiF9EpmDE3XG1GowP+L3Tb/RSef/96/GLyAwy8OB83eIqhh+FxI3fCTSMQdrvdfVNpZm2xRlA3rCE7zHB0NWB8N4b1JdvbuSiRCNhyjIXrfRfTu/7D0g2btw3pnAH/zhDnIsNl0k6Ftd/Td1Rc5ege31ByjWdu2/wJS6fRM","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/deletecontact"}}');var a=n(74848),i=n(28453),s=n(33617),c=n.n(s),r=n(17543),l=n.n(r),d=n(86013),p=n.n(d),h=n(63723),m=n.n(h),u=(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:"eJy9V+tu2zYUfpVT/lkLKL6kaYfpV4OuyIIVS7FkKLDUCCjpWGJCkSx55AsM/duT7NH2JMOhZEdO3GIZigKGbZHnfvnO0UaQLINIr8Vba0jmFMQsEQWG3CtHyhqRiqsK4QwJego4/XAOUmu7DLC2DZAFj+QVLhAKJKl0AJnZhkBCcJirucoh73hHIhHWoZcs+rwQqSiR+juRCCe9rJHQs0UbYWSNIhX9/Y0qRCIUW+QkVeKhmTa7xZzOC7BzuBfp8XOjPBYiJd9gIgKtNQsNqnYaRSJw5bQtUKRzqQMT5BXWUqQbQWsXKckrU4pEzK2vJQ1PcCWjlFS4X6ZZlR9XLhNtO2O1wVkTMLCg48mEf/bNDU2eYwjzRsMuIiKJzqIhppfOaZXHi/FtYKbNY+s6rzl2nsWQ6lRug/FkP6ppVq2Ob51okz7+TxNwaxEyRGbHWir9P/gzxDf9wSi3NYtylTVPNuVk+nJ6HD8sIvcoCYtTOiTmnul4cvzyaDo5mvx4NX2dnvyUvno9mkwmf4pErOroTV+VhaToJSnSw+fGFd9BT/uQrK/4vgGHDNteaFvmOjlUi5e2RqqUKWGJhmDprSkTcBplQCC/BllKZUBLQv/s2xUpem/918P0NMvagdvKaGXwZtuINyeTyc10F4STx0HYwpuxBHPbmOL7enpA/dfdObk53rnz6rE752YhtSoiWl/ZOzTf152heurUPy5a1RHFe7Hn7PC8czJg3nhF6zgZVkfSqaPuPr2eMeJyndh+osRRQpVIxbiv/vHmfoq0gqX5xXbMNF6LVFRELqTjcZCmyOxqZB2aoEqjZRYYhsbSqfGCoeQhh3TuCdTYHD2NIZAslSm/zjW7D9AlJ7HL016YdtmSTv2Ka7HF9z2qfsBWKAv0MWPKzG1k7nNz4dBcqtLEzC6mj8bwR9S5rZHXAqoQtuT//PV35Chs3tRoKBbeM7hoPDi7RM9zUJoC5hpXKtN4YMsIKGuNIeg1KENYekkIhSoVSQ0cFYaJXDqZKa24VJnMMreHQbWHEXyskCr0fPWDR5BQ4AI1Vzhoa+9YDlmQDdk66uhthqX1d3M2KQEJWROUwRAgIG5Z0FTS5AjbXCRgPUgDaAi98yogSFUz8dx6wPlc5YoFc3F67v5aGlkiK0uA7eYoOG8XqsAA3mZNIAhWN9ER1lgjUueiQSzCCH5WC+wc58NuHmABZcMiEshtgdC3KbthCsgwEDhWr3KMQgNJT6BxgT7WXszkvNEanGX8UFLzljXMLQsiL03gidwZtE3NLnzOW155oo5CrkfwyXwyjPDQBOQC0MrchfSTOYLrXZl9xCwowtnzbT8sl8tHffBin+dMUdVk4NHZe74yHsauGbLvHl6IRBD6OlzML9EvVI59E35B5zgSj3tU5QnLyNjtPNxjbx4yMMJplaMJOMDA07MP72EBL0cTkQw6/z8YPH5//vbdb5fvWC6DWdd/09FkNIk7kw1USzNQNVjiH7bt5n40fOt9v0cdwhWNnZYqIn10dNOj9LW439fTwbY/S0RlAzHBZpPJgH943bZ8/LlBz5NgloiF9EpmDE3XG1GowP+L3Tb/RSef/96/GLyAwy8OB83eIqhh+FxI3fCTSMQdrvdfVNpZm2xRlA3rCE7zHB0NWB8N4b1JdvbuSiRCNhyjIXrfRfTu/7D0g2btw3pnAH/zhDnIsNl0k6Ftd/Td1Rc5ege31ByjWdu2/wJS6fRM",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,C={},f=[];function N(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,a.jsx)(c(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(e.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,a.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(l(),{parameters:[{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,a.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,a.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 I(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(N,{...t})}):N(t)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.96765119.js b/assets/js/05632a52.96765119.js deleted file mode 100644 index 348d67b03..000000000 --- a/assets/js/05632a52.96765119.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8669],{72558:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>g,contentTitle:()=>x,default:()=>A,frontMatter:()=>u,metadata:()=>o,toc:()=>y});const o=JSON.parse('{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","source":"@site/docs/API-docs/getcontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getcontact","permalink":"/docs/API-docs/getcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar_label":"Get Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oA8l4cJ0X1FCMNXKNBHdQuAtRZGJQ0K9GmSIYc7QULvfVL+mn9kmIo7Vprb4K6CAIY65U4tzOcOTO7ESTLINJr8dYakjkFMUtEgSH3ypGyRqTiqkI4Q4JeAk4/nIPU2i4DrG0DZMEjeYULhAJJKh1AZrYhkBAc5mqucsg73ZFIhHXoJZs+L0QqSqT+TCTCSS9rJPQc0UYYWaNIRX9+owqRCMUROUmVeBimzW4xp/MC7BzuTXr83CiPhUjJN5iIQGvNRoOqnUaRCFw5bQsU6VzqwAJ5hbUU6UbQ2kVJ8sqUIhFz62tJwze4ktFKKtwv06zKjyuXibadsdvgrAkY2NDxZML/9sMNTZ5jCPNGwy4jIolg0RDLS+e0yuPB+Daw0uZxdB1qzp1nM6Q6l9tkPBlHNc2q1fGtE23S5/9pBm4tQobI6lhLpf+Hfob4pn8xym3NplxlzZNDOZm+nB7HPzaRe5SExSkdMnOvdDw5fnk0nRxNfryavk5PfkpfvR5NJpM/RSJWdUTTV2UhKaIkRXr43LjiO/hpH4r1Fd834FBh2wtty1onh2rx0tZIlTIlLNEQLL01ZQJOowwI5NcgS6kMaEnon327IkXvrf96mp4WWTuArYxWBm+2jXhzMpncTHdJOHmchC29GUswt40pvi/SA+6/Dufk5ngH59VjOOdmIbUqIltf2Ts03xfO0D117h8XreqE4rnYAzt834EMmDde0TpOhtWRdOqoO0+vZ8y4XCe2nyhxlFAlUjHuq3+8uZ8irWBrfrEdM43XIhUVkQvpeBykKTK7GlmHJqjSaJkFpqGxdGq8YCp5qCGde4J0IFkqUx59VWt2j/eS76RL+x7qXfKlU7/iWmzpek+qn5cVygJ9vABl5jYq96m+cGguVWniRS2mj6bqR9S5rZGnPFUIW/F//vo7ahQ2b2o0FOvoGVw0HpxdouexJk0Bc40rlWk8sDQElLXGEPQalCEsvSSEQpWKpAbOCnd9Lp3MlFZceSxmWdvDoHjDCD5WSBV6PvrBI0gocIGaCxa0tXdshyzIhmwdffQxw9L6uzmHlICErAnKYAgQELcqaCppcoTtXSRgPUgDaAi98yogSFWz8Nx6wPlc5YoNc615buZaGlkiO0uA4+YsOG8XqsAA3mZNIAhWNxEIe6wRqYNoEIswgp/VAjvg/LKjdyygbNhEArktEPquYximgAwDgWP3KsdoNJD0BBoX6GPtxZucN1qDs0wHSmpemoZ3y4bISxN4wHYBba9mlz7nLW8w0Uch1yP4ZD4ZJmxoAnIBaGXuQvrJHMH1rsw+YhYU4ez5th+Wy+WjPnixr3OmqGoy8OjsvV4ZX8auGarvHl6IRBD6OlzML9EvVI59E37B5zgKj3uS5IHJRNetMNxjbx4qMGFplaMJOKC007MP72EBL0cTkQw6/z8EPH5//vbdb5fv2C5zU9d/09FkNIkrkA1USzNwNdjJH7bt5p7pv/X63rMO4YrGTksViTsC3fSkey3u1+90sLzPElHZQCyw2WQy4B9ety2//tygZ2KfJWIhvZIZU9P1RhQq8Pdit5x/EeTz3/s9/wUc/h1wMOwtgxqmz4XUDT+JRNzhev93Rztrky2LcmCdwGmeo6OB6qOZujeYzt5diUTIhnM0ZO+7yN79F7Z+MKx9Wu8C4E+eMAcVNptuMrTtTr47+qJGD3ArzTmatW37L6ap4yE=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Contact","permalink":"/docs/API-docs/createcontact"},"next":{"title":"Delete Contact","permalink":"/docs/API-docs/deletecontact"}}');var a=n(74848),i=n(28453),c=n(33617),s=n.n(c),r=n(17543),p=n.n(r),l=n(86013),d=n.n(l),m=n(63723),h=n.n(m),I=(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:"eJy9V9tu3DYQ/ZUJX5oA8l4cJ0X1FCMNXKNBHdQuAtRZGJQ0K9GmSIYc7QULvfVL+mn9kmIo7Vprb4K6CAIY65U4tzOcOTO7ESTLINJr8dYakjkFMUtEgSH3ypGyRqTiqkI4Q4JeAk4/nIPU2i4DrG0DZMEjeYULhAJJKh1AZrYhkBAc5mqucsg73ZFIhHXoJZs+L0QqSqT+TCTCSS9rJPQc0UYYWaNIRX9+owqRCMUROUmVeBimzW4xp/MC7BzuTXr83CiPhUjJN5iIQGvNRoOqnUaRCFw5bQsU6VzqwAJ5hbUU6UbQ2kVJ8sqUIhFz62tJwze4ktFKKtwv06zKjyuXibadsdvgrAkY2NDxZML/9sMNTZ5jCPNGwy4jIolg0RDLS+e0yuPB+Daw0uZxdB1qzp1nM6Q6l9tkPBlHNc2q1fGtE23S5/9pBm4tQobI6lhLpf+Hfob4pn8xym3NplxlzZNDOZm+nB7HPzaRe5SExSkdMnOvdDw5fnk0nRxNfryavk5PfkpfvR5NJpM/RSJWdUTTV2UhKaIkRXr43LjiO/hpH4r1Fd834FBh2wtty1onh2rx0tZIlTIlLNEQLL01ZQJOowwI5NcgS6kMaEnon327IkXvrf96mp4WWTuArYxWBm+2jXhzMpncTHdJOHmchC29GUswt40pvi/SA+6/Dufk5ngH59VjOOdmIbUqIltf2Ts03xfO0D117h8XreqE4rnYAzt834EMmDde0TpOhtWRdOqoO0+vZ8y4XCe2nyhxlFAlUjHuq3+8uZ8irWBrfrEdM43XIhUVkQvpeBykKTK7GlmHJqjSaJkFpqGxdGq8YCp5qCGde4J0IFkqUx59VWt2j/eS76RL+x7qXfKlU7/iWmzpek+qn5cVygJ9vABl5jYq96m+cGguVWniRS2mj6bqR9S5rZGnPFUIW/F//vo7ahQ2b2o0FOvoGVw0HpxdouexJk0Bc40rlWk8sDQElLXGEPQalCEsvSSEQpWKpAbOCnd9Lp3MlFZceSxmWdvDoHjDCD5WSBV6PvrBI0gocIGaCxa0tXdshyzIhmwdffQxw9L6uzmHlICErAnKYAgQELcqaCppcoTtXSRgPUgDaAi98yogSFWz8Nx6wPlc5YoNc615buZaGlkiO0uA4+YsOG8XqsAA3mZNIAhWNxEIe6wRqYNoEIswgp/VAjvg/LKjdyygbNhEArktEPquYximgAwDgWP3KsdoNJD0BBoX6GPtxZucN1qDs0wHSmpemoZ3y4bISxN4wHYBba9mlz7nLW8w0Uch1yP4ZD4ZJmxoAnIBaGXuQvrJHMH1rsw+YhYU4ez5th+Wy+WjPnixr3OmqGoy8OjsvV4ZX8auGarvHl6IRBD6OlzML9EvVI59E37B5zgKj3uS5IHJRNetMNxjbx4qMGFplaMJOKC007MP72EBL0cTkQw6/z8EPH5//vbdb5fv2C5zU9d/09FkNIkrkA1USzNwNdjJH7bt5p7pv/X63rMO4YrGTksViTsC3fSkey3u1+90sLzPElHZQCyw2WQy4B9ety2//tygZ2KfJWIhvZIZU9P1RhQq8Pdit5x/EeTz3/s9/wUc/h1wMOwtgxqmz4XUDT+JRNzhev93Rztrky2LcmCdwGmeo6OB6qOZujeYzt5diUTIhnM0ZO+7yN79F7Z+MKx9Wu8C4E+eMAcVNptuMrTtTr47+qJGD3ArzTmatW37L6ap4yE=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={},y=[];function k(t){const e={p:"p",...(0,i.R)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Get Contact"}),"\n",(0,a.jsx)(s(),{method:"get",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,a.jsx)(e.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,a.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.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,a.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function A(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(k,{...t})}):k(t)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.7a8c2a64.js b/assets/js/13fdae3b.7a8c2a64.js deleted file mode 100644 index 5c6f5ed8d..000000000 --- a/assets/js/13fdae3b.7a8c2a64.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8472],{20080:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>j,default:()=>R,frontMatter:()=>u,metadata:()=>l,toc:()=>m});const l=JSON.parse('{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/delete-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/delete-webhook","permalink":"/docs/API-docs/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu4zYQ/ZUJX7YLKLaz3T5UT7togkXQoFnAWeTBMQJKGktcUyTLoWQbht76Jf20fkkxlOVbukFbFH3xhXPmcoYzR9qKIEsS6Uw8YlZZuxTzRBRIuVcuKGtEKh4qhGvUGBB2GPj4+Rak1nYFG9tAsFD09tXO3ngtEmEdeslBbguRih4yZEmER3LWEJJIt+LdZMJfp4mnTZ4j0aLRsA8lEpFbE9AExkvntMqjYfyV2GkrKK+wlvwrbByKVNjsK+ZBJMJ5DhNUn9IjNToc4Sh4ZUqRCFzL2mk+Gvj2tRdA+4r05kJ0XSKCChGpjFYGnwdSz+8mk+cfRdcx5v3k/UtyXwg9GBtgYRtTXPx3vNB761+ndZ77NSJc/EDjh5c0bk0rtSriRDzYJZr/l8lx+tCn51LXtWY/I+ueUgRFuzihenzekyTMG6/CRqSzrVhfSqcue3s6m3fzRNQYKnsYZ65ZhkqkYrzaTzahb9FTDMGbkIoqBEfpeEzSFJldj6xDQ6o0WmY0ym09lk6N2yvRJece0rl/gKYgS2XKy1e95geWU76JvtknXPctl079jBuRDK08RiVC8QRUKAv0se3KLGx03jX43qGZqtLE62mvxLmyPKLObY0sIKFCGOB//PZ79Chs3tRoQpyeC7hvPDi7Qs+CIE0BC41rlWk8yBENekQoa41EegPKBCy9DAiFKlWQGrgrypSQSyczpRXPG8Mse3s4GlkawWOFoULPpjceQUKBLWoeU9DWLjlOsCCbYOuYY1czrKxfLrikBCRkDSmDRECIgwuaSpocYbiLBKwHaQBNQO+8IgSpagYvrAdcLFSuODAvl5d5gFoaWSInS4Dr5i44b1tVIIG3WUMByOomEuGMNWLoKRrEgkZwrVrsifNhgUEqjQWUDYdIILcFwm7XmIYpIEMK4Di9yjEGpSB9AI0t+jh78SZZIMFZFgElNdjFyd1yoOCloYX1dV/QcDX79jlvWWljjkJuRvBknsyUh6Uh5AHQyiwpfTKXMNuP2SNmpALOvxv2YbVavdiDt6c+n1Somgw8OnvwK+Nh3Jpj9/2ftyIRAX1N94sp+lbluFvCb+QcR/B4J40yj9KItVS637EP5w4sU1rlaAiPhOzjp8930ML3o4lIjjb/bxQ8vrv96eaX6Q3HZW3q9+9qNBlN+MhZCrU0R6lOH/jnm7s9SPy/fz3YSUzAdRg7LVXU5shquxPVmVgdXkoqS4GPtttMEn7xuuv4+NcGPav1PBGt9EpmrDyzeZcMwsQqvMQNty/P0fFjppW66dXt7OF0ovDXN3c3DzciEbLhYo41cRk1cfeDEwwmszkKfyqWfQ38ybr9lw7bba+3XbfH96Zveuw4Dmju4bzruj8Bkg1z0g==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"}}');var s=o(74848),n=o(28453),i=o(33617),r=o.n(i),c=o(17543),d=o.n(c),a=o(86013),p=o.n(a),h=o(63723),k=o.n(h),b=(o(18766),o(79329),o(9303));const u={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/ZUJX7YLKLaz3T5UT7togkXQoFnAWeTBMQJKGktcUyTLoWQbht76Jf20fkkxlOVbukFbFH3xhXPmcoYzR9qKIEsS6Uw8YlZZuxTzRBRIuVcuKGtEKh4qhGvUGBB2GPj4+Rak1nYFG9tAsFD09tXO3ngtEmEdeslBbguRih4yZEmER3LWEJJIt+LdZMJfp4mnTZ4j0aLRsA8lEpFbE9AExkvntMqjYfyV2GkrKK+wlvwrbByKVNjsK+ZBJMJ5DhNUn9IjNToc4Sh4ZUqRCFzL2mk+Gvj2tRdA+4r05kJ0XSKCChGpjFYGnwdSz+8mk+cfRdcx5v3k/UtyXwg9GBtgYRtTXPx3vNB761+ndZ77NSJc/EDjh5c0bk0rtSriRDzYJZr/l8lx+tCn51LXtWY/I+ueUgRFuzihenzekyTMG6/CRqSzrVhfSqcue3s6m3fzRNQYKnsYZ65ZhkqkYrzaTzahb9FTDMGbkIoqBEfpeEzSFJldj6xDQ6o0WmY0ym09lk6N2yvRJece0rl/gKYgS2XKy1e95geWU76JvtknXPctl079jBuRDK08RiVC8QRUKAv0se3KLGx03jX43qGZqtLE62mvxLmyPKLObY0sIKFCGOB//PZ79Chs3tRoQpyeC7hvPDi7Qs+CIE0BC41rlWk8yBENekQoa41EegPKBCy9DAiFKlWQGrgrypSQSyczpRXPG8Mse3s4GlkawWOFoULPpjceQUKBLWoeU9DWLjlOsCCbYOuYY1czrKxfLrikBCRkDSmDRECIgwuaSpocYbiLBKwHaQBNQO+8IgSpagYvrAdcLFSuODAvl5d5gFoaWSInS4Dr5i44b1tVIIG3WUMByOomEuGMNWLoKRrEgkZwrVrsifNhgUEqjQWUDYdIILcFwm7XmIYpIEMK4Di9yjEGpSB9AI0t+jh78SZZIMFZFgElNdjFyd1yoOCloYX1dV/QcDX79jlvWWljjkJuRvBknsyUh6Uh5AHQyiwpfTKXMNuP2SNmpALOvxv2YbVavdiDt6c+n1Somgw8OnvwK+Nh3Jpj9/2ftyIRAX1N94sp+lbluFvCb+QcR/B4J40yj9KItVS637EP5w4sU1rlaAiPhOzjp8930ML3o4lIjjb/bxQ8vrv96eaX6Q3HZW3q9+9qNBlN+MhZCrU0R6lOH/jnm7s9SPy/fz3YSUzAdRg7LVXU5shquxPVmVgdXkoqS4GPtttMEn7xuuv4+NcGPav1PBGt9EpmrDyzeZcMwsQqvMQNty/P0fFjppW66dXt7OF0ovDXN3c3DzciEbLhYo41cRk1cfeDEwwmszkKfyqWfQ38ybr9lw7bba+3XbfH96Zveuw4Dmju4bzruj8Bkg1z0g==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,y={},m=[];function v(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:"Delete Webhook"}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(k(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function R(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.cd77c361.js b/assets/js/13fdae3b.cd77c361.js new file mode 100644 index 000000000..8d418528e --- /dev/null +++ b/assets/js/13fdae3b.cd77c361.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8472],{20080:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>w,contentTitle:()=>m,default:()=>W,frontMatter:()=>u,metadata:()=>s,toc:()=>T});const s=JSON.parse('{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","source":"@site/docs/API-docs/delete-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/delete-webhook","permalink":"/docs/API-docs/delete-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar_label":"Delete Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vs1u4zYQfpUJL+0Ciu1st4fq1EUTLIIGzQLOIgfHCChpLHFNkSyHkm0Yuu2T9NH6JMVQlv/SDbpF0YstcX6/+fmorQiyJJHOxCNmlbVLMU9EgZR75YKyRqTioUK4Ro0BYacD7z/egtTarmBjGwgWil6+2skbr0UirEMv2cltIVLRqwxREuGRnDWEJNKteDuZ8N9p4GmT50i0aDTsXYlE5NYENIH1pXNa5VEw/kxstBWUV1hLfgobhyIVNvuMeRCJcJ7dBNWH9EiNDkd6FLwypUgErmXtNB8NePvcC6B9RnpzIbouEUGFqKmMVgafB1DPbyeT559E17HOu8m7l+A+EXowNsDCNqa4+O9woffWvw7rPPZrQDj5AcaPL2HcmlZqVcSJeLBLNP8vkuPwoQ/Pqa5rzXZG1j2kqBTl4gTq8XkPkjBvvAobkc62Yn0pnbrs5els3s0TUWOo7GGcOWcZKpGK8Wo/2YS+RU/RBW9CKqoQHKXjMUlTZHY9sg4NqdJomdEot/VYOjVur0SXnFtI575BG5vLbzOgIEtlytet5oeyTLl1fXdOirPvkXTqV9yIZKj9sVYiFI9MhbJAH/ukzMJG411H7h2aqSpN7Gd7Jc6p6BF1bmtkxgkVwqD+55c/okVh86ZGE+K4XcB948HZFXpmEGkKWGhcq0zjgb9oIDBCWWsk0htQJmDpZUAoVKmC1MBVUaaEXDqZKa14QFnNsrWHoxmnETxWGCr0LPrOI0gosEXNcw3a2iX7CRZkE2wdY+xyhpX1ywWnlICErCFlkAgIcTBBU0mTIwy9SMB6kAbQBPTOK0KQqmblhfWAi4XKFTvmbfQyD1BLI0vkYAlw3lwF522rCiTwNmsoAFndRCAcsUYMPUSDWNAIrlWLPXA+LDBIpbGAsmEXCeS2QNgtJ8MwBWRIARyHVzlGpxSkD6CxRR9nL3aSGRWcZdZQUoNdnPSWHQUvDS2sr/uEhtbsy+e8ZWqOMQq5GcGTeTJTHpaGkAdAK7Ok9Mlcwmw/Zo+YkQo4/37Yh9Vq9WIP3pzafFChajLw6OzBroyHcWuOzfcvb0QiAvqa7hdT9K3KcbeEX4k5jsrjHZfKPHIp1lLpfsd+PjdgXtMqR0N4xHzvP3y8gxZ+GE1EcrT5/yDh8d3tLze/TW/YL5NZv39Xo8lowkfOUqilOQp1+oVwvrnbw53w778ndhQTcB3GTksVyTyi2u5YeCZWh6+YylLgo+02k4SfvO46Pv69Qc/0Pk9EK72SGTPPbN4lAzExbS9xw+XLc3R8L7VSNz27nd1mJ1fC9c3dzcONSIRsOJljTlxGTtw9cIBBZDZH7k/Jss+Bf5m3/9Zgu+35tuv2+r3oqxY7jIM213Dedd1ftUmE/Q==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/save-update-webhook"},"next":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"}}');var l=t(74848),n=t(28453),i=t(33617),c=t.n(i),d=t(17543),r=t.n(d),a=t(86013),p=t.n(a),k=t(63723),b=t.n(k),h=(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:"eJy9Vs1u4zYQfpUJL+0Ciu1st4fq1EUTLIIGzQLOIgfHCChpLHFNkSyHkm0Yuu2T9NH6JMVQlv/SDbpF0YstcX6/+fmorQiyJJHOxCNmlbVLMU9EgZR75YKyRqTioUK4Ro0BYacD7z/egtTarmBjGwgWil6+2skbr0UirEMv2cltIVLRqwxREuGRnDWEJNKteDuZ8N9p4GmT50i0aDTsXYlE5NYENIH1pXNa5VEw/kxstBWUV1hLfgobhyIVNvuMeRCJcJ7dBNWH9EiNDkd6FLwypUgErmXtNB8NePvcC6B9RnpzIbouEUGFqKmMVgafB1DPbyeT559E17HOu8m7l+A+EXowNsDCNqa4+O9woffWvw7rPPZrQDj5AcaPL2HcmlZqVcSJeLBLNP8vkuPwoQ/Pqa5rzXZG1j2kqBTl4gTq8XkPkjBvvAobkc62Yn0pnbrs5els3s0TUWOo7GGcOWcZKpGK8Wo/2YS+RU/RBW9CKqoQHKXjMUlTZHY9sg4NqdJomdEot/VYOjVur0SXnFtI575BG5vLbzOgIEtlytet5oeyTLl1fXdOirPvkXTqV9yIZKj9sVYiFI9MhbJAH/ukzMJG411H7h2aqSpN7Gd7Jc6p6BF1bmtkxgkVwqD+55c/okVh86ZGE+K4XcB948HZFXpmEGkKWGhcq0zjgb9oIDBCWWsk0htQJmDpZUAoVKmC1MBVUaaEXDqZKa14QFnNsrWHoxmnETxWGCr0LPrOI0gosEXNcw3a2iX7CRZkE2wdY+xyhpX1ywWnlICErCFlkAgIcTBBU0mTIwy9SMB6kAbQBPTOK0KQqmblhfWAi4XKFTvmbfQyD1BLI0vkYAlw3lwF522rCiTwNmsoAFndRCAcsUYMPUSDWNAIrlWLPXA+LDBIpbGAsmEXCeS2QNgtJ8MwBWRIARyHVzlGpxSkD6CxRR9nL3aSGRWcZdZQUoNdnPSWHQUvDS2sr/uEhtbsy+e8ZWqOMQq5GcGTeTJTHpaGkAdAK7Ok9Mlcwmw/Zo+YkQo4/37Yh9Vq9WIP3pzafFChajLw6OzBroyHcWuOzfcvb0QiAvqa7hdT9K3KcbeEX4k5jsrjHZfKPHIp1lLpfsd+PjdgXtMqR0N4xHzvP3y8gxZ+GE1EcrT5/yDh8d3tLze/TW/YL5NZv39Xo8lowkfOUqilOQp1+oVwvrnbw53w778ndhQTcB3GTksVyTyi2u5YeCZWh6+YylLgo+02k4SfvO46Pv69Qc/0Pk9EK72SGTPPbN4lAzExbS9xw+XLc3R8L7VSNz27nd1mJ1fC9c3dzcONSIRsOJljTlxGTtw9cIBBZDZH7k/Jss+Bf5m3/9Zgu+35tuv2+r3oqxY7jIM213Dedd1ftUmE/Q==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},m=void 0,w={},T=[];function I(e){const o={p:"p",...(0,n.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Webhook"}),"\n",(0,l.jsx)(c(),{method:"delete",path:"/webhook",context:"endpoint"}),"\n",(0,l.jsx)(o.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,l.jsx)(r(),{parameters:void 0}),"\n",(0,l.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(b(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook deleted successfully!"}},title:"inline_response_200_9"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function W(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,l.jsx)(o,{...e,children:(0,l.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.48f7e73e.js b/assets/js/1f73ca32.48f7e73e.js deleted file mode 100644 index c3937d6b1..000000000 --- a/assets/js/1f73ca32.48f7e73e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8211],{54472:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>h,contentTitle:()=>j,default:()=>A,frontMatter:()=>g,metadata:()=>o,toc:()=>y});const o=JSON.parse('{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/get-user.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-user","permalink":"/docs/API-docs/get-user","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar_label":"Get your account details","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vm1v2zYQ/itXftkKKLbz2k2fmm1ZkLZYCyRFgaVGcZLOEmOK5EhKjmHo237Jftp+yXCU5dhOWyzY0C+2SN5zb7x7jisRsPQivRXvPTkxTURBPnfSBmm0SMVNRXBJAfgUzt9dAWnMFHlYmgaCgZICfzowCw2Y56bRAQoKKJUfiUQYSw5Z11UhUlFSiGYS4chboz15ka7E0WTCf7uWr5s8J+9njYKNEpGI3OhAOrA8WqtkHg/Gd55BK+Hzimrkr7C0JFJhsjvKg0iEdawmyN5kv81ObSR9cFKXIhEz42oM2zt0j7VVLPTrpZwfHWfV+1eiS4TGmp6q4ZUh+ImI4VSjVE/F3xnKiF6uN0a5qVmVrYx+sisnp2cvfjg+Ojw6ZhV3JruRQT1ZS0Etw3NTW9TLp6KNJe1lqaMKRxioOA+fU/IAOZocHR8cTg4mL24Oz9KTH9PTs9FkMvldJOK+jvns70UUGGKeQx/WZt3Y4hvY6fbFGi79LbF+3bHgyeTkcQfEntMmwMw0unj2/xU/OWfc12Pft91t+S21kpo+DS38iZ0fwjh9HMaVblHJIrLHjZmT/raRbJsPvfnHVyN7oXgudkLd3u+D9JQ3ToalSG9X4v4ArTzoz9PbaTdNRE2hMmu2Y4cxVCIV45JC03OfJ9eS8xHfOCVSUYVgfToee9RFZu5HQ1MozDx3+BitHLeHokv2EWjtE6R9wFLq8uCrqOlDiNd8DX2mdwLd5ButfE1LMTDhjlQiJF9/RVjEOuf1zETwOrtvLelrWep4N+2h2B8+H0jlpiaeM6EiGMT//vOviChM3tSkQyydZ/C2cWDNghyPDNQFzBTdy0xRFEalzGIztjxhrch7tQSpA5UOA0EhSxlQAWdF6hJytJhJJbnYWMz0k26rXv0IPlQUKnJ89J0jQCioJcU1CsqYOesJBrAJpo421j7Dwrj5jF1KACFrvNTkPXiiAUK6Qp0TDHeRgHGAGkgHctZJT4CyZuGZcUCzmcwlK+bOcpgHqFFjSWwsAfabs2CdaWVBHpzJGh/AG9XEQNhiTcMw10SFH8EvsqU+cN7spzoVUDasIoHcFATrRuMwdAEZ+QCWzcucolIf0AVQ1JKLtRdvctYoBdYwA0hUYGY7d8uKgkPteW70Dg1Xs0mfdYZfB9FGgcsRfNQf9TUXS+OJC0BJPffpR30At5sy+0CZl4Gm3w/9sFgsHvXB813MpQxVk4Ejax5wZdyMXbMN3yyei0QEcrV/O7sm18qc1k34BZvjKDxe8yLmkRfXrwPusZf7AOYoJXPSnrZY7Pzy3Rto4Xg0EclW5/8Lh8dvrn6++O36gvUyN/X9dziajCbxdWF8qFFvmbocSmXvzbffw6sHpv/Pb8k15wS6D2OrUEamjmGu1ix7KwaWnSaiMj7w1mqVoaf3TnUdb//RkGPuniaiRSfZg8jcycBUTMtzWnI+85wsc3iLqunpbm9U7fD95cWNSAQ27Mk2Q84jQ64/WPtwpJdbuneps3eAf5nFPwtYrXr27bqNfH/0RcQ6wEGaEzjtuu4fseAjPQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/opensign-api-v-1"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/createcontact"}}');var i=s(74848),n=s(28453),a=s(33617),r=s.n(a),c=s(17543),d=s.n(c),p=s(86013),l=s.n(p),m=s(63723),u=s.n(m),f=(s(18766),s(79329),s(9303));const g={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k2fmm1ZkLZYCyRFgaVGcZLOEmOK5EhKjmHo237Jftp+yXCU5dhOWyzY0C+2SN5zb7x7jisRsPQivRXvPTkxTURBPnfSBmm0SMVNRXBJAfgUzt9dAWnMFHlYmgaCgZICfzowCw2Y56bRAQoKKJUfiUQYSw5Z11UhUlFSiGYS4chboz15ka7E0WTCf7uWr5s8J+9njYKNEpGI3OhAOrA8WqtkHg/Gd55BK+Hzimrkr7C0JFJhsjvKg0iEdawmyN5kv81ObSR9cFKXIhEz42oM2zt0j7VVLPTrpZwfHWfV+1eiS4TGmp6q4ZUh+ImI4VSjVE/F3xnKiF6uN0a5qVmVrYx+sisnp2cvfjg+Ojw6ZhV3JruRQT1ZS0Etw3NTW9TLp6KNJe1lqaMKRxioOA+fU/IAOZocHR8cTg4mL24Oz9KTH9PTs9FkMvldJOK+jvns70UUGGKeQx/WZt3Y4hvY6fbFGi79LbF+3bHgyeTkcQfEntMmwMw0unj2/xU/OWfc12Pft91t+S21kpo+DS38iZ0fwjh9HMaVblHJIrLHjZmT/raRbJsPvfnHVyN7oXgudkLd3u+D9JQ3ToalSG9X4v4ArTzoz9PbaTdNRE2hMmu2Y4cxVCIV45JC03OfJ9eS8xHfOCVSUYVgfToee9RFZu5HQ1MozDx3+BitHLeHokv2EWjtE6R9wFLq8uCrqOlDiNd8DX2mdwLd5ButfE1LMTDhjlQiJF9/RVjEOuf1zETwOrtvLelrWep4N+2h2B8+H0jlpiaeM6EiGMT//vOviChM3tSkQyydZ/C2cWDNghyPDNQFzBTdy0xRFEalzGIztjxhrch7tQSpA5UOA0EhSxlQAWdF6hJytJhJJbnYWMz0k26rXv0IPlQUKnJ89J0jQCioJcU1CsqYOesJBrAJpo421j7Dwrj5jF1KACFrvNTkPXiiAUK6Qp0TDHeRgHGAGkgHctZJT4CyZuGZcUCzmcwlK+bOcpgHqFFjSWwsAfabs2CdaWVBHpzJGh/AG9XEQNhiTcMw10SFH8EvsqU+cN7spzoVUDasIoHcFATrRuMwdAEZ+QCWzcucolIf0AVQ1JKLtRdvctYoBdYwA0hUYGY7d8uKgkPteW70Dg1Xs0mfdYZfB9FGgcsRfNQf9TUXS+OJC0BJPffpR30At5sy+0CZl4Gm3w/9sFgsHvXB813MpQxVk4Ejax5wZdyMXbMN3yyei0QEcrV/O7sm18qc1k34BZvjKDxe8yLmkRfXrwPusZf7AOYoJXPSnrZY7Pzy3Rto4Xg0EclW5/8Lh8dvrn6++O36gvUyN/X9dziajCbxdWF8qFFvmbocSmXvzbffw6sHpv/Pb8k15wS6D2OrUEamjmGu1ix7KwaWnSaiMj7w1mqVoaf3TnUdb//RkGPuniaiRSfZg8jcycBUTMtzWnI+85wsc3iLqunpbm9U7fD95cWNSAQ27Mk2Q84jQ64/WPtwpJdbuneps3eAf5nFPwtYrXr27bqNfH/0RcQ6wEGaEzjtuu4fseAjPQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,h={},y=[];function b(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,i.jsx)(d(),{parameters:void 0}),"\n",(0,i.jsx)(l(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"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 A(e={}){const{wrapper:t}={...(0,n.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/1f73ca32.bd793e95.js b/assets/js/1f73ca32.bd793e95.js new file mode 100644 index 000000000..2da5f1c03 --- /dev/null +++ b/assets/js/1f73ca32.bd793e95.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8211],{54472:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>P,default:()=>h,frontMatter:()=>I,metadata:()=>o,toc:()=>z});const o=JSON.parse('{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","source":"@site/docs/API-docs/get-user.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-user","permalink":"/docs/API-docs/get-user","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar_label":"Get your account details","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vm1v2zYQ/itXftkKKLbz0nbTp3ZbF6Qt1gJJEWCJUZyks8SYIjmSkmMY+rZfsp+2XzIcZTm20xYzNvSLLZL33Avv7jmuRMDSi/RGfPTkxDQRBfncSRuk0SIVVxXBOQXgU3j14QJIY6bIw9I0EAyUFPjTgVlowDw3jQ5QUECp/EgkwlhyyLouCpGKkkI0kwhH3hrtyYt0JU4mE/7btXzZ5Dl5P2sUbJSIRORGB9KB5dFaJfN4ML7zDFoJn1dUI3+FpSWRCpPdUR5EIqxjNUH2Jvttdmoj6YOTuhSJmBlXY9jeoXusrWKhX8/l/OQ0qz6+EV0iNNZ0qIY3huAnIoZTjVIdir8zlBG9XG+MclOzKlsZfbArZ8+ev/jh9OT45JRV3JnsSgZ1sJaCWobnpraol4eijSXtZamjCkcYqHgVPqfkAXIyOTk9Op4cTV5cHT9Pz35Mnz0fTSaT30Ui7ut4n31eRIEh3nPow9qsG1t8AzvdvljDpb8l1q87FjybnD3ugNhz2gSYmUYXT/6/4ifnjPt67Pu2uy2/pVZS06ehhT+x80MYzx6HcaFbVLKI7HFl5qS/bSTb5kNv/nFqZC8Uz8VOqNv7fZCe8sbJsBTpzUrcH6GVR/15ejPtpomoKVRmzXbsMIZKpGJcUmh67vPkWnI+4hunRCqqEKxPx2OPusjM/WhoCoWZ5w4fo5Xj9lh0yT4CrT1AmpqjwwA+YCl1+XXU9OFOLjlvfWp2bmaTILTyLS3FQJ07UomQXC8VYREbg9czE8HrdLy3pC9lqWMy22OxP62uSeWmJh5MoSIYxP/+86+IKEze1KRDrLUn8L5xYM2CHM8Y1AXMFN3LTFEURqXMYjPnPGGtyHu1BKkDlQ4DQSFLGVAB34rUJeRoMZNKcnWymOlH41aB+xFcVxQqcnz0nSNAKKglxUUNypg56wkGsAmmjjbWPsPCuPmMXUoAIWu81OQ9eKIBQrpCnRMMuUjAOEANpAM566QnQFmz8Mw4oNlM5pIVcys6zAPUqLEkNpYA+823YJ1pZUEenMkaH8Ab1cRA2GJNw/TXRIUfwS+ypT5w3uyfAVRA2bCKBHJTEKw7k8PQBWTkA1g2L3OKSn1AF0BRSy7WXszkrFEKrGHKkKjAzHZyy4qCQ+150PQODanZXJ91hp8T0UaByxHc6lt9ycXSeOICUFLPfXqrj+BmU2bXlHkZaPr90A+LxeJRHzzdxZzLUDUZOLLmAVfGzdg12/DN4qlIRCBX+/ezS3KtzGndhF+wOY7C4zWRYh6JdP2c4B57uQ9gUlMyJ+1pi/ZenX94By2cjiYi2er8f+Hw+N3Fz69/u3zNepnM+v47Hk1Gk/gcMT7UqLdMnQ+lsvdI3O/h1cNo+M+PzzXnBLoPY6tQRmqPYa7WtHwjBlqeJqIyPvDWapWhp49OdR1v/9GQY7KfJqJFJ9mDSPXJwFTM43Na8n3mOVkm/RZV09Pd3mzbGRDnr69EIrBhT7YZch4Zcv3B2ocjvdzSvUudvQP8yyz+WcBq1bNv123k+6MvItYBDtJ8gdOu6/4BT+w0aA==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Introduction","permalink":"/docs/API-docs/opensign-api-v-1"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/createcontact"}}');var s=n(74848),a=n(28453),r=n(33617),i=n.n(r),c=n(17543),l=n.n(c),p=n(86013),d=n.n(p),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:"eJy9Vm1v2zYQ/itXftkKKLbz0nbTp3ZbF6Qt1gJJEWCJUZyks8SYIjmSkmMY+rZfsp+2XzIcZTm20xYzNvSLLZL33Avv7jmuRMDSi/RGfPTkxDQRBfncSRuk0SIVVxXBOQXgU3j14QJIY6bIw9I0EAyUFPjTgVlowDw3jQ5QUECp/EgkwlhyyLouCpGKkkI0kwhH3hrtyYt0JU4mE/7btXzZ5Dl5P2sUbJSIRORGB9KB5dFaJfN4ML7zDFoJn1dUI3+FpSWRCpPdUR5EIqxjNUH2Jvttdmoj6YOTuhSJmBlXY9jeoXusrWKhX8/l/OQ0qz6+EV0iNNZ0qIY3huAnIoZTjVIdir8zlBG9XG+MclOzKlsZfbArZ8+ev/jh9OT45JRV3JnsSgZ1sJaCWobnpraol4eijSXtZamjCkcYqHgVPqfkAXIyOTk9Op4cTV5cHT9Pz35Mnz0fTSaT30Ui7ut4n31eRIEh3nPow9qsG1t8AzvdvljDpb8l1q87FjybnD3ugNhz2gSYmUYXT/6/4ifnjPt67Pu2uy2/pVZS06ehhT+x80MYzx6HcaFbVLKI7HFl5qS/bSTb5kNv/nFqZC8Uz8VOqNv7fZCe8sbJsBTpzUrcH6GVR/15ejPtpomoKVRmzXbsMIZKpGJcUmh67vPkWnI+4hunRCqqEKxPx2OPusjM/WhoCoWZ5w4fo5Xj9lh0yT4CrT1AmpqjwwA+YCl1+XXU9OFOLjlvfWp2bmaTILTyLS3FQJ07UomQXC8VYREbg9czE8HrdLy3pC9lqWMy22OxP62uSeWmJh5MoSIYxP/+86+IKEze1KRDrLUn8L5xYM2CHM8Y1AXMFN3LTFEURqXMYjPnPGGtyHu1BKkDlQ4DQSFLGVAB34rUJeRoMZNKcnWymOlH41aB+xFcVxQqcnz0nSNAKKglxUUNypg56wkGsAmmjjbWPsPCuPmMXUoAIWu81OQ9eKIBQrpCnRMMuUjAOEANpAM566QnQFmz8Mw4oNlM5pIVcys6zAPUqLEkNpYA+823YJ1pZUEenMkaH8Ab1cRA2GJNw/TXRIUfwS+ypT5w3uyfAVRA2bCKBHJTEKw7k8PQBWTkA1g2L3OKSn1AF0BRSy7WXszkrFEKrGHKkKjAzHZyy4qCQ+150PQODanZXJ91hp8T0UaByxHc6lt9ycXSeOICUFLPfXqrj+BmU2bXlHkZaPr90A+LxeJRHzzdxZzLUDUZOLLmAVfGzdg12/DN4qlIRCBX+/ezS3KtzGndhF+wOY7C4zWRYh6JdP2c4B57uQ9gUlMyJ+1pi/ZenX94By2cjiYi2er8f+Hw+N3Fz69/u3zNepnM+v47Hk1Gk/gcMT7UqLdMnQ+lsvdI3O/h1cNo+M+PzzXnBLoPY6tQRmqPYa7WtHwjBlqeJqIyPvDWapWhp49OdR1v/9GQY7KfJqJFJ9mDSPXJwFTM43Na8n3mOVkm/RZV09Pd3mzbGRDnr69EIrBhT7YZch4Zcv3B2ocjvdzSvUudvQP8yyz+WcBq1bNv123k+6MvItYBDtJ8gdOu6/4BT+w0aA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},P=void 0,j={},z=[];function U(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get your account details"}),"\n",(0,s.jsx)(i(),{method:"get",path:"/getuser",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,s.jsx)(l(),{parameters:void 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:{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 h(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(U,{...e})}):U(e)}}}]); \ No newline at end of file diff --git a/assets/js/2304e9ae.7b709933.js b/assets/js/2304e9ae.7b709933.js deleted file mode 100644 index 67da847ae..000000000 --- a/assets/js/2304e9ae.7b709933.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8790],{3924:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>y,default:()=>A,frontMatter:()=>m,metadata:()=>r,toc:()=>b});const r=JSON.parse('{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/createfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createfolder","permalink":"/docs/API-docs/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tu3DYQ/ZUJX9oA2oudS1E91U3TwG0QG7WLAN0sjJE0q2VMkQxJ7Xqx0Fu+pJ/WLymGXNl7cYy6KIK+LFbkXM/MnJHWImDtRT4RPxtVkRPTTFTkSydtkEaLXFzOCV45wkCQRODk/BRQKbP0sDItBANlup/F+6HIhLHkkA2cViIX6Trdikw4+tSSDz+aaiXy9Z67c2cWsiIoSJklWHTYUCB34EVkojQ6kA5sA61VsoweRx89G1oLX86pQf7HDqWjitNM2hob4lTDypLIhSk+UhlEJqzjyIMkz3pJ9h3L5ute1gcndS0yMTOuwbB9QjfYWMVCmpZ9nF0mLDrSIaHHgDzOlui6TAQZ4kMyelUwdh1f3OUWXEvxwFujfcrgeDw+hDjZ2MBZgW/LkryftUqtnjwG1ofBS8ePT9fOj4r5zfFHy8j9Pyrwy7FG/+JanhPb2uB2Eu4zc6d0PD5+NjgaD8bfXR69zJ9/n794ORyPx3+ITNw0inVjE+aiwhDt9iXun1tbfQU/3b5YAq2igFJ5cdB63HVdJp7f11gXpqEwl7qGJekAS2d0nYFVhJ4guBVgjVKDwkDuP+w0cs64h0F6XGTbAye1kpqu+qm6ej4eXx3dgvDiEIRTvUAlq8iSl+aa9NfNdNt9SO4PayyTULwXO8lun6ckPZWtk2El8sla3AzQykG6zyfTbpoJBtYwy1vjY8QY5iIXoz3S9+QW5Hy00jolcjEPwfp8NPKoq8LcDI0l7WWtFRZ+WJpmhFaOFkeiy/Y10NpHSPuAtdT14EGt6V2iF1yMhPdOureoo5W/0kpkPZrbUpmQ3ARzwjQrmeAa/3a38V73ldpdL9t8dUhXgosk9czEKDbFOrOkL2StY6kXR2J/cb8nVZqGeHOGOUEv/tfnP6NGZcq2IR1iJz6Bs9aBNUtys1YB6gpmim5koeiede8JG0XeqxVIHah2vJYrWcuAChheHrQSLRZSSe5dFjOs7WCr/f0Q3s8pzMnx1TeOAKGiBSlueVDGXLOdYADbYJroYxMzLI27nnFIGSAUrZeavAdP1KuQnqMuCfqiZmAcoAbSgZx10hOgbFh4ZhzQbCZLyYZ5UB2WARrUWBM7y4DjZhRsejfx4EzR+gDeqDYmwh4bopBS1ESVH8JPckEpcT5MhEoV1C2byKA0FcFmbjkNXUFBPoBl97KkaNQHdAEULcjFJo6V5E0N1jChSFRgZju1ZUPBofa80VJAfWlu4bPO8MqPPipcDeGD/qCZI6H1xA2gpL72+Qc9gMltm72nwstA02/7wVoulwcD9XRX540M87YAR9bc6dXxMI7ftvrtw1ORiUCu8WezC3ILWdJmmr/gcxSFRxuaxTLSLDUoVRrWH/YVeJqULEl72iLFkzfnb2EBz4ZjkW1RyD8IePT29NXrdxev2S6TXJq/o+F4OI4vH8aHBvWWq5336f3BXd9ti3/38r2hqUA3YWQVykjxMaH1hp0nu6/k00zMmbzziVivC/T0u1Ndx8efWnLM/NNMLNBJLJh5JtMu6xmO6fyaVpxTCnpwyd5ZXLWJLPfWHRN00jgpS7LhQdnt/XJ+dnEpMlFsPhsaU7GOwyV/UuCSWZI/POJAxrd+PlsLhbpusWbZZJNJGVuGYZvRryOjb/5wVv2VXm1FuEv1KQ3+5aTuVViv07boulv5dPVFjQ2wvTRXb9p13d8hK7yd","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/getfolder"}}');var a=o(74848),d=o(28453),i=o(33617),n=o.n(i),l=o(17543),s=o.n(l),p=o(86013),c=o.n(p),u=o(63723),h=o.n(u),f=(o(18766),o(79329),o(9303));const m={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:"eJzNV9tu3DYQ/ZUJX9oA2oudS1E91U3TwG0QG7WLAN0sjJE0q2VMkQxJ7Xqx0Fu+pJ/WLymGXNl7cYy6KIK+LFbkXM/MnJHWImDtRT4RPxtVkRPTTFTkSydtkEaLXFzOCV45wkCQRODk/BRQKbP0sDItBANlup/F+6HIhLHkkA2cViIX6Trdikw4+tSSDz+aaiXy9Z67c2cWsiIoSJklWHTYUCB34EVkojQ6kA5sA61VsoweRx89G1oLX86pQf7HDqWjitNM2hob4lTDypLIhSk+UhlEJqzjyIMkz3pJ9h3L5ute1gcndS0yMTOuwbB9QjfYWMVCmpZ9nF0mLDrSIaHHgDzOlui6TAQZ4kMyelUwdh1f3OUWXEvxwFujfcrgeDw+hDjZ2MBZgW/LkryftUqtnjwG1ofBS8ePT9fOj4r5zfFHy8j9Pyrwy7FG/+JanhPb2uB2Eu4zc6d0PD5+NjgaD8bfXR69zJ9/n794ORyPx3+ITNw0inVjE+aiwhDt9iXun1tbfQU/3b5YAq2igFJ5cdB63HVdJp7f11gXpqEwl7qGJekAS2d0nYFVhJ4guBVgjVKDwkDuP+w0cs64h0F6XGTbAye1kpqu+qm6ej4eXx3dgvDiEIRTvUAlq8iSl+aa9NfNdNt9SO4PayyTULwXO8lun6ckPZWtk2El8sla3AzQykG6zyfTbpoJBtYwy1vjY8QY5iIXoz3S9+QW5Hy00jolcjEPwfp8NPKoq8LcDI0l7WWtFRZ+WJpmhFaOFkeiy/Y10NpHSPuAtdT14EGt6V2iF1yMhPdOureoo5W/0kpkPZrbUpmQ3ARzwjQrmeAa/3a38V73ldpdL9t8dUhXgosk9czEKDbFOrOkL2StY6kXR2J/cb8nVZqGeHOGOUEv/tfnP6NGZcq2IR1iJz6Bs9aBNUtys1YB6gpmim5koeiede8JG0XeqxVIHah2vJYrWcuAChheHrQSLRZSSe5dFjOs7WCr/f0Q3s8pzMnx1TeOAKGiBSlueVDGXLOdYADbYJroYxMzLI27nnFIGSAUrZeavAdP1KuQnqMuCfqiZmAcoAbSgZx10hOgbFh4ZhzQbCZLyYZ5UB2WARrUWBM7y4DjZhRsejfx4EzR+gDeqDYmwh4bopBS1ESVH8JPckEpcT5MhEoV1C2byKA0FcFmbjkNXUFBPoBl97KkaNQHdAEULcjFJo6V5E0N1jChSFRgZju1ZUPBofa80VJAfWlu4bPO8MqPPipcDeGD/qCZI6H1xA2gpL72+Qc9gMltm72nwstA02/7wVoulwcD9XRX540M87YAR9bc6dXxMI7ftvrtw1ORiUCu8WezC3ILWdJmmr/gcxSFRxuaxTLSLDUoVRrWH/YVeJqULEl72iLFkzfnb2EBz4ZjkW1RyD8IePT29NXrdxev2S6TXJq/o+F4OI4vH8aHBvWWq5336f3BXd9ti3/38r2hqUA3YWQVykjxMaH1hp0nu6/k00zMmbzziVivC/T0u1Ndx8efWnLM/NNMLNBJLJh5JtMu6xmO6fyaVpxTCnpwyd5ZXLWJLPfWHRN00jgpS7LhQdnt/XJ+dnEpMlFsPhsaU7GOwyV/UuCSWZI/POJAxrd+PlsLhbpusWbZZJNJGVuGYZvRryOjb/5wVv2VXm1FuEv1KQ3+5aTuVViv07boulv5dPVFjQ2wvTRXb9p13d8hK7yd",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,k={},b=[];function j(e){const t={p:"p",...(0,d.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)(n(),{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)(s(),{parameters:void 0}),"\n",(0,a.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}},required:!0}}),"\n",(0,a.jsx)(h(),{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 A(e={}){const{wrapper:t}={...(0,d.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/2304e9ae.fa36879b.js b/assets/js/2304e9ae.fa36879b.js new file mode 100644 index 000000000..077821d34 --- /dev/null +++ b/assets/js/2304e9ae.fa36879b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8790],{3924:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>k,contentTitle:()=>g,default:()=>w,frontMatter:()=>h,metadata:()=>r,toc:()=>x});const r=JSON.parse('{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","source":"@site/docs/API-docs/createfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createfolder","permalink":"/docs/API-docs/createfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar_label":"Create Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tuGzcQ/ZUJX9oAq4udS9F9qpumgdsgNmoXAaoIxuzuaMWYSzIkV7Ig7Fu+pJ/WLymG1Nq6OEZdFEFfDIuc65mZM9y1CFh7kU/Ez0ZV5MQ0ExX50kkbpNEiF5dzgleOMBAkETg5PwVUyiw9rEwLwUCZ7mfxfigyYSw5ZAOnlchFuk63IhOOPrXkw4+mWol8vefu3JmFrAgKUmYJFh02FMgdeBGZKI0OpAPbQGuVLKPH0UfPhtbCl3NqkP9jh9JRxWkmbY0NcaphZUnkwhQfqQwiE9Zx5EGSZ70k+45l83Uv64OTuhaZmBnXYNg+oRtsrGIhTcs+zi4TFh3pkNBjQB5nS3RdJoIM8UcyelUwdh1f3OUWXEvxwFujfcrgeDw+hDjZ2MBZgW/LkryftUqtnjwG1ofBS8ePT9fOj4r5zfFHy8j9Pyrwy7FG/+JanhPb2uB2Eu4zc6d0PD5+NjgaD8bfXR69zJ9/n794ORyPx3+ITNw0inVjE+aiwhDt9iXuf7e2+gp+un2xBFpFAaXy4qD1uOu6TDy/r7EuTENhLnUNS9IBls7oOgOrCD1BcCvAGqUGhYHcf9hp5JxxD4P0uMi2B05qJTVd9VN19Xw8vjq6BeHFIQineoFKVpElL8016a+b6bb7kNwf1lgmoXgvdpLdPk9JeipbJ8NK5JO1uBmglYN0n0+m3TQTDKxhlrfGx4gxzEUuRnuk78ktyPlopXVK5GIegvX5aORRV4W5GRpL2staKyz8sDTNCK0cLY5El+1roLWPkKZ28DgFH7CWun5Ya3qHzAVXLxVoB5/bMqGVv9JKZD3821KZkNw1c8I0XJngpvjtbkW+7ku7u4+2Ce6Q3wRXVeqZiVFsqntmSV/IWsfeWByJ/U3/nlRpGuJVG+YEvfhfn/+MGpUp24Z0iK37BM5aB9Ysyc1aBagrmCm6kYWie94HnrBR5L1agdSBasd7vJK1DKiA4eXJLNFiIZXkZmcxw9oOtubFD+H9nMKcHF994wgQKlqQ4hkBZcw12wkGsA2miT42McPSuOsZh5QBQtF6qcl78ES9Cuk56pKgL2oGxgFqIB3IWSc9AcqGhWfGAc1mspRsmCfbYRmgQY01sbMMOG5GwabHjAdnitYH8Ea1MRH22BCFlKImqvwQfpILSonzYWJgqqBu2UQGpakINoPOaegKCvIBLLuXJUWjPqALoGhBLjZxrCSvdrCGGUiiAjPbqS0bCg615xWYAupLcwufdYbfCNFHhashfNAfNJMqtJ64AZTU1z7/oAcwuW2z91R4GWj6bT9Yy+XyYKCe7uq8kWHeFuDImju9Oh7G8dtWv/3xVGQikGv82eyC3EKWtJnmL/gcReHRhpexjLxMDUqVhvWHfQWeJiVL0p62WPTkzflbWMCz4VhkWxTyDwIevT199frdxWu2y6yY5u9oOB6O42vF+NCg3nK18wDfH9z13Xr5d6/1DU0Fugkjq1DGnRATWm/ofLL7hp9mYs5sn0/Eel2gp9+d6jo+/tSS41UxzcQCncSCmWcy7bKe4Zj/r2nFOaWgB5fsncVVm8hybz8yQSeNk7IkGx6U3V5I52cXlyITxeY7ozEV6zhc8jcILpkl+UslDmT8TOCztVCo6xZrlk02mZSxZRi2Gf06MvrmH86qv9KrrQh3qT6lwX85qXsV1uu0LbruVj5dfVFjA2wvzdWbdl33N4JVzcg=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Webhook","permalink":"/docs/API-docs/delete-webhook"},"next":{"title":"Get Folder","permalink":"/docs/API-docs/getfolder"}}');var n=o(74848),a=o(28453),l=o(33617),i=o.n(l),s=o(17543),d=o.n(s),c=o(86013),p=o.n(c),u=o(63723),f=o.n(u),m=(o(18766),o(79329),o(9303));const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/ZUJX9oAq4udS9F9qpumgdsgNmoXAaoIxuzuaMWYSzIkV7Ig7Fu+pJ/WLymG1Nq6OEZdFEFfDIuc65mZM9y1CFh7kU/Ez0ZV5MQ0ExX50kkbpNEiF5dzgleOMBAkETg5PwVUyiw9rEwLwUCZ7mfxfigyYSw5ZAOnlchFuk63IhOOPrXkw4+mWol8vefu3JmFrAgKUmYJFh02FMgdeBGZKI0OpAPbQGuVLKPH0UfPhtbCl3NqkP9jh9JRxWkmbY0NcaphZUnkwhQfqQwiE9Zx5EGSZ70k+45l83Uv64OTuhaZmBnXYNg+oRtsrGIhTcs+zi4TFh3pkNBjQB5nS3RdJoIM8UcyelUwdh1f3OUWXEvxwFujfcrgeDw+hDjZ2MBZgW/LkryftUqtnjwG1ofBS8ePT9fOj4r5zfFHy8j9Pyrwy7FG/+JanhPb2uB2Eu4zc6d0PD5+NjgaD8bfXR69zJ9/n794ORyPx3+ITNw0inVjE+aiwhDt9iXuf7e2+gp+un2xBFpFAaXy4qD1uOu6TDy/r7EuTENhLnUNS9IBls7oOgOrCD1BcCvAGqUGhYHcf9hp5JxxD4P0uMi2B05qJTVd9VN19Xw8vjq6BeHFIQineoFKVpElL8016a+b6bb7kNwf1lgmoXgvdpLdPk9JeipbJ8NK5JO1uBmglYN0n0+m3TQTDKxhlrfGx4gxzEUuRnuk78ktyPlopXVK5GIegvX5aORRV4W5GRpL2staKyz8sDTNCK0cLY5El+1roLWPkKZ28DgFH7CWun5Ya3qHzAVXLxVoB5/bMqGVv9JKZD3821KZkNw1c8I0XJngpvjtbkW+7ku7u4+2Ce6Q3wRXVeqZiVFsqntmSV/IWsfeWByJ/U3/nlRpGuJVG+YEvfhfn/+MGpUp24Z0iK37BM5aB9Ysyc1aBagrmCm6kYWie94HnrBR5L1agdSBasd7vJK1DKiA4eXJLNFiIZXkZmcxw9oOtubFD+H9nMKcHF994wgQKlqQ4hkBZcw12wkGsA2miT42McPSuOsZh5QBQtF6qcl78ES9Cuk56pKgL2oGxgFqIB3IWSc9AcqGhWfGAc1mspRsmCfbYRmgQY01sbMMOG5GwabHjAdnitYH8Ea1MRH22BCFlKImqvwQfpILSonzYWJgqqBu2UQGpakINoPOaegKCvIBLLuXJUWjPqALoGhBLjZxrCSvdrCGGUiiAjPbqS0bCg615xWYAupLcwufdYbfCNFHhashfNAfNJMqtJ64AZTU1z7/oAcwuW2z91R4GWj6bT9Yy+XyYKCe7uq8kWHeFuDImju9Oh7G8dtWv/3xVGQikGv82eyC3EKWtJnmL/gcReHRhpexjLxMDUqVhvWHfQWeJiVL0p62WPTkzflbWMCz4VhkWxTyDwIevT199frdxWu2y6yY5u9oOB6O42vF+NCg3nK18wDfH9z13Xr5d6/1DU0Fugkjq1DGnRATWm/ofLL7hp9mYs5sn0/Eel2gp9+d6jo+/tSS41UxzcQCncSCmWcy7bKe4Zj/r2nFOaWgB5fsncVVm8hybz8yQSeNk7IkGx6U3V5I52cXlyITxeY7ozEV6zhc8jcILpkl+UslDmT8TOCztVCo6xZrlk02mZSxZRi2Gf06MvrmH86qv9KrrQh3qT6lwX85qXsV1uu0LbruVj5dfVFjA2wvzdWbdl33N4JVzcg=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,k={},x=[];function F(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Folder"}),"\n",(0,n.jsx)(i(),{method:"post",path:"/createfolder",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,n.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:void 0}),"\n",(0,n.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,n.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"folder created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"folderdetails"},title:"folder"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function w(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.45ebbf79.js b/assets/js/28b19cd2.45ebbf79.js deleted file mode 100644 index 8dfe848ad..000000000 --- a/assets/js/28b19cd2.45ebbf79.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5772],{98681:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>b,default:()=>j,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocumentwithtemplateid","permalink":"/docs/API-docs/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztGmtvGzfyr0z5xY2xkh9Jenf61DQJesYVZyNxURwsQ+XujrS0ueSW5EraCvrWX9Kf1l9yGHKfluRHr98uQODY3BnOezgz5IY5vrBscsM+6KTMUTnLbiOWok2MKJzQik3YdYbw3iB3CA0UzI3OwWFeSFp+d3UBXEq9slDpEpyGBSo09EnhCtJmb4gruCutg8LopUiFWrR7zEQKQlmHPAU9h7KQmnsA7reYC4lfCwUuQ5hrkxNMzC1+8wa0gVgobqpXgEs0FTiRo+dDIabETBKY5y0jY7iuyVraDQwWBJHKCkqLqadmIeEKYqyx0yByadGAUA7NnCcI3MHN8fEHjMsF/HhxfHz7deZcYScnJ7woxrpAZcVCSR7bcaLzk5QAi3T+ipgurZe/U+51T53jqZqq/+jSMxG0hZDinJfSwZLL0quBlA4rkS6QdMuJde11JAwonuPguy2LQhsHuE6wcECMcVcajMA6nhcRCCWc4NJGIHK+wPFUnY3h+BhzLuTx8VT9/PPPU7WZKoApo92nbAJT5j9PWRTWDfJUK1nRtzmXFuv1mvUeyre45nkhkRQzZVO1rQlM1TlRJQKHiYbfXkLzTuOQymuicqdjuBZOPkKKQByBvIxegnpI7w3RS3RecFUdplYDvFCfQZNQLB1Ilw7pviW6KXePiEhfX0bx7Gx0+nZ0fnr+dkjsGyLmcO1ivT5MrwZ4Gcm8AsIb0vubV2qGyf2jBBuIl1C8mTLtM+DofMpuO6IjUmcAmxwfQxOjGV8iaIUU2bk2CC7jyi+EaHUZdz4hWcpIMYJFiQnllbhqAtsH/d+9vYwuUr1Sj9ishniZEoNEZ0Ml/oMoGp4KDXHpnH6Eqof6n0myiOmCjgeh1UXKJqxOsXV2XgmXNceCSFnECm54jg4NnVQbzw6bsN7JwSIm6KQquMvYw+NLx3eYuAt/rDQplkXM4C+lMJiyiTMlRsy6StK2VlAssYjhupA6RTYJojGbZJhzNtkwVxUe0hmhFixidCBx11+pI5JY+udZnCXnWRGz7fY2kEXrvtNpRVslWjlUjn7lRSFF4pVycmeJ9U2PZsfuDaPUTcq4jRpWgoykKkOadQKtR68BO565MbwidTnM++sHNjCahNiVuJPvXZLo0imuHNtGIbM/qiIP0N/gTmP/KKBdgoEfo3qnEWJEAi4yrZ6APjt/Tf9enxF8fRz+eZ08zV2d32aeXhMkPZRYa4lc9XG8j22jJnQe379OhbFes+02Yv502omiXnjMPgc/mDWyb1+E5onMtUzRULQ+xhkJbFGls4eO0In8sLYUFtr4flBE2gITMa9glaHL0PjlFVcO/O5dIlXOQwdux0D16rBUEpZOHVPilI3hYu6LrvBF0x8DFnqwwFUKSsORpzezpXeIo5P671in1VGHaYEbrHkWmLYseOC2zrWwElIS31RpjqcDLyCyTRQ15PYpfKjD96V1OgdPpkbyxWFb4UGddMbwnisQKpFlinUpTQqnOhQ2m8YFZt4ztlvYbMiWaGbk8ttt1C0QrcGCj8KwYjBBsRxgtUvYIbZrPVRcF8JUM6pHwkJdDvUZEAsl1GJWGrndjnecr7PMs/W2o6baYrTJ/4HGiJ0LdWlSNM+I14s5WPThdkTOehQB5bagGWGsq6MwOHnNsP96SMt10yGrMXxso9qWsSUo1ezXRY0zYrFAgynUEB45AioaAHmShXzgueJzCmiiXhhcCl3ahr2MWyBNSaQKLDRMtZ7G8F1bkEXQ0w5lhoHs4z2hS73ntX5fb/2BV/0DRZV5jGZHp75fpTa1xoKUV5ao+V6UPnCZlL4zDOYGMjelrkqXpm1q+6dsS6nl7+wtRYfiscTL66tnWJoEglHIjqGGCzYIe8Dl9RUs0Yh5XbKM4Ufb2qkxPB+AQKJThKXgwfQRrDKRZKT9CnKaCqDy9gqp3Nuta9j9AQkj2GUoFXYvR1E4TShUS8/avo0hFQYTJyvvQLp0wNNUEDqXYB0WdrzvmA5KuNblc2LmCU1yWJQi9ZYuTZu40dioNyah0YgpE0K2kJamGR3UTkuQCVrb6anRCgH19o8AlQ3oHObcOjQRlMpPNExZUDQ0W+K6QCNQJbhXBb1E93SqpSPZDyR0OHwLNFYr6pW0WXAlfg0OQprJtKXaLuMygNZpwkKMxBVF9zCJNVOWP377nXV8HaxEdxkLFHiaGrT2CQ59Gxfcibo+gwVlPz3kiPZD8+3D8Q9x511yluu0dVP7fA+6QpMLZ9uc6DRxDSgxTNdsmWTAbZdrbX+o46c8NiKRqHr0kyJdkLy4FtaRcptRkTgUfZ+Q9Jj0ePBTMYoZ8ihV9cOn5cvpB9v5qk/YsNqv1PZ42sFKddYvVf2J78vaYV/nF2yhlQ3F+/npKf03VG871WxGfbZMKJrmpZTVVyx6fpf2eOfQdKIv7SGzO3H+6zpZnl95BxcLVRr55xuYp5u0fT3Hg5EdcTLk4nmi1OPR0siR0yOSZdT6hd+2Z2+hpFA4aww4S3Uya6QnuByt5Yu96ecxHlpz+0phaOsnyJOLbSP2Zp8XXfjz2A+C1JE/R9p4oj6iCRiKrWbQqw0o7dr5bgPCpfbB6LK6NKE23GN6N//L/BGN0eal2ruSyC11Xa4sOknCxk9p8M3p6SzplPh2jxLVkkuR+huFa32P6i8Mv4PidsL1ybtAnlhd57Lr/JkIQP47G0jbXw9CWkxKI1zlB1frES/EKHyf3NzSOChHl2kagRXaeo5pgjVhJ8NUd7Lp5boto23NshmH+ShsA8tylcZ6vXv3wAtxsqSJxEOMvTcVB6Gt4wuhFqNHsW47wT+TcYL+B+J3yasQ/0Jy6lq7fah6rJchp+6E9Ek2/9SN0D42luvNum6asVV/NtWOpnbmTS3hZqbUjpR6c6Pe2Kg/gGzGPP0pTz0tbAc5g2mNt3k3SmFsOC4Jk8gH7T9jw7a2QWqbtoC1r/M4ezuo+WvW+sVrM9vsF3ODiuphQXWwuDlQ2zTlolBz7a1eB8tlgYrmSz7Ulmc7Jc9PKBMd+iKqEhrwP3773WM0keHJfAWXpYFCr9DMS+mz7VziWlD9u3s1aZHnEq2Vlb/IW/hrylQshKOSvy5+E17wWEhBuYPAdOi1eunHjuGnbi51ZPz9Ii5RUsoBqfW9r9E18NLp3NNozp2VNvdzYikCDjHdA1LhaREbFFQZVwkl2RBEvmjjKjRIhREWgYucgKldwPlcJMLXL1o5wxMHOVd84auvCIhv0kJ9ylgwOqZuy2pZhn7CacgRXRDR31GM4QP1b15w32OiI7OnoZWwUWjl6jAiMVQKMfqLXZ44kWDothw3DiTdyvqkEcYEpZRQaBdadyo/+7aljZzhyvpL3tDf1qZp1Vf3Op5Gyqsx0CXGZ3KW0iI5gBTq3k7oquamdbOfMLbCYXdBu1qtdhLYqyHO98JlZUxFvu7wFn7Rp7s+evvHKxYxhya3l/PPaJYiacqeAzRPPPBJfczxMPBrgo0XYm8bIUWCymLvUHr3/dUPsITX41MW9VL2Mxg++eHi/cd/f/5I+9KhEuLvbHw6PvXzdW1dzlWP1N63AL2blUEg9644vjwk+PKQ4MtDgi8PCb48JPjykOAve0hQdxFk0ZNCcqF6g4nQTN08mBuxiE36bwduI5ZR8zW5YZsN5b4f6aKEln8p0VDndhuxJTeCqmZf/9ez1bRX7B848b7+VE+jXsGBZwh7+W9aI0V9kTd7KPvvsXrw8GF7u42a/ohYCxDvAwOja9qn22Gneab2LmC8SyiXPwrb71avLj9fs4g192y5fyfBDF9RK8RXgdtgsPCOgNY2THK1KP3EhoU9qaXjJVmp3w/e+36w/oWk2quPYaMYxKCfJNRehM0m9JrbbQsfPh3EqBXbQJNxbrfb7X8B+jdzoA==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"}}');var a=n(74848),s=n(28453),r=n(33617),o=n.n(r),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 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:"eJztGmtvGzfyr0z5xY2xkh9Jenf61DQJesYVZyNxURwsQ+XujrS0ueSW5EraCvrWX9Kf1l9yGHKfluRHr98uQODY3BnOezgz5IY5vrBscsM+6KTMUTnLbiOWok2MKJzQik3YdYbw3iB3CA0UzI3OwWFeSFp+d3UBXEq9slDpEpyGBSo09EnhCtJmb4gruCutg8LopUiFWrR7zEQKQlmHPAU9h7KQmnsA7reYC4lfCwUuQ5hrkxNMzC1+8wa0gVgobqpXgEs0FTiRo+dDIabETBKY5y0jY7iuyVraDQwWBJHKCkqLqadmIeEKYqyx0yByadGAUA7NnCcI3MHN8fEHjMsF/HhxfHz7deZcYScnJ7woxrpAZcVCSR7bcaLzk5QAi3T+ipgurZe/U+51T53jqZqq/+jSMxG0hZDinJfSwZLL0quBlA4rkS6QdMuJde11JAwonuPguy2LQhsHuE6wcECMcVcajMA6nhcRCCWc4NJGIHK+wPFUnY3h+BhzLuTx8VT9/PPPU7WZKoApo92nbAJT5j9PWRTWDfJUK1nRtzmXFuv1mvUeyre45nkhkRQzZVO1rQlM1TlRJQKHiYbfXkLzTuOQymuicqdjuBZOPkKKQByBvIxegnpI7w3RS3RecFUdplYDvFCfQZNQLB1Ilw7pviW6KXePiEhfX0bx7Gx0+nZ0fnr+dkjsGyLmcO1ivT5MrwZ4Gcm8AsIb0vubV2qGyf2jBBuIl1C8mTLtM+DofMpuO6IjUmcAmxwfQxOjGV8iaIUU2bk2CC7jyi+EaHUZdz4hWcpIMYJFiQnllbhqAtsH/d+9vYwuUr1Sj9ishniZEoNEZ0Ml/oMoGp4KDXHpnH6Eqof6n0myiOmCjgeh1UXKJqxOsXV2XgmXNceCSFnECm54jg4NnVQbzw6bsN7JwSIm6KQquMvYw+NLx3eYuAt/rDQplkXM4C+lMJiyiTMlRsy6StK2VlAssYjhupA6RTYJojGbZJhzNtkwVxUe0hmhFixidCBx11+pI5JY+udZnCXnWRGz7fY2kEXrvtNpRVslWjlUjn7lRSFF4pVycmeJ9U2PZsfuDaPUTcq4jRpWgoykKkOadQKtR68BO565MbwidTnM++sHNjCahNiVuJPvXZLo0imuHNtGIbM/qiIP0N/gTmP/KKBdgoEfo3qnEWJEAi4yrZ6APjt/Tf9enxF8fRz+eZ08zV2d32aeXhMkPZRYa4lc9XG8j22jJnQe379OhbFes+02Yv502omiXnjMPgc/mDWyb1+E5onMtUzRULQ+xhkJbFGls4eO0In8sLYUFtr4flBE2gITMa9glaHL0PjlFVcO/O5dIlXOQwdux0D16rBUEpZOHVPilI3hYu6LrvBF0x8DFnqwwFUKSsORpzezpXeIo5P671in1VGHaYEbrHkWmLYseOC2zrWwElIS31RpjqcDLyCyTRQ15PYpfKjD96V1OgdPpkbyxWFb4UGddMbwnisQKpFlinUpTQqnOhQ2m8YFZt4ztlvYbMiWaGbk8ttt1C0QrcGCj8KwYjBBsRxgtUvYIbZrPVRcF8JUM6pHwkJdDvUZEAsl1GJWGrndjnecr7PMs/W2o6baYrTJ/4HGiJ0LdWlSNM+I14s5WPThdkTOehQB5bagGWGsq6MwOHnNsP96SMt10yGrMXxso9qWsSUo1ezXRY0zYrFAgynUEB45AioaAHmShXzgueJzCmiiXhhcCl3ahr2MWyBNSaQKLDRMtZ7G8F1bkEXQ0w5lhoHs4z2hS73ntX5fb/2BV/0DRZV5jGZHp75fpTa1xoKUV5ao+V6UPnCZlL4zDOYGMjelrkqXpm1q+6dsS6nl7+wtRYfiscTL66tnWJoEglHIjqGGCzYIe8Dl9RUs0Yh5XbKM4Ufb2qkxPB+AQKJThKXgwfQRrDKRZKT9CnKaCqDy9gqp3Nuta9j9AQkj2GUoFXYvR1E4TShUS8/avo0hFQYTJyvvQLp0wNNUEDqXYB0WdrzvmA5KuNblc2LmCU1yWJQi9ZYuTZu40dioNyah0YgpE0K2kJamGR3UTkuQCVrb6anRCgH19o8AlQ3oHObcOjQRlMpPNExZUDQ0W+K6QCNQJbhXBb1E93SqpSPZDyR0OHwLNFYr6pW0WXAlfg0OQprJtKXaLuMygNZpwkKMxBVF9zCJNVOWP377nXV8HaxEdxkLFHiaGrT2CQ59Gxfcibo+gwVlPz3kiPZD8+3D8Q9x511yluu0dVP7fA+6QpMLZ9uc6DRxDSgxTNdsmWTAbZdrbX+o46c8NiKRqHr0kyJdkLy4FtaRcptRkTgUfZ+Q9Jj0ePBTMYoZ8ihV9cOn5cvpB9v5qk/YsNqv1PZ42sFKddYvVf2J78vaYV/nF2yhlQ3F+/npKf03VG871WxGfbZMKJrmpZTVVyx6fpf2eOfQdKIv7SGzO3H+6zpZnl95BxcLVRr55xuYp5u0fT3Hg5EdcTLk4nmi1OPR0siR0yOSZdT6hd+2Z2+hpFA4aww4S3Uya6QnuByt5Yu96ecxHlpz+0phaOsnyJOLbSP2Zp8XXfjz2A+C1JE/R9p4oj6iCRiKrWbQqw0o7dr5bgPCpfbB6LK6NKE23GN6N//L/BGN0eal2ruSyC11Xa4sOknCxk9p8M3p6SzplPh2jxLVkkuR+huFa32P6i8Mv4PidsL1ybtAnlhd57Lr/JkIQP47G0jbXw9CWkxKI1zlB1frES/EKHyf3NzSOChHl2kagRXaeo5pgjVhJ8NUd7Lp5boto23NshmH+ShsA8tylcZ6vXv3wAtxsqSJxEOMvTcVB6Gt4wuhFqNHsW47wT+TcYL+B+J3yasQ/0Jy6lq7fah6rJchp+6E9Ek2/9SN0D42luvNum6asVV/NtWOpnbmTS3hZqbUjpR6c6Pe2Kg/gGzGPP0pTz0tbAc5g2mNt3k3SmFsOC4Jk8gH7T9jw7a2QWqbtoC1r/M4ezuo+WvW+sVrM9vsF3ODiuphQXWwuDlQ2zTlolBz7a1eB8tlgYrmSz7Ulmc7Jc9PKBMd+iKqEhrwP3773WM0keHJfAWXpYFCr9DMS+mz7VziWlD9u3s1aZHnEq2Vlb/IW/hrylQshKOSvy5+E17wWEhBuYPAdOi1eunHjuGnbi51ZPz9Ii5RUsoBqfW9r9E18NLp3NNozp2VNvdzYikCDjHdA1LhaREbFFQZVwkl2RBEvmjjKjRIhREWgYucgKldwPlcJMLXL1o5wxMHOVd84auvCIhv0kJ9ylgwOqZuy2pZhn7CacgRXRDR31GM4QP1b15w32OiI7OnoZWwUWjl6jAiMVQKMfqLXZ44kWDothw3DiTdyvqkEcYEpZRQaBdadyo/+7aljZzhyvpL3tDf1qZp1Vf3Op5Gyqsx0CXGZ3KW0iI5gBTq3k7oquamdbOfMLbCYXdBu1qtdhLYqyHO98JlZUxFvu7wFn7Rp7s+evvHKxYxhya3l/PPaJYiacqeAzRPPPBJfczxMPBrgo0XYm8bIUWCymLvUHr3/dUPsITX41MW9VL2Mxg++eHi/cd/f/5I+9KhEuLvbHw6PvXzdW1dzlWP1N63AL2blUEg9644vjwk+PKQ4MtDgi8PCb48JPjykOAve0hQdxFk0ZNCcqF6g4nQTN08mBuxiE36bwduI5ZR8zW5YZsN5b4f6aKEln8p0VDndhuxJTeCqmZf/9ez1bRX7B848b7+VE+jXsGBZwh7+W9aI0V9kTd7KPvvsXrw8GF7u42a/ohYCxDvAwOja9qn22Gneab2LmC8SyiXPwrb71avLj9fs4g192y5fyfBDF9RK8RXgdtgsPCOgNY2THK1KP3EhoU9qaXjJVmp3w/e+36w/oWk2quPYaMYxKCfJNRehM0m9JrbbQsfPh3EqBXbQJNxbrfb7X8B+jdzoA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,g={},y=[];function x(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,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,a.jsx)(o(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,a.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,a.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,a.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,a.jsxs)(t.ol,{children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"2",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"3",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"4",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"5",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"6",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"7",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,a.jsxs)(t.ul,{children:["\n",(0,a.jsxs)(t.li,{children:[(0,a.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,a.jsxs)(t.ol,{start:"8",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"9",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.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,a.jsx)(c(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,a.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,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.fbf28e5d.js b/assets/js/28b19cd2.fbf28e5d.js new file mode 100644 index 000000000..610946b0a --- /dev/null +++ b/assets/js/28b19cd2.fbf28e5d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5772],{98681:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>j,contentTitle:()=>f,default:()=>b,frontMatter:()=>g,metadata:()=>i,toc:()=>x});const i=JSON.parse('{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","source":"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocumentwithtemplateid","permalink":"/docs/API-docs/createdocumentwithtemplateid","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar_label":"Create Document from Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztWttuIzcS/ZUKX5wxWvJlZrK7espkZpA1NlgbMw6ChWUo7O6Smjab7JBsSR1Bb/mSfFq+ZFFkXy3Jl2zedoCBx2YXWcW6sU6RG+b4wrLJDfugkzJH5Sy7jViKNjGicEIrNmHXGcJ7g9whNFQwNzoHh3khafjd1QVwKfXKQqVLcBoWqNDQJ4UrSJu1Ia7grrQOCqOXIhVq0a4xEykIZR3yFPQcykJq7gm4X2IuJH4tFLgMYa5NTjQxt/jNG9AGYqG4qV4BLtFU4ESOXg6FmJIwSRCet4KM4bpma2k1MFgQRSorKC2mnpuFhCuIsZ6dhi2XFg0I5dDMeYLAHdwcH3/AuFzAjxfHx7dfZ84VdnJywotirAtUViyU5LEdJzo/SYmwSOevSOjS+v13yr3uqXM8VVP1H116IYK2EFKc81I6WHJZejWQ0mEl0gWSbjmJrr2OhAHFcxx8t2VRaOMA1wkWDkgw7kqDEVjH8yICoYQTXNoIRM4XOJ6qszEcH2POhTw+nqqff/55qjZTBTBltPqUTWDK/Ocpi8K4QZ5qJSv6NufSYj1ei96b8i2ueV5IJMVM2VRtawZTdU5cicFhpuG3l/C80zjk8pq43OkYroWTj7AiEkckL+OXoB7ye0P8Ep0XXFWHudUEL9Rn0CQUSwfSpUO+b4lvyt0jW6SvL+N4djY6fTs6Pz1/O2T2DTFzuHaxXh/mVxO8jGVeAc0b8vubV2qGyf2jDBuKl3C8mTLtM+DofMpuO6YjUmcgmxwfQxOjGV8iaIUU2bk2CC7jyg+EaHUZdz4hWcpIMYJFiQnllbhqAtsH/d+9vYwuUr1Sj9ispniZEsOOzoZK/AdxNDwVGuLSOf0IV0/1P7NkEdMFHQ9Cq4uUTVidYuvsvBIua44FkbKIFdzwHB0aOqk2Xhw2Yb2Tg0VM0ElVcJexh8eXju8wcRf+WGlSLIuYwV9KYTBlE2dKjJh1laRlraBYYhHDdSF1imwStsZskmHO2WTDXFV4SmeEWrCI0YHEXX+kjkgS6Z9ncZacZ0XMttvbwBat+06nFS2VaOVQOfqVF4UUiVfKyZ0l0Tc9np24N4xSNynjNmpECXskVRnSrBNo/fSasJOZG8MrUpfDvD9+YAGjaRO7O+729y5JdOkUV45to5DZH1WRJ+gvcKexfxTQKsHAj3G90wgxIhEXmVZPUJ+dv6Z/r8+Ivj4O/7xOnpauzm8zz68Jkt6UWGuJXPXneB/bRk3oPL5+nQpjvWbbbcT86bQTRb3wmH0OfjBr9r590TTPZK5lioai9THJaMMWVTp76Ajdlh/WlsJCG98PikhbYCLmFawydBkaP7ziyoFfvUukynnqIO0YqF4dlkrC0qljSpyyMVzMfdEVvmj6YyBCjxa4SkFpOPL8Zrb0DnF0Uv8d67Q66mZa4AZrmQWmrQieuK1zLayElCQ3VZrj6cALiG0TRQ27fQof6vB9aZ3OwbOpJ/nisK3woE46Y3jPFQiVyDLFupQmhVMdCptN4wIz7xnbLWw2ZEs0M3L57TbqBojXYMBHYRgxmKBYDma1Q9hNbMd6U3FdCFPNqB4JA3U51BdALJRQi1lp5HY73nG+zjLP1tuOmmqL0SL/BxojcS7UpUnRPCNeL+Zg0YfbETnrUQSU24JmhLGujsLg5LXA/ushLdegQ1Zj+NhGtS1jS1SqWa+LGmfEYoEGU6gp/OQIqGgA5EkW8oGXis8poIl7YXApdGkb8TJugTQlkSqwAJhqPY3hu7Ygi6CnHcoMg72P94QuYc9r/b5e+gOv+geKKvMYzY5OPV4lmFrPgpRXlrh5LEofuExKjwyDuYHMTamr0qVpQW3/lG05tfKdvaXoUDyWeHl99QxL04ZgFLJjqOGCDcIacHl9BUs0Yl6XLGP40bZ2agzPBySQ6BRhKXgwfQSrTCQZab+CnLoCqLy9Qir3dusAuz8gYQS7AqXC7pUoCqcJhWrpRdu3MKTCYOJk5R1Ilw54mgqaziVYh4Ud7zumgxKudfmcmHlCkxwWpUi9pUvTJm40Nuq1Sag1YsqEJltIS9O0DmqnJcoEre301GiFiHrrR4DKhukc5tw6NBGUync0TFlQNDRL4rpAI1AluFcFvUT3dKqlI9k3JHQ4fAs0VivCStosuBK/BgchzWTaUm2XcRlI6zRhIUaSiqJ7mMSaLssfv/3OOrkOVqK7ggUOPE0NWvuEhB7GBXci1GewoOynhxLRemi+fdj+Iem8S85ynbZuap/vQVdocuFsmxOdJqkBJYbumi2TDLjtcq3tN3V8l8dGtCWqHn2nSBe0X1wL60i5TatIHIq+T0h6THoy+K4YxQx5lKr64dPK5fSD5XzVJ2wY7VdqezztYKU665eq/sT3Ze0Q1/kBW2hlQ/F+fnpK/w3V23Y1m1afLROKpnkpZfUVi56P0h5HDg0SfSmGzO7E+a/rZHl+5R1cLFRp5J8HME+DtH2Y40HLjiQZSvG8rdTt0dLIkdMj2suo9Qu/bM/eQkmhcNYYcJbqZNbsnuhytJYv9qafx2Roze0rhaGtn2BPLraN2Jt9XnThz2PfCFJH/hxp44lwRBMwFFtNo1cbUNq1/d2GhEvtg9FldWlCMNzP9G7+l/kjGqPNS7V3JZFbQl2uLLqdhIWf0uCb09NZ0inx7R4lqiWXIvU3Ctf6HtVfGH4Ht9ttrs/eBfYk6jqXHfJnIhD572yw2/542KTFpDTCVb5xtR7xQozC98nNLbWDcnSZphZYoa2XmDpYE3YyTHUnm16u2zJa1iybdpiPwjawLFdprNe7dw+8ECdL6kg8nLH3puIgNZajl02wji+EWjw+67bT1GeyZjDYQF9dtivEv5CioDZHn6ruA2bICc6QAchJPnU9t4+NqXvNsZumz9VvZrW9rJ0GVcu4aUK1Paheo6nXZ+p3LJu+UL8tVLcX287PoL3jnaTrvTA27K+E1uWDfgFjQxzcTGpRXpi1D6qcvR2AhFq0frXbNEP71d+gBHtYgR2shg4UQ019KdRce6vX0XVZoKKGlI/N5dlOjfQTykQHIEVlRUP+x2+/+xlNKHk2X8FlaaDQKzTzUvr0PJe4FlQw795lWuS5RGtl5W/+Fv5eMxUL4Qgj1NVywgseCyko2RCZDuCsl6/sGH7qGllHxl9I4hIl5SiQWt/7ol4DL53OPY/moFppcz8nkSLgENPFIVWqFrGZgirjKqGsHILIV3lcBURVGGERuMiJmPAFzuciEb7g0coZnjjIueILX65FQHKTFupjyYLRMcEzq2UZAIjTkCO6sEV/qTGGDwT4/MY9KEVHZk8D9rBRwH51GNE2VAox+ptgnjiRYIBnjhsHkq5xfdIIfYVSSii0C1if6tW+bWkhZ7iy/lY4AOLaNK36anDkeaS8GgPdenwmZyktkgNIoe7thO52blo3+wljKxx2N7qr1Wongb0azvleuKyMCRXobt7CD/p015/e/vGKRcyhye3l/DOapUiaOukAzxNPfFKfizx0CJtg44XYizukSFBZ7J1i776/+gGW8Hp8yqJeyn6GwCc/XLz/+O/PH2ldOoVC/J2NT8enviGvrcu56rHa+3igdxUzCOTenciXlwdfXh58eXnw5eXBl5cHX14e/GUvD2oUQRY9KSQXqtfJCOjr5kGjiUVs0n9scBuxjNDa5IZtNpT7fqSbFRr+pURDUO82YktuBFXNvv6vm7Fpr9g/cOJ9/aluX72CA+8W9srfQCNFuMibPZT991g9eCmxvd1GDT4i0QLF+yDA6JrW6VbYQdsE78KMdwnl8kdp+/D26vLzNYtYczGX+4cVzPAVQSG+CtIGg4WHBzS2YZKrRelbPCysSZCOl2SlPh6893iw/oV2tVcfQ6AYtkE/aVN7J2w2AWtuty19+HRwRq3YhpqMc7vdbv8LOVCEyw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"},"next":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"}}');var a=n(74848),r=n(28453),o=n(33617),l=n.n(o),s=n(17543),d=n.n(s),c=n(86013),p=n.n(c),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const g={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWttuIzcS/ZUKX5wxWvJlZrK7espkZpA1NlgbMw6ChWUo7O6Smjab7JBsSR1Bb/mSfFq+ZFFkXy3Jl2zedoCBx2YXWcW6sU6RG+b4wrLJDfugkzJH5Sy7jViKNjGicEIrNmHXGcJ7g9whNFQwNzoHh3khafjd1QVwKfXKQqVLcBoWqNDQJ4UrSJu1Ia7grrQOCqOXIhVq0a4xEykIZR3yFPQcykJq7gm4X2IuJH4tFLgMYa5NTjQxt/jNG9AGYqG4qV4BLtFU4ESOXg6FmJIwSRCet4KM4bpma2k1MFgQRSorKC2mnpuFhCuIsZ6dhi2XFg0I5dDMeYLAHdwcH3/AuFzAjxfHx7dfZ84VdnJywotirAtUViyU5LEdJzo/SYmwSOevSOjS+v13yr3uqXM8VVP1H116IYK2EFKc81I6WHJZejWQ0mEl0gWSbjmJrr2OhAHFcxx8t2VRaOMA1wkWDkgw7kqDEVjH8yICoYQTXNoIRM4XOJ6qszEcH2POhTw+nqqff/55qjZTBTBltPqUTWDK/Ocpi8K4QZ5qJSv6NufSYj1ei96b8i2ueV5IJMVM2VRtawZTdU5cicFhpuG3l/C80zjk8pq43OkYroWTj7AiEkckL+OXoB7ye0P8Ep0XXFWHudUEL9Rn0CQUSwfSpUO+b4lvyt0jW6SvL+N4djY6fTs6Pz1/O2T2DTFzuHaxXh/mVxO8jGVeAc0b8vubV2qGyf2jDBuKl3C8mTLtM+DofMpuO6YjUmcgmxwfQxOjGV8iaIUU2bk2CC7jyg+EaHUZdz4hWcpIMYJFiQnllbhqAtsH/d+9vYwuUr1Sj9ispniZEsOOzoZK/AdxNDwVGuLSOf0IV0/1P7NkEdMFHQ9Cq4uUTVidYuvsvBIua44FkbKIFdzwHB0aOqk2Xhw2Yb2Tg0VM0ElVcJexh8eXju8wcRf+WGlSLIuYwV9KYTBlE2dKjJh1laRlraBYYhHDdSF1imwStsZskmHO2WTDXFV4SmeEWrCI0YHEXX+kjkgS6Z9ncZacZ0XMttvbwBat+06nFS2VaOVQOfqVF4UUiVfKyZ0l0Tc9np24N4xSNynjNmpECXskVRnSrBNo/fSasJOZG8MrUpfDvD9+YAGjaRO7O+729y5JdOkUV45to5DZH1WRJ+gvcKexfxTQKsHAj3G90wgxIhEXmVZPUJ+dv6Z/r8+Ivj4O/7xOnpauzm8zz68Jkt6UWGuJXPXneB/bRk3oPL5+nQpjvWbbbcT86bQTRb3wmH0OfjBr9r590TTPZK5lioai9THJaMMWVTp76Ajdlh/WlsJCG98PikhbYCLmFawydBkaP7ziyoFfvUukynnqIO0YqF4dlkrC0qljSpyyMVzMfdEVvmj6YyBCjxa4SkFpOPL8Zrb0DnF0Uv8d67Q66mZa4AZrmQWmrQieuK1zLayElCQ3VZrj6cALiG0TRQ27fQof6vB9aZ3OwbOpJ/nisK3woE46Y3jPFQiVyDLFupQmhVMdCptN4wIz7xnbLWw2ZEs0M3L57TbqBojXYMBHYRgxmKBYDma1Q9hNbMd6U3FdCFPNqB4JA3U51BdALJRQi1lp5HY73nG+zjLP1tuOmmqL0SL/BxojcS7UpUnRPCNeL+Zg0YfbETnrUQSU24JmhLGujsLg5LXA/ushLdegQ1Zj+NhGtS1jS1SqWa+LGmfEYoEGU6gp/OQIqGgA5EkW8oGXis8poIl7YXApdGkb8TJugTQlkSqwAJhqPY3hu7Ygi6CnHcoMg72P94QuYc9r/b5e+gOv+geKKvMYzY5OPV4lmFrPgpRXlrh5LEofuExKjwyDuYHMTamr0qVpQW3/lG05tfKdvaXoUDyWeHl99QxL04ZgFLJjqOGCDcIacHl9BUs0Yl6XLGP40bZ2agzPBySQ6BRhKXgwfQSrTCQZab+CnLoCqLy9Qir3dusAuz8gYQS7AqXC7pUoCqcJhWrpRdu3MKTCYOJk5R1Ilw54mgqaziVYh4Ud7zumgxKudfmcmHlCkxwWpUi9pUvTJm40Nuq1Sag1YsqEJltIS9O0DmqnJcoEre301GiFiHrrR4DKhukc5tw6NBGUync0TFlQNDRL4rpAI1AluFcFvUT3dKqlI9k3JHQ4fAs0VivCStosuBK/BgchzWTaUm2XcRlI6zRhIUaSiqJ7mMSaLssfv/3OOrkOVqK7ggUOPE0NWvuEhB7GBXci1GewoOynhxLRemi+fdj+Iem8S85ynbZuap/vQVdocuFsmxOdJqkBJYbumi2TDLjtcq3tN3V8l8dGtCWqHn2nSBe0X1wL60i5TatIHIq+T0h6THoy+K4YxQx5lKr64dPK5fSD5XzVJ2wY7VdqezztYKU665eq/sT3Ze0Q1/kBW2hlQ/F+fnpK/w3V23Y1m1afLROKpnkpZfUVi56P0h5HDg0SfSmGzO7E+a/rZHl+5R1cLFRp5J8HME+DtH2Y40HLjiQZSvG8rdTt0dLIkdMj2suo9Qu/bM/eQkmhcNYYcJbqZNbsnuhytJYv9qafx2Roze0rhaGtn2BPLraN2Jt9XnThz2PfCFJH/hxp44lwRBMwFFtNo1cbUNq1/d2GhEvtg9FldWlCMNzP9G7+l/kjGqPNS7V3JZFbQl2uLLqdhIWf0uCb09NZ0inx7R4lqiWXIvU3Ctf6HtVfGH4Ht9ttrs/eBfYk6jqXHfJnIhD572yw2/542KTFpDTCVb5xtR7xQozC98nNLbWDcnSZphZYoa2XmDpYE3YyTHUnm16u2zJa1iybdpiPwjawLFdprNe7dw+8ECdL6kg8nLH3puIgNZajl02wji+EWjw+67bT1GeyZjDYQF9dtivEv5CioDZHn6ruA2bICc6QAchJPnU9t4+NqXvNsZumz9VvZrW9rJ0GVcu4aUK1Paheo6nXZ+p3LJu+UL8tVLcX287PoL3jnaTrvTA27K+E1uWDfgFjQxzcTGpRXpi1D6qcvR2AhFq0frXbNEP71d+gBHtYgR2shg4UQ019KdRce6vX0XVZoKKGlI/N5dlOjfQTykQHIEVlRUP+x2+/+xlNKHk2X8FlaaDQKzTzUvr0PJe4FlQw795lWuS5RGtl5W/+Fv5eMxUL4Qgj1NVywgseCyko2RCZDuCsl6/sGH7qGllHxl9I4hIl5SiQWt/7ol4DL53OPY/moFppcz8nkSLgENPFIVWqFrGZgirjKqGsHILIV3lcBURVGGERuMiJmPAFzuciEb7g0coZnjjIueILX65FQHKTFupjyYLRMcEzq2UZAIjTkCO6sEV/qTGGDwT4/MY9KEVHZk8D9rBRwH51GNE2VAox+ptgnjiRYIBnjhsHkq5xfdIIfYVSSii0C1if6tW+bWkhZ7iy/lY4AOLaNK36anDkeaS8GgPdenwmZyktkgNIoe7thO52blo3+wljKxx2N7qr1Wongb0azvleuKyMCRXobt7CD/p015/e/vGKRcyhye3l/DOapUiaOukAzxNPfFKfizx0CJtg44XYizukSFBZ7J1i776/+gGW8Hp8yqJeyn6GwCc/XLz/+O/PH2ldOoVC/J2NT8enviGvrcu56rHa+3igdxUzCOTenciXlwdfXh58eXnw5eXBl5cHX14e/GUvD2oUQRY9KSQXqtfJCOjr5kGjiUVs0n9scBuxjNDa5IZtNpT7fqSbFRr+pURDUO82YktuBFXNvv6vm7Fpr9g/cOJ9/aluX72CA+8W9srfQCNFuMibPZT991g9eCmxvd1GDT4i0QLF+yDA6JrW6VbYQdsE78KMdwnl8kdp+/D26vLzNYtYczGX+4cVzPAVQSG+CtIGg4WHBzS2YZKrRelbPCysSZCOl2SlPh6893iw/oV2tVcfQ6AYtkE/aVN7J2w2AWtuty19+HRwRq3YhpqMc7vdbv8LOVCEyw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,j={},x=[];function 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,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Document from Template"}),"\n",(0,a.jsx)(l(),{method:"post",path:"/createdocument/{template_id}",context:"endpoint"}),"\n",(0,a.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,a.jsx)(t.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(t.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,a.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,a.jsxs)(t.ol,{children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"email"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "email",\n "readonly": false,\n "default": "email@example.com"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"2",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"name"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "name",\n "readonly": false,\n "default": "joe"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"3",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"job Title"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "job title",\n "readonly": false,\n "default": "ceo"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"4",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"company"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "company",\n "readonly": false,\n "default": "example pvt ltd"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"5",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"date"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "date",\n "readonly": false,\n "default": "11-05-2025"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"6",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"textbox"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "textbox",\n "readonly": false,\n "default": "my text"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"7",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "checkbox",\n "readonly": false,\n "default": ["option-2"]\n}\n'})}),"\n",(0,a.jsxs)(t.ul,{children:["\n",(0,a.jsxs)(t.li,{children:[(0,a.jsx)(t.strong,{children:"default:"})," You can have one or more than one value that needs to be selected by default."]}),"\n"]}),"\n",(0,a.jsxs)(t.ol,{start:"8",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "dropdown",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,a.jsxs)(t.ol,{start:"9",children:["\n",(0,a.jsx)(t.li,{children:(0,a.jsx)(t.strong,{children:"radio button"})}),"\n"]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{children:'{\n "name": "radio",\n "readonly": false,\n "default": "option1"\n}\n'})}),"\n",(0,a.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.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,a.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["signers"],type:"object",properties:{signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"Accoutnant"},email:{type:"string",format:"mail",example:"joe@example.com"},name:{type:"string",example:"joe bee"},phone:{type:"string",example:"123123131"},widgets:{type:"array",items:{type:"object",properties:{name:{type:"string",example:"textbox_1"},readonly:{type:"boolean",example:!1},default:{type:"string",example:"my textbox"}},title:"createdocumenttemplate_id_Signers_widgets"}}},title:"createdocumenttemplate_id_Signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_template_id_body"}}},required:!0}}),"\n",(0,a.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 b(e={}){const{wrapper:t}={...(0,r.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/2c586be5.7f649be6.js b/assets/js/2c586be5.7f649be6.js new file mode 100644 index 000000000..8df7288dd --- /dev/null +++ b/assets/js/2c586be5.7f649be6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9599],{60112:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>i,toc:()=>j});const i=JSON.parse('{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/createdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocument","permalink":"/docs/API-docs/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztG9lyHLfxV5B5kcWaXXJXlKzwKbLkJEwck2VS5UqRLBo707sDcQYYA5g9zNo3f0k+LV+S6gYwxx5c6ohDV1YP4g7QABqN7kZfuI8sn5jo5Cp6p5KqAGlNdBNHKZhEi9IKJaOT6DID9lYDt8ACFHtzfsp4nquZYZUBbZhVbAISNEJJmLE0zMdGC1ZqNRWpkBOWcsvZTNiMjbiBV8cMZKJSSNlY5NC/ltfyUpQn7H2ZK56yhao0O3/353o2XAbbrg4O3sGomrD3pwcHN19l1pbm5PCQl2VflSCNmMicj0w/UcVhioBlOn4es1kGGnBWlnDJgBuRLxhPUzYT6QSsiZnNQLJElQuWKKVTIbkFE7OST4DJqhiBNjHjMmWF0sCEZJxp4OmiZ1WvMsD+dnH2PRsrXXDbZ+d5ZeJ6uVRoSGy+cNPbDOpdPTOBGsZqIScxK/gdUktY9nMlkjvctgGZ4l8c+Ob8lGh1cHBRlaXSFlL2o9vCycEB9nwDuZoxroHgE1UUSrKSa16ApePKuKVuDT9XQkPqDoXneaDFybXssYMDuyjh5OCAncpUJEgMmhBbmRp72L4DRSIh6EUJiRgLD9oiHVOSzTKRZESTGXfnWeY8cWhqMCUkVkyhO/E8Zguc+B1IFTDIlBa/KGl5TscxBW1FwvP2sSGCCGos1xbJWSohbWj1K7B/+uPB06ND8XyFqKVIrEJI6jHApjyvwHisZjHLEKsfoNRgiNX9vEhImbIMxCTbuh5PP1TGdiZmlUE021j4tcIpEXmByDbmuQEmxh1aFvwOWqsxRTLM8z77ZsFSGPMqtzETyHFWV9Bn3yvLeFnmIuGjHJBzGQoPt5WGHp2yZwePiOQFnfE5STQYxlkqxmPQKJzYSVP4MQE75LNGBZDk2IxLpuTKQScqV3qdhai5S0eWKGlB2j57M+UiJ+TdZg0TMsmrFNgo58ldzEZ5BTHTkDrBXQCqrdgrIQRh3HiaE32YgRy5UEnEXyq/vDDMeKzSPrvMhGnkCTsDqWkRYdpU9VI7VrgykiCIGIOCizwmwsXsgxoxK2wOMQpsyeUiRn0JMbMwtyM1j1mSQXJHvzRPhWKjylol3cZSrcpUzaSn5VhJa8QvGyQy9Hw8RYcxO47Zq5i9jtngKGaDYcwGxzEbvIrZ4HXMhkcxGw5jNjyO2fCVQ2v42tOa1wRuIzAYOirb3w91Ue9+JwxJNipMU+vgWUcHD/rs4KCWJmz76aefruX9tWTsOkLhuo5O2HVUg1xHsetDnYl9A/89x48Xw6/95wI/Xw1f+88ZgQ6O/WeGn8PBtVz6Ba/lkDCxvCgfwAK7vygG/sszEbbRotgW9Bk2oiKKQweeVQcf7Fi29/IC9yKksILnZvt2AsQT2lGD0tqmjnFTxK7bd0TdT2g7bXywh9Sk6yK12uoKAk9YDNd2/7Lvb5btm3fLPpm9t9D5vK2/wq2jarpE1bR9/7X2ekJEWMXp8yjxdZ8MANLM2+ngAZ4QFboYfR4NXiMN8FLaTgDsfUK7b6GDHf6Gd31Hx73By97waHjcoQD6Rg6gKHpp2lssFl+Cemjz+OXR5AkWqrPs0Csda1VscD/IO2igvE1Ev4PJ/g801EfBhoUU/T5yLILFUnt8bSvbqpQvnhk3VRhaG2cI35hmixaa1IV4kPebZEokHnmECSbZCB28PtKgR5Q8TNPDFiWxMU17RdFbacTPHhG+1VgU/TTtr0CunY5rLFiaxmy9eWN7mrKiKLY0u/briEyqPyLre0tsO/d7gN9KABo+7y78oHBgPEDJnNYmJ22zdKxcIZmQvsOzClsB0DCpcq5hjt6mEUo66C8vOUFwGnudvFNy7Mj3d6RgX515m/y5Z2rcQncCbNk9bm1n7Uk0TGBOcySVsapAZETKcYaYmSrJ0HvjwfRHujdxGvpKeCkwSpCDtdQKNulvQsKdWsvDxlNddbAN2M5muGFh5AYfm46f2HtwRNebdzAeuN88xBNS8SsoYacLV2D31XVUcLIAkMug+a1sBvo6uqnHOK8a0h1jbx4hR5lIIecjyNe7Hi0D7b14fmoRBjsKIetIAOF7FLc6+Xyl0/UtN8iW23GbqYMSD6IRSMxyYUIspEuv9mgfLKIQngSgqOAIWBiAAdcguZ/L5jVij+NzpwX84exYAuEYAdaBurDajhU6B9MmDM5RCCmKqqgjjuN61kCywt/mbXrhSIxjhxXap7u2Ap/vWAHDe9sXuJYDigyEiMIDtp6HeELKYAWlh+X0U9RE5478QpfbbgEM22oL4IYrEUHdZVgLn9kufX12hhcQRjndIIxbJQmUFmNcnyuaNcqPvoIoCtSObG3nvDbUE+K+DWj9lznQw/02XNje3u+IEztoP5obXRyv4JMHnF3qfkL85/FZOdwojlSJmU+h5GkanUQJJUtDdi+KaWow9huVLqKT+8hH2vGnj2Pj0MMPBtOt95FJMig4/gooYYIWE6RRTMFi0CaKIwq9YLYW6RWdRGr0ARJcrdSIjhVgcA4ad3IfoFyGMYq9Ix6dRC71GMURzHlRInC0kpst03G0DAs+NFXd0kxl6Eed6sR5MIn3idN8j0OXKwnqT5rpXWsG2lsBl+qtwj4L7/jCtOZ1N320mhfHMSgHiR/FUr4wKFqVcUZZwvOkytGph3kp9KKOMJBn3+KPGt96pRrfwctlc+gNSlxrvojiSFgo2u1bmECrjz+5BBRShsK8Hzv2g4IRwJ98A6bh6eB58dFYfFDARkCHXmZKfvT4wfDFYDh4MRjiDD4/8+l0dL3rGHQZ4w26o5AGQ73XpFRjRmmN/i4eDfC0bT6B3cx4uS3V3srwmUxVeYq5M+C6TxnvTy6m6PJ3fR31d3DzMo7muzczZ4nqhTw++yqHsWVVWYJmidIS9PN2MO/JbG54fLyMo8Xu7S1+l9v7Gg9vtnt3P1IBRFMc8r/A9cXrZRxlu3H9a12i8T9E9vjVsrldV4yH25FKF7dBby13AYaLAuHGKk9Bo0Gyrq8aVYMaBkuLblf1/EipHLjcoGg6uXlfBIZ2IZqEPpo9ywDN6sZcpNkbC9UbkA5bzPfDSrBRGDQEdQXXUZ+djlv2LsUKVssDAiyl6qViz2i9W1ORGn926L+RRs/aZVBYmdJE8QMKBMwsFGVOdUQzkeeIN97rfVb/I8uvpiQiEK7LsPDuq+KtC2rSgn5QtwiHeduxz95yWRdidAse2P19zQbEHcslu7/HUwV9i5fuchk3DbhWp4HuVdeiIQEx7Yyqm6AZWLe1hjoT5xZNHNfgE2NtBMRECjm5rXS+XPbX2LA5o0fTbY1M/uxwkv8DiiE6p/JMp6AfIbmnY+eyKfYMmfWZD5ATZYQ21sujY3ePsMtzbaGyL2hAT+/bWr5NNTIIJcN8jfxYLSYTwGJDD0GDfXkQ8CRzmoGw4mMUbSog1DAVqjIBvYyb2uROEUI4cRFy0vU4W9Sh6q323vubRFdiPdHZ5fkjaEn+cM9pIudMul26OdjZ5TmWJIqx9+367L2pKRFIyzsgDH0tNhU8lC3V5tvChSxBEkWc2uzUj/Z9MWCPrSOUCrMRo7hJmtQFvGsTNzWreESqslgsK3wllrFQmg4dCYuakJeqegxX7qAkZ5OKcq4Wb+WgGimR05QUCmmsrly4lqWVDlWUni0QMgFjGjoFqiBQa/6YgTRuOGdjbizomFVSIOV1hdGSekqYl6AFyAQ2kkCDIx1K7m5t1q3Pe//Dd75SOewhCOUIJdBNDCmrSuIakoS6bjSc3OrWN+oOr7Z2I4gXNFV3+kh9CdooybAqU0+4FL84FianQxn02DKeO1CvKjBjjfighHeRCebUv3/9VwuvrW7nOmJuBZ6mmD7cgSFFyxzDY5ReQ4kaUHUxwvlA/2nVzkPsSGhuC5XWgmQez+PnWExsTa0XraLic8jBVcqHdGatb00cdKzxniNmNTVlH5HYVpW4X5gLY1uVj6E+YV0//ABIx6SFA3kaKNXI83LRFvAaL19h2UxHNqDoVs3Wlu6KLDxssTqTtolzeVWMleBKGud0D4+O8E+XpPVLBD8pEg8ZfVzl+eIPUfz4INvDHr9r3mxFP+TCZx/E8Jd5Mh2eRz6A09UEHxl4+KQoDI5ZjcFs0UcPbsX7PpXO8ZkD7qVX8wJN2zpjIXMh4TYc4G2qktuwe4QrwJhuQONRONTHTRZC96x3LI8stoyj401cdKEKsBmJDs470wpfX5Q5cHwNoBeMT7iQDN0A/QWZCrRW+mG/7OMwe4gEx0dHt4OaCC/XiXAqKQdOb3ou1R3I33an7eWtWx5RnRfEqO5+ioQDov6os9l2u9ukgaTSwi6ik6v7aN7jpei5/pOrm+UNsqDNFMbpS2UIY26z6CQ6XAvbG9BTCrte3Tu5qUXBcJlionotFMBLcTgdRMt4dcTGwMFWaKh6HzfAWD4RcvLwqJuGNhd4fu6IOhRq9FMp/g6ooPwBtKHiSCDfZMDR8UCSI1v80CQ5vg2HG9IPmzIKzSGu5ghCiqAT9V+9UzfE8TeH8QcvWwH0qxALp/B2Hd3eFLCutx5C0HUEuhVUbsWUrxomr8O3IXo7oLDn8PiY4oNfDyiQ9uI1xaiOXy2JLZt4TRR1YzKUjVqNLERR12MOg2p/0I9qnBqXGu1Y576pa62GmWrrsGOirVpoW62lLcZSsJCFHCviN88EZyXIC3RAUA9MB+thRcgTVdTPPQL4v3/9F40IzEPL/IGdVZqVagZ6XLk3I+Mc5gJN/tbLxRC0Al7kYEy+YGjpT+gNYyomVDYW7OiEl3wkcoGKDcGUS+K0dKPpsx+bsNcz7SroppCjPmS5UvSkD22+yqqC1giX2kzpuzGiFDPORvgKDC1ZAxCGgMy4TDBy5sSXrEB8woieSamFAcZFgcDoIcF4LBJBxpGSVvPEsoJLPiFzLqbwJlKhDG+4tBqhg2lUXjkXCl+SAVi3Rcot99k7dFlp45S8AovHnjrvycTOe/Xi459IjjBSUOLyIgHT1NrmMAVN6srFHqo8Z6WyLh6A9mz7bHEiq7k0aB34xJk/mpp83sehNVK+6DNMMOMFipY+MkAu5J170HhVs9mPMDLCQhPanc1ma6rzeXfMX4TNqhF6DaoZN6FGUrTt4fXHc9RLoAtzNr4APRVJsKm2rHlIwIf+DuYuihiEjZdio1+SiwSkgdaN+eYv59+xKXvRP4ri1mXxCIQPvzt9++33F9/ivHj/Ofkb9I/6R5SPUsYWXLaWWnkcvCq6rYT3/i3x/i3x/i3x/i3x/i3x7+a16/4t8f4t8f4t8f4t8f4t8f4t8X+PCPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xF/uJef+LfH+LfH+LfFT58T9W+JQRIJW4WGZcyFbZXuuVOlq9YXxTRxlWMt0chXd32P67z2+F8DmnyvQWAh1E0dTrgUGuakMKg7VO1i2cgdYP/LWxex7l7h+7NidMs4r1V9YfORGvKFjfxC2XW51fnZxGcVReOBRqBTHaD7DF9J85gpPPDXp0Sqn12Y5l5OKqmgiNycWHPHKZt1qpTuqVvI/WsU4XC5aGHbLmNw28H/c1MYB9/euEmq5rOFd19YRnrABGs/vZrlc/gd6HGxg","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),u=t(63723),h=t.n(u),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:"eJztG9lyHLfxV5B5kcWaXXJXlKzwKbLkJEwck2VS5UqRLBo707sDcQYYA5g9zNo3f0k+LV+S6gYwxx5c6ohDV1YP4g7QABqN7kZfuI8sn5jo5Cp6p5KqAGlNdBNHKZhEi9IKJaOT6DID9lYDt8ACFHtzfsp4nquZYZUBbZhVbAISNEJJmLE0zMdGC1ZqNRWpkBOWcsvZTNiMjbiBV8cMZKJSSNlY5NC/ltfyUpQn7H2ZK56yhao0O3/353o2XAbbrg4O3sGomrD3pwcHN19l1pbm5PCQl2VflSCNmMicj0w/UcVhioBlOn4es1kGGnBWlnDJgBuRLxhPUzYT6QSsiZnNQLJElQuWKKVTIbkFE7OST4DJqhiBNjHjMmWF0sCEZJxp4OmiZ1WvMsD+dnH2PRsrXXDbZ+d5ZeJ6uVRoSGy+cNPbDOpdPTOBGsZqIScxK/gdUktY9nMlkjvctgGZ4l8c+Ob8lGh1cHBRlaXSFlL2o9vCycEB9nwDuZoxroHgE1UUSrKSa16ApePKuKVuDT9XQkPqDoXneaDFybXssYMDuyjh5OCAncpUJEgMmhBbmRp72L4DRSIh6EUJiRgLD9oiHVOSzTKRZESTGXfnWeY8cWhqMCUkVkyhO/E8Zguc+B1IFTDIlBa/KGl5TscxBW1FwvP2sSGCCGos1xbJWSohbWj1K7B/+uPB06ND8XyFqKVIrEJI6jHApjyvwHisZjHLEKsfoNRgiNX9vEhImbIMxCTbuh5PP1TGdiZmlUE021j4tcIpEXmByDbmuQEmxh1aFvwOWqsxRTLM8z77ZsFSGPMqtzETyHFWV9Bn3yvLeFnmIuGjHJBzGQoPt5WGHp2yZwePiOQFnfE5STQYxlkqxmPQKJzYSVP4MQE75LNGBZDk2IxLpuTKQScqV3qdhai5S0eWKGlB2j57M+UiJ+TdZg0TMsmrFNgo58ldzEZ5BTHTkDrBXQCqrdgrIQRh3HiaE32YgRy5UEnEXyq/vDDMeKzSPrvMhGnkCTsDqWkRYdpU9VI7VrgykiCIGIOCizwmwsXsgxoxK2wOMQpsyeUiRn0JMbMwtyM1j1mSQXJHvzRPhWKjylol3cZSrcpUzaSn5VhJa8QvGyQy9Hw8RYcxO47Zq5i9jtngKGaDYcwGxzEbvIrZ4HXMhkcxGw5jNjyO2fCVQ2v42tOa1wRuIzAYOirb3w91Ue9+JwxJNipMU+vgWUcHD/rs4KCWJmz76aefruX9tWTsOkLhuo5O2HVUg1xHsetDnYl9A/89x48Xw6/95wI/Xw1f+88ZgQ6O/WeGn8PBtVz6Ba/lkDCxvCgfwAK7vygG/sszEbbRotgW9Bk2oiKKQweeVQcf7Fi29/IC9yKksILnZvt2AsQT2lGD0tqmjnFTxK7bd0TdT2g7bXywh9Sk6yK12uoKAk9YDNd2/7Lvb5btm3fLPpm9t9D5vK2/wq2jarpE1bR9/7X2ekJEWMXp8yjxdZ8MANLM2+ngAZ4QFboYfR4NXiMN8FLaTgDsfUK7b6GDHf6Gd31Hx73By97waHjcoQD6Rg6gKHpp2lssFl+Cemjz+OXR5AkWqrPs0Csda1VscD/IO2igvE1Ev4PJ/g801EfBhoUU/T5yLILFUnt8bSvbqpQvnhk3VRhaG2cI35hmixaa1IV4kPebZEokHnmECSbZCB28PtKgR5Q8TNPDFiWxMU17RdFbacTPHhG+1VgU/TTtr0CunY5rLFiaxmy9eWN7mrKiKLY0u/briEyqPyLre0tsO/d7gN9KABo+7y78oHBgPEDJnNYmJ22zdKxcIZmQvsOzClsB0DCpcq5hjt6mEUo66C8vOUFwGnudvFNy7Mj3d6RgX515m/y5Z2rcQncCbNk9bm1n7Uk0TGBOcySVsapAZETKcYaYmSrJ0HvjwfRHujdxGvpKeCkwSpCDtdQKNulvQsKdWsvDxlNddbAN2M5muGFh5AYfm46f2HtwRNebdzAeuN88xBNS8SsoYacLV2D31XVUcLIAkMug+a1sBvo6uqnHOK8a0h1jbx4hR5lIIecjyNe7Hi0D7b14fmoRBjsKIetIAOF7FLc6+Xyl0/UtN8iW23GbqYMSD6IRSMxyYUIspEuv9mgfLKIQngSgqOAIWBiAAdcguZ/L5jVij+NzpwX84exYAuEYAdaBurDajhU6B9MmDM5RCCmKqqgjjuN61kCywt/mbXrhSIxjhxXap7u2Ap/vWAHDe9sXuJYDigyEiMIDtp6HeELKYAWlh+X0U9RE5478QpfbbgEM22oL4IYrEUHdZVgLn9kufX12hhcQRjndIIxbJQmUFmNcnyuaNcqPvoIoCtSObG3nvDbUE+K+DWj9lznQw/02XNje3u+IEztoP5obXRyv4JMHnF3qfkL85/FZOdwojlSJmU+h5GkanUQJJUtDdi+KaWow9huVLqKT+8hH2vGnj2Pj0MMPBtOt95FJMig4/gooYYIWE6RRTMFi0CaKIwq9YLYW6RWdRGr0ARJcrdSIjhVgcA4ad3IfoFyGMYq9Ix6dRC71GMURzHlRInC0kpst03G0DAs+NFXd0kxl6Eed6sR5MIn3idN8j0OXKwnqT5rpXWsG2lsBl+qtwj4L7/jCtOZ1N320mhfHMSgHiR/FUr4wKFqVcUZZwvOkytGph3kp9KKOMJBn3+KPGt96pRrfwctlc+gNSlxrvojiSFgo2u1bmECrjz+5BBRShsK8Hzv2g4IRwJ98A6bh6eB58dFYfFDARkCHXmZKfvT4wfDFYDh4MRjiDD4/8+l0dL3rGHQZ4w26o5AGQ73XpFRjRmmN/i4eDfC0bT6B3cx4uS3V3srwmUxVeYq5M+C6TxnvTy6m6PJ3fR31d3DzMo7muzczZ4nqhTw++yqHsWVVWYJmidIS9PN2MO/JbG54fLyMo8Xu7S1+l9v7Gg9vtnt3P1IBRFMc8r/A9cXrZRxlu3H9a12i8T9E9vjVsrldV4yH25FKF7dBby13AYaLAuHGKk9Bo0Gyrq8aVYMaBkuLblf1/EipHLjcoGg6uXlfBIZ2IZqEPpo9ywDN6sZcpNkbC9UbkA5bzPfDSrBRGDQEdQXXUZ+djlv2LsUKVssDAiyl6qViz2i9W1ORGn926L+RRs/aZVBYmdJE8QMKBMwsFGVOdUQzkeeIN97rfVb/I8uvpiQiEK7LsPDuq+KtC2rSgn5QtwiHeduxz95yWRdidAse2P19zQbEHcslu7/HUwV9i5fuchk3DbhWp4HuVdeiIQEx7Yyqm6AZWLe1hjoT5xZNHNfgE2NtBMRECjm5rXS+XPbX2LA5o0fTbY1M/uxwkv8DiiE6p/JMp6AfIbmnY+eyKfYMmfWZD5ATZYQ21sujY3ePsMtzbaGyL2hAT+/bWr5NNTIIJcN8jfxYLSYTwGJDD0GDfXkQ8CRzmoGw4mMUbSog1DAVqjIBvYyb2uROEUI4cRFy0vU4W9Sh6q323vubRFdiPdHZ5fkjaEn+cM9pIudMul26OdjZ5TmWJIqx9+367L2pKRFIyzsgDH0tNhU8lC3V5tvChSxBEkWc2uzUj/Z9MWCPrSOUCrMRo7hJmtQFvGsTNzWreESqslgsK3wllrFQmg4dCYuakJeqegxX7qAkZ5OKcq4Wb+WgGimR05QUCmmsrly4lqWVDlWUni0QMgFjGjoFqiBQa/6YgTRuOGdjbizomFVSIOV1hdGSekqYl6AFyAQ2kkCDIx1K7m5t1q3Pe//Dd75SOewhCOUIJdBNDCmrSuIakoS6bjSc3OrWN+oOr7Z2I4gXNFV3+kh9CdooybAqU0+4FL84FianQxn02DKeO1CvKjBjjfighHeRCebUv3/9VwuvrW7nOmJuBZ6mmD7cgSFFyxzDY5ReQ4kaUHUxwvlA/2nVzkPsSGhuC5XWgmQez+PnWExsTa0XraLic8jBVcqHdGatb00cdKzxniNmNTVlH5HYVpW4X5gLY1uVj6E+YV0//ABIx6SFA3kaKNXI83LRFvAaL19h2UxHNqDoVs3Wlu6KLDxssTqTtolzeVWMleBKGud0D4+O8E+XpPVLBD8pEg8ZfVzl+eIPUfz4INvDHr9r3mxFP+TCZx/E8Jd5Mh2eRz6A09UEHxl4+KQoDI5ZjcFs0UcPbsX7PpXO8ZkD7qVX8wJN2zpjIXMh4TYc4G2qktuwe4QrwJhuQONRONTHTRZC96x3LI8stoyj401cdKEKsBmJDs470wpfX5Q5cHwNoBeMT7iQDN0A/QWZCrRW+mG/7OMwe4gEx0dHt4OaCC/XiXAqKQdOb3ou1R3I33an7eWtWx5RnRfEqO5+ioQDov6os9l2u9ukgaTSwi6ik6v7aN7jpei5/pOrm+UNsqDNFMbpS2UIY26z6CQ6XAvbG9BTCrte3Tu5qUXBcJlionotFMBLcTgdRMt4dcTGwMFWaKh6HzfAWD4RcvLwqJuGNhd4fu6IOhRq9FMp/g6ooPwBtKHiSCDfZMDR8UCSI1v80CQ5vg2HG9IPmzIKzSGu5ghCiqAT9V+9UzfE8TeH8QcvWwH0qxALp/B2Hd3eFLCutx5C0HUEuhVUbsWUrxomr8O3IXo7oLDn8PiY4oNfDyiQ9uI1xaiOXy2JLZt4TRR1YzKUjVqNLERR12MOg2p/0I9qnBqXGu1Y576pa62GmWrrsGOirVpoW62lLcZSsJCFHCviN88EZyXIC3RAUA9MB+thRcgTVdTPPQL4v3/9F40IzEPL/IGdVZqVagZ6XLk3I+Mc5gJN/tbLxRC0Al7kYEy+YGjpT+gNYyomVDYW7OiEl3wkcoGKDcGUS+K0dKPpsx+bsNcz7SroppCjPmS5UvSkD22+yqqC1giX2kzpuzGiFDPORvgKDC1ZAxCGgMy4TDBy5sSXrEB8woieSamFAcZFgcDoIcF4LBJBxpGSVvPEsoJLPiFzLqbwJlKhDG+4tBqhg2lUXjkXCl+SAVi3Rcot99k7dFlp45S8AovHnjrvycTOe/Xi459IjjBSUOLyIgHT1NrmMAVN6srFHqo8Z6WyLh6A9mz7bHEiq7k0aB34xJk/mpp83sehNVK+6DNMMOMFipY+MkAu5J170HhVs9mPMDLCQhPanc1ma6rzeXfMX4TNqhF6DaoZN6FGUrTt4fXHc9RLoAtzNr4APRVJsKm2rHlIwIf+DuYuihiEjZdio1+SiwSkgdaN+eYv59+xKXvRP4ri1mXxCIQPvzt9++33F9/ivHj/Ofkb9I/6R5SPUsYWXLaWWnkcvCq6rYT3/i3x/i3x/i3x/i3x/i3x7+a16/4t8f4t8f4t8f4t8f4t8f4t8X+PCPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xPu3xF/uJef+LfH+LfH+LfFT58T9W+JQRIJW4WGZcyFbZXuuVOlq9YXxTRxlWMt0chXd32P67z2+F8DmnyvQWAh1E0dTrgUGuakMKg7VO1i2cgdYP/LWxex7l7h+7NidMs4r1V9YfORGvKFjfxC2XW51fnZxGcVReOBRqBTHaD7DF9J85gpPPDXp0Sqn12Y5l5OKqmgiNycWHPHKZt1qpTuqVvI/WsU4XC5aGHbLmNw28H/c1MYB9/euEmq5rOFd19YRnrABGs/vZrlc/gd6HGxg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},j=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(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:"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,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.b0969c28.js b/assets/js/2c586be5.b0969c28.js deleted file mode 100644 index 915360c91..000000000 --- a/assets/js/2c586be5.b0969c28.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9599],{60112:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>f,contentTitle:()=>g,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","source":"@site/docs/API-docs/createdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createdocument","permalink":"/docs/API-docs/createdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar_label":"Create Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztG9lyHLfxVzrzIos1u+SuKFnhU2TJSZg4JsukypUiWTR2pncH4gwwBjB7mLVv/pJ8Wr4k1Tjm2INLHXHoyupB3AEaQKPR3egL95FhEx2dXEXvZFIVKIyObuIoRZ0oXhouRXQSXWYIbxUygxCg4M35KbA8lzMNlUalwUiYoEBFUAJnkIb5YLSAUskpT7mYQMoMgxk3GYyYxlfHgCKRKaYw5jn2r8W1uOTlCbwvc8lSWMhKwfm7P9ez0TLUdnVw8A5H1QTenx4c3HyVGVPqk8NDVpZ9WaLQfCJyNtL9RBaHKQGW6fh5DLMMFdKskDAByDTPF8DSFGY8naDRMZgMBSSyXEAipUq5YAZ1DCWbIIiqGKHSMTCRQiEVAhfAQCFLFz0je5VG+NvF2fcwlqpgpg/neaXjermUK0xMvnDTmwzrXT3TgRraKC4mMRTsjqjFDfxc8eSOtq1RpPSXBr45P7W0Oji4qMpSKoMp/Oi2cHJwQD3fYC5nwBRa+EQWhRRQMsUKNPa4MmZst8KfK64wdYfC8jzQ4uRa9ODgwCxKPDk4gFOR8oSIYSekVpBjD9t3oEQkAr0oMeFj7kFbpAMpYJbxJLM0mTF3nmXOEoemQl1iYvgUuxPPY1jQxO9QyIBBJhX/RQrDcnscU1SGJyxvHxshSKDaMGWInKXkwoRWvwL80x8PnZ49FM9XhFpKxCq4sD0aYcryCrXHahZDRlj9gKVCbVndz0uEFClkyCfZ1vVY+qHSpjMxVJrQbGPh1wqnZMmLlmxjlmsEPu7QsmB32FoNpJVhlvfhmwWkOGZVbmLgxHFGVdiH76UBVpY5T9goR+JcIOFhplLYs6fs2cEjIlhhz/jcSjRqYJDy8RgVCSd12in8mIAd8VmjAqzkmIwJkGLloBOZS7XOQra5S0dIpDAoTB/eTBnPLfJusxq4SPIqRRjlLLmLYZRXGIPC1AnuAkltxV4JEQgw7Wlu6QMac+JCKQh/If3yXIP2WKV9uMy4buSJOgOp7SJct6nqpXYsaWUiQRAxwILxPLaEi+GDHIHhJseYBLZkYhGTvsQYDM7NSM5jSDJM7uwvxVIuYVQZI4XbWKpkmcqZ8LQcS2E0/2WDRIaej6foMIbjGF7F8DqGwVEMg2EMg+MYBq9iGLyOYXgUw3AYw/A4huErh9bwtac1qwncRmAwdFQ2vx/qkt79jmsr2aQwda2DZx0dPOjDwUEtTdT2008/XYv7awFwHZFwXUcncB3VINdR7PpIZ1LfwH/P6ePF8Gv/uaDPV8PX/nNmQQfH/jOjz+HgWiz9gtdiaDExrCgfwIK6vygG/sszEbXZRakt6DNqJEUUhw46qw4+1LFs7+UF7YULbjjL9fbtBIgntKMGpbVNHdOmLLtu35HtfkLbaeNDPVZNui6rVltdQeAtFsO13b/s+5tl++bdsk9m7y10Pm/rr2jrpJouSTVt33+tvZ4QEVZx+jxKfN23BoDVzNvp4AGeEBW6GH0eDV4TDehS2k4A6n1Cu2+hQx3+hnd9R8e9wcve8Gh43KEA+UYOoCh6adpbLBZfgnpk8/jlyeQJFqqz7MgrHStZbHA/rHfQQHmbyP4OJvs/yFAfBRsWU/L7rGMRLJba42tb2UambPFMu6nC0No4I/jGNFu00LRdhIf1fpNM8sQjTzDBJBuRg9cnGvQsJQ/T9LBFSWpM015R9FYa6bNnCd9qLIp+mvZXINdOxzUWkKYxrDdvbE9TKIpiS7Nrv46sSfVHYn1viW3nfg/wWwlAw+fdhR8UDooHSJHbta2Ttlk6Vq6QjAvf4VkFVgAUTqqcKZyTt6m5FA76y0tOEJzGXrfeqXXsrO/vSAFfnXmb/LlnatpCdwJq2T1ubWftSRROcG7nSCptZEHI8JTRDDHoKsnIe2PB9Ce6N3Ea+5WwklOUIEdjbCuapL8JCXdqLQ+bTnXVwdZoOpthGsLIDT62PX7L3oMje715B+OB+81DPCEVv4ISdbpwBXVfXUcFsxYAcRk2v6XJUF1HN/UY51VjumPszSPkKOMp5myE+XrXo2WgvRfPTy3CUEfBRR0JsPgexa1ONl/pdH3LDbLldtxm6qDEg2gEEkPOdYiFdOnVHu2DRTaEJxBtVHCEEAZQwDVI7ueyeY3Y4/jcaQF/ODuWIDiwgHWgLqy2Y4XOwbQJQ3MUXPCiKuqI47ieNZCs8Ld5m140kuLYYYX26a6twOY7VqDw3vYFrsXARgZCROEBW89DPCFlsILSw3L6KWqic0d+octttwCGbbUFcMOVSKDuMqyFT2+Xvj6c0QVEUU43iOJWSYKloRjX54pmjfKjryAbBWpHtrZzXhvqCXHfBrT+yxzo4X4bLmxv73fEiR20H82NLo5XsMkDzq7tfkL85/FZOdwojmRJmU8uxWkanUSJTZaG7F4U26lRm29kuohO7iMfaaefPo5NQw8/aEq33kc6ybBg9CugRAlaSpBGsQ0Wo9JRHNnQC2VriV7RSSRHHzCh1UpF6BiOmuaw407uA5TLMEaxd8Sjk8ilHqM4wjkrSgKOVnKzZTqOlmHBh6aqW5qptP1RpzppHkrifeI039PQ5UqC+pNmeteawe6twEv5VlKfwXdsoVvzups+Ws2L0xiSg8SPgpQtNIlWpZ1RlrA8qXJy6nFecrWoIwzWs2/xR41vvVKN7+Dlsjn0BiWmFFtEccQNFu32LUyg5MefXIKSKGPDvB879oPEEeKffAOl4e3Bs+KjsfggEUZoD73MpPjo8YPhi8Fw8GIwpBl8fubT6eh61zHoMsYbckcxDYZ6r0mpxmDTGv1dPBrg7bbZBHcz4+W2VHsrw6czWeUp5c6Qqb7NeH9yMUWXv+vrqL+Dm5dxNN+9mTkkshfy+PBVjmMDVVmigkQqgep5O5j3ZDY3PD5extFi9/YWv8vtfU2HN9u9ux9tAURTHPK/wPXF62UcZbtx/WtdovE/RPb41bK5XVeMh9uRTBe3QW8tdwGGi4LgxjJPUZFBsq6vGlVDGoZKi25X9fxIyhyZ2KBoOrl5XwRGdiGZhD6aPcuQzOrGXLSzNxaqNyAdtpTvx5VgI9dkCKoKr6M+nI5b9q6NFayWBwRYm6oXEp7Z9W51ZdX4s0P/TTR61i6DosqUJoofULDAYLAoc1tHNON5TnjTvd6H+p+1/GpKEgLhugwL774q3rqgpl3QD+oW4YC3Hfvwlom6EKNb8AD39zUbWO5YLuH+nk4V1S1dustl3DTQWp0Ge6+6FoUJ8mlnVN2EzcC6rTXUmTi3ZOK4Bp8YayPAJ4KLyW2l8uWyv8aGzRk9mm5rZPJnR5P8H1CM0DkVZypF9QjJPR07l03CM2LWZz5AbinDlTZeHh27e4RdnmsLlX1BA3l639byrauRJigR5mvkxyg+mSAVG3oIO9iXByFLMqcZLFZsTKJtCwgVTrmsdEAvY7o2uVOC4E5cuJh0Pc4WdWz1Vnvv/U2iK6ie6Ozy/BG0tP5wz2ki50y6Xbo54OzynEoS+dj7dn14r2tKBNKyDgiQrwVTzkLZUm2+LVzIEoWliFObnfrRvi8G7ME6QinXGzGKm6RJXcC7NnFTs0pHJCtDxbLcV2Jpg6Xu0NFiURPyUlaP4codlGQwqWzO1dCtHFSjTeQ0JYVcaKMqF66FtFKhitKzBUEmqHVDp0AVAmrNHwMK7YYzGDNtUMVQCU6UVxVFS+opcV6i4igS3EgChY50JLm7tVm3Pu/9D9/5SuWwhyCUI5JANzGmUJWWa6wk1HWj4eRWt75Rd3i1tRtBuqBtdaeP1JeotBRAVZlqwgT/xbGwdTqkJo8tY7kD9aqCMtaED0l4F5lgTv3713+18Nrqdq4j5lZgaUrpwx0Y2miZY3iK0issSQPKLkY0H6o/rdp5hJ0VmttCprUg6cfz+DkVExtd60UjbfE55ugq5UM6s9a3Og46VnvPkbKaymYfidhGlrRfnHNtWpWPoT5hXT/8gETHpIWD9TRIqonnxaIt4DVevsKymc7agLxbNVtbuiuy8LDF6kzaJs7lVTFVgkuhndM9PDqiP12S1i8R/KREPGL0cZXniz9E8eODbA97/K55sxX9kAuffeDDX+bJdHge+QBOVxN8ZODhk6IwNGY1BrNFHz24Fe/7VCqnZw60l17NC3ba1hlzkXOBt+EAb1OZ3IbdE1yBWncDGo/CoT5uayF0z3rH8sRiyzg63sRFF7JAk1nRoXlnStLrizJHRq8B1ALYhHEB5AaoL8hUqJRUD/tlH4fZQyQ4Pjq6HdREeLlOhFNhc+D2Tc+lvEPx2+60vbxxyxOq88IyqrufIu6AbH/U2Wy73W1SY1IpbhbRydV9NO+xkvdc/8nVzfKGWNBkkuL0pdQWY2ay6CQ6XAvba1RTG3a9undyU4uCZiKlRPVaKICV/HA6iJbx6oiNgYOt0NqwCReT3oOjbpqtXtBxOIp3Ntyom5L/HUnfeHq2oeKIExtkyMiPIArSKf/Q5Cy+DWcVsgmbEgTNmayG/EPEvxPEX70iN4TlN0flBy9b8fCrENq20eo6WL0p/lxvPUSU64ByK0bcChFfNTxbR2NDMHZgo5jD42Mb7vt6YONiL17bkNPxq6Xlsib8EkXdEItNLq0GCqKo6wCHQbV750c1PorLdHaMbd/UNT7DTLWx17G4Vg2urcbPFtsnGLxcjKXlN88EZyWKC/InSKyng/UoIeaJLOrXGwH837/+y44IzGOX+QOcVQpKOUM1rtwTkHGOc04WfOshYohBISty1DpfABnuE/skMeUTWwUWzOKElWzEc056isCky8m0VJ3uw49NFOuZcgVxU8xJvUEupX2hRyZcZWRh1wh31EyquzGhFAODET3qIsNUI4YhKDImEgqEOfG1Rh29SCRHo1RcIzBeEDA5PDge84RbW0cKo1hioGCCTax1FttoJVGhDE+ylByRv6hlXjmPiB6GIRq3RZsq7sM78kDtxm0uCg0de+qcIR07Z9SLj3/xOCLHv6TleYK6KZ3NcYrKqisXSqjyHEppnHtP5mn7bGkio5jQdNn7PJg/mpp83mWxa6Rs0QfKF9N9SIY7MUDOxZ17n3hVs9mPONLcYBOpnc1ma6rzeXfMX7jJqhE5AbIZN7GNVtG2h9cfz0kvoSr02fgC1ZQnwUTasuahBT70VypzQcEgbKzkG92MnCcoNLYuwDd/Of8OpvCifxTFrcviEQgffnf69tvvL76leek6c/I36B/1j2x6SWpTMNFaauWt76rotvLX+6fB+6fB+6fB+6fB+6fBv5vHq/unwfunwfunwfunwfunwfunwf89IuyfBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBn+5h5n7p8H7p8H7p8FPnRP3T4NDEQlZhYdlzrhoVeG5yqOr1QfDN3GUUWnSyVV0f0/pv/dU/k/NP1eoqK7pJo6mTHEKctuqpjhU71DZyh1S/chbF7PvXdL6sWN3m3FeKeai4iM34o099gdh29VT52cXl1EchfcahUxpjGIzevDMZq7wxFPTvkFl9vFYzsSkslU0kZuTCo5YZbJutdKdrVbyP1rFOEwsWhh2y5jcNuh/2tTGAff3rhJquazhXdfWEZ6wAZrO72a5XP4HD25bNQ==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"},"next":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const 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:"eJztG9lyHLfxVzrzIos1u+SuKFnhU2TJSZg4JsukypUiWTR2pncH4gwwBjB7mLVv/pJ8Wr4k1Tjm2INLHXHoyupB3AEaQKPR3egL95FhEx2dXEXvZFIVKIyObuIoRZ0oXhouRXQSXWYIbxUygxCg4M35KbA8lzMNlUalwUiYoEBFUAJnkIb5YLSAUskpT7mYQMoMgxk3GYyYxlfHgCKRKaYw5jn2r8W1uOTlCbwvc8lSWMhKwfm7P9ez0TLUdnVw8A5H1QTenx4c3HyVGVPqk8NDVpZ9WaLQfCJyNtL9RBaHKQGW6fh5DLMMFdKskDAByDTPF8DSFGY8naDRMZgMBSSyXEAipUq5YAZ1DCWbIIiqGKHSMTCRQiEVAhfAQCFLFz0je5VG+NvF2fcwlqpgpg/neaXjermUK0xMvnDTmwzrXT3TgRraKC4mMRTsjqjFDfxc8eSOtq1RpPSXBr45P7W0Oji4qMpSKoMp/Oi2cHJwQD3fYC5nwBRa+EQWhRRQMsUKNPa4MmZst8KfK64wdYfC8jzQ4uRa9ODgwCxKPDk4gFOR8oSIYSekVpBjD9t3oEQkAr0oMeFj7kFbpAMpYJbxJLM0mTF3nmXOEoemQl1iYvgUuxPPY1jQxO9QyIBBJhX/RQrDcnscU1SGJyxvHxshSKDaMGWInKXkwoRWvwL80x8PnZ49FM9XhFpKxCq4sD0aYcryCrXHahZDRlj9gKVCbVndz0uEFClkyCfZ1vVY+qHSpjMxVJrQbGPh1wqnZMmLlmxjlmsEPu7QsmB32FoNpJVhlvfhmwWkOGZVbmLgxHFGVdiH76UBVpY5T9goR+JcIOFhplLYs6fs2cEjIlhhz/jcSjRqYJDy8RgVCSd12in8mIAd8VmjAqzkmIwJkGLloBOZS7XOQra5S0dIpDAoTB/eTBnPLfJusxq4SPIqRRjlLLmLYZRXGIPC1AnuAkltxV4JEQgw7Wlu6QMac+JCKQh/If3yXIP2WKV9uMy4buSJOgOp7SJct6nqpXYsaWUiQRAxwILxPLaEi+GDHIHhJseYBLZkYhGTvsQYDM7NSM5jSDJM7uwvxVIuYVQZI4XbWKpkmcqZ8LQcS2E0/2WDRIaej6foMIbjGF7F8DqGwVEMg2EMg+MYBq9iGLyOYXgUw3AYw/A4huErh9bwtac1qwncRmAwdFQ2vx/qkt79jmsr2aQwda2DZx0dPOjDwUEtTdT2008/XYv7awFwHZFwXUcncB3VINdR7PpIZ1LfwH/P6ePF8Gv/uaDPV8PX/nNmQQfH/jOjz+HgWiz9gtdiaDExrCgfwIK6vygG/sszEbXZRakt6DNqJEUUhw46qw4+1LFs7+UF7YULbjjL9fbtBIgntKMGpbVNHdOmLLtu35HtfkLbaeNDPVZNui6rVltdQeAtFsO13b/s+5tl++bdsk9m7y10Pm/rr2jrpJouSTVt33+tvZ4QEVZx+jxKfN23BoDVzNvp4AGeEBW6GH0eDV4TDehS2k4A6n1Cu2+hQx3+hnd9R8e9wcve8Gh43KEA+UYOoCh6adpbLBZfgnpk8/jlyeQJFqqz7MgrHStZbHA/rHfQQHmbyP4OJvs/yFAfBRsWU/L7rGMRLJba42tb2UambPFMu6nC0No4I/jGNFu00LRdhIf1fpNM8sQjTzDBJBuRg9cnGvQsJQ/T9LBFSWpM015R9FYa6bNnCd9qLIp+mvZXINdOxzUWkKYxrDdvbE9TKIpiS7Nrv46sSfVHYn1viW3nfg/wWwlAw+fdhR8UDooHSJHbta2Ttlk6Vq6QjAvf4VkFVgAUTqqcKZyTt6m5FA76y0tOEJzGXrfeqXXsrO/vSAFfnXmb/LlnatpCdwJq2T1ubWftSRROcG7nSCptZEHI8JTRDDHoKsnIe2PB9Ce6N3Ea+5WwklOUIEdjbCuapL8JCXdqLQ+bTnXVwdZoOpthGsLIDT62PX7L3oMje715B+OB+81DPCEVv4ISdbpwBXVfXUcFsxYAcRk2v6XJUF1HN/UY51VjumPszSPkKOMp5myE+XrXo2WgvRfPTy3CUEfBRR0JsPgexa1ONl/pdH3LDbLldtxm6qDEg2gEEkPOdYiFdOnVHu2DRTaEJxBtVHCEEAZQwDVI7ueyeY3Y4/jcaQF/ODuWIDiwgHWgLqy2Y4XOwbQJQ3MUXPCiKuqI47ieNZCs8Ld5m140kuLYYYX26a6twOY7VqDw3vYFrsXARgZCROEBW89DPCFlsILSw3L6KWqic0d+octttwCGbbUFcMOVSKDuMqyFT2+Xvj6c0QVEUU43iOJWSYKloRjX54pmjfKjryAbBWpHtrZzXhvqCXHfBrT+yxzo4X4bLmxv73fEiR20H82NLo5XsMkDzq7tfkL85/FZOdwojmRJmU8uxWkanUSJTZaG7F4U26lRm29kuohO7iMfaaefPo5NQw8/aEq33kc6ybBg9CugRAlaSpBGsQ0Wo9JRHNnQC2VriV7RSSRHHzCh1UpF6BiOmuaw407uA5TLMEaxd8Sjk8ilHqM4wjkrSgKOVnKzZTqOlmHBh6aqW5qptP1RpzppHkrifeI039PQ5UqC+pNmeteawe6twEv5VlKfwXdsoVvzups+Ws2L0xiSg8SPgpQtNIlWpZ1RlrA8qXJy6nFecrWoIwzWs2/xR41vvVKN7+Dlsjn0BiWmFFtEccQNFu32LUyg5MefXIKSKGPDvB879oPEEeKffAOl4e3Bs+KjsfggEUZoD73MpPjo8YPhi8Fw8GIwpBl8fubT6eh61zHoMsYbckcxDYZ6r0mpxmDTGv1dPBrg7bbZBHcz4+W2VHsrw6czWeUp5c6Qqb7NeH9yMUWXv+vrqL+Dm5dxNN+9mTkkshfy+PBVjmMDVVmigkQqgep5O5j3ZDY3PD5extFi9/YWv8vtfU2HN9u9ux9tAURTHPK/wPXF62UcZbtx/WtdovE/RPb41bK5XVeMh9uRTBe3QW8tdwGGi4LgxjJPUZFBsq6vGlVDGoZKi25X9fxIyhyZ2KBoOrl5XwRGdiGZhD6aPcuQzOrGXLSzNxaqNyAdtpTvx5VgI9dkCKoKr6M+nI5b9q6NFayWBwRYm6oXEp7Z9W51ZdX4s0P/TTR61i6DosqUJoofULDAYLAoc1tHNON5TnjTvd6H+p+1/GpKEgLhugwL774q3rqgpl3QD+oW4YC3Hfvwlom6EKNb8AD39zUbWO5YLuH+nk4V1S1dustl3DTQWp0Ge6+6FoUJ8mlnVN2EzcC6rTXUmTi3ZOK4Bp8YayPAJ4KLyW2l8uWyv8aGzRk9mm5rZPJnR5P8H1CM0DkVZypF9QjJPR07l03CM2LWZz5AbinDlTZeHh27e4RdnmsLlX1BA3l639byrauRJigR5mvkxyg+mSAVG3oIO9iXByFLMqcZLFZsTKJtCwgVTrmsdEAvY7o2uVOC4E5cuJh0Pc4WdWz1Vnvv/U2iK6ie6Ozy/BG0tP5wz2ki50y6Xbo54OzynEoS+dj7dn14r2tKBNKyDgiQrwVTzkLZUm2+LVzIEoWliFObnfrRvi8G7ME6QinXGzGKm6RJXcC7NnFTs0pHJCtDxbLcV2Jpg6Xu0NFiURPyUlaP4codlGQwqWzO1dCtHFSjTeQ0JYVcaKMqF66FtFKhitKzBUEmqHVDp0AVAmrNHwMK7YYzGDNtUMVQCU6UVxVFS+opcV6i4igS3EgChY50JLm7tVm3Pu/9D9/5SuWwhyCUI5JANzGmUJWWa6wk1HWj4eRWt75Rd3i1tRtBuqBtdaeP1JeotBRAVZlqwgT/xbGwdTqkJo8tY7kD9aqCMtaED0l4F5lgTv3713+18Nrqdq4j5lZgaUrpwx0Y2miZY3iK0issSQPKLkY0H6o/rdp5hJ0VmttCprUg6cfz+DkVExtd60UjbfE55ugq5UM6s9a3Og46VnvPkbKaymYfidhGlrRfnHNtWpWPoT5hXT/8gETHpIWD9TRIqonnxaIt4DVevsKymc7agLxbNVtbuiuy8LDF6kzaJs7lVTFVgkuhndM9PDqiP12S1i8R/KREPGL0cZXniz9E8eODbA97/K55sxX9kAuffeDDX+bJdHge+QBOVxN8ZODhk6IwNGY1BrNFHz24Fe/7VCqnZw60l17NC3ba1hlzkXOBt+EAb1OZ3IbdE1yBWncDGo/CoT5uayF0z3rH8sRiyzg63sRFF7JAk1nRoXlnStLrizJHRq8B1ALYhHEB5AaoL8hUqJRUD/tlH4fZQyQ4Pjq6HdREeLlOhFNhc+D2Tc+lvEPx2+60vbxxyxOq88IyqrufIu6AbH/U2Wy73W1SY1IpbhbRydV9NO+xkvdc/8nVzfKGWNBkkuL0pdQWY2ay6CQ6XAvba1RTG3a9undyU4uCZiKlRPVaKICV/HA6iJbx6oiNgYOt0NqwCReT3oOjbpqtXtBxOIp3Ntyom5L/HUnfeHq2oeKIExtkyMiPIArSKf/Q5Cy+DWcVsgmbEgTNmayG/EPEvxPEX70iN4TlN0flBy9b8fCrENq20eo6WL0p/lxvPUSU64ByK0bcChFfNTxbR2NDMHZgo5jD42Mb7vt6YONiL17bkNPxq6Xlsib8EkXdEItNLq0GCqKo6wCHQbV750c1PorLdHaMbd/UNT7DTLWx17G4Vg2urcbPFtsnGLxcjKXlN88EZyWKC/InSKyng/UoIeaJLOrXGwH837/+y44IzGOX+QOcVQpKOUM1rtwTkHGOc04WfOshYohBISty1DpfABnuE/skMeUTWwUWzOKElWzEc056isCky8m0VJ3uw49NFOuZcgVxU8xJvUEupX2hRyZcZWRh1wh31EyquzGhFAODET3qIsNUI4YhKDImEgqEOfG1Rh29SCRHo1RcIzBeEDA5PDge84RbW0cKo1hioGCCTax1FttoJVGhDE+ylByRv6hlXjmPiB6GIRq3RZsq7sM78kDtxm0uCg0de+qcIR07Z9SLj3/xOCLHv6TleYK6KZ3NcYrKqisXSqjyHEppnHtP5mn7bGkio5jQdNn7PJg/mpp83mWxa6Rs0QfKF9N9SIY7MUDOxZ17n3hVs9mPONLcYBOpnc1ma6rzeXfMX7jJqhE5AbIZN7GNVtG2h9cfz0kvoSr02fgC1ZQnwUTasuahBT70VypzQcEgbKzkG92MnCcoNLYuwDd/Of8OpvCifxTFrcviEQgffnf69tvvL76leek6c/I36B/1j2x6SWpTMNFaauWt76rotvLX+6fB+6fB+6fB+6fB+6fBv5vHq/unwfunwfunwfunwfunwfunwf89IuyfBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBu+fBn+5h5n7p8H7p8H7p8FPnRP3T4NDEQlZhYdlzrhoVeG5yqOr1QfDN3GUUWnSyVV0f0/pv/dU/k/NP1eoqK7pJo6mTHEKctuqpjhU71DZyh1S/chbF7PvXdL6sWN3m3FeKeai4iM34o099gdh29VT52cXl1EchfcahUxpjGIzevDMZq7wxFPTvkFl9vFYzsSkslU0kZuTCo5YZbJutdKdrVbyP1rFOEwsWhh2y5jcNuh/2tTGAff3rhJquazhXdfWEZ6wAZrO72a5XP4HD25bNQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,f={},y=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},signurl:{type:"array",items:{type:"object",properties:{email:{type:"string",format:"string",example:"mail@example.com"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_doc_signurl"}},message:{type:"string",format:"string",example:"Document sent successfully!"}},title:"inline_response_doc"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function 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/377084eb.5276d129.js b/assets/js/377084eb.5276d129.js deleted file mode 100644 index 4d5f5b8f6..000000000 --- a/assets/js/377084eb.5276d129.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9441],{4741:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>h,contentTitle:()=>b,default:()=>I,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/get-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-template","permalink":"/docs/API-docs/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWNtuHDcS/ZUKXzYGWnORx3J2niIkhlfYYG2stDCw9kBgd9dM02KTDFk9Fwz6LV+ST8uXBMW+qEcjjyzswkBepGmyTt1YN3IvSK6CmH8UN1g6LQmDWCQix5B55UhZI+bipkB4iwQdCVy+vwKptd0E2NkKyIJH8grXCDmSVDqATG1FICE4zNRSZUAteNSzCRDQrxFkgFRX6LwyFGBpPWQeJSmzgtxmVYm8vFFUgPOY41IZzCGQrzKqPIaRSIR16CVre5WLuVghdTJEIpz0skRCz2buhZElirno1LlVuUiEYjOdpEI8tP3qZ7DLXnmgQhIYxDyw1SnCEikrkHl4/LVSHnMxJ19hIgLtNEsKqnSaFcGt0zZHMV9KHZggK7CUYr4XtHORkrwyK5GIpfWlpGbFrERdL5h9cNYEDAw4n0z436GqocoyDGFZaej9IRKRWUNoiOmlc1plcWP8OTBof6yFTT9jRuw4z2xINSKbZfbvaX2bFdzKaPVcbKf/SE0Zzt+vRJ0IUsSrxyzuASH+6F3OKGPpCVB/QJG0ZpV0jv5bmdUE1SkFG30gEtb3jriPw1ZhVl095aKCyIX5eNyBq4B+lNmS0XZjDuw+5ayYZ7bTKhFBrUzMkx4tvZc7ThDCMjztTW+fUj1D+3UO+2wRUoxqYSmVfpI6RfyxXeh84QprnhAze3VxPn35w+sp029UvkL6H+xvdo/lHSbqJZdOzGEtdYUBzoD9LrmYJRBIlm70RPD19Kz0diDQVGWKfojuV3r0+WxWJ2L3TNTrKfvnmaCXP9SJKJ4Jml3wyckVPhM3fTStrpuQvu2Otj5FFTMzoMmvzDt/WD5SazVKMxTIZb5OREwizC/pdKCdT85fnk0nZ5PXN9OL+ezv81cXo8lk8l+RiG0Zo7vtTHlb9Dolu+/K5d9EDhqZaryx1deZ7zFXHjO6rfyjOXoqjllcnCNuS5vzlBBbUzgtN3ZPPqhDc4b94uH58qnXiZg91jWvbYlU8LCxQUOw8dasEnAaZUAgvwO5ksoAs/Hf/f/aKXpvnyjTz9NsGNfKaGXwthsZbmeTye20d8Ls2Ak3g/YJS1uZ/Nua+pj80wbNbi96g14dG3Rl1lKrPE6qN/YOzbe1ZyieGvHHEasaorgvDowdrjdGBswqr2gXR9jtmXTqrNmff1zwdMiRYtvZN868VIi56AeE8X4w79aC+fl1NxHHxO1niiBNntrtyDo03Ge0TAP307F0arzmNvkQIZ17BnUguVJmdXYStbi3+JpPpXH8gd33LdqpfyL36NatQ6p2si9Qxtmq5u+ljeDW2e8cGq7+8ajW06Ne/QF1ZkvkaZ8KhI78j99+j4jughIj6Tt4V3lwdoOeh3Bpclhq3KpUP3ZlCihLjSHoHShDuPIc/7laKZI6TgSc+Zl0MlVacewxmWW0h0H4hhF8KJAK9Lz1N48gIcc1ag5Z0NbeMR+yICuyZZTR6gwb6++WrFICEtIqKIOBL2XYQdAU0mQI3VkkYD1IA2gIvfMqIEhVMjHf2nC5VJlixpxoXmYEpTRyhSwsAdabveC8XascA3ibVoEgWF1FQ1hiiUiNifGSNYKf1Robw3mxuV1iDquKWSSQ2RyhzTs2w+SQYiBwLF5lGJkGkp5A4xp9jL14kstKa3CWC4KSmi95w7NlRuSlCdy+GoW6o+nd57zl+1aUkcvdCD6ZT4aLNlQBOQC0Mndh/smcwcc+zD5gGhTh4vsuHzabzVEevDjEvFVUVCl4dPYet4qLMWuG8P7jhUgEoS/Du+U1+rXKuovDF2SOI/G4LZMyi2Wynbw5x358COCSpVWGJuCgqF2+ff8LrOHlaCKSQeZ/hcLjX65+evOv6zfMl2tTk3/T0WQ0ibO8DVRKMxA1fJJ4mLf7+2L/F3i+aCsZ4ZbGTksV20E7TzWl/OP9LJOI+fDxYpGIwgZikv0+lQH/43Vd8/KvFXpuGItErKVXPNXFep+rwL/z/iHii577/t/tm8YL+Pp3kEeN6Wq14UId7z08/iXiDncPHmPqBd8ZmoLN2jYUl1mGjgbYowZ+0AXfvrkRiZAVFYeN4i42ivYHc39Ur8MO0ijAf7mZPQrY75smVNc9fbP1RURrYEfNTlrUdf0n0VXFuQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/update-template"}}');var p=a(74848),l=a(28453),r=a(33617),n=a.n(r),s=a(17543),o=a.n(s),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:"eJzVWNtuHDcS/ZUKXzYGWnORx3J2niIkhlfYYG2stDCw9kBgd9dM02KTDFk9Fwz6LV+ST8uXBMW+qEcjjyzswkBepGmyTt1YN3IvSK6CmH8UN1g6LQmDWCQix5B55UhZI+bipkB4iwQdCVy+vwKptd0E2NkKyIJH8grXCDmSVDqATG1FICE4zNRSZUAteNSzCRDQrxFkgFRX6LwyFGBpPWQeJSmzgtxmVYm8vFFUgPOY41IZzCGQrzKqPIaRSIR16CVre5WLuVghdTJEIpz0skRCz2buhZElirno1LlVuUiEYjOdpEI8tP3qZ7DLXnmgQhIYxDyw1SnCEikrkHl4/LVSHnMxJ19hIgLtNEsKqnSaFcGt0zZHMV9KHZggK7CUYr4XtHORkrwyK5GIpfWlpGbFrERdL5h9cNYEDAw4n0z436GqocoyDGFZaej9IRKRWUNoiOmlc1plcWP8OTBof6yFTT9jRuw4z2xINSKbZfbvaX2bFdzKaPVcbKf/SE0Zzt+vRJ0IUsSrxyzuASH+6F3OKGPpCVB/QJG0ZpV0jv5bmdUE1SkFG30gEtb3jriPw1ZhVl095aKCyIX5eNyBq4B+lNmS0XZjDuw+5ayYZ7bTKhFBrUzMkx4tvZc7ThDCMjztTW+fUj1D+3UO+2wRUoxqYSmVfpI6RfyxXeh84QprnhAze3VxPn35w+sp029UvkL6H+xvdo/lHSbqJZdOzGEtdYUBzoD9LrmYJRBIlm70RPD19Kz0diDQVGWKfojuV3r0+WxWJ2L3TNTrKfvnmaCXP9SJKJ4Jml3wyckVPhM3fTStrpuQvu2Otj5FFTMzoMmvzDt/WD5SazVKMxTIZb5OREwizC/pdKCdT85fnk0nZ5PXN9OL+ezv81cXo8lk8l+RiG0Zo7vtTHlb9Dolu+/K5d9EDhqZaryx1deZ7zFXHjO6rfyjOXoqjllcnCNuS5vzlBBbUzgtN3ZPPqhDc4b94uH58qnXiZg91jWvbYlU8LCxQUOw8dasEnAaZUAgvwO5ksoAs/Hf/f/aKXpvnyjTz9NsGNfKaGXwthsZbmeTye20d8Ls2Ak3g/YJS1uZ/Nua+pj80wbNbi96g14dG3Rl1lKrPE6qN/YOzbe1ZyieGvHHEasaorgvDowdrjdGBswqr2gXR9jtmXTqrNmff1zwdMiRYtvZN868VIi56AeE8X4w79aC+fl1NxHHxO1niiBNntrtyDo03Ge0TAP307F0arzmNvkQIZ17BnUguVJmdXYStbi3+JpPpXH8gd33LdqpfyL36NatQ6p2si9Qxtmq5u+ljeDW2e8cGq7+8ajW06Ne/QF1ZkvkaZ8KhI78j99+j4jughIj6Tt4V3lwdoOeh3Bpclhq3KpUP3ZlCihLjSHoHShDuPIc/7laKZI6TgSc+Zl0MlVacewxmWW0h0H4hhF8KJAK9Lz1N48gIcc1ag5Z0NbeMR+yICuyZZTR6gwb6++WrFICEtIqKIOBL2XYQdAU0mQI3VkkYD1IA2gIvfMqIEhVMjHf2nC5VJlixpxoXmYEpTRyhSwsAdabveC8XascA3ibVoEgWF1FQ1hiiUiNifGSNYKf1Robw3mxuV1iDquKWSSQ2RyhzTs2w+SQYiBwLF5lGJkGkp5A4xp9jL14kstKa3CWC4KSmi95w7NlRuSlCdy+GoW6o+nd57zl+1aUkcvdCD6ZT4aLNlQBOQC0Mndh/smcwcc+zD5gGhTh4vsuHzabzVEevDjEvFVUVCl4dPYet4qLMWuG8P7jhUgEoS/Du+U1+rXKuovDF2SOI/G4LZMyi2Wynbw5x358COCSpVWGJuCgqF2+ff8LrOHlaCKSQeZ/hcLjX65+evOv6zfMl2tTk3/T0WQ0ibO8DVRKMxA1fJJ4mLf7+2L/F3i+aCsZ4ZbGTksV20E7TzWl/OP9LJOI+fDxYpGIwgZikv0+lQH/43Vd8/KvFXpuGItErKVXPNXFep+rwL/z/iHii577/t/tm8YL+Pp3kEeN6Wq14UId7z08/iXiDncPHmPqBd8ZmoLN2jYUl1mGjgbYowZ+0AXfvrkRiZAVFYeN4i42ivYHc39Ur8MO0ijAf7mZPQrY75smVNc9fbP1RURrYEfNTlrUdf0n0VXFuQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,h={},y=[];function x(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,p.jsx)(n(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,p.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,p.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,p.jsx)(o(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,p.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,p.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,p.jsx)(t,{...e,children:(0,p.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.71fcd1cb.js b/assets/js/377084eb.71fcd1cb.js new file mode 100644 index 000000000..c5d94b74a --- /dev/null +++ b/assets/js/377084eb.71fcd1cb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9441],{4741:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>b,contentTitle:()=>x,default:()=>v,frontMatter:()=>f,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/get-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-template","permalink":"/docs/API-docs/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWFtv3DYW/iunfNkGkOfiTJzuPNVog6yxxSZYexFgk4FBSWdGjCmSJY/mgoHe+kv60/pLikNdrPE44xi7CNAXe0Sd79xv1F6QXAUx/yhusHRaEgaxSESOIfPKkbJGzMVNgfAWCToSuHx/BVJruwmwsxWQBY/kFa4RciSpdACZ2opAQnCYqaXKgFrwqGcTIKBfI8gAqa7QeWUowNJ6yDxKUmYFuc2qEvl4o6gA5zHHpTKYQyBfZVR5DCORCOvQS9b2KhdzsULqZIhEOOlliYSezdwLI0sUc9Gpc6tykQjFZjpJhXho+9XPYJe98kCFJDCIeWCrU4QlUlYg8/D4a6U85mJOvsJEBNpplhRU6TQrglunbY5ivpQ6MEFWYCnFfC9o5yIleWVWIhFL60tJzYlZibpeMPvgrAkYGHA+mfC/Q1VDlWUYwrLS0PtDJCKzhtAQ00vntMrii/HnwKD9sRY2/YwZseM8syHViGyO2b+n9W1OcCuj1XOxnf4jNWU4f78SdSJIEZ8es7gHhPijdzmjjKUnQH2AImnNKukc/bcyq0mqUwo2+kAkrO8dcZ+HrcKsunrKRQWRC/PxuANXAf0osyWj7cYc2H3KWbHObKdVIoJamVgnPVp6L3dcIIRleNqb3j6leob26xz22SKkGNXCUir9JHWK+GN70PnCFdY8IWb26uJ8+vKH11Om36h8hfQ/2N+8PZZ3WKiX3Doxh7XUFQY4A/a75GaWQCBZutETydfTs9LbgUBTlSn6Ibo/6dHns1mdiN0zUa+n7J9ngl7+UCeieCZodsGRkyt8Jm76aFldNyl924W2PkUVKzOgya/MO3/YPlJrNUozFMhtvk5ELCLML+l0op1Pzl+eTSdnk9c304v57O/zVxejyWTyX5GIbRmzu51Medv0OiW758rl30QOGplqvLHV15nvMVceM7qt/KM1eiqPWVzcI25Lm/OWEEdTOC03Tk8O1KE5w3nxML4c9ToRs8em5rUtkQpeNjZoCDbemlUCTqMMCOR3IFdSGWA2/rv/3zhF7+0Tbfp5mg3zWhmtDN52K8PtbDK5nfZOmB074WYwPmFpK5N/W1Mfk3/aoNntRW/Qq2ODrsxaapXHTfXG3qH5tvYMxVMj/jhjVUMU34sDY4fnjZEBs8or2sUVdnsmnTpr3s8/Lng75Eyx7e4bd14qxFz0C8J4P9h3a8H8/LrbiGPh9jtFkCZP7XZkHRqeM1qmgefpWDo1XvOYfIiQzj2DGquz5wECyZUyq9Ooxb2LrjmMTaQOHHU/0536J/JQb+MwpGqvAgXKuIzV/Ly0EdxG551Dw+MixnY9PRruH1BntkS+HlCB0JH/8dvvEdHdaGLqfQfvKg/ObtDz1i5NDkuNW5Xqx+5YAWWpMQS9A2UIV54LJlcrRVLHFYJbRSadTJVWnKxMZhntYZDvYQQfCqQCPb/6m0eQkOMaNec4aGvvmA9ZkBXZMspodYaN9XdLVikBCWkVlMHAtzjsIGgKaTKELhYJWA/SABpC77wKCFKVTMzXPFwuVaaYMVemlxlBKY1cIQtLgPVmLzhv1yrHAN6mVSAIVlfREJZYIlJjYryVjeBntcbGcD5srqOYw6piFglkNkdoC5XNMDmkGAgci1cZRqaBpCfQuEYfcy9GcllpDc5yB1FS861wGFtmRF6awPOuUagLTe8+5y1f0KKMXO5G8Ml8MtzloQrICaCVuQvzT+YMPvZp9gHToAgX33f1sNlsjurgxSHmraKiSsGjs/e4VTyMVTOE9w8vRCIIfRneLa/Rr1XW3TS+IHMcicdtX5VZ7Kvtqs419uNDAPc4rTI0AQdd8PLt+19gDS9HE5EMKv8rFB7/cvXTm39dv2G+3Mya+puOJqNJXP5toFKagajhN4yHdbu/nw5/ge8dbScj3NLYaani/GgXsKb3f7xffhIxH37tWCSisIGYZL9PZcD/eF3XfPxrhZ4nzCIRa+kVr4FxQOQq8O+8/3LxRc99/+/2I8gL+PoPJ48a0/Vqw406XpR4X0zEHe4efL2pF3zJaBo2a9tQXGYZOhpgjyb+wdh8++ZGJEJWVBwOirs4KNofzP1RvQ4nSKMA/+Vh9ihgv2+GUF339M2rLyJaAztqdtKirus/AVH81uQ=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/createtemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/update-template"}}');var r=a(74848),s=a(28453),p=a(33617),i=a.n(p),l=a(17543),o=a.n(l),m=a(86013),d=a.n(m),c=a(63723),g=a.n(c),u=(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:"eJzVWFtv3DYW/iunfNkGkOfiTJzuPNVog6yxxSZYexFgk4FBSWdGjCmSJY/mgoHe+kv60/pLikNdrPE44xi7CNAXe0Sd79xv1F6QXAUx/yhusHRaEgaxSESOIfPKkbJGzMVNgfAWCToSuHx/BVJruwmwsxWQBY/kFa4RciSpdACZ2opAQnCYqaXKgFrwqGcTIKBfI8gAqa7QeWUowNJ6yDxKUmYFuc2qEvl4o6gA5zHHpTKYQyBfZVR5DCORCOvQS9b2KhdzsULqZIhEOOlliYSezdwLI0sUc9Gpc6tykQjFZjpJhXho+9XPYJe98kCFJDCIeWCrU4QlUlYg8/D4a6U85mJOvsJEBNpplhRU6TQrglunbY5ivpQ6MEFWYCnFfC9o5yIleWVWIhFL60tJzYlZibpeMPvgrAkYGHA+mfC/Q1VDlWUYwrLS0PtDJCKzhtAQ00vntMrii/HnwKD9sRY2/YwZseM8syHViGyO2b+n9W1OcCuj1XOxnf4jNWU4f78SdSJIEZ8es7gHhPijdzmjjKUnQH2AImnNKukc/bcyq0mqUwo2+kAkrO8dcZ+HrcKsunrKRQWRC/PxuANXAf0osyWj7cYc2H3KWbHObKdVIoJamVgnPVp6L3dcIIRleNqb3j6leob26xz22SKkGNXCUir9JHWK+GN70PnCFdY8IWb26uJ8+vKH11Om36h8hfQ/2N+8PZZ3WKiX3Doxh7XUFQY4A/a75GaWQCBZutETydfTs9LbgUBTlSn6Ibo/6dHns1mdiN0zUa+n7J9ngl7+UCeieCZodsGRkyt8Jm76aFldNyl924W2PkUVKzOgya/MO3/YPlJrNUozFMhtvk5ELCLML+l0op1Pzl+eTSdnk9c304v57O/zVxejyWTyX5GIbRmzu51Medv0OiW758rl30QOGplqvLHV15nvMVceM7qt/KM1eiqPWVzcI25Lm/OWEEdTOC03Tk8O1KE5w3nxML4c9ToRs8em5rUtkQpeNjZoCDbemlUCTqMMCOR3IFdSGWA2/rv/3zhF7+0Tbfp5mg3zWhmtDN52K8PtbDK5nfZOmB074WYwPmFpK5N/W1Mfk3/aoNntRW/Qq2ODrsxaapXHTfXG3qH5tvYMxVMj/jhjVUMU34sDY4fnjZEBs8or2sUVdnsmnTpr3s8/Lng75Eyx7e4bd14qxFz0C8J4P9h3a8H8/LrbiGPh9jtFkCZP7XZkHRqeM1qmgefpWDo1XvOYfIiQzj2DGquz5wECyZUyq9Ooxb2LrjmMTaQOHHU/0536J/JQb+MwpGqvAgXKuIzV/Ly0EdxG551Dw+MixnY9PRruH1BntkS+HlCB0JH/8dvvEdHdaGLqfQfvKg/ObtDz1i5NDkuNW5Xqx+5YAWWpMQS9A2UIV54LJlcrRVLHFYJbRSadTJVWnKxMZhntYZDvYQQfCqQCPb/6m0eQkOMaNec4aGvvmA9ZkBXZMspodYaN9XdLVikBCWkVlMHAtzjsIGgKaTKELhYJWA/SABpC77wKCFKVTMzXPFwuVaaYMVemlxlBKY1cIQtLgPVmLzhv1yrHAN6mVSAIVlfREJZYIlJjYryVjeBntcbGcD5srqOYw6piFglkNkdoC5XNMDmkGAgci1cZRqaBpCfQuEYfcy9GcllpDc5yB1FS861wGFtmRF6awPOuUagLTe8+5y1f0KKMXO5G8Ml8MtzloQrICaCVuQvzT+YMPvZp9gHToAgX33f1sNlsjurgxSHmraKiSsGjs/e4VTyMVTOE9w8vRCIIfRneLa/Rr1XW3TS+IHMcicdtX5VZ7Kvtqs419uNDAPc4rTI0AQdd8PLt+19gDS9HE5EMKv8rFB7/cvXTm39dv2G+3Mya+puOJqNJXP5toFKagajhN4yHdbu/nw5/ge8dbScj3NLYaani/GgXsKb3f7xffhIxH37tWCSisIGYZL9PZcD/eF3XfPxrhZ4nzCIRa+kVr4FxQOQq8O+8/3LxRc99/+/2I8gL+PoPJ48a0/Vqw406XpR4X0zEHe4efL2pF3zJaBo2a9tQXGYZOhpgjyb+wdh8++ZGJEJWVBwOirs4KNofzP1RvQ4nSKMA/+Vh9ihgv2+GUF339M2rLyJaAztqdtKirus/AVH81uQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,b={},y=[];function h(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,r.jsx)(i(),{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)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(o(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,r.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/451a5132.25f6966a.js b/assets/js/451a5132.25f6966a.js new file mode 100644 index 000000000..d59001b2b --- /dev/null +++ b/assets/js/451a5132.25f6966a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4553],{33487:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>j,contentTitle:()=>g,default:()=>I,frontMatter:()=>h,metadata:()=>o,toc:()=>k});const o=JSON.parse('{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/folderlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/folderlist","permalink":"/docs/API-docs/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9uO2zYQ/RWGL20ArS1vsinqpy7aNNg2SALsFgG6MRYjaSwxpkiWHPkCQ2/9kn5av6QYyrLlvaTZIs3LekXOmTkznAu5lQRlkNNr+bPVBXo5S2SBIffKkbJGTuVVhaLbE69VIHH+7kJg7ewKfRAb2wiywiN5hUsUIDTL2LmYd5CVokrY7tc2JBx4NNTpuyhkIq1DD2zqopBT2aFYh0ykAw81Enrmt5UGapRTeUeDYpZ/NOg38jZ3m33EnC6KAyGZSI9/NMpjIadz0AETGWijMRr3tUwkrp22BR628wprkNOtpI1juUBemVImEQA0XME11C4qk22b7DlrVSu6TfWzeZBvjmjUsFZ1U8vpWZomPSnT1Bl62Q44TNIBhbBQ7osxeNhm2s5Yb3DWBAwse5qm/HN8MKHJcwxh3mixTwCZyNwaQkMsD85plceN8cfAoO1dAt35cqp4VkOqM+kxNJoGcuA9sMOKsA7/ju/T5rFn7qpJVq1PPzoOSZdvb2L0H6fG4KrP1ja5ne+P1PXLqYFwtlDv8Lau/8osNNmAXe4RCItzuk/VAXianj47maQn6XdXkxfT599Pz16M0jT9XSZyXWvG7tK0AIpMSZEefjeu+Ap2Bgudizceg2yH68poZfCmT/Gb0zS9mTxjmTaRz+/L9UtbI1XKlGKFhsTKW1MmwmmEgIL8RkAJyggNhP7JlysC9N76T0frccw+FYXnHIV9EM7uBuHCLEGrIk6PK7tA83U9HZqnzjxTPc4J1QnFfXnk7HC9czJg3nhFmziZ1ifg1Em3P72ecQvkwFqeaCV2o4wqOZXjo/kW0C/74dZ4LaeyInJhOh4HMEVm1yPr0ARVGg1ZGOW2HoNT4+VEcl8/RoBzj5DG5uRxgEBQKlN+GjU7hOWSj647naPgHDqyU78it+Rd7IdSuylVIcQm0/L33Ebw7kTeOjSXqjTxPJeTO3P/Perc1shXE6pQ9OJ///lXRBQ2b2o0FNPtiXjbeBHvMzyOwBRirnGtMo1RGLS2q/1NJyDUGkPQG6EMYemBUBSqVARacFS4mnJwkCmtOEFZzDLai0GOh5F4XyFV6HnrG883pwKXqDmvhbZ2wXrICmjI1tHGjrNYWb+YM6VEgMiaoAyGIAJiD0FTgclR9GeR8P0LjEBD6J1XAQWomoXn1gucz1WuWDFXo4ecRA0GSmRjiWDeHAXn7VIVGIS3WRNIBKub6AhbrBGpc9EgFmEkflJL7BznxQIJlMZClA2rSERuCxS74mQ3TCEyDCQcm1c5RqWBwJPQuEQfcy+e5LzRWjjLXUOB5mvd8GxZEXkwgWdYR6g/mn34nLd884g2CtiMxAfzwXAjFE1ATgCtzCJMP5gTcb1Ps/eYBUU4+7avh9VqdacOnh5jXimqmkx4dPaAK+NirJohfP/xVCaS0Nfh7fwS/VLluCvCB2yOo/B410shj70Ua1C6q7EfbgO4r2mVowk46Hznr969FkvxbJTKZFD5n0F4/Prix5dvLl+yXm5mXf1NRukojRcOG6gGMzD1Cql/G+za4FHpbg9D4f9+eew6EeGaxk6Dij0/Or/d9evr4XtklsjKBuLV7TaDgL953ba83F2nuYsXKkCmBxfqB32792VyL6MFbu579SxBN907I7nHbgfqnx2fI7t7HxxEZ/zhFcvGoZb0DZkd7TDneY5uaODOFD8aha9eXslEQsOhHQ6CRRwEu39Ye79lNgPdxxOiI8B/2ad7AdttN2Tadi/fbT2I2DnYS3P8Z23b/gPCBDsE","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/deletefolder"}}');var i=r(74848),n=r(28453),s=r(33617),a=r.n(s),l=r(17543),d=r.n(l),m=r(86013),p=r.n(m),c=r(63723),u=r.n(c),f=(r(18766),r(79329),r(9303));const h={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:"eJy9V9uO2zYQ/RWGL20ArS1vsinqpy7aNNg2SALsFgG6MRYjaSwxpkiWHPkCQ2/9kn5av6QYyrLlvaTZIs3LekXOmTkznAu5lQRlkNNr+bPVBXo5S2SBIffKkbJGTuVVhaLbE69VIHH+7kJg7ewKfRAb2wiywiN5hUsUIDTL2LmYd5CVokrY7tc2JBx4NNTpuyhkIq1DD2zqopBT2aFYh0ykAw81Enrmt5UGapRTeUeDYpZ/NOg38jZ3m33EnC6KAyGZSI9/NMpjIadz0AETGWijMRr3tUwkrp22BR628wprkNOtpI1juUBemVImEQA0XME11C4qk22b7DlrVSu6TfWzeZBvjmjUsFZ1U8vpWZomPSnT1Bl62Q44TNIBhbBQ7osxeNhm2s5Yb3DWBAwse5qm/HN8MKHJcwxh3mixTwCZyNwaQkMsD85plceN8cfAoO1dAt35cqp4VkOqM+kxNJoGcuA9sMOKsA7/ju/T5rFn7qpJVq1PPzoOSZdvb2L0H6fG4KrP1ja5ne+P1PXLqYFwtlDv8Lau/8osNNmAXe4RCItzuk/VAXianj47maQn6XdXkxfT599Pz16M0jT9XSZyXWvG7tK0AIpMSZEefjeu+Ap2Bgudizceg2yH68poZfCmT/Gb0zS9mTxjmTaRz+/L9UtbI1XKlGKFhsTKW1MmwmmEgIL8RkAJyggNhP7JlysC9N76T0frccw+FYXnHIV9EM7uBuHCLEGrIk6PK7tA83U9HZqnzjxTPc4J1QnFfXnk7HC9czJg3nhFmziZ1ifg1Em3P72ecQvkwFqeaCV2o4wqOZXjo/kW0C/74dZ4LaeyInJhOh4HMEVm1yPr0ARVGg1ZGOW2HoNT4+VEcl8/RoBzj5DG5uRxgEBQKlN+GjU7hOWSj647naPgHDqyU78it+Rd7IdSuylVIcQm0/L33Ebw7kTeOjSXqjTxPJeTO3P/Perc1shXE6pQ9OJ///lXRBQ2b2o0FNPtiXjbeBHvMzyOwBRirnGtMo1RGLS2q/1NJyDUGkPQG6EMYemBUBSqVARacFS4mnJwkCmtOEFZzDLai0GOh5F4XyFV6HnrG883pwKXqDmvhbZ2wXrICmjI1tHGjrNYWb+YM6VEgMiaoAyGIAJiD0FTgclR9GeR8P0LjEBD6J1XAQWomoXn1gucz1WuWDFXo4ecRA0GSmRjiWDeHAXn7VIVGIS3WRNIBKub6AhbrBGpc9EgFmEkflJL7BznxQIJlMZClA2rSERuCxS74mQ3TCEyDCQcm1c5RqWBwJPQuEQfcy+e5LzRWjjLXUOB5mvd8GxZEXkwgWdYR6g/mn34nLd884g2CtiMxAfzwXAjFE1ATgCtzCJMP5gTcb1Ps/eYBUU4+7avh9VqdacOnh5jXimqmkx4dPaAK+NirJohfP/xVCaS0Nfh7fwS/VLluCvCB2yOo/B410shj70Ua1C6q7EfbgO4r2mVowk46Hznr969FkvxbJTKZFD5n0F4/Prix5dvLl+yXm5mXf1NRukojRcOG6gGMzD1Cql/G+za4FHpbg9D4f9+eew6EeGaxk6Dij0/Or/d9evr4XtklsjKBuLV7TaDgL953ba83F2nuYsXKkCmBxfqB32792VyL6MFbu579SxBN907I7nHbgfqnx2fI7t7HxxEZ/zhFcvGoZb0DZkd7TDneY5uaODOFD8aha9eXslEQsOhHQ6CRRwEu39Ye79lNgPdxxOiI8B/2ad7AdttN2Tadi/fbT2I2DnYS3P8Z23b/gPCBDsE",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,j={},k=[];function x(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,i.jsx)(a(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,i.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.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,i.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:t}={...(0,n.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/451a5132.c012dd2f.js b/assets/js/451a5132.c012dd2f.js deleted file mode 100644 index 4cea414bd..000000000 --- a/assets/js/451a5132.c012dd2f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4553],{33487:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>u,contentTitle:()=>x,default:()=>g,frontMatter:()=>y,metadata:()=>r,toc:()=>v});const r=JSON.parse('{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","source":"@site/docs/API-docs/folderlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/folderlist","permalink":"/docs/API-docs/folderlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar_label":"Get folder list","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V1tv2zYU/issX7YCii2nTYf5acHWFdmKtkAyFFhqBEfSscSaIjnyyBcYetsv2U/bLxkOZdlyLl0zdH2JI/JcvnM/3EqCMsjptfzZ6gK9nCWywJB75UhZI6fyqkLR3YnXKpA4f3chsHZ2hT6IjW0EWeGRvMIlChCaaexczDuWlaJK2O7XNiQceDTUybsoZCKtQw+s6qKQU9lxsQyZSAceaiT0jG8rDdQop/KOBMUo/2jQb+Rt7Db7iDldFAdAMpEe/2iUx0JO56ADJjLQRmNU7muZSFw7bQs8XOcV1iCnW0kbx3SBvDKlTCID0PAE11C7KEy2bbLHrFWt6DbUz8ZBvjmCUcNa1U0tp2dpmvSgTFNn6GU7wDBJBxDCQrkvhuBhnWk7Y7nBWRMwMO1pmvLPcWBCk+cYwrzRYp8AMpG5NYSGmB6c0yqPF+OPgZm2dwF08eVU8SyGVKfSY2g0DejAe2CDFWEd/p2/T5vHxtxVk6xan3507JIu395E7z9OjMFVn61tcjvfHynrl1MD4Wyh3uFtWf8VWWiyAbrcIxAW53SfqAPjaXr67GSSnqTfXU1eTJ9/Pz17MUrT9HeZyHWtmXeXpgVQREqK9PC7ccVX0DM46Ey88RhkOzxXRiuDN32K35ym6c3kGdO0iXx+X65f2hqpUqYUKzQkVt6aMhFOIwQU5DcCSlBGaCD0T75cEaD31n/aW49D9ikvPGcv7J1wdtcJF2YJWhVxelzZBZqva+lQPXXqGepxTqiOKN7LI2OH552RAfPGK9rEybQ+AadOuvvp9YxbIDvW8kQrsRtlVMmpHB/Nt4B+2Q+3xms5lRWRC9PxOIApMrseWYcmqNJoyMIot/UYnBovJ5L7+jEHOPcI6kBQKlOefJJrdrDykiPROfvI1kODdepX5A67c+WQajd0KoTYM1r+ntvIvHPwW4fmUpUmhmc5uTPG36PObY28aVCFoif/+8+/Ikdh86ZGQzF7noi3jRdxPeHpAqYQc41rlWmMxKC1Xe0Xl4BQawxBb4QyhKUHQlGoUhFowV7h4sjBQaa04nxjMsvcXgxSNozE+wqpQs9X33hehApcouY0FdraBcshK6AhW0cdO8xiZf1izpASASJrgjIYggiIPQuaCkyOoo9FwusUGIGG0DuvAgpQNRPPrRc4n6tcsWAuLg85iRoMlMjKEsG42QvO26UqMAhvsyaQCFY30RDWWCNSZ6JBLMJI/KSW2BnOhwUSKI2FKBsWkYjcFih2tcZmmEJkGEg4Vq9yjEIDgSehcYk+5l6M5LzRWjjLTUCB5i1tGFsWRB5M4JHUAepDs3ef85YXiaijgM1IfDAfDPc10QTkBNDKLML0gzkR1/s0e49ZUISzb/t6WK1Wd+rg6THPK0VVkwmPzh74yngYq2bIvv94KhNJ6Ovwdn6Jfqly3BXhAzrHkXi8a42Qx9aINSjd1dgPtxm4TWmVowk4aGTnr969FkvxbJTKZFD5nwF4/Prix5dvLl+yXO5NXf1NRukojfuDDVSDGah6hdSv+ruudlS620OP/78fErtORLimsdOgYguPxm937fd6+LyYJbKygfh0u80g4G9ety0fd9sxN+VCBcj0YD9+0LZ7Hxr3Ilrg5r5HzBJ00z0bknv0dkz9K+JzaHfr/oF0xh9eMW2cUUnfkNnQjuc8z9ENFdwZykeT7dXLK5lIaNi1w0GwiINg9w9L76/MZiD7eEJ0APgv23Qvw3bbDZm23dN3Vw9y7Azsqdn/s7Zt/wF5NinZ","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/deletefolder"}}');var s=i(74848),o=i(28453),n=i(33617),d=i.n(n),a=i(17543),l=i.n(a),p=i(86013),c=i.n(p),m=i(63723),f=i.n(m),h=(i(18766),i(79329),i(9303));const y={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V1tv2zYU/issX7YCii2nTYf5acHWFdmKtkAyFFhqBEfSscSaIjnyyBcYetsv2U/bLxkOZdlyLl0zdH2JI/JcvnM/3EqCMsjptfzZ6gK9nCWywJB75UhZI6fyqkLR3YnXKpA4f3chsHZ2hT6IjW0EWeGRvMIlChCaaexczDuWlaJK2O7XNiQceDTUybsoZCKtQw+s6qKQU9lxsQyZSAceaiT0jG8rDdQop/KOBMUo/2jQb+Rt7Db7iDldFAdAMpEe/2iUx0JO56ADJjLQRmNU7muZSFw7bQs8XOcV1iCnW0kbx3SBvDKlTCID0PAE11C7KEy2bbLHrFWt6DbUz8ZBvjmCUcNa1U0tp2dpmvSgTFNn6GU7wDBJBxDCQrkvhuBhnWk7Y7nBWRMwMO1pmvLPcWBCk+cYwrzRYp8AMpG5NYSGmB6c0yqPF+OPgZm2dwF08eVU8SyGVKfSY2g0DejAe2CDFWEd/p2/T5vHxtxVk6xan3507JIu395E7z9OjMFVn61tcjvfHynrl1MD4Wyh3uFtWf8VWWiyAbrcIxAW53SfqAPjaXr67GSSnqTfXU1eTJ9/Pz17MUrT9HeZyHWtmXeXpgVQREqK9PC7ccVX0DM46Ey88RhkOzxXRiuDN32K35ym6c3kGdO0iXx+X65f2hqpUqYUKzQkVt6aMhFOIwQU5DcCSlBGaCD0T75cEaD31n/aW49D9ikvPGcv7J1wdtcJF2YJWhVxelzZBZqva+lQPXXqGepxTqiOKN7LI2OH552RAfPGK9rEybQ+AadOuvvp9YxbIDvW8kQrsRtlVMmpHB/Nt4B+2Q+3xms5lRWRC9PxOIApMrseWYcmqNJoyMIot/UYnBovJ5L7+jEHOPcI6kBQKlOefJJrdrDykiPROfvI1kODdepX5A67c+WQajd0KoTYM1r+ntvIvHPwW4fmUpUmhmc5uTPG36PObY28aVCFoif/+8+/Ikdh86ZGQzF7noi3jRdxPeHpAqYQc41rlWmMxKC1Xe0Xl4BQawxBb4QyhKUHQlGoUhFowV7h4sjBQaa04nxjMsvcXgxSNozE+wqpQs9X33hehApcouY0FdraBcshK6AhW0cdO8xiZf1izpASASJrgjIYggiIPQuaCkyOoo9FwusUGIGG0DuvAgpQNRPPrRc4n6tcsWAuLg85iRoMlMjKEsG42QvO26UqMAhvsyaQCFY30RDWWCNSZ6JBLMJI/KSW2BnOhwUSKI2FKBsWkYjcFih2tcZmmEJkGEg4Vq9yjEIDgSehcYk+5l6M5LzRWjjLTUCB5i1tGFsWRB5M4JHUAepDs3ef85YXiaijgM1IfDAfDPc10QTkBNDKLML0gzkR1/s0e49ZUISzb/t6WK1Wd+rg6THPK0VVkwmPzh74yngYq2bIvv94KhNJ6Ovwdn6Jfqly3BXhAzrHkXi8a42Qx9aINSjd1dgPtxm4TWmVowk4aGTnr969FkvxbJTKZFD5nwF4/Prix5dvLl+yXO5NXf1NRukojfuDDVSDGah6hdSv+ruudlS620OP/78fErtORLimsdOgYguPxm937fd6+LyYJbKygfh0u80g4G9ety0fd9sxN+VCBcj0YD9+0LZ7Hxr3Ilrg5r5HzBJ00z0bknv0dkz9K+JzaHfr/oF0xh9eMW2cUUnfkNnQjuc8z9ENFdwZykeT7dXLK5lIaNi1w0GwiINg9w9L76/MZiD7eEJ0APgv23Qvw3bbDZm23dN3Vw9y7Azsqdn/s7Zt/wF5NinZ",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={},v=[];function I(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,s.jsx)(d(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{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 g(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/4d665321.3e46ed7a.js b/assets/js/4d665321.3e46ed7a.js deleted file mode 100644 index 98f46cc97..000000000 --- a/assets/js/4d665321.3e46ed7a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6792],{87610:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>f,contentTitle:()=>v,default:()=>Q,frontMatter:()=>k,metadata:()=>n,toc:()=>x});const n=JSON.parse('{"id":"API-docs/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/revokedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/revokedocument","permalink":"/docs/API-docs/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/RVmXpoA2osvSVE91bkgNRrURuwiQJ2FMSuNtIwpkiGpvWCht35JP61fUgwl7cqXGAmQ5sVeUXM9Mzwz2kLA0kN6Ba9NVlekg4dZAjn5zEkbpNGQwuWCxHtamhsSeSclTs5PBSplVl5sTC2CEa6V8JYyWchsL1o4U7GQ2x35MSRgLDlkD6c5pNBq9wKQgEWHFQVyHN0WNFYEKfQC1zKHBCRHZzEs4G7I584sZU7CzD9RFk5zYYp9QLtgIQFHn2vpKIc0uJoS8GGj2JGXlVUsQGurTE6QFqg8C2QLqhDSLYSNjZLBSV1CAoVxFYbhCa0xWknBLg7ni0P0OTTNrPVKPrw0+YYtZUYHzjrdAlqrZBZxmXzynMv2vss2KwbJMYpBkue3jrDTuBvaPhBomgSCDPHhDuhNwy8deWu0b00eTqf87za4fat0KObC11lG3he1UpsnkHyvfPriPZ7RyzUDa3+zRxCjjyGdhMeVDqeHR6OD6Wj68+XBi/T4l/T5i/F0Ov0LElhXinX7hsNAMICsfW7uinX9dA/bDtPjh2C8MBWFhdSlWDGYK2d0mQirCD2J4DYCS5RaKAzkviOq5Jxxj6PzbZENO0pqJTVd9z10fTydXh/sQDh+pJe0CaIwtc5/bKoP+X88oePro11Cz+8ndKqXqGQeCfLS3JD+sfkM3YfW/f1ula1QfA+3kh2et0l6ymonwyay8HqEVo7a9+nVjKmMO8Uwg1vjW94OC0hh0rPKZDvg7AbYoFv2rF47BSksQrA+nUw86nxu1mNjSXtZaoVzP85MNUErJ8sDaJK7GmjtN0j7gKXU5ehRrdk+5QsuS4v8rcR3+KOVv9MGkh7XoVQ3nRaEOblYA672+z3xv+lrtidu4GJIXZjooyvKmSV9IUsdS7o8uDfqPpDKTEU81cKCRC/+79//RI0e/dhxT8RZ7YQ1K3JFrQTqXBSK1nKu6IGJ7gkrRd6rjZA6UOkwkMhlKQMqweAxQ2RocS6V5B5lMdOO+kGb+7H4sKCwIMevfnIkUOS0JMWtLZQxN2wnGIF1MFX00V/KlXE3BYeUCBTz2ktN3gtP1KuQXqDOSPQlS4RxArUgHchZJz0JlBULF8YJKgqZSTbMF9JhFkSFGktiZ4nguBkF2y4PXjgzr30Q3qg6JsIeK6LQpqiJcj8Wr+WS2sTjikMBpaJclDWbSERmchLd/eQ0dC7m5IOw7F5mFI36gC4IRUtysUVjJXmcCmuYOCQq3mCGtWVDwaH2vHZ061VXmh181hmey9FHjpux+Kg/aiZ3UXviBlBS3/j0ox6Jq12bfaC5l4FmT/trs1qt7l2XZ7d13sqwqOfCkTV7vTIexss1VN89PIMEArnKnxUX5JYyo+6ufsHnJApPOjrFLNIpVShVexV/vavAt0nJjLSnAfmdvD1/J5biaDyFZEAQXxHw5N3pqzd/XLxhu0xh7f07GE/HUz5iAqxQD1x1S/Pr/VZ76+oOFr//acfueCrQOkysQhnZPua87Yj6CgY7dzpcr2cJLJjS0yvYbufo6U+nmoaPP9fkeB7MEliikzhnnrraQi49/853u/IXs336vlu7n4mv3tQfzKUnYs0svERVxx03gRva3PlaaGZN0rMxB9tKvGpDGl2ynb2Fe0Oah0mrcZJlZMOjssOpeH52cQkJzLtNv4qfEuBwxd8euGqjNRGidofnsy0o1GWNJcu2NnmAYM0VG06fmzh9uh+c1YN43B5LbRr8l5N6UGG7bSdb0+zk21df1OiA7aW5OLOmaf4DsZMFfg==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"}}');var s=o(74848),r=o(28453),i=o(33617),a=o.n(i),c=o(17543),d=o.n(c),l=o(86013),p=o.n(l),u=o(63723),m=o.n(u),h=(o(18766),o(79329),o(9303));const k={id:"revokedocument",title:"Revoke Document",description:"The Revoke document API allows you to revoke specific document from your documents.",sidebar_label:"Revoke Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/RVmXpoA2osvSVE91bkgNRrURuwiQJ2FMSuNtIwpkiGpvWCht35JP61fUgwl7cqXGAmQ5sVeUXM9Mzwz2kLA0kN6Ba9NVlekg4dZAjn5zEkbpNGQwuWCxHtamhsSeSclTs5PBSplVl5sTC2CEa6V8JYyWchsL1o4U7GQ2x35MSRgLDlkD6c5pNBq9wKQgEWHFQVyHN0WNFYEKfQC1zKHBCRHZzEs4G7I584sZU7CzD9RFk5zYYp9QLtgIQFHn2vpKIc0uJoS8GGj2JGXlVUsQGurTE6QFqg8C2QLqhDSLYSNjZLBSV1CAoVxFYbhCa0xWknBLg7ni0P0OTTNrPVKPrw0+YYtZUYHzjrdAlqrZBZxmXzynMv2vss2KwbJMYpBkue3jrDTuBvaPhBomgSCDPHhDuhNwy8deWu0b00eTqf87za4fat0KObC11lG3he1UpsnkHyvfPriPZ7RyzUDa3+zRxCjjyGdhMeVDqeHR6OD6Wj68+XBi/T4l/T5i/F0Ov0LElhXinX7hsNAMICsfW7uinX9dA/bDtPjh2C8MBWFhdSlWDGYK2d0mQirCD2J4DYCS5RaKAzkviOq5Jxxj6PzbZENO0pqJTVd9z10fTydXh/sQDh+pJe0CaIwtc5/bKoP+X88oePro11Cz+8ndKqXqGQeCfLS3JD+sfkM3YfW/f1ula1QfA+3kh2et0l6ymonwyay8HqEVo7a9+nVjKmMO8Uwg1vjW94OC0hh0rPKZDvg7AbYoFv2rF47BSksQrA+nUw86nxu1mNjSXtZaoVzP85MNUErJ8sDaJK7GmjtN0j7gKXU5ehRrdk+5QsuS4v8rcR3+KOVv9MGkh7XoVQ3nRaEOblYA672+z3xv+lrtidu4GJIXZjooyvKmSV9IUsdS7o8uDfqPpDKTEU81cKCRC/+79//RI0e/dhxT8RZ7YQ1K3JFrQTqXBSK1nKu6IGJ7gkrRd6rjZA6UOkwkMhlKQMqweAxQ2RocS6V5B5lMdOO+kGb+7H4sKCwIMevfnIkUOS0JMWtLZQxN2wnGIF1MFX00V/KlXE3BYeUCBTz2ktN3gtP1KuQXqDOSPQlS4RxArUgHchZJz0JlBULF8YJKgqZSTbMF9JhFkSFGktiZ4nguBkF2y4PXjgzr30Q3qg6JsIeK6LQpqiJcj8Wr+WS2sTjikMBpaJclDWbSERmchLd/eQ0dC7m5IOw7F5mFI36gC4IRUtysUVjJXmcCmuYOCQq3mCGtWVDwaH2vHZ061VXmh181hmey9FHjpux+Kg/aiZ3UXviBlBS3/j0ox6Jq12bfaC5l4FmT/trs1qt7l2XZ7d13sqwqOfCkTV7vTIexss1VN89PIMEArnKnxUX5JYyo+6ufsHnJApPOjrFLNIpVShVexV/vavAt0nJjLSnAfmdvD1/J5biaDyFZEAQXxHw5N3pqzd/XLxhu0xh7f07GE/HUz5iAqxQD1x1S/Pr/VZ76+oOFr//acfueCrQOkysQhnZPua87Yj6CgY7dzpcr2cJLJjS0yvYbufo6U+nmoaPP9fkeB7MEliikzhnnrraQi49/853u/IXs336vlu7n4mv3tQfzKUnYs0svERVxx03gRva3PlaaGZN0rMxB9tKvGpDGl2ynb2Fe0Oah0mrcZJlZMOjssOpeH52cQkJzLtNv4qfEuBwxd8euGqjNRGidofnsy0o1GWNJcu2NnmAYM0VG06fmzh9uh+c1YN43B5LbRr8l5N6UGG7bSdb0+zk21df1OiA7aW5OLOmaf4DsZMFfg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},v=void 0,f={},x=[];function j(e){const t={p:"p",...(0,r.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)(a(),{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)(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)(p(),{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 Q(e={}){const{wrapper:t}={...(0,r.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/4d665321.c9b93ca4.js b/assets/js/4d665321.c9b93ca4.js new file mode 100644 index 000000000..205443337 --- /dev/null +++ b/assets/js/4d665321.c9b93ca4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6792],{87610:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>P,contentTitle:()=>y,default:()=>k,frontMatter:()=>h,metadata:()=>n,toc:()=>x});const n=JSON.parse('{"id":"API-docs/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","source":"@site/docs/API-docs/revokedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/revokedocument","permalink":"/docs/API-docs/revokedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar_label":"Revoke Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V1lv3DYQ/ivMvDQBtIePpKie6hxIjQa1EbsIUGdhzEojLWOKZEhqDyz01l/Sn9ZfUgwl7cpHjARI87IrkXMf34y2ELD0kF7Ba5PVFengYZZATj5z0gZpNKRwuSDxnpbmhkTeUYmT81OBSpmVFxtTi2CEaym8pUwWMtuTFs5UTOR2R34MCRhLDlnDaQ4ptNw9ASRg0WFFgRxbtwWNFUEKPcG1zCEBydZZDAu4a/K5M0uZkzDzT5SF01yYYm/QzlhIwNHnWjrKIQ2upgR82ChW5GVlFRPQ2iqTE6QFKs8E2YIqhHQLYWMjZXBSl5BAYVyFYXhCa4xSUrCLw/niEH0OTTNrtZIPL02+YUmZ0YG9TreA1iqZxbhMPnn2ZXtfZesVB8lxFIMkz7eOsOO4a9reEGiaBIIM8eVO0JuGLx15a7RvRR5Op/x3O7h9qXRRzIWvs4y8L2qlNk8g+V7+9Ml73KOXaw6s/c0eQbQ+mnQSHmc6nB4ejQ6mo+nPlwcv0uNf0ucvxtPp9C9IYF0p5u0LDgPBIGTte3OXrKune7HtYnr8UBgvTEVhIXUpVhzMlTO6TIRVhJ5EcBuBJUotFAZy3zGq5Jxxj0fn2ywbVpTUSmq67mvo+ng6vT7YBeH4kVrSJojC1Dr/sa4+pP9xh46vj3YOPb/v0KleopJ5BMhLc0P6x/ozVB9a9ferVbZE8R5uOTs8b530lNVOhk1E4fUIrRy19+nVjKGMK8UwglvjW9wOC0hh0qPKZDvA7AZYoFv2qF47BSksQrA+nUw86nxu1mNjSXtZaoVzP85MNUErJ8sDaJK7HGjtN1BTPfo2Bh+wlLp8nGu2j9EF57FN1a1I7RKGVv5OG0j6RAypunG2IMzJxaRxebzfT4o3fZL3SA+cPakLE3V0WTyzpC9kqWMNLA/uzcYPpDJTEY/BsCDRk//79z+Ro09XLNEn4qx2wpoVuaJWAnUuCkVrOVf0wArgCStF3quNkDpQ6TCQyGUpAyrBwWNIydDiXCrJRc1kpt0NBn3hx+LDgsKCHF/95EigyGlJintBKGNuWE4wAutgqqij7+KVcTcFm5QIFPPaS03eC0/Us5BeoM5I9ClLhHECtSAdyFknPQmUFRMXxgkqCplJFswd7DALokKNJbGyRLDdHAXbbhteODOvfRDeqDo6whorotC6qIlyPxav5ZJax+NORAGlolyUNYtIRGZyEl1Dsxs6F3PyQVhWLzOKQn1AF4SiJblYojGTPH+FNYw0EhWvPMPcsqDgUHveU7p9rEvNLnzWGR7kUUeOm7H4qD9qngai9sQFoKS+8elHPRJXuzL7QHMvA82e9m2zWq3utcuz2zxvZVjUc+HImj1fGQ9jcw3Zdy/PIIFArvJnxQW5pcyo69Uv6JxE4kmHv5hF/KUKpWpb8de7DNxNSmakPQ3Q8uTt+TuxFEfjKSQDgPgKgyfvTl+9+ePiDctlzGv772A8HU/5iBGzQj1Q1W3Zr/dr8K3WHWyK/9NS3uFUoHWYWIUyjofo87ZD9isYLOnpcB+fJbDgGZBewXY7R09/OtU0fPy5JscDZJbAEp3EOePU1RZy6fk53y3XX/T26ftuT38mvnq1f9CXHog1o/ASVR2X4gRuaHPn86KZNUmPxmxsS/GqNWl0yXL2Eu5NdR4mLcdJlpENj9IOx+j52cUlJDDvPg2q+O0BDlf8sYKr1loTQ9Qu/Xy2BYW6rLFk2lYmDxCsOWPD6XMTp0/3wF49GI/bY6l1g3/ZqQcZttt2sjXNjr69+iJHF9iempMza5rmP9m2Fqk=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Document","permalink":"/docs/API-docs/update-document"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"}}');var s=o(74848),i=o(28453),c=o(33617),r=o.n(c),p=o(17543),a=o.n(p),l=o(86013),u=o.n(l),m=o(63723),d=o.n(m),v=(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:"eJy9V1lv3DYQ/ivMvDQBtIePpKie6hxIjQa1EbsIUGdhzEojLWOKZEhqDyz01l/Sn9ZfUgwl7cpHjARI87IrkXMf34y2ELD0kF7Ba5PVFengYZZATj5z0gZpNKRwuSDxnpbmhkTeUYmT81OBSpmVFxtTi2CEaym8pUwWMtuTFs5UTOR2R34MCRhLDlnDaQ4ptNw9ASRg0WFFgRxbtwWNFUEKPcG1zCEBydZZDAu4a/K5M0uZkzDzT5SF01yYYm/QzlhIwNHnWjrKIQ2upgR82ChW5GVlFRPQ2iqTE6QFKs8E2YIqhHQLYWMjZXBSl5BAYVyFYXhCa4xSUrCLw/niEH0OTTNrtZIPL02+YUmZ0YG9TreA1iqZxbhMPnn2ZXtfZesVB8lxFIMkz7eOsOO4a9reEGiaBIIM8eVO0JuGLx15a7RvRR5Op/x3O7h9qXRRzIWvs4y8L2qlNk8g+V7+9Ml73KOXaw6s/c0eQbQ+mnQSHmc6nB4ejQ6mo+nPlwcv0uNf0ucvxtPp9C9IYF0p5u0LDgPBIGTte3OXrKune7HtYnr8UBgvTEVhIXUpVhzMlTO6TIRVhJ5EcBuBJUotFAZy3zGq5Jxxj0fn2ywbVpTUSmq67mvo+ng6vT7YBeH4kVrSJojC1Dr/sa4+pP9xh46vj3YOPb/v0KleopJ5BMhLc0P6x/ozVB9a9ferVbZE8R5uOTs8b530lNVOhk1E4fUIrRy19+nVjKGMK8UwglvjW9wOC0hh0qPKZDvA7AZYoFv2qF47BSksQrA+nUw86nxu1mNjSXtZaoVzP85MNUErJ8sDaJK7HGjtN1BTPfo2Bh+wlLp8nGu2j9EF57FN1a1I7RKGVv5OG0j6RAypunG2IMzJxaRxebzfT4o3fZL3SA+cPakLE3V0WTyzpC9kqWMNLA/uzcYPpDJTEY/BsCDRk//79z+Ro09XLNEn4qx2wpoVuaJWAnUuCkVrOVf0wArgCStF3quNkDpQ6TCQyGUpAyrBwWNIydDiXCrJRc1kpt0NBn3hx+LDgsKCHF/95EigyGlJintBKGNuWE4wAutgqqij7+KVcTcFm5QIFPPaS03eC0/Us5BeoM5I9ClLhHECtSAdyFknPQmUFRMXxgkqCplJFswd7DALokKNJbGyRLDdHAXbbhteODOvfRDeqDo6whorotC6qIlyPxav5ZJax+NORAGlolyUNYtIRGZyEl1Dsxs6F3PyQVhWLzOKQn1AF4SiJblYojGTPH+FNYw0EhWvPMPcsqDgUHveU7p9rEvNLnzWGR7kUUeOm7H4qD9qngai9sQFoKS+8elHPRJXuzL7QHMvA82e9m2zWq3utcuz2zxvZVjUc+HImj1fGQ9jcw3Zdy/PIIFArvJnxQW5pcyo69Uv6JxE4kmHv5hF/KUKpWpb8de7DNxNSmakPQ3Q8uTt+TuxFEfjKSQDgPgKgyfvTl+9+ePiDctlzGv772A8HU/5iBGzQj1Q1W3Zr/dr8K3WHWyK/9NS3uFUoHWYWIUyjofo87ZD9isYLOnpcB+fJbDgGZBewXY7R09/OtU0fPy5JscDZJbAEp3EOePU1RZy6fk53y3XX/T26ftuT38mvnq1f9CXHog1o/ASVR2X4gRuaHPn86KZNUmPxmxsS/GqNWl0yXL2Eu5NdR4mLcdJlpENj9IOx+j52cUlJDDvPg2q+O0BDlf8sYKr1loTQ9Qu/Xy2BYW6rLFk2lYmDxCsOWPD6XMTp0/3wF49GI/bY6l1g3/ZqQcZttt2sjXNjr69+iJHF9iempMza5rmP9m2Fqk=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,P={},x=[];function D(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(v.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)(v.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)(d(),{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 k(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(D,{...e})}):D(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.b91649d3.js b/assets/js/52d5c0f9.b91649d3.js deleted file mode 100644 index e3f3dca90..000000000 --- a/assets/js/52d5c0f9.b91649d3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4469],{27668:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>P,default:()=>y,frontMatter:()=>b,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/deletedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletedocument","permalink":"/docs/API-docs/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu20YQ/ZXJvjQGaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMB2rxI5PLMfefMrEXA3Iv4TlyapCpJBy+mkUjJJ07aII0WsbgtCC5JUSBIOxRcvL8GVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJ1KmKRNvp7gIiERYclBXLs3VpoLIlhHeBepiISkr2zGArx2OX3zsxlSmBmnygJ1ymYbOtQMNCaE5Fw9LmSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczopT9Kmo6ylb9dZoT571nE4m/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux588i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xZ6KO+lpdhOeFTienZ8cnk+PJ97cnr+PzH+JXr0eTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvD5oTTemJJCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3fHa+zrN6ELXUSmq67+/Q/flkcn+yScL5M3dJmwCZqXT6bUM9ZP/5gM7vzzYBvdoP6FrPUcm0IaFb80D628YzNB9a8/u3Vbag5rvYCXZ43gbpKamcDKuG6ZbHaOVx+z2+mzJd8E0xW5Zs2DEUIhbjntPG6wEz1oJVunnPnZVTIhZFCNbH47FHnc7McmQsaS9zrXDmR4kpx2jleH4i6uixBFr7FWgfMJc6P35WaroN+oYL0+Z+J/RNBdDKX2kloj6zQ1Q3AwrClFxTBakz0wh3+X5nSd/IXDfVmp/sTYoPpBJTEg+FUBD08H/++ruR6NPaXKYX8K5yYM2CXFYpQJ1CpmgpZ4oODERPWCryXq1A6kC5Qx6gMpcBFXBWuPkTtDiTSvL1Y5hpJ+XgBvsRfCgoFOT403eOACGlOSm+taCMeWA9wQBWwZQ4HNIL4x4ydikChFnlpSbvwRP1IqQL1AlBX4sIjAPUQDqQs056ApQlgzPjgLJMJpIVc685TAKUqDEnNhYB+81ZsO3s9eDMrPIBvFFVEwhbLIlCG6ImSv0ILuWc2sCbDYECSkUp5BWriCAxKUHXehyGTmFGPoBl8zKhRqkP6AIompNr7l5TSZ6UYA1zgkTFC8CwtqwoONSep3a3nXSl2aTPOsMjt7GR4moEH/VHzbwNlSe+AErqBx9/1Mdwt7lmH2jmZaDpy74fFovFXh8c7cq8kaGoZuDImq1c3hw2XTMU37wciUgEcqV/l92Qm8uEuiZ8wua4AY87psSkYUoqUaq2x358LMCspWRC2tOA1y7evH8LczgbTUQ06PwvcHj89vrnq99urlgvc1PbfyejyWjCR9b4UKIemOp2zsvtUrjTuust5f9PK2pHQIGWYWwVyobIm5jXHQPficHKGg+302kkCuMDQ9brGXr6w6m65uPPFTmm+mkk5ugkzpin7tYilZ6f082q+WS0L3/vttYj+OJF92AsPcNqptc5qorfRCQeaPVo2a6nddTTLDvbIi6ShGwYyO5N3p3xdXn19ur2SkQCK07ekOEfGobvHtjAQdd2qb/1gX95Ch0UWK/b6VHXG3z76UmJLsYezXma1nX9L4AUmIY=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"}}');var c=o(74848),s=o(28453),l=o(33617),m=o.n(l),i=o(17543),r=o.n(i),d=o(86013),p=o.n(d),a=o(63723),u=o.n(a),I=(o(18766),o(79329),o(9303));const b={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:"eJy9Vttu20YQ/ZXJvjQGaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMB2rxI5PLMfefMrEXA3Iv4TlyapCpJBy+mkUjJJ07aII0WsbgtCC5JUSBIOxRcvL8GVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJ1KmKRNvp7gIiERYclBXLs3VpoLIlhHeBepiISkr2zGArx2OX3zsxlSmBmnygJ1ymYbOtQMNCaE5Fw9LmSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczopT9Kmo6ylb9dZoT571nE4m/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux588i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xZ6KO+lpdhOeFTienZ8cnk+PJ97cnr+PzH+JXr0eTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvD5oTTemJJCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3fHa+zrN6ELXUSmq67+/Q/flkcn+yScL5M3dJmwCZqXT6bUM9ZP/5gM7vzzYBvdoP6FrPUcm0IaFb80D628YzNB9a8/u3Vbag5rvYCXZ43gbpKamcDKuG6ZbHaOVx+z2+mzJd8E0xW5Zs2DEUIhbjntPG6wEz1oJVunnPnZVTIhZFCNbH47FHnc7McmQsaS9zrXDmR4kpx2jleH4i6uixBFr7FWgfMJc6P35WaroN+oYL0+Z+J/RNBdDKX2kloj6zQ1Q3AwrClFxTBakz0wh3+X5nSd/IXDfVmp/sTYoPpBJTEg+FUBD08H/++ruR6NPaXKYX8K5yYM2CXFYpQJ1CpmgpZ4oODERPWCryXq1A6kC5Qx6gMpcBFXBWuPkTtDiTSvL1Y5hpJ+XgBvsRfCgoFOT403eOACGlOSm+taCMeWA9wQBWwZQ4HNIL4x4ydikChFnlpSbvwRP1IqQL1AlBX4sIjAPUQDqQs056ApQlgzPjgLJMJpIVc685TAKUqDEnNhYB+81ZsO3s9eDMrPIBvFFVEwhbLIlCG6ImSv0ILuWc2sCbDYECSkUp5BWriCAxKUHXehyGTmFGPoBl8zKhRqkP6AIompNr7l5TSZ6UYA1zgkTFC8CwtqwoONSep3a3nXSl2aTPOsMjt7GR4moEH/VHzbwNlSe+AErqBx9/1Mdwt7lmH2jmZaDpy74fFovFXh8c7cq8kaGoZuDImq1c3hw2XTMU37wciUgEcqV/l92Qm8uEuiZ8wua4AY87psSkYUoqUaq2x358LMCspWRC2tOA1y7evH8LczgbTUQ06PwvcHj89vrnq99urlgvc1PbfyejyWjCR9b4UKIemOp2zsvtUrjTuust5f9PK2pHQIGWYWwVyobIm5jXHQPficHKGg+302kkCuMDQ9brGXr6w6m65uPPFTmm+mkk5ugkzpin7tYilZ6f082q+WS0L3/vttYj+OJF92AsPcNqptc5qorfRCQeaPVo2a6nddTTLDvbIi6ShGwYyO5N3p3xdXn19ur2SkQCK07ekOEfGobvHtjAQdd2qb/1gX95Ch0UWK/b6VHXG3z76UmJLsYezXma1nX9L4AUmIY=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},P=void 0,g={},h=[];function k(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,c.jsx)(m(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,c.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,c.jsx)(I.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,c.jsx)(r(),{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,c.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,c.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,s.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.bbcdd440.js b/assets/js/52d5c0f9.bbcdd440.js new file mode 100644 index 000000000..cc7cd6615 --- /dev/null +++ b/assets/js/52d5c0f9.bbcdd440.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4469],{27668:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>b,default:()=>M,frontMatter:()=>J,metadata:()=>n,toc:()=>B});const n=JSON.parse('{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/deletedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletedocument","permalink":"/docs/API-docs/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu20YQ/ZXJvjQBaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMG2rxI5PLMffbMrEXA3Iv4VlyYpCpJBy+mkUjJJ07aII0WsbgpCC5IUSBIOxScf7gCVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJVKmKRNvp7gIiERYclBXLs3VpoLIlhHeBOpiISkr2zGArx0OUPzsxlSmBmnykJVymYbOtQMNCaE5Fw9KWSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczIoT9Kmo6ylb9dZoT571nEwm/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux589i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xp6KO+lqdh6eFTiYnp0fHk6PJ9zfHb+KzH+LXb0aTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvDZoTRem5JCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3dHae51k9iFpqJTXd9T10dzaZ3B1vknD2RC9pEyAzlU6/baiH7D8d0Nnd6Sag1/sBXek5Kpk2JHRj7kl/23iG5kNrfr9bZQtqvoudYIfnbZCeksrJsGqYbnmEVh613+PbKdMFd4rZsmTDjqEQsRj3nDZeD5ixFqzSzXvurJwSsShCsD4ejz3qdGaWI2NJe5lrhTM/Skw5RivH82NRRw8l0NpnoKk6ep6AD5hLnT8tNd1m6Zor2RZrJ1ebkqGVv9JKRH0phqhuaBSEKbmmbFJnphHuCvTekr6WuW7KOz/eGy0fSSWmJJ4ioSDo4f/89Xcj0deh6b4X8L5yYM2CXFYpQJ1CpmgpZ4oOTFBPWCryXq1A6kC5Q564MpcBFXBWmC0StDiTSnK/Msy0o3XQ8n4EHwsKBTn+9J0jQEhpTorbHJQx96wnGMAqmBKHU31h3H3GLkWAMKu81OQ9eKJehHSBOiHoaxGBcYAaSAdy1klPgLJkcGYcUJbJRLJivpwOkwAlasyJjUXAfnMWbDusPTgzq3wAb1TVBMIWS6LQhqiJUj+CCzmnNvBmpaCAUlEKecUqIkhMStDdVQ5DpzAjH8CyeZlQo9QHdAEUzck1vddUkkcrWMMkIlHxxjCsLSsKDrXnMd+tM11pNumzzvCMbmykuBrBJ/1JM9FD5YkbQEl97+NP+ghuN232kWZeBpq+7O/DYrHYuwevdmXeylBUM3BkzVYubw6bWzMU37y8EpEI5Er/PrsmN5cJdZfwEZvjBjzuqBWThlqpRKnaO/bjQwGmOSUT0p4GRHj+9sM7mMPpaCKiwc3/CofH765+vvzt+pL1Mpm19+94NBlN+MgaH0rUA1Pdknqx3SJ3ru56OyP+p522I6BAyzC2CmXD/E3M646yb8Vgx42H6+w0EoXxgSHr9Qw9/eFUXfPxl4ocz4ZpJOboJM6Yp27XIpWen9PNbvpotC9/79bcV/DVm/HBWHqG1Uyvc1QVv4lI3NPqwXZeT+uop1l2tkWcJwnZMJDdG9U78+7i8t3lzaWIBFacvCHD3zcM3z2wgYOu7VJ/6wP/8hQ6KLBet9Ojrjf49tOjEl2MPZrzNK3r+l+YLKmx","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"}}');var l=o(74848),s=o(28453),d=o(33617),c=o.n(d),p=o(17543),i=o.n(p),r=o(86013),m=o.n(r),a=o(63723),u=o.n(a),k=(o(18766),o(79329),o(9303));const J={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMG2rxI5PLMffbMrEXA3Iv4VlyYpCpJBy+mkUjJJ07aII0WsbgpCC5IUSBIOxScf7gCVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJVKmKRNvp7gIiERYclBXLs3VpoLIlhHeBOpiISkr2zGArx0OUPzsxlSmBmnykJVymYbOtQMNCaE5Fw9KWSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczIoT9Kmo6ylb9dZoT571nEwm/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux589i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xp6KO+lqdh6eFTiYnp0fHk6PJ9zfHb+KzH+LXb0aTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvDZoTRem5JCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3dHae51k9iFpqJTXd9T10dzaZ3B1vknD2RC9pEyAzlU6/baiH7D8d0Nnd6Sag1/sBXek5Kpk2JHRj7kl/23iG5kNrfr9bZQtqvoudYIfnbZCeksrJsGqYbnmEVh613+PbKdMFd4rZsmTDjqEQsRj3nDZeD5ixFqzSzXvurJwSsShCsD4ejz3qdGaWI2NJe5lrhTM/Skw5RivH82NRRw8l0NpnoKk6ep6AD5hLnT8tNd1m6Zor2RZrJ1ebkqGVv9JKRH0phqhuaBSEKbmmbFJnphHuCvTekr6WuW7KOz/eGy0fSSWmJJ4ioSDo4f/89Xcj0deh6b4X8L5yYM2CXFYpQJ1CpmgpZ4oOTFBPWCryXq1A6kC5Q564MpcBFXBWmC0StDiTSnK/Msy0o3XQ8n4EHwsKBTn+9J0jQEhpTorbHJQx96wnGMAqmBKHU31h3H3GLkWAMKu81OQ9eKJehHSBOiHoaxGBcYAaSAdy1klPgLJkcGYcUJbJRLJivpwOkwAlasyJjUXAfnMWbDusPTgzq3wAb1TVBMIWS6LQhqiJUj+CCzmnNvBmpaCAUlEKecUqIkhMStDdVQ5DpzAjH8CyeZlQo9QHdAEUzck1vddUkkcrWMMkIlHxxjCsLSsKDrXnMd+tM11pNumzzvCMbmykuBrBJ/1JM9FD5YkbQEl97+NP+ghuN232kWZeBpq+7O/DYrHYuwevdmXeylBUM3BkzVYubw6bWzMU37y8EpEI5Er/PrsmN5cJdZfwEZvjBjzuqBWThlqpRKnaO/bjQwGmOSUT0p4GRHj+9sM7mMPpaCKiwc3/CofH765+vvzt+pL1Mpm19+94NBlN+MgaH0rUA1Pdknqx3SJ3ru56OyP+p522I6BAyzC2CmXD/E3M646yb8Vgx42H6+w0EoXxgSHr9Qw9/eFUXfPxl4ocz4ZpJOboJM6Yp27XIpWen9PNbvpotC9/79bcV/DVm/HBWHqG1Uyvc1QVv4lI3NPqwXZeT+uop1l2tkWcJwnZMJDdG9U78+7i8t3lzaWIBFacvCHD3zcM3z2wgYOu7VJ/6wP/8hQ6KLBet9Ojrjf49tOjEl2MPZrzNK3r+l+YLKmx",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,h={},B=[];function y(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,l.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(k.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(i(),{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,l.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,l.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 M(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.7898036f.js b/assets/js/5a2de241.7898036f.js deleted file mode 100644 index f9f1db3fa..000000000 --- a/assets/js/5a2de241.7898036f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2223],{85651:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>f,metadata:()=>i,toc:()=>h});const i=JSON.parse('{"id":"API-docs/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","source":"@site/docs/API-docs/update-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/update-template","permalink":"/docs/API-docs/update-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar_label":"Update Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzFWNtuIzcS/ZUKX3YCtC72OAlWTztJBomxwdoYazDAzhgG1ayWGLNJhsWWLAj9tl+yn7ZfsiiyW2pbGmdmc9kXQ2ZXFU9dWHXInYhySWL2Xsyx9kZGJHFbCIVUBu2jdlbMxHyF8NYrGRF6KXh1fQlo5cIgwdY1EB3UTulqC9IqaLJ0XCEojFIbAleBBPJY6kqXEDs7Y1EI5zFI3upSiZnIqv0+ohBeBlljxMAwd8LKGsVM9AbutBKF0AzTy7gST7Fffs87M5BeA+JKRrCIihj1Aju0bCfgL40OqMQshgYLQXFreDfStTcMBh+8cQrFrJKGWKBcYS3FbCfi1ifJGLRdikJULtQyHlba9jbbR4rfOrVlncdQr4Nba4WwQOM2sHebQfbx7HMEL2QEg5IiOIsD2d6BL0UhSmcj2sgbSe+NLlOQJz8T77Y7hu4WP2MZOeKBUxI1En/NAf91Bzk4MoVpJij92OMVbSGsi59t5ppdRAi41rhJhUV6aSGuNIFyZVOze+2TlH/eFvuqGNpoWccoDFyRx/YO2iyZT8HV/HogunDOoLRH1chVBaPsgEuLsNHGdCcJrubXsMbAJyTlagxvCQNlmYAl6jWCfCQCpVMIay0Ba6lNAZuVLldc8FuoG4qAtquhLnS4j9wYUhHDCI4BKU0nERUgjXEbbZfQJGinDIPSActotrDRceWaCFIpzerSAEX0NB5GMaHYB3LumvDbIylh2WiFCqJrAlQuJJQYqACfjhl7oC3F0JSsTKAazm7yg0X5tw+uRKJDnPqosNDAfgFoKatLqCRFDAU0VnPkQ+Mjqr1JfPAYNNoST4YgBfcuNdIu4PTpsbjGUOtIvaecGqkUoEFOCgE15Qpk/i5jE5AK0FZHLQ0VQFHWngpwASI+cF+B6Dw3T3zQFBn8RqslRgL9sTp6g3xGygGGKrg6ZZ9jY7fDQtjjiu6JuTknVVM3PirZmAhraZpTMWsLEXV8dJTvBrPhbsGttm1ZLiB5Zyl3tfPp9LgD76dbNxE4ZFwBVWPM9ovfr6Xm5V9rLpLU+Y90ffGj5zbTQXoVn1c6n56/HJ1NR9Nv5mdfzy7+Ovvq6/F0Ov2nKMRDbQ79XKiuL/fRy/8PFrQ12uJdH7W78+n07mUXyotT0eu6te/G2FoaraDSaBTwnvQ7BhBDcOF/nCbP4HvOfXa5d/7imdKxLkLlGqv+3+6eQvS8gxd33+xd/OrYxUubQ8bUb+7u0f4ZHh78GW4f8/YM9XFV6yyUvotHzg7Xs5OEZRN03CZa+TCSXo/y99n7WyZrNcaVY0rqmwSY6eVMTPruMtkN+kwr2F5Y9yy1CUbMxCpGT7PJhKRVC/cwdh4td0YjFzQuXT2RXk/WZ6ItnmpI7z9DmqJcarscPat1e/D4hrOSA//I7334pdd/x60o+rAOpTq2vUKpMKQUcLLfHJjt6z5l+6w8pYM9G/w0gnc07k5RtiFjE+IRK+uo+pBedEsnx20/i7WtXApJV0JXHu0No+MCXJ8dwXqHpnQ19uOsF//Pv/6dNHp30jZfwFUTwLsNhqoxyfHK4INmcsHCCdj+YkUoa4NEZgvMKZYhOa+XOjKf6phFKb1caKP5RLGYY+0Ag0NJY3i3wrjCwJ/+EpglKVyj4YMIxrn7RIAcyCa6Ou3RE7qNC/cVQypAwqIhbZEICLFXQbuStkToKyzxCGkz+/RBE4LUNQszF8Oq0qVmw9w+giwj1NLKZSIEBTBujkLXqQmCWzCVJWeaTNb4tokYs4vpKjeG75kcJ8d5MV87UWWeRkXmyV03YTesggVSBM/b6xIzlY0y8MVqjSGdqJRJnv7gHbc5LQ0zomFu2VAM0hL34gyoT80+fB2RTHsouR3DB/vB3nCxNIRcAEbbe5p9sCN4vy+zd7ggHfH2RX/KN5vN0en+8rHODzqumgUE9O6gt0yLqRcM1ff/8F0xYqjpqrrBsNYldq3lI3tOkvCka/6yTM0/3T5y5/jbUwVuxEaXaGnYFF79cP0TrOHleCqKQT/7BMCTny6/e/2Pm9dslztuPn9n4+l4ykveUaylHWz15PHi6dHdHabYH/3W0fVXZtgTb6ROQyo5v+sGzHsxaJOz4TPHbSFWjiKL7HYLSfg2mLbl5V8aDDzGbguxlkEz0jSFuvuK2je8j7r94k3/cACf92Jy0qF+ilgeIYm556Z8j9snTzftbVv0o4QRZ4nvMq7RnO0cLBwRDJ6EWeNVWaKPz8oOJ/r127koxKJ7hqnTi44IcsNPQHKTweZbZRqSaW0njLTLRi5ZNpvk4Scbztpwct6nydn9YKdOhuPxSM1e8F/26aTCbpenctvu5fOnj2p0ce2lOTe3bdv+FzoFAz4=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/delete-template"}}');var n=a(74848),s=a(28453),o=a(33617),p=a.n(o),l=a(17543),d=a.n(l),r=a(86013),c=a.n(r),u=a(63723),m=a.n(u),b=(a(18766),a(79329),a(9303));const f={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWNtuIzcS/ZUKX3YCtC72OAlWTztJBomxwdoYazDAzhgG1ayWGLNJhsWWLAj9tl+yn7ZfsiiyW2pbGmdmc9kXQ2ZXFU9dWHXInYhySWL2Xsyx9kZGJHFbCIVUBu2jdlbMxHyF8NYrGRF6KXh1fQlo5cIgwdY1EB3UTulqC9IqaLJ0XCEojFIbAleBBPJY6kqXEDs7Y1EI5zFI3upSiZnIqv0+ohBeBlljxMAwd8LKGsVM9AbutBKF0AzTy7gST7Fffs87M5BeA+JKRrCIihj1Aju0bCfgL40OqMQshgYLQXFreDfStTcMBh+8cQrFrJKGWKBcYS3FbCfi1ifJGLRdikJULtQyHlba9jbbR4rfOrVlncdQr4Nba4WwQOM2sHebQfbx7HMEL2QEg5IiOIsD2d6BL0UhSmcj2sgbSe+NLlOQJz8T77Y7hu4WP2MZOeKBUxI1En/NAf91Bzk4MoVpJij92OMVbSGsi59t5ppdRAi41rhJhUV6aSGuNIFyZVOze+2TlH/eFvuqGNpoWccoDFyRx/YO2iyZT8HV/HogunDOoLRH1chVBaPsgEuLsNHGdCcJrubXsMbAJyTlagxvCQNlmYAl6jWCfCQCpVMIay0Ba6lNAZuVLldc8FuoG4qAtquhLnS4j9wYUhHDCI4BKU0nERUgjXEbbZfQJGinDIPSActotrDRceWaCFIpzerSAEX0NB5GMaHYB3LumvDbIylh2WiFCqJrAlQuJJQYqACfjhl7oC3F0JSsTKAazm7yg0X5tw+uRKJDnPqosNDAfgFoKatLqCRFDAU0VnPkQ+Mjqr1JfPAYNNoST4YgBfcuNdIu4PTpsbjGUOtIvaecGqkUoEFOCgE15Qpk/i5jE5AK0FZHLQ0VQFHWngpwASI+cF+B6Dw3T3zQFBn8RqslRgL9sTp6g3xGygGGKrg6ZZ9jY7fDQtjjiu6JuTknVVM3PirZmAhraZpTMWsLEXV8dJTvBrPhbsGttm1ZLiB5Zyl3tfPp9LgD76dbNxE4ZFwBVWPM9ovfr6Xm5V9rLpLU+Y90ffGj5zbTQXoVn1c6n56/HJ1NR9Nv5mdfzy7+Ovvq6/F0Ov2nKMRDbQ79XKiuL/fRy/8PFrQ12uJdH7W78+n07mUXyotT0eu6te/G2FoaraDSaBTwnvQ7BhBDcOF/nCbP4HvOfXa5d/7imdKxLkLlGqv+3+6eQvS8gxd33+xd/OrYxUubQ8bUb+7u0f4ZHh78GW4f8/YM9XFV6yyUvotHzg7Xs5OEZRN03CZa+TCSXo/y99n7WyZrNcaVY0rqmwSY6eVMTPruMtkN+kwr2F5Y9yy1CUbMxCpGT7PJhKRVC/cwdh4td0YjFzQuXT2RXk/WZ6ItnmpI7z9DmqJcarscPat1e/D4hrOSA//I7334pdd/x60o+rAOpTq2vUKpMKQUcLLfHJjt6z5l+6w8pYM9G/w0gnc07k5RtiFjE+IRK+uo+pBedEsnx20/i7WtXApJV0JXHu0No+MCXJ8dwXqHpnQ19uOsF//Pv/6dNHp30jZfwFUTwLsNhqoxyfHK4INmcsHCCdj+YkUoa4NEZgvMKZYhOa+XOjKf6phFKb1caKP5RLGYY+0Ag0NJY3i3wrjCwJ/+EpglKVyj4YMIxrn7RIAcyCa6Ou3RE7qNC/cVQypAwqIhbZEICLFXQbuStkToKyzxCGkz+/RBE4LUNQszF8Oq0qVmw9w+giwj1NLKZSIEBTBujkLXqQmCWzCVJWeaTNb4tokYs4vpKjeG75kcJ8d5MV87UWWeRkXmyV03YTesggVSBM/b6xIzlY0y8MVqjSGdqJRJnv7gHbc5LQ0zomFu2VAM0hL34gyoT80+fB2RTHsouR3DB/vB3nCxNIRcAEbbe5p9sCN4vy+zd7ggHfH2RX/KN5vN0en+8rHODzqumgUE9O6gt0yLqRcM1ff/8F0xYqjpqrrBsNYldq3lI3tOkvCka/6yTM0/3T5y5/jbUwVuxEaXaGnYFF79cP0TrOHleCqKQT/7BMCTny6/e/2Pm9dslztuPn9n4+l4ykveUaylHWz15PHi6dHdHabYH/3W0fVXZtgTb6ROQyo5v+sGzHsxaJOz4TPHbSFWjiKL7HYLSfg2mLbl5V8aDDzGbguxlkEz0jSFuvuK2je8j7r94k3/cACf92Jy0qF+ilgeIYm556Z8j9snTzftbVv0o4QRZ4nvMq7RnO0cLBwRDJ6EWeNVWaKPz8oOJ/r127koxKJ7hqnTi44IcsNPQHKTweZbZRqSaW0njLTLRi5ZNpvk4Scbztpwct6nydn9YKdOhuPxSM1e8F/26aTCbpenctvu5fOnj2p0ce2lOTe3bdv+FzoFAz4=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},h=[];function T(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"template_template_id_body"}}}}}),"\n",(0,n.jsx)(m(),{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 j(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(T,{...e})}):T(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.a0e6338f.js b/assets/js/5a2de241.a0e6338f.js new file mode 100644 index 000000000..7701bfb00 --- /dev/null +++ b/assets/js/5a2de241.a0e6338f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2223],{85651:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>b,contentTitle:()=>v,default:()=>g,frontMatter:()=>f,metadata:()=>i,toc:()=>T});const i=JSON.parse('{"id":"API-docs/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","source":"@site/docs/API-docs/update-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/update-template","permalink":"/docs/API-docs/update-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar_label":"Update Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzFWG1vI7cR/isTfukFWL3Y5ySoPvWaHBKjQW2cdTigd4ZBLWclxlyS4XAlC8J+6y/pT+svKYbcldaWzjm3afvFkLkzw2deOPOQOxHlksTso5hj7Y2MSOK2EAqpDNpH7ayYifkK4b1XMiL0UvDm+hLQyoVBgq1rIDqondLVFqRV0GTpuEJQGKU2BK4CCeSx1JUuIXZ2xqIQzmOQvNWlEjORVft9RCG8DLLGiIFh7oSVNYqZ6A3caSUKoRmml3ElnmK//IF3ZiC9BsSVjGARFTHqBXZo2U7AXxsdUIlZDA0WguLW8G6ka28YDD544xSKWSUNsUC5wlqK2U7ErU+SMWi7FIWoXKhlPKy07W22jxT/7NSWdR5DvQ5urRXCAo3bwN5tBtnHs88RvJIRDEqK4CwOZHsHvhaFKJ2NaCNvJL03ukxBnvxCvNvuGLpb/IJl5IgHTknUSPw1B/y3HeTgyBSmmaD0Y49XtIWwLr7YzDW7iBBwrXGTCov00kJcaQLlyqZm99onKX/ZFvuqGNpoWccoDFyRx/YO2iyZT8HV/HogunDOoLRH1chVBaPsgEuLsNHGdCcJrubXsMbAJyTlagzvCQNlmYAl6jWCfCQCpVMIay0Ba6lNAZuVLldc8FuoG4qAtquhLnS4j9wYUhHDCI4BKU0nERUgjXEbbZfQJGinDIPSActotrDRceWaCFIpzerSAEX0NB5GMaHYB3LumvCfR1LCstEKFUTXBKhcSCgxUAE+HTP2QFuKoSlZmUA1nN3kB4vybx9ciUSHOPVRYaGB/QLQUlaXUEmKGAporObIh8ZHVHuT+OAxaLQlngxBCu5daqRdwOnLY3GNodaRek85NVIpQIOcFAJqyhXI/F3GJiAVoK2OWhoqgKKsPRXgAkR84L4C0XlunvigKTL4jVZLjAT6c3X0DvmMlAMMVXB1yj7Hxm6HhbDHFd0Tc3NOqqZufFSyMRHW0jSnYtYWIur46CjfDWbD3YJbbduyXEDyzlLuaufT6XEH3k+3biJwyLgCqsaY7Ve/X0vNy7/VXCSp85/o+uInz22mg/QmPq90Pj1/PTqbjqbfzc++nV38cfbNt+PpdPo3UYiH2hz6uVBdX+6jl/8fLGhrtMW7Pmp359Pp3esulBenotd1a9+NsbU0WkGl0SjgPel3DCCG4MK/OU2ewfec++xy7/zFM6VjXYTKNVb9v909heh5By/uvtu7+M2xi5c2h4yp39zdo/1feHjwZ7h9zNsz1MdVrbNQ+i4eOTtcz04Slk3QcZto5cNIej3K32cfb5ms1RhXjimpbxJgppczMem7y2Q36DOtYHth3bPUJhgxE6sYPc0mE5JWLdzD2Hm03BmNXNC4dPVEej1Zn4m2eKohvX+BNDajlylQlEttl89r3R5CdMNpzJl6FKh9vqTXf8GtKPo8DKU6er5CqTCknHF1vDtQ4bd9jvdpfMofe/r4ZYzwaD6e4nhDiifEIxrXcfshH+mWTs7nfnhrW7kUkq7mrjzaG0bHFbs+O4L1AU3pauznXy/+z7//I2n07qRtvoKrJoB3GwxVY5LjlcEHzWyEhROw/U2MUNYGicwWmIQsQ3JeL3VkAtZRkVJ6udBG8xFkMcfaAQanmMbwYYVxhYE//SEwrVK4RsMnF4xz94kxOZBNdHXao2eAGxfuK4ZUgIRFQ9oiERBir4J2JW2J0FdYIh7SZrrqgyYEqWsWZvKGVaVLzYa53wRZRqillcvEIApg3ByFrrUTBLdg7kvONJnd8fUUMWYX091vDD8wm06O82K+p6LKxI6KTKy79sNuWAULpAiet9clZu4bZeCb2BpDOlEpk0wXwDvui1oaplDD3LKhGKQlbt4ZUJ+affg65pn2UHI7hk/2k73hYmkIuQCMtvc0+2RH8HFfZh9wQTri7av+lG82m6PT/fVjnR91XDULCOjdQW+ZFlMvGKrv/+HLZcRQ01V1g2GtS+xay2f2nCThSTctZJmmRbqu5M7xp6cK3LmNLtHSsCm8+fH6Z1jD6/FUFIN+9gWAJz9ffv/2rzdv2S636Hz+zsbT8ZSXvKNYSzvY6slrx9OjuzuMvf/240jXX5mST7yROk215Pyum0gfxaBNzobvIreFWDmKLLLbLSTh+2Dalpd/bTDw3LstxFoGzUjT2OouOGrf8D7r9qt3/UsDvOyJ5aRD/RSxPEIS1c9N+R63T9562tu26EcJI84S32dcoznbOVg4YiQ8CbPGm7JEH5+VHVKA6/dzUYhF925TpycgEeSG34zkJoPN19A0JNPaThhpl41csmw2ycNPNpy14eS8T5Oz+8FOnQzH45GaveC/7NNJhd0uT+W23cvnT5/V6OLaS3Nubtu2/RcMrxRp","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/delete-template"}}');var n=a(74848),s=a(28453),o=a(33617),l=a.n(o),p=a(17543),d=a.n(p),r=a(86013),c=a.n(r),m=a(63723),u=a.n(m),h=(a(18766),a(79329),a(9303));const f={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vI7cR/isTfukFWL3Y5ySoPvWaHBKjQW2cdTigd4ZBLWclxlyS4XAlC8J+6y/pT+svKYbcldaWzjm3afvFkLkzw2deOPOQOxHlksTso5hj7Y2MSOK2EAqpDNpH7ayYifkK4b1XMiL0UvDm+hLQyoVBgq1rIDqondLVFqRV0GTpuEJQGKU2BK4CCeSx1JUuIXZ2xqIQzmOQvNWlEjORVft9RCG8DLLGiIFh7oSVNYqZ6A3caSUKoRmml3ElnmK//IF3ZiC9BsSVjGARFTHqBXZo2U7AXxsdUIlZDA0WguLW8G6ka28YDD544xSKWSUNsUC5wlqK2U7ErU+SMWi7FIWoXKhlPKy07W22jxT/7NSWdR5DvQ5urRXCAo3bwN5tBtnHs88RvJIRDEqK4CwOZHsHvhaFKJ2NaCNvJL03ukxBnvxCvNvuGLpb/IJl5IgHTknUSPw1B/y3HeTgyBSmmaD0Y49XtIWwLr7YzDW7iBBwrXGTCov00kJcaQLlyqZm99onKX/ZFvuqGNpoWccoDFyRx/YO2iyZT8HV/HogunDOoLRH1chVBaPsgEuLsNHGdCcJrubXsMbAJyTlagzvCQNlmYAl6jWCfCQCpVMIay0Ba6lNAZuVLldc8FuoG4qAtquhLnS4j9wYUhHDCI4BKU0nERUgjXEbbZfQJGinDIPSActotrDRceWaCFIpzerSAEX0NB5GMaHYB3LumvCfR1LCstEKFUTXBKhcSCgxUAE+HTP2QFuKoSlZmUA1nN3kB4vybx9ciUSHOPVRYaGB/QLQUlaXUEmKGAporObIh8ZHVHuT+OAxaLQlngxBCu5daqRdwOnLY3GNodaRek85NVIpQIOcFAJqyhXI/F3GJiAVoK2OWhoqgKKsPRXgAkR84L4C0XlunvigKTL4jVZLjAT6c3X0DvmMlAMMVXB1yj7Hxm6HhbDHFd0Tc3NOqqZufFSyMRHW0jSnYtYWIur46CjfDWbD3YJbbduyXEDyzlLuaufT6XEH3k+3biJwyLgCqsaY7Ve/X0vNy7/VXCSp85/o+uInz22mg/QmPq90Pj1/PTqbjqbfzc++nV38cfbNt+PpdPo3UYiH2hz6uVBdX+6jl/8fLGhrtMW7Pmp359Pp3esulBenotd1a9+NsbU0WkGl0SjgPel3DCCG4MK/OU2ewfec++xy7/zFM6VjXYTKNVb9v909heh5By/uvtu7+M2xi5c2h4yp39zdo/1feHjwZ7h9zNsz1MdVrbNQ+i4eOTtcz04Slk3QcZto5cNIej3K32cfb5ms1RhXjimpbxJgppczMem7y2Q36DOtYHth3bPUJhgxE6sYPc0mE5JWLdzD2Hm03BmNXNC4dPVEej1Zn4m2eKohvX+BNDajlylQlEttl89r3R5CdMNpzJl6FKh9vqTXf8GtKPo8DKU6er5CqTCknHF1vDtQ4bd9jvdpfMofe/r4ZYzwaD6e4nhDiifEIxrXcfshH+mWTs7nfnhrW7kUkq7mrjzaG0bHFbs+O4L1AU3pauznXy/+z7//I2n07qRtvoKrJoB3GwxVY5LjlcEHzWyEhROw/U2MUNYGicwWmIQsQ3JeL3VkAtZRkVJ6udBG8xFkMcfaAQanmMbwYYVxhYE//SEwrVK4RsMnF4xz94kxOZBNdHXao2eAGxfuK4ZUgIRFQ9oiERBir4J2JW2J0FdYIh7SZrrqgyYEqWsWZvKGVaVLzYa53wRZRqillcvEIApg3ByFrrUTBLdg7kvONJnd8fUUMWYX091vDD8wm06O82K+p6LKxI6KTKy79sNuWAULpAiet9clZu4bZeCb2BpDOlEpk0wXwDvui1oaplDD3LKhGKQlbt4ZUJ+affg65pn2UHI7hk/2k73hYmkIuQCMtvc0+2RH8HFfZh9wQTri7av+lG82m6PT/fVjnR91XDULCOjdQW+ZFlMvGKrv/+HLZcRQ01V1g2GtS+xay2f2nCThSTctZJmmRbqu5M7xp6cK3LmNLtHSsCm8+fH6Z1jD6/FUFIN+9gWAJz9ffv/2rzdv2S636Hz+zsbT8ZSXvKNYSzvY6slrx9OjuzuMvf/240jXX5mST7yROk215Pyum0gfxaBNzobvIreFWDmKLLLbLSTh+2Dalpd/bTDw3LstxFoGzUjT2OouOGrf8D7r9qt3/UsDvOyJ5aRD/RSxPEIS1c9N+R63T9562tu26EcJI84S32dcoznbOVg4YiQ8CbPGm7JEH5+VHVKA6/dzUYhF925TpycgEeSG34zkJoPN19A0JNPaThhpl41csmw2ycNPNpy14eS8T5Oz+8FOnQzH45GaveC/7NNJhd0uT+W23cvnT5/V6OLaS3Nubtu2/RcMrxRp",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},v=void 0,b={},T=[];function y(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(l(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"template_template_id_body"}}}}}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Template not found!"}},title:"inline_response_404_7"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,s.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/5c04ee3b.08676753.js b/assets/js/5c04ee3b.08676753.js deleted file mode 100644 index f0973bf29..000000000 --- a/assets/js/5c04ee3b.08676753.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6382],{45016:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>w,contentTitle:()=>u,default:()=>g,frontMatter:()=>j,metadata:()=>s,toc:()=>W});const s=JSON.parse('{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/get-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-webhook","permalink":"/docs/API-docs/get-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar_label":"Get Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu4zYQ/ZVZvrQLyJdstyjgp120QRB00V3AWeTBMYKRNJK4pkiWpHyBobd+ST+tX1IMJTmy0w3aouiL7QznzMwZzhzmKAKWXixW4p7SypiNWCciJ585aYM0WizEXUVwQwF6B3j/6RZQKbODg2kgGCgpwK4/bJwSiTCWHDL8NhcLUVIYgifCkbdGe/JicRRv5nP+Os+3bLKMvC8aBac4IhGZ0YF0YH+0VsksHsy+eAYdhc8qqpF/hYMlsRAm/UJZEImwjsME2aXsCx05+uCkLkUiaI+1VWyqQrB+MZsdTOMmPWLSOPWud5lmphZtm4ggQwRIraSmx4Hc45v5/PEH0bbs83b+9jnJz54caBOgMI3OX/13/Mg5415md5n7JSJc/EDj++c0bvUWlczjTNyZDen/l8k4fejSc6n7WjFOY91Rik7xXJxRHds7kp6yxslwEIvVUewnaOWkO1+s1u06ETWFyvQzzQVjqMRCzHan8fbktuR8xPMuPM2SR52nZj81lrSXpVaYep6jGVo5216JNrlEoLX/wNsHLKUuJy+i1k8Ul3wNXafPiJ76jVb+TAeRDH0ceyVC8vVXhDm52HOpCxPBfXc/WtJLWep4N9srcakq96QyUxPrR6gIBvc/fvs9InKTNTXpEEfnFXxsHFizI8eqgDqHQtFepoqe1MgPcuQJa0XeqwNIHah0GAhyWcqACrgrUpeQocVUKsnDxm6G0Q5G8+qncF9RqMjx0TeOACGnLSmeUVDGbDhOMIBNMHXM0dcMO+M2BZeUAELaeKnJe/BEA4R0hTojGO4iAeMANZAO5KyTngBlzc6FcUBFITPJgXmzHGYBatRYEidLgOvmLlhntjInD86kjQ/gjWoiEc5YE4WOoibK/RR+klvqiLMxp4BSUQ5lwyESyExO0C8a09A5pOQDWE4vM4pBfUAXQNGWXJy9eJNFoxRYwwogUYEpzu6WAwWH2hfG1V1Bw9Wc2med4Qcg5sjxMIUH/aCXPCyNJx4AJfXGLx70BFanMbun1MtA62+Hfdjtds/24PU55kaGqknBkTVPuDIa49aM4ac/XotEBHK1/1gsyW1lNjwYX8k5i86zXhcxi7pINUrV7di7SwBrlJIZaU8jFXt/8+kDbOG76Vwko83/GwXPPtz+eP3L8prjsjZ1+3c1nU/nbLLGhxr1KNXosb9c2+OTuP+b/wt6ZQm0DzOrUEY9jmSOvZauTg/0OhGV8YFNx2OKnj471bZs/rUhxwq9TsQWncSUBWe1bpNBj1h8N3TgrmUZWVbqLaqmE7WLB+lM1W+u70QisOFKxjq4iTrY/+Dow5E+jGKfC2RXAH+yVv8l4HjsNLZtT/7d0VcRPcHBmxu4btv2T7y+bYs=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/save-update-webhook"}}');var n=t(74848),i=t(28453),a=t(33617),c=t.n(a),p=t(17543),l=t.n(p),r=t(86013),d=t.n(r),b=t(63723),h=t.n(b),k=(t(18766),t(79329),t(9303));const j={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:"eJy9Vttu4zYQ/ZVZvrQLyJdstyjgp120QRB00V3AWeTBMYKRNJK4pkiWpHyBobd+ST+tX1IMJTmy0w3aouiL7QznzMwZzhzmKAKWXixW4p7SypiNWCciJ585aYM0WizEXUVwQwF6B3j/6RZQKbODg2kgGCgpwK4/bJwSiTCWHDL8NhcLUVIYgifCkbdGe/JicRRv5nP+Os+3bLKMvC8aBac4IhGZ0YF0YH+0VsksHsy+eAYdhc8qqpF/hYMlsRAm/UJZEImwjsME2aXsCx05+uCkLkUiaI+1VWyqQrB+MZsdTOMmPWLSOPWud5lmphZtm4ggQwRIraSmx4Hc45v5/PEH0bbs83b+9jnJz54caBOgMI3OX/13/Mg5415md5n7JSJc/EDj++c0bvUWlczjTNyZDen/l8k4fejSc6n7WjFOY91Rik7xXJxRHds7kp6yxslwEIvVUewnaOWkO1+s1u06ETWFyvQzzQVjqMRCzHan8fbktuR8xPMuPM2SR52nZj81lrSXpVaYep6jGVo5216JNrlEoLX/wNsHLKUuJy+i1k8Ul3wNXafPiJ76jVb+TAeRDH0ceyVC8vVXhDm52HOpCxPBfXc/WtJLWep4N9srcakq96QyUxPrR6gIBvc/fvs9InKTNTXpEEfnFXxsHFizI8eqgDqHQtFepoqe1MgPcuQJa0XeqwNIHah0GAhyWcqACrgrUpeQocVUKsnDxm6G0Q5G8+qncF9RqMjx0TeOACGnLSmeUVDGbDhOMIBNMHXM0dcMO+M2BZeUAELaeKnJe/BEA4R0hTojGO4iAeMANZAO5KyTngBlzc6FcUBFITPJgXmzHGYBatRYEidLgOvmLlhntjInD86kjQ/gjWoiEc5YE4WOoibK/RR+klvqiLMxp4BSUQ5lwyESyExO0C8a09A5pOQDWE4vM4pBfUAXQNGWXJy9eJNFoxRYwwogUYEpzu6WAwWH2hfG1V1Bw9Wc2med4Qcg5sjxMIUH/aCXPCyNJx4AJfXGLx70BFanMbun1MtA62+Hfdjtds/24PU55kaGqknBkTVPuDIa49aM4ac/XotEBHK1/1gsyW1lNjwYX8k5i86zXhcxi7pINUrV7di7SwBrlJIZaU8jFXt/8+kDbOG76Vwko83/GwXPPtz+eP3L8prjsjZ1+3c1nU/nbLLGhxr1KNXosb9c2+OTuP+b/wt6ZQm0DzOrUEY9jmSOvZauTg/0OhGV8YFNx2OKnj471bZs/rUhxwq9TsQWncSUBWe1bpNBj1h8N3TgrmUZWVbqLaqmE7WLB+lM1W+u70QisOFKxjq4iTrY/+Dow5E+jGKfC2RXAH+yVv8l4HjsNLZtT/7d0VcRPcHBmxu4btv2T7y+bYs=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,w={},W=[];function m(e){const o={p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,n.jsx)(c(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,n.jsx)(l(),{parameters:void 0}),"\n",(0,n.jsx)(d(),{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:{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 g(e={}){const{wrapper:o}={...(0,i.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(m,{...e})}):m(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.7a2cdde0.js b/assets/js/5c04ee3b.7a2cdde0.js new file mode 100644 index 000000000..c087fdb26 --- /dev/null +++ b/assets/js/5c04ee3b.7a2cdde0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6382],{45016:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>v,contentTitle:()=>k,default:()=>M,frontMatter:()=>b,metadata:()=>i,toc:()=>P});const i=JSON.parse('{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","source":"@site/docs/API-docs/get-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/get-webhook","permalink":"/docs/API-docs/get-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar_label":"Get Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu3DYQ/ZUJX9oA2ovTFAX2KUFrGEaDOoAd+GG9MEbSSGKWIlmS2gsWesuX9NP6JcVQ0lq7boymKPpi75JzZubM5XAPImDpxWIp7imtjFmLVSJy8pmTNkijxULcVQRXFKA3gPcfrwGVMlvYmwaCgZICbPvLximRCGPJIcOvc7EQJYXBeSIceWu0Jy8WB/FmPud/p/Fumywj74tGwdGPSERmdCAd2B6tVTKLF7PPnkEH4bOKauRPYW9JLIRJP1MWRCKsYzdBdiH7REeGPjipS5EI2mFtFR9VIVi/mM32pnGTHjFpnHrXm0wzU4u2TUSQIQKkVlLT40Du8c18/viTaFu2eTt/+5zkJ08OtAlQmEbnr/47fuSccS+zO4/9EhFOfqDx43Ma13qDSuZxJu7MmvT/y2QcPnThOdVdrRinse4oRaN4L06ojs87kp6yxsmwF4vlQewmaOWku18sV+0qETWFyvQzzQljqMRCzLbH8fbkNuR8xPMuPM2SR52nZjc1lrSXpVaYep6jGVo521yINjlHoLXfYE3N5NsAPmApdfkyavVUk1vuW9eak8ocG4RW/kp7kQyFH1slQvK8VIQ5udgkqQsTwX07bizpW1nq2MzNhTiXoXtSmamJBSdUBIP5n1/+iIjcZE1NOsRZewU3jQNrtuRYRlDnUCjayVTRk3z5Qb88Ya3Ie7UHqQOVDgNBLksZUAFXReoSMrSYSiV5OtnMMNrBaMD9FO4rChU5vvrOESDktCHFQw3KmDX7CQawCaaOMfqcYWvcuuCUEkBIGy81eQ+eaICQrlBnBEMvEjAOUAPpQM466QlQ1mxcGAdUFDKT7JhX0WEWoEaNJXGwBDhvroJ1ZiNz8uBM2vgA3qgmEuGINVHoKGqi3E/hF7mhjjgf5hRQKsqhbNhFApnJCfrNZBo6h5R8AMvhZUbRqQ/oAijakIuzFztZNEqBNSwZEhWY4qS37Cg41L4wru4SGlpzLJ91hl+MGCPH/RQe9IO+5WFpPPEAKKnXfvGgJ7A8jtk9pV4GWn0/7MN2u322B69PMVcyVE0Kjqx5wpXxMG7NGH788lokIpCr/U1xS24js+GF+UrMWTSe9UKKWRRSqlGqbsfenQNY1JTMSHsayd77q48fYAM/TOciGW3+P0h49uH658vfbi/ZL4tZt38X0/l0zkfW+FCjHoUa/To4X9vD02vwb35I9MoSaBdmVqGMAh7JHHrxXR5f9FUiKuMDHx0OKXr65FTb8vHvDTmW9FUiNugkpiw4y1WbDHrEar2mPVcty8iytG9QNZ2onb1gJ8/A1eWdSAQ2nMlYB9dRB/sP7H240vuR71OB7BLgv6zVfws4HDqNbdujfXf1VURPcLDmAq7atv0Ltvx+tg==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template list","permalink":"/docs/API-docs/gettemplatelist"},"next":{"title":"Save or Update Webhook","permalink":"/docs/API-docs/save-update-webhook"}}');var n=t(74848),s=t(28453),a=t(33617),r=t.n(a),l=t(17543),p=t.n(l),c=t(86013),d=t.n(c),u=t(63723),m=t.n(u),h=(t(18766),t(79329),t(9303));const b={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu3DYQ/ZUJX9oA2ovTFAX2KUFrGEaDOoAd+GG9MEbSSGKWIlmS2gsWesuX9NP6JcVQ0lq7boymKPpi75JzZubM5XAPImDpxWIp7imtjFmLVSJy8pmTNkijxULcVQRXFKA3gPcfrwGVMlvYmwaCgZICbPvLximRCGPJIcOvc7EQJYXBeSIceWu0Jy8WB/FmPud/p/Fumywj74tGwdGPSERmdCAd2B6tVTKLF7PPnkEH4bOKauRPYW9JLIRJP1MWRCKsYzdBdiH7REeGPjipS5EI2mFtFR9VIVi/mM32pnGTHjFpnHrXm0wzU4u2TUSQIQKkVlLT40Du8c18/viTaFu2eTt/+5zkJ08OtAlQmEbnr/47fuSccS+zO4/9EhFOfqDx43Ma13qDSuZxJu7MmvT/y2QcPnThOdVdrRinse4oRaN4L06ojs87kp6yxsmwF4vlQewmaOWku18sV+0qETWFyvQzzQljqMRCzLbH8fbkNuR8xPMuPM2SR52nZjc1lrSXpVaYep6jGVo521yINjlHoLXfYE3N5NsAPmApdfkyavVUk1vuW9eak8ocG4RW/kp7kQyFH1slQvK8VIQ5udgkqQsTwX07bizpW1nq2MzNhTiXoXtSmamJBSdUBIP5n1/+iIjcZE1NOsRZewU3jQNrtuRYRlDnUCjayVTRk3z5Qb88Ya3Ie7UHqQOVDgNBLksZUAFXReoSMrSYSiV5OtnMMNrBaMD9FO4rChU5vvrOESDktCHFQw3KmDX7CQawCaaOMfqcYWvcuuCUEkBIGy81eQ+eaICQrlBnBEMvEjAOUAPpQM466QlQ1mxcGAdUFDKT7JhX0WEWoEaNJXGwBDhvroJ1ZiNz8uBM2vgA3qgmEuGINVHoKGqi3E/hF7mhjjgf5hRQKsqhbNhFApnJCfrNZBo6h5R8AMvhZUbRqQ/oAijakIuzFztZNEqBNSwZEhWY4qS37Cg41L4wru4SGlpzLJ91hl+MGCPH/RQe9IO+5WFpPPEAKKnXfvGgJ7A8jtk9pV4GWn0/7MN2u322B69PMVcyVE0Kjqx5wpXxMG7NGH788lokIpCr/U1xS24js+GF+UrMWTSe9UKKWRRSqlGqbsfenQNY1JTMSHsayd77q48fYAM/TOciGW3+P0h49uH658vfbi/ZL4tZt38X0/l0zkfW+FCjHoUa/To4X9vD02vwb35I9MoSaBdmVqGMAh7JHHrxXR5f9FUiKuMDHx0OKXr65FTb8vHvDTmW9FUiNugkpiw4y1WbDHrEar2mPVcty8iytG9QNZ2onb1gJ8/A1eWdSAQ2nMlYB9dRB/sP7H240vuR71OB7BLgv6zVfws4HDqNbdujfXf1VURPcLDmAq7atv0Ltvx+tg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},k=void 0,v={},P=[];function G(e){const o={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Webhook"}),"\n",(0,n.jsx)(r(),{method:"get",path:"/webhook",context:"endpoint"}),"\n",(0,n.jsx)(o.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,n.jsx)(p(),{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:{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,s.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(G,{...e})}):G(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9853b.b628cd80.js b/assets/js/5ce9853b.b628cd80.js deleted file mode 100644 index 8a648768c..000000000 --- a/assets/js/5ce9853b.b628cd80.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1019],{77408:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>b,default:()=>q,frontMatter:()=>I,metadata:()=>s,toc:()=>y});const s=JSON.parse('{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/resendrequestmail.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/resendrequestmail","permalink":"/docs/API-docs/resendrequestmail","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar_label":"Resend request mail","hide_title":true,"hide_table_of_contents":true,"api":"eJzlV81uGzcQfpUJL22A1Y9T96JTUicIjAZ1ELvIwREEane0YswlGf5IFhZ765P00fokxZC7q5WlOEmLtodeDJmc348z38zWzPPSsdkte6nzUKHyjs0zVqDLrTBeaMVm7B06VAVY/BTQeai4kOA1BIcWVtqCE6USqoSiNTH+oFjGtEHLycJl0dtoTZAFlrH2v590sWOzmuVaeVSefnJjpMij9uSjoyBq5vI1Vpx+kZ6wWFDYnc+FKFjGMFqeZ8zvDLIZ08uPmHuWMWMpHC/QkYGh0qzuhJ23QpVk5Z5XRtKRsXojCuwzA1GwpnNzQvMQt047AhVRW1ldRbjQOoLQ4ugI2oTePgbSft7+O8511QewcCGl98VALoLzrWPug8XeX7QDrR0QCjze+8naV5IetuJ+DBdcgVC5DAXCSkupt/TUG24FX0p0AHXdw+mFl9g0UNeUFdqF4hU2TbY/IH8HB2atVStiMUexOdDqj3Cv2J8NVPHeCLtbFNy3B7muDFe7YQCpSBfByqYZHyC8R3TZluLfgpOM/I+xbDIWY2czZmPT75Ft6HLfvd4GjAfOaOVSaz6bTmOHHgDOsq8nh8c736IL8mTHpDc6TQOpS6j/XchzdG4VpNyND3IVSgqFiy6ZxbPpdHE2pZSbjJ3/s1mhtdp+a1LXukK/pgLcUmZbq1X5eErn0+niWZ/R+XFGoz1RKu1hpYMqQKyG9AnCxbtcW4s5jYpR4scDhZY5i3SV2qpVNLGoIlklIgUpnAe99xL5879E9gQI2j7I8ktIny/OeqR/PEb6Um24FAW8eHsJN/oO1ZN/Ied9hkP3PrmnUO+rOBWJKGJSUSjes4Nkh+cpSYd5sMLv2Oy2ZvcjbsQo3c9u5808Y1SqmvYIo12MmPs1m7HJnmEYGbEbtC7aCFayGVt7b9xsMnFcFUt9P9YGFVWN5EtHs3TCjZhszliTPdTgxnyDtPO8FKocPao136d5TU+R0D5ItsecG/Ez7ljWYTmUypigElgjL9BG3OmF3+2XqVfdOz3YdE6uM/02c7xoHO0ZjB0Oyjg5hVrpGHn7vFcG1bUoVSyOzdnR9HyPMtcV0vrj1wid+B+//R41uthi7T6Bq2DB6C3aVZDAVQErifdiKTEKc5qhDnY6kDmHvJLonKTx67G03CMUohSey35JzbnhSyEFVTuJadK2MGgYN4b3a/RrtHT1nUXgUOAGJTUJSK3vyI7XwIPXVfTR4bnV9m5FIWXAYRmcUOgcOMROBdWaqxyhK4SMmIErQOXRGiscAhcVCdNijauVyAUZpta2PKcNUfESyVkGFDeh0D6rA6uXwXlwWoaYCHmsEH1KUSEWbgwvxQZT4nRYoOdCYgFlIBMZ5LpAaKuA0lAFLGm3MeRe5BiNOs+tB4kbtLHw40vSUASjiYIEl8TIw7clQ95y5Yg5U0Dd0/TwGatpukYfBd+N4YP6oGhOEXlSAUih7tyMZsZtX2bvcemEx/n3XTNut9ujJnx6qPNa+HVYgkWj93plPIwtO1Tv/3nKMubRVu5qdY12I3JsGeAzPidReNISM0+Letds3IjnDxWom6TIUTkc0OiL12/fwAZ+GE9ZNqCdrwh48uby4tUv16/ILhFj6r+z8XQ8pSOi0oqrgasTH3oP23fwmfYXvwtbhovbsZFcxNkQ86pbWr8dLI70Mbcmzp/dsrpecoe/0tJJx58CWhoY84x1K3QcF1lHjTQH7pB46iLFPLoh3yQuQ2LZB1OSmD1pvMhzNP5R2eFYent1fcMy1n0/VLqI+y/f0mcu3ybq1BHDtIfSWc0kV2XgJckmm8TmPBAIw1FwF0dB+4Oy6q7UbhDh4YxIadBfSuqkQl2nMdM0vXy6+qxGC2wnTW83b5rmTxlKzUc=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"}}');var i=n(74848),o=n(28453),r=n(33617),d=n.n(r),a=n(17543),c=n.n(a),m=n(86013),p=n.n(m),l=n(63723),u=n.n(l),h=(n(18766),n(79329),n(9303));const I={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:"eJzlV81uGzcQfpUJL22A1Y9T96JTUicIjAZ1ELvIwREEane0YswlGf5IFhZ765P00fokxZC7q5WlOEmLtodeDJmc348z38zWzPPSsdkte6nzUKHyjs0zVqDLrTBeaMVm7B06VAVY/BTQeai4kOA1BIcWVtqCE6USqoSiNTH+oFjGtEHLycJl0dtoTZAFlrH2v590sWOzmuVaeVSefnJjpMij9uSjoyBq5vI1Vpx+kZ6wWFDYnc+FKFjGMFqeZ8zvDLIZ08uPmHuWMWMpHC/QkYGh0qzuhJ23QpVk5Z5XRtKRsXojCuwzA1GwpnNzQvMQt047AhVRW1ldRbjQOoLQ4ugI2oTePgbSft7+O8511QewcCGl98VALoLzrWPug8XeX7QDrR0QCjze+8naV5IetuJ+DBdcgVC5DAXCSkupt/TUG24FX0p0AHXdw+mFl9g0UNeUFdqF4hU2TbY/IH8HB2atVStiMUexOdDqj3Cv2J8NVPHeCLtbFNy3B7muDFe7YQCpSBfByqYZHyC8R3TZluLfgpOM/I+xbDIWY2czZmPT75Ft6HLfvd4GjAfOaOVSaz6bTmOHHgDOsq8nh8c736IL8mTHpDc6TQOpS6j/XchzdG4VpNyND3IVSgqFiy6ZxbPpdHE2pZSbjJ3/s1mhtdp+a1LXukK/pgLcUmZbq1X5eErn0+niWZ/R+XFGoz1RKu1hpYMqQKyG9AnCxbtcW4s5jYpR4scDhZY5i3SV2qpVNLGoIlklIgUpnAe99xL5879E9gQI2j7I8ktIny/OeqR/PEb6Um24FAW8eHsJN/oO1ZN/Ied9hkP3PrmnUO+rOBWJKGJSUSjes4Nkh+cpSYd5sMLv2Oy2ZvcjbsQo3c9u5808Y1SqmvYIo12MmPs1m7HJnmEYGbEbtC7aCFayGVt7b9xsMnFcFUt9P9YGFVWN5EtHs3TCjZhszliTPdTgxnyDtPO8FKocPao136d5TU+R0D5ItsecG/Ez7ljWYTmUypigElgjL9BG3OmF3+2XqVfdOz3YdE6uM/02c7xoHO0ZjB0Oyjg5hVrpGHn7vFcG1bUoVSyOzdnR9HyPMtcV0vrj1wid+B+//R41uthi7T6Bq2DB6C3aVZDAVQErifdiKTEKc5qhDnY6kDmHvJLonKTx67G03CMUohSey35JzbnhSyEFVTuJadK2MGgYN4b3a/RrtHT1nUXgUOAGJTUJSK3vyI7XwIPXVfTR4bnV9m5FIWXAYRmcUOgcOMROBdWaqxyhK4SMmIErQOXRGiscAhcVCdNijauVyAUZpta2PKcNUfESyVkGFDeh0D6rA6uXwXlwWoaYCHmsEH1KUSEWbgwvxQZT4nRYoOdCYgFlIBMZ5LpAaKuA0lAFLGm3MeRe5BiNOs+tB4kbtLHw40vSUASjiYIEl8TIw7clQ95y5Yg5U0Dd0/TwGatpukYfBd+N4YP6oGhOEXlSAUih7tyMZsZtX2bvcemEx/n3XTNut9ujJnx6qPNa+HVYgkWj93plPIwtO1Tv/3nKMubRVu5qdY12I3JsGeAzPidReNISM0+Letds3IjnDxWom6TIUTkc0OiL12/fwAZ+GE9ZNqCdrwh48uby4tUv16/ILhFj6r+z8XQ8pSOi0oqrgasTH3oP23fwmfYXvwtbhovbsZFcxNkQ86pbWr8dLI70Mbcmzp/dsrpecoe/0tJJx58CWhoY84x1K3QcF1lHjTQH7pB46iLFPLoh3yQuQ2LZB1OSmD1pvMhzNP5R2eFYent1fcMy1n0/VLqI+y/f0mcu3ybq1BHDtIfSWc0kV2XgJckmm8TmPBAIw1FwF0dB+4Oy6q7UbhDh4YxIadBfSuqkQl2nMdM0vXy6+qxGC2wnTW83b5rmTxlKzUc=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,g={},y=[];function j(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,i.jsx)(d(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(c(),{parameters:void 0}),"\n",(0,i.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}}.",example:""},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}},title:"resendmail_body"}}},required:!0}}),"\n",(0,i.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 q(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9853b.efc3024a.js b/assets/js/5ce9853b.efc3024a.js new file mode 100644 index 000000000..6cb945b55 --- /dev/null +++ b/assets/js/5ce9853b.efc3024a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1019],{77408:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>v,contentTitle:()=>g,default:()=>q,frontMatter:()=>j,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","source":"@site/docs/API-docs/resendrequestmail.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/resendrequestmail","permalink":"/docs/API-docs/resendrequestmail","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar_label":"Resend request mail","hide_title":true,"hide_table_of_contents":true,"api":"eJzlV81uGzcQfpUJL22A1Y9T96JTUicIjAZ1ELvIwREEane0YswlGf5IFhZ765P00fokxZC7q5WlOEmLtodeDJmc348z38zWzPPSsdkte6nzUKHyjs0zVqDLrTBeaMVm7B06VAVY/BTQeai4kOA1BIcWVtqCE6USqoSiNTH+oFjGtEHLycJl0dtoTZAFlrH2v590sWOzmuVaeVSefnJjpMij9uSjoyBq5vI1Vpx+kZ6wWFDYnc+FKFjGMFqeZ8zvDLIZ08uPmHuWMWMpHC/QkYGh0qzuhJ23QpVk5Z5XRtKRsXojCuwzA1GwpnNzQvMQt047AhVRW1ldRbjQOoLQ4ugI2oTePgbSft7+O8511QewcCGl98VALoLzrWPug8XeX7QDrR0QCjze+8naV5IetuJ+DBdcgVC5DAXCSkupt/TUG24FX0p0AHXdw+mFl9g0UNeUFdqF4hU2TbY/IH8HB2atVStiMUexOdDqj3Cv2J8NVPHeCLtbFNy3B7muDFe7YQCpSBfByqYZHyC8R3TZluLfgpOM/I+xbDIWY2czZmPT75Ft6HLfvd4GjAfOaOVSaz6bTmOHHgDOsq8nh8c736IL8mTHpDc6TQOpS6j/XchzdG4VpNyND3IVSgqFiy6ZxbPpdHE2pZSbjJ3/s1mhtdp+a1LXukK/pgLcUmZbq1X5eErn0+niWZ/R+XFGoz1RKu1hpYMqQKyG9AnCxbtcW4s5jYpR4scDhZY5i3SV2qpVNLGoIlklIgUpnAe99xL5879E9gQI2j7I8ktIny/OeqR/PEb6Um24FAW8eHsJN/oO1ZN/Ied9hkP3PrmnUO+rOBWJKGJSUSjes4Nkh+cpSYd5sMLv2Oy2ZvcjbsQo3c9u5808Y1SqmvYIo12MmPs1m7HJnmEYGbEbtC7aCFayGVt7b9xsMnFcFUt9P9YGFVWN5EtHs3TCjZhszliTPdTgxnyDNIbRtyk4z0uhyse15ntcrunt0vMcoNM/EjfiZ9yxrAN/KJUxQTWzRl6gjQ9FJfFuv3296h72wWp0cv/p15/jzeRoMWHscLLGUSvUSsfI23q4MqiuRaliNW3Ojsbte5S5rpD2Jb9G6MT/+O33qNHFFov9CVwFC0Zv0a6CBK4KWEm8F0uJUZjT0HWw04HMOeSVROckzWuPpeUeoRCl8Fz2W23ODV8KKag9SEyTtoVBh7kxvF+jX6Olq+8sAocCNyipq0BqfUd2vAYevK6ijw7PrbZ3KwopAw7L4IRC58Ahdiqo1lzlCF0hZEQlXAEqj9ZY4RC4qEiYNnFcrUQuyDBxgeU5rZSKl0jOMqC4CYX2WR1YvQzOg9MyxETIY4XoU4oKsXBjeCk2mBKnwwI9FxILKAOZyCDXBUJbBZSGKmBJy5Ah9yLHaNR5bj1I3KCNhR9fkqYoGE2cJbgkCh++LRnylitHVJsC6p6mh89YTeM4+ij4bgwf1AdFg43YlgpACnXnZjRkbvsye49LJzzOv++acbvdHjXh00Od18KvwxIsGr3XK+NhbNmhev/PU5Yxj7ZyV6trtBuRY8sAn/E5icKTlsl52uy7ZuNGPH+oQN0kRY7K4YB3X7x++wY28MN4yrIB7XxFwJM3lxevfrl+RXaJSVP/nY2n4ykdEfdWXA1cnfgyfNi+g++6v/gh2TJcXKeN5CIOk5hX3c6B28GmSV9/axoSs1tW10vu8FfaUun4U0BLE2aesW7njvMl66iRBscdEk9dpJhHN+SbxGVILPtgrBKzJ40XeY7GPyo7nGNvr65vWMa6D45KF3Fh5lv6LubbRJ06YpgWVzqrmeSqDLwk2WST2JwHAmE4Cu7iKGh/UFbdldoNIjycESkN+ktJnVSo6zRmmqaXT1ef1WiB7aTp7eZN0/wJaKrecg==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"},"next":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"}}');var i=n(74848),o=n(28453),r=n(33617),a=n.n(r),l=n(17543),d=n.n(l),c=n(86013),p=n.n(c),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));const j={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV81uGzcQfpUJL22A1Y9T96JTUicIjAZ1ELvIwREEane0YswlGf5IFhZ765P00fokxZC7q5WlOEmLtodeDJmc348z38zWzPPSsdkte6nzUKHyjs0zVqDLrTBeaMVm7B06VAVY/BTQeai4kOA1BIcWVtqCE6USqoSiNTH+oFjGtEHLycJl0dtoTZAFlrH2v590sWOzmuVaeVSefnJjpMij9uSjoyBq5vI1Vpx+kZ6wWFDYnc+FKFjGMFqeZ8zvDLIZ08uPmHuWMWMpHC/QkYGh0qzuhJ23QpVk5Z5XRtKRsXojCuwzA1GwpnNzQvMQt047AhVRW1ldRbjQOoLQ4ugI2oTePgbSft7+O8511QewcCGl98VALoLzrWPug8XeX7QDrR0QCjze+8naV5IetuJ+DBdcgVC5DAXCSkupt/TUG24FX0p0AHXdw+mFl9g0UNeUFdqF4hU2TbY/IH8HB2atVStiMUexOdDqj3Cv2J8NVPHeCLtbFNy3B7muDFe7YQCpSBfByqYZHyC8R3TZluLfgpOM/I+xbDIWY2czZmPT75Ft6HLfvd4GjAfOaOVSaz6bTmOHHgDOsq8nh8c736IL8mTHpDc6TQOpS6j/XchzdG4VpNyND3IVSgqFiy6ZxbPpdHE2pZSbjJ3/s1mhtdp+a1LXukK/pgLcUmZbq1X5eErn0+niWZ/R+XFGoz1RKu1hpYMqQKyG9AnCxbtcW4s5jYpR4scDhZY5i3SV2qpVNLGoIlklIgUpnAe99xL5879E9gQI2j7I8ktIny/OeqR/PEb6Um24FAW8eHsJN/oO1ZN/Ied9hkP3PrmnUO+rOBWJKGJSUSjes4Nkh+cpSYd5sMLv2Oy2ZvcjbsQo3c9u5808Y1SqmvYIo12MmPs1m7HJnmEYGbEbtC7aCFayGVt7b9xsMnFcFUt9P9YGFVWN5EtHs3TCjZhszliTPdTgxnyDNIbRtyk4z0uhyse15ntcrunt0vMcoNM/EjfiZ9yxrAN/KJUxQTWzRl6gjQ9FJfFuv3296h72wWp0cv/p15/jzeRoMWHscLLGUSvUSsfI23q4MqiuRaliNW3Ojsbte5S5rpD2Jb9G6MT/+O33qNHFFov9CVwFC0Zv0a6CBK4KWEm8F0uJUZjT0HWw04HMOeSVROckzWuPpeUeoRCl8Fz2W23ODV8KKag9SEyTtoVBh7kxvF+jX6Olq+8sAocCNyipq0BqfUd2vAYevK6ijw7PrbZ3KwopAw7L4IRC58Ahdiqo1lzlCF0hZEQlXAEqj9ZY4RC4qEiYNnFcrUQuyDBxgeU5rZSKl0jOMqC4CYX2WR1YvQzOg9MyxETIY4XoU4oKsXBjeCk2mBKnwwI9FxILKAOZyCDXBUJbBZSGKmBJy5Ah9yLHaNR5bj1I3KCNhR9fkqYoGE2cJbgkCh++LRnylitHVJsC6p6mh89YTeM4+ij4bgwf1AdFg43YlgpACnXnZjRkbvsye49LJzzOv++acbvdHjXh00Od18KvwxIsGr3XK+NhbNmhev/PU5Yxj7ZyV6trtBuRY8sAn/E5icKTlsl52uy7ZuNGPH+oQN0kRY7K4YB3X7x++wY28MN4yrIB7XxFwJM3lxevfrl+RXaJSVP/nY2n4ykdEfdWXA1cnfgyfNi+g++6v/gh2TJcXKeN5CIOk5hX3c6B28GmSV9/axoSs1tW10vu8FfaUun4U0BLE2aesW7njvMl66iRBscdEk9dpJhHN+SbxGVILPtgrBKzJ40XeY7GPyo7nGNvr65vWMa6D45KF3Fh5lv6LubbRJ06YpgWVzqrmeSqDLwk2WST2JwHAmE4Cu7iKGh/UFbdldoNIjycESkN+ktJnVSo6zRmmqaXT1ef1WiB7aTp7eZN0/wJaKrecg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,v={},b=[];function y(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Resend request mail"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/resendmail",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"Resend request mail to user for signing document."}),"\n",(0,i.jsx)(h.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:["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}}.",example:""},email_body:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}},title:"resendmail_body"}}},required:!0}}),"\n",(0,i.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 q(e={}){const{wrapper:t}={...(0,o.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/70853c19.5d1e4741.js b/assets/js/70853c19.5d1e4741.js deleted file mode 100644 index a5494b1fa..000000000 --- a/assets/js/70853c19.5d1e4741.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3451],{47561:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>U,contentTitle:()=>E,default:()=>A,frontMatter:()=>g,metadata:()=>i,toc:()=>I});const i=JSON.parse('{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/save-update-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/save-update-webhook","permalink":"/docs/API-docs/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWetu27gSfpUpC+ylUGynmwUO/Gu9qbdrnFyM2EGxiI2UlsYSNxSpJSk7huF/50nOo50nORhRUmQndbftIigK//GFnCHnm/k4JIdr5nhsWfeGvcNZovUdmwYsQhsakTmhFeuycYJg+QJBG8iziDuEUhZ6wwFwKfXSwkrn4LQX5LAsBa6vzmCZiDABYSG3GJGMMyKO0QAuUDnbmqiJevnyJfSLv136++rVcQsWApcYdV+9mqgjeJegAg5WxApN0WWBQ6TDPEXlAnCJsH5AWAopqzlaE/X+/fuJWk8UwIQVAhPWhQnzo09Y4HvcKkPf8eby9Pq8fzG+Hf8x7Nf9evYnhm4Q7cgM3tQScyF3R7i+Oqu7FU93uy965w8TKO3K/qFEbhEMkonAVVSg9ggrwLVaI1Reu+7xrrLUekMtAGv/tW3NaPD2on/VtMVLYMqF3BLpn/cGZ1syWaLV9jDD3y8v+hPmRTb0NS3N8f7+dfXBISuRXhmg8eC8Pxr3zod1f2iQuycFJmpTBpq487oFpeg2eSrnERdLgc8gTql5YM5zMefvhH1fjMElRudxAi5BiAyfO3CYZpISWW84OFDgK6NAQyY3jVEGF2+9Uz6TI5Qafmr5LWRPZvD9MFvV281nMMQP8s0ThBpLYnyMFh8nxUeywqY58z+wS5y0INRpJnHvPtFgg5QlH+znpIxqqm+eE1/PvoHGibkIeQXztH81Hvw2OO2N+1uOqmPz5aT6uQURhlLszTCVxBfmmGqYA6Oei1GVx/eeYiuhLyMTC5jO0HByyiBiXUYXq+/89au6qQXM4F85Wverjlasu965tw2NXogIITeSbl1+VnhQDrVyqBwp8iyTtFCEVu0/LWmvmQ0TTDn9olmEwYhuiddG0g2RqMa6JaNYwDJD1jqBlhRyI+mrFLLOCBWzgM21SblrtuA9p6XHuixxLrPddnulc3NU3h6PciN/KUVaoU7ZZhMwJ1yhUMrczgj7ZkNdBm2mlfU2vO50HrtklIchWjvPJdTe/RRP7Idt0ObSPYX8AWd1c/aRjMDWFsnViy2AQhGNbitQt687ndt/lUhPngSnU3SJUDEsiyRitIoDyPxKdGYFPOZCAZ17zYt/DjUao81+0J9m2T4nnHQ6t8e1E44fO6H2r5HApUEerQDvhXX2eSHvs2M/wOPbZQ3w5DHAa4sGlHYw17mKnhfU7tz7gZzUMH5+DGOgFlyKqKggjfUdqudF0pze+enJ1Pu0SFy0sxSQCqGin21BbbZ7kBbD3Ai3Yt2bNbs/4pk48v3dm+lmGjBaAJryeKZtYTF3Ceuy9rJOxxbNAo0tBigSaJ0TLVfRTN+3dIaKdkTJZ5byYZtnor04ZptgV4Nn2SdIW8djoeKjvVrTB4wjioN39RbS2uE8E//GFQsqRzalAiYo/gnyCE3hdArv1cNG1q+CtGvm/q2Bxp3rwogyTJcZqhGdOijIi2O2W9d8hzLUKRYVyQShEv/ff/5baFTHlIKDL+AyN5DpJRraPOhAM5d4L2YSnyqCIk8lWitXIJTD2NDGG4lYOO7vEJQKQ57xmZCCWEtimrQNNIhvW3R6dAka6vreUGE1wgVKIjtIre9oHKeB506nxRzVKXOpzd2cTAqAwyy3QqG1YBErFVQJVyFCFdOAqrtcASqHJjPCInCRkvBcG8D5XISCBqYlanjoIOWKx+iLr2Q3eSHzJw4LRs9y68BqmRdAaMYU0XmICjGyLXgjFuiBU2OEjguJEcQ5DRFAqCOEMsQEQ0UwQ+sgo+lFiMWg1nHjQOICTcHhIpK0mUKmKZUILkHPt2JLAznDlaXjiDeoCk3tvsxo2pWLOSK+agGd7mkXoxo2EUAKdUel6iO4qWn2DmdWOJz+UBF2uVw+Wk8/buu8FS7JZ2Aw0w96cdFYrL6mev3nRxYwhya1l/MRmoUIqwPUB+ZsF8LtMsHysEiwxdnYr9VfdhVoNUkRorLYSIe9t8MzWMBPrQ4LGkvzbxjcPhuc9i9GfRqXcpxff8etTqtDTZQSU64aU43K54brreeG3RW8ftgwDo8Uhwve4ZHiUKE+PFIcKHB4pDg8UhweKQ6PFF9f0jg8UhwY9Y09UpQVH4f3rp1JLopCWVn/9zWum6pUT+8GCVW/ujdsvZ5xi9dGbjbU/FeOhkpn04AtuBF8RgWcm+kmqOpEVBS7wxXrslN/5Tsa08QkLnNfctqpF1KZy2v0whAzt1e2WaAbXo7GLGCz8k0l1RHpGL6k9xa+ZF1WvM0UdY2i6k9taya5inMek6wfk0pbPCcPNOtid0VdrPxBqKoutWpYuF0w8zDok0A9qbBe+5rbZlPL+64PapSOraQpcNPNZvN/PSfj8Q==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/delete-webhook"}}');var o=t(74848),s=t(28453),r=t(33617),d=t.n(r),a=t(17543),l=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={id:"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:"eJztWetu27gSfpUpC+ylUGynmwUO/Gu9qbdrnFyM2EGxiI2UlsYSNxSpJSk7huF/50nOo50nORhRUmQndbftIigK//GFnCHnm/k4JIdr5nhsWfeGvcNZovUdmwYsQhsakTmhFeuycYJg+QJBG8iziDuEUhZ6wwFwKfXSwkrn4LQX5LAsBa6vzmCZiDABYSG3GJGMMyKO0QAuUDnbmqiJevnyJfSLv136++rVcQsWApcYdV+9mqgjeJegAg5WxApN0WWBQ6TDPEXlAnCJsH5AWAopqzlaE/X+/fuJWk8UwIQVAhPWhQnzo09Y4HvcKkPf8eby9Pq8fzG+Hf8x7Nf9evYnhm4Q7cgM3tQScyF3R7i+Oqu7FU93uy965w8TKO3K/qFEbhEMkonAVVSg9ggrwLVaI1Reu+7xrrLUekMtAGv/tW3NaPD2on/VtMVLYMqF3BLpn/cGZ1syWaLV9jDD3y8v+hPmRTb0NS3N8f7+dfXBISuRXhmg8eC8Pxr3zod1f2iQuycFJmpTBpq487oFpeg2eSrnERdLgc8gTql5YM5zMefvhH1fjMElRudxAi5BiAyfO3CYZpISWW84OFDgK6NAQyY3jVEGF2+9Uz6TI5Qafmr5LWRPZvD9MFvV281nMMQP8s0ThBpLYnyMFh8nxUeywqY58z+wS5y0INRpJnHvPtFgg5QlH+znpIxqqm+eE1/PvoHGibkIeQXztH81Hvw2OO2N+1uOqmPz5aT6uQURhlLszTCVxBfmmGqYA6Oei1GVx/eeYiuhLyMTC5jO0HByyiBiXUYXq+/89au6qQXM4F85Wverjlasu965tw2NXogIITeSbl1+VnhQDrVyqBwp8iyTtFCEVu0/LWmvmQ0TTDn9olmEwYhuiddG0g2RqMa6JaNYwDJD1jqBlhRyI+mrFLLOCBWzgM21SblrtuA9p6XHuixxLrPddnulc3NU3h6PciN/KUVaoU7ZZhMwJ1yhUMrczgj7ZkNdBm2mlfU2vO50HrtklIchWjvPJdTe/RRP7Idt0ObSPYX8AWd1c/aRjMDWFsnViy2AQhGNbitQt687ndt/lUhPngSnU3SJUDEsiyRitIoDyPxKdGYFPOZCAZ17zYt/DjUao81+0J9m2T4nnHQ6t8e1E44fO6H2r5HApUEerQDvhXX2eSHvs2M/wOPbZQ3w5DHAa4sGlHYw17mKnhfU7tz7gZzUMH5+DGOgFlyKqKggjfUdqudF0pze+enJ1Pu0SFy0sxSQCqGin21BbbZ7kBbD3Ai3Yt2bNbs/4pk48v3dm+lmGjBaAJryeKZtYTF3Ceuy9rJOxxbNAo0tBigSaJ0TLVfRTN+3dIaKdkTJZ5byYZtnor04ZptgV4Nn2SdIW8djoeKjvVrTB4wjioN39RbS2uE8E//GFQsqRzalAiYo/gnyCE3hdArv1cNG1q+CtGvm/q2Bxp3rwogyTJcZqhGdOijIi2O2W9d8hzLUKRYVyQShEv/ff/5baFTHlIKDL+AyN5DpJRraPOhAM5d4L2YSnyqCIk8lWitXIJTD2NDGG4lYOO7vEJQKQ57xmZCCWEtimrQNNIhvW3R6dAka6vreUGE1wgVKIjtIre9oHKeB506nxRzVKXOpzd2cTAqAwyy3QqG1YBErFVQJVyFCFdOAqrtcASqHJjPCInCRkvBcG8D5XISCBqYlanjoIOWKx+iLr2Q3eSHzJw4LRs9y68BqmRdAaMYU0XmICjGyLXgjFuiBU2OEjguJEcQ5DRFAqCOEMsQEQ0UwQ+sgo+lFiMWg1nHjQOICTcHhIpK0mUKmKZUILkHPt2JLAznDlaXjiDeoCk3tvsxo2pWLOSK+agGd7mkXoxo2EUAKdUel6iO4qWn2DmdWOJz+UBF2uVw+Wk8/buu8FS7JZ2Aw0w96cdFYrL6mev3nRxYwhya1l/MRmoUIqwPUB+ZsF8LtMsHysEiwxdnYr9VfdhVoNUkRorLYSIe9t8MzWMBPrQ4LGkvzbxjcPhuc9i9GfRqXcpxff8etTqtDTZQSU64aU43K54brreeG3RW8ftgwDo8Uhwve4ZHiUKE+PFIcKHB4pDg8UhweKQ6PFF9f0jg8UhwY9Y09UpQVH4f3rp1JLopCWVn/9zWum6pUT+8GCVW/ujdsvZ5xi9dGbjbU/FeOhkpn04AtuBF8RgWcm+kmqOpEVBS7wxXrslN/5Tsa08QkLnNfctqpF1KZy2v0whAzt1e2WaAbXo7GLGCz8k0l1RHpGL6k9xa+ZF1WvM0UdY2i6k9taya5inMek6wfk0pbPCcPNOtid0VdrPxBqKoutWpYuF0w8zDok0A9qbBe+5rbZlPL+64PapSOraQpcNPNZvN/PSfj8Q==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},E=void 0,U={},I=[{value:"Events:",id:"events",level:3}];function v(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)(m.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)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{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)(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 A(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.6bd16af0.js b/assets/js/70853c19.6bd16af0.js new file mode 100644 index 000000000..ad187e320 --- /dev/null +++ b/assets/js/70853c19.6bd16af0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3451],{47561:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>M,contentTitle:()=>N,default:()=>x,frontMatter:()=>u,metadata:()=>o,toc:()=>I});const o=JSON.parse('{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","source":"@site/docs/API-docs/save-update-webhook.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/save-update-webhook","permalink":"/docs/API-docs/save-update-webhook","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWetu27gSfpUpC+ylUGynmwUO/Gu9qbdrnFyM2EGxiI2UlsYSNxSpJSk7huF/50nOo50nORhRUmQndbftIigK//GFnBnO5eOQnFkzx2PLujfsHc4Sre/YNGAR2tCIzAmtWJeNEwTLFwjaQJ5F3CGUtNAbDoBLqZcWVjoHpz0hh2VJcH11BstEhAkIC7nFiGicEXGMBnCBytnWRE3Uy5cvoV/87dLfV6+OW7AQuMSo++rVRB3BuwQVcLAiVmiKKQscIh3mKSoXgEuE9QJhKaSs1mhN1Pv37ydqPVEAE1YQTFgXJsxLn7DAz7hVhn7izeXp9Xn/Ynw7/mPYr+f17E8M3SDaoRm8qSnmQu5KuL46q6cVT3enL3rnDwso7cr5oURuEQySisBVVFjtLawMrtkaofLc9Yx3laXRGxoBWPuvbW1Gg7cX/aumLp4CUy7kFkn/vDc426LJEq22xQx/v7zoT5gn2dDXtFTH+/vX1QdFViS9MkDjwXl/NO6dD+v50CB3TxJM1KYMNGHndQtK0m3wVM4jLJYEnwGckvOAnOdCzt8J+74Yg0uMzuMEXIIQGT534DDNJCWy3nBwgMBXBoEGTW4aUgYXb71TPhMjlBp+avkjZE9m8PMwW9XHzWcgxAv55gFCgyUwPgaLj4PiI1lh01z5HzglTloQ6jSTuPecaKBByhIP9nNSRrXUN4+Jr+fcQOPEXIS8MvO0fzUe/DY47Y37W46qY/PloPq5BRGGUuzNMBXFF+aYSswBUc+FqMrje2+xFdGXgYkFTGdoODllELEuo4fVd/75Vb3UAmbwrxyt+1VHK9Zd77zbhkYvRISQG0mvLr8qPDCHWjlUjhh5lknaKEKr9p+WuNfMhgmmnH7RKsJgRK/EayPphUhQY90SUSxgmSFtnUBLDLmR9FUSWWeEilnA5tqk3DVH8J7T1mNdljiX2W67vdK5OSpfj0e5kb+UJK1Qp2yzCZgTrmAoaW5nZPtmQ1MGbaaV9Tq87nQeu2SUhyFaO88l1N79FE/sN9ugzaV7yvIHO6uXs49kBLbWSK5ebBkoFMHotjLq9nWnc/uv0tKTJ43TKbpEqBiWRRIxWsUBZH4nOrMCHnOhgO695sU/ZzUao81+oz9Ns31OOOl0bo9rJxw/dkLtXyOBS4M8WgHeC+vs85q8T4/9Bh7fLmsDTx4beG3RgNIO5jpX0fMatbv2fkNOajN+fmzGQC24FFFRQRrrO1TPa0lzeeeXJ1Xv0yJx0clSmFQQFfNsy9TmuDfSYpgb4Vase7Nm90c8E0d+vnsz3UwDRhtAUx7PtC005i5hXdZe1unYolmgsYWAIoHWOdFyFc30fUtnqOhElHxmKR+2eSbai2O2CXY5eJZ9AjXmR5/GYB2PhYr3c00fnDKiwPnYbLmmjhDPxL9xxYLK802qgAkCTII8QlNEifBw9XDy9auo7qq5/ywhuXNdKFHG9TJDNaJrCqFiccx2C6HvUIY6xaKEmSBU5P/7z38LjupeU4D2BVzmBjK9REOnDd2A5hLvxUziU1VT5KlEa+UKhHIYGzqpIxELx/2jg3JnyDM+E1IQzIlME7eBxk6xLbpuugQNTX1vqBIb4QIl7Q6QWt+RHKeB506nxRrVtXSpzd2cVAqAwyy3QqG1YBErFlQJVyFCFdOAysFcASqHJjPCInCREvFcG8D5XISCBNOeNjx0kHLFY/TVWtKbvJD5K4oFo2e5dWC1zAtDaMUU0XkTFWJkW/BGLNAbToMROi4kRhDnJCKAUEcIZYjJDBXBDK2DjJYXIRZCrePGgcQFmgLDRSTp9IVMU+4RXIKeb8WWBDnDlaX7i1eoCk3tvsxoOsaLNSK+agE9B+jYo6I3AUAKdUe17SO4qWH2DmdWOJz+UAF2uVw+2k8/bvO8FS7JZ2Aw0w98cTFY7L4me/3nRxYwhya1l/MRmoUIqxvXB9ZsF8TtMiPzsMjIxWXa79VfdhloN0kRorLYyJ+9t8MzWMBPrQ4LGlvzbyjcPhuc9i9GfZJLSdHvv+NWp9WhIcqhKVeNpUZlf+J6qz+xu4PXDyfMoatxeBEeuhqHkvahq3GAwKGrcehqHLoah67G15c0Dl2NA6K+sa5GWfFxeO/ameSiqKyVDQNfFLupavvUaEioXNa9Yev1jFu8NnKzoeG/cjRUa5sGbMGN4DMq4NxMN0FVJ6Iq2h2uWJed+iff0ZgWJnKZ+5LTToGRylyeoxeGmLm9tM2K3vByNGYBm5VNmFRHxGP4kho0fMm6rGjmFHWNok1AY2smuYpzHhOtl0mlLZ6TB5p1sbuiLlb+IKuqKbVqaLhdMPNm0CcZ9STDeu1rbptNTe+nPshROraipsBNN5vN/wFVYPUc","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/delete-webhook"}}');var s=t(74848),i=t(28453),a=t(33617),r=t.n(a),d=t(17543),l=t.n(d),c=t(86013),h=t.n(c),p=t(63723),E=t.n(p),m=(t(18766),t(79329),t(9303));const u={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWetu27gSfpUpC+ylUGynmwUO/Gu9qbdrnFyM2EGxiI2UlsYSNxSpJSk7huF/50nOo50nORhRUmQndbftIigK//GFnBnO5eOQnFkzx2PLujfsHc4Sre/YNGAR2tCIzAmtWJeNEwTLFwjaQJ5F3CGUtNAbDoBLqZcWVjoHpz0hh2VJcH11BstEhAkIC7nFiGicEXGMBnCBytnWRE3Uy5cvoV/87dLfV6+OW7AQuMSo++rVRB3BuwQVcLAiVmiKKQscIh3mKSoXgEuE9QJhKaSs1mhN1Pv37ydqPVEAE1YQTFgXJsxLn7DAz7hVhn7izeXp9Xn/Ynw7/mPYr+f17E8M3SDaoRm8qSnmQu5KuL46q6cVT3enL3rnDwso7cr5oURuEQySisBVVFjtLawMrtkaofLc9Yx3laXRGxoBWPuvbW1Gg7cX/aumLp4CUy7kFkn/vDc426LJEq22xQx/v7zoT5gn2dDXtFTH+/vX1QdFViS9MkDjwXl/NO6dD+v50CB3TxJM1KYMNGHndQtK0m3wVM4jLJYEnwGckvOAnOdCzt8J+74Yg0uMzuMEXIIQGT534DDNJCWy3nBwgMBXBoEGTW4aUgYXb71TPhMjlBp+avkjZE9m8PMwW9XHzWcgxAv55gFCgyUwPgaLj4PiI1lh01z5HzglTloQ6jSTuPecaKBByhIP9nNSRrXUN4+Jr+fcQOPEXIS8MvO0fzUe/DY47Y37W46qY/PloPq5BRGGUuzNMBXFF+aYSswBUc+FqMrje2+xFdGXgYkFTGdoODllELEuo4fVd/75Vb3UAmbwrxyt+1VHK9Zd77zbhkYvRISQG0mvLr8qPDCHWjlUjhh5lknaKEKr9p+WuNfMhgmmnH7RKsJgRK/EayPphUhQY90SUSxgmSFtnUBLDLmR9FUSWWeEilnA5tqk3DVH8J7T1mNdljiX2W67vdK5OSpfj0e5kb+UJK1Qp2yzCZgTrmAoaW5nZPtmQ1MGbaaV9Tq87nQeu2SUhyFaO88l1N79FE/sN9ugzaV7yvIHO6uXs49kBLbWSK5ebBkoFMHotjLq9nWnc/uv0tKTJ43TKbpEqBiWRRIxWsUBZH4nOrMCHnOhgO695sU/ZzUao81+oz9Ns31OOOl0bo9rJxw/dkLtXyOBS4M8WgHeC+vs85q8T4/9Bh7fLmsDTx4beG3RgNIO5jpX0fMatbv2fkNOajN+fmzGQC24FFFRQRrrO1TPa0lzeeeXJ1Xv0yJx0clSmFQQFfNsy9TmuDfSYpgb4Vase7Nm90c8E0d+vnsz3UwDRhtAUx7PtC005i5hXdZe1unYolmgsYWAIoHWOdFyFc30fUtnqOhElHxmKR+2eSbai2O2CXY5eJZ9AjXmR5/GYB2PhYr3c00fnDKiwPnYbLmmjhDPxL9xxYLK802qgAkCTII8QlNEifBw9XDy9auo7qq5/ywhuXNdKFHG9TJDNaJrCqFiccx2C6HvUIY6xaKEmSBU5P/7z38LjupeU4D2BVzmBjK9REOnDd2A5hLvxUziU1VT5KlEa+UKhHIYGzqpIxELx/2jg3JnyDM+E1IQzIlME7eBxk6xLbpuugQNTX1vqBIb4QIl7Q6QWt+RHKeB506nxRrVtXSpzd2cVAqAwyy3QqG1YBErFlQJVyFCFdOAysFcASqHJjPCInCREvFcG8D5XISCBNOeNjx0kHLFY/TVWtKbvJD5K4oFo2e5dWC1zAtDaMUU0XkTFWJkW/BGLNAbToMROi4kRhDnJCKAUEcIZYjJDBXBDK2DjJYXIRZCrePGgcQFmgLDRSTp9IVMU+4RXIKeb8WWBDnDlaX7i1eoCk3tvsxoOsaLNSK+agE9B+jYo6I3AUAKdUe17SO4qWH2DmdWOJz+UAF2uVw+2k8/bvO8FS7JZ2Aw0w98cTFY7L4me/3nRxYwhya1l/MRmoUIqxvXB9ZsF8TtMiPzsMjIxWXa79VfdhloN0kRorLYyJ+9t8MzWMBPrQ4LGlvzbyjcPhuc9i9GfZJLSdHvv+NWp9WhIcqhKVeNpUZlf+J6qz+xu4PXDyfMoatxeBEeuhqHkvahq3GAwKGrcehqHLoah67G15c0Dl2NA6K+sa5GWfFxeO/ameSiqKyVDQNfFLupavvUaEioXNa9Yev1jFu8NnKzoeG/cjRUa5sGbMGN4DMq4NxMN0FVJ6Iq2h2uWJed+iff0ZgWJnKZ+5LTToGRylyeoxeGmLm9tM2K3vByNGYBm5VNmFRHxGP4kho0fMm6rGjmFHWNok1AY2smuYpzHhOtl0mlLZ6TB5p1sbuiLlb+IKuqKbVqaLhdMPNm0CcZ9STDeu1rbptNTe+nPshROraipsBNN5vN/wFVYPUc",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},N=void 0,M={},I=[{value:"Events:",id:"events",level:3}];function v(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,s.jsx)(r(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,s.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,s.jsx)(E(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.49352e31.js b/assets/js/770b40a9.49352e31.js deleted file mode 100644 index 89e11b238..000000000 --- a/assets/js/770b40a9.49352e31.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7605],{71625:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>y,default:()=>v,frontMatter:()=>b,metadata:()=>i,toc:()=>h});const i=JSON.parse('{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/gettemplatelist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/gettemplatelist","permalink":"/docs/API-docs/gettemplatelist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar_label":"Get Template list","hide_title":true,"hide_table_of_contents":true,"api":"eJzdV1tv2zYU/iunfNkKyLacWzs/NdiKLFixFEiGAkuNgJKOLTYUyZGULzD0tl+yn7ZfMhzqYjlu4mYr+rCXxCLPd+43bpjnc8cmt+wGCyO5R8emEcvQpVYYL7RiE3aTI1ygh5YE3gnn4fz9JXAp9dLBWpfgNVj0VuACgYMkCj0DvuBC8kQi+Jb/EG5y4WBWqpT4cyn8GozVC5GhA65AL9AuBC4DXsotMgJUPJFCzaF0aB3JTHOtHcLM6gJwJZyn2w4ByxwVpBZ5OM90WhaovBuyiGmDlpMGlxmbsDn6FkW6s4gZbnmBHi25Z8MUL5BNmBSFoFtBjvmjRLtmEbP4RyksZmwy49JhxJxfS6KeaVuwiOHKSJ0hm3hb0m2aY8HZZMMKvhJFWbDJaRxHzK8NgVRZJGhZRTheGGI0jquoU8HdC/PVNHhcZlxNia8zWjl0RHsUx/RvNzlcmabo3KyU0HmURSzVyqPyRM+NkSINF6NPjkCbfQV08gnT4HZLbLyoRVp0pfQ9Om4tJ4OFx8IdxtfHFOGO0nkr1JxFwTXc908629lq/HOiCnf0fk4+8cLT6T6LLcCFH13mEUppfwDUUkMgrUglmaH9VmbV+fSUgrU+EAirrSM6xe8ahUl1cchFuffGTUajFkw1PEx1QWi9VDt2P+WsUM661SpiTsxVqNJ/myRWH1I9Rf1lDvukERIMamHBhTxInSC+aQ5aX5hcqwNiTk7PjsbHr1+NiX4psjn6/2B/fbsvb7fQz6nXYwYLLkt0MADyO/elxQic54UZHki+jp6UXu03nx66O+nQRycnVcTWz0S9GpN/ngk6fl1FLH8m6OSMIsfn+Ezc+LNldV2n9F0b2uopqlCZDlV2qa7sbvtItJbIVV8gDYAqYqGIMDv3TyfaUXx0PBjHg/jVzfhscvLD5PRsGMfx7yxiqyJkdzOUsqbptUq236XJvomcsBngjS6/zHyLmbCY+rvSfrZGn8pjEhcWn7tCZ2LWjDb3tNwwlilQu+b058XD+O5GXSgpFN61A/nuKI7vzoikithJfLo/mC/VgkuRhT3tRt+jevH1xjJaqw+06754X4vfN1/UROGe7RjbP6+NdJiWVvh12MZWA27EoL6f3E5pVSnQ57pZ5cL65nM2YaMHW51Du2hXuhD7biw5rrJEr4baoKJWJXniqCWPuBGjBXXahwhuzDOonedzoeaDJ1HTrZ3XFIva3TvWbru8Eb8gtfnGmX2qZj3MkYfxXNH3TAdw4+Irg4oaSAjQYrzX7j+gTHWBtGP7HKEl//vPvwKiXaVD/ryAq9KC0Uu0tAdylcFM4krQ3r//THDIC4nOyTUI5XFuaahnYi48l2Go0KqecsMTIQVlHJFpQlvoJa0bwoccfY6Wrr6z9OzIcIGSEhWk1vfhKaCBl14XQUajMyy1vZ+RShFwSEonFDoHDrGFoMq5ShHaWESgLT1NUHm0xgqHwEVBxDNtAWczkQpiTOVleeqh4IrPkYRFQHqTF7o3jtVJ6Tw4LctgCEksEH1tokLM3BB+EgusDafDDD0XEjOYl8QiglRnCE21kRkqgwSdB0PiRYqBqfPcepC4QBtyL0RyVkoJRlMbEFzSI6sfW2LkLVeOOmCtUBuazn3Galr5g4yMr4fwUX1U15QspUNKACnUvZt8VAO47dLsAyZOeJx+39bDcrncq4OXu5gL4fMyAYtGb3HzcBiqpg/vPl6yiHm0hbuaXdNDMm13z0dkjgLxqGmOPA3NsVneqMbePARQo5IiReWw18rOL96/gwUcD2MW9Sr/CxQevbv88e2v12+JL/Wmuv7Gw3gYh3VQO19w1RO18xZv+tpO8W62ff5/+nhvWqDHlR8ZyUWYHs0srzv/Ldvp/NOI5dp5Ot9sEu7wNyurio7rJzTNg0w4snb7iL7Hde/JHxbfev4/Stu8zbekU/qwgmjDoIrankwCa8x5mqLpC9ibzDvj7eLtDYsYL32+OwvuwyxofhD39kqte7x3h0StAP0lmz4L2GzqOVNVHX199SiiMbClpthMq6r6B+p1XhI=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"}}');var n=a(74848),l=a(28453),s=a(33617),o=a.n(s),p=a(17543),r=a.n(p),m=a(86013),c=a.n(m),d=a(63723),u=a.n(d),g=(a(18766),a(79329),a(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:"eJzdV1tv2zYU/iunfNkKyLacWzs/NdiKLFixFEiGAkuNgJKOLTYUyZGULzD0tl+yn7ZfMhzqYjlu4mYr+rCXxCLPd+43bpjnc8cmt+wGCyO5R8emEcvQpVYYL7RiE3aTI1ygh5YE3gnn4fz9JXAp9dLBWpfgNVj0VuACgYMkCj0DvuBC8kQi+Jb/EG5y4WBWqpT4cyn8GozVC5GhA65AL9AuBC4DXsotMgJUPJFCzaF0aB3JTHOtHcLM6gJwJZyn2w4ByxwVpBZ5OM90WhaovBuyiGmDlpMGlxmbsDn6FkW6s4gZbnmBHi25Z8MUL5BNmBSFoFtBjvmjRLtmEbP4RyksZmwy49JhxJxfS6KeaVuwiOHKSJ0hm3hb0m2aY8HZZMMKvhJFWbDJaRxHzK8NgVRZJGhZRTheGGI0jquoU8HdC/PVNHhcZlxNia8zWjl0RHsUx/RvNzlcmabo3KyU0HmURSzVyqPyRM+NkSINF6NPjkCbfQV08gnT4HZLbLyoRVp0pfQ9Om4tJ4OFx8IdxtfHFOGO0nkr1JxFwTXc908629lq/HOiCnf0fk4+8cLT6T6LLcCFH13mEUppfwDUUkMgrUglmaH9VmbV+fSUgrU+EAirrSM6xe8ahUl1cchFuffGTUajFkw1PEx1QWi9VDt2P+WsUM661SpiTsxVqNJ/myRWH1I9Rf1lDvukERIMamHBhTxInSC+aQ5aX5hcqwNiTk7PjsbHr1+NiX4psjn6/2B/fbsvb7fQz6nXYwYLLkt0MADyO/elxQic54UZHki+jp6UXu03nx66O+nQRycnVcTWz0S9GpN/ngk6fl1FLH8m6OSMIsfn+Ezc+LNldV2n9F0b2uopqlCZDlV2qa7sbvtItJbIVV8gDYAqYqGIMDv3TyfaUXx0PBjHg/jVzfhscvLD5PRsGMfx7yxiqyJkdzOUsqbptUq236XJvomcsBngjS6/zHyLmbCY+rvSfrZGn8pjEhcWn7tCZ2LWjDb3tNwwlilQu+b058XD+O5GXSgpFN61A/nuKI7vzoikithJfLo/mC/VgkuRhT3tRt+jevH1xjJaqw+06754X4vfN1/UROGe7RjbP6+NdJiWVvh12MZWA27EoL6f3E5pVSnQ57pZ5cL65nM2YaMHW51Du2hXuhD7biw5rrJEr4baoKJWJXniqCWPuBGjBXXahwhuzDOonedzoeaDJ1HTrZ3XFIva3TvWbru8Eb8gtfnGmX2qZj3MkYfxXNH3TAdw4+Irg4oaSAjQYrzX7j+gTHWBtGP7HKEl//vPvwKiXaVD/ryAq9KC0Uu0tAdylcFM4krQ3r//THDIC4nOyTUI5XFuaahnYi48l2Go0KqecsMTIQVlHJFpQlvoJa0bwoccfY6Wrr6z9OzIcIGSEhWk1vfhKaCBl14XQUajMyy1vZ+RShFwSEonFDoHDrGFoMq5ShHaWESgLT1NUHm0xgqHwEVBxDNtAWczkQpiTOVleeqh4IrPkYRFQHqTF7o3jtVJ6Tw4LctgCEksEH1tokLM3BB+EgusDafDDD0XEjOYl8QiglRnCE21kRkqgwSdB0PiRYqBqfPcepC4QBtyL0RyVkoJRlMbEFzSI6sfW2LkLVeOOmCtUBuazn3Galr5g4yMr4fwUX1U15QspUNKACnUvZt8VAO47dLsAyZOeJx+39bDcrncq4OXu5gL4fMyAYtGb3HzcBiqpg/vPl6yiHm0hbuaXdNDMm13z0dkjgLxqGmOPA3NsVneqMbePARQo5IiReWw18rOL96/gwUcD2MW9Sr/CxQevbv88e2v12+JL/Wmuv7Gw3gYh3VQO19w1RO18xZv+tpO8W62ff5/+nhvWqDHlR8ZyUWYHs0srzv/Ldvp/NOI5dp5Ot9sEu7wNyurio7rJzTNg0w4snb7iL7Hde/JHxbfev4/Stu8zbekU/qwgmjDoIrankwCa8x5mqLpC9ibzDvj7eLtDYsYL32+OwvuwyxofhD39kqte7x3h0StAP0lmz4L2GzqOVNVHX199SiiMbClpthMq6r6B+p1XhI=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,f={},h=[];function x(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Template list"}),"\n",(0,n.jsx)(o(),{method:"get",path:"/templatelist",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,n.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.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,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:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},xml:{name:"template"},title:"template"}}},title:"inline_response_200_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.ccc1511d.js b/assets/js/770b40a9.ccc1511d.js new file mode 100644 index 000000000..4316a5f66 --- /dev/null +++ b/assets/js/770b40a9.ccc1511d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7605],{71625:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>h,default:()=>j,frontMatter:()=>y,metadata:()=>a,toc:()=>x});const a=JSON.parse('{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","source":"@site/docs/API-docs/gettemplatelist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/gettemplatelist","permalink":"/docs/API-docs/gettemplatelist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar_label":"Get Template list","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWFtv2zYU/iunfNkKyLacWzs/NdiKLFixFEiGAkuNgJKOLTYUyZGULzD0tl+yn7ZfMhzqYjlu4mYr+rCXJCLPx3O/ZcM8nzs2uWU3WBjJPTo2jViGLrXCeKEVm7CbHOECPbQk8E44D+fvL4FLqZcO1roEr8GitwIXCBwkUegZ8AUXkicSwbfvD+EmFw5mpUrpfS6FX4OxeiEydMAV6AXahcBlwEu5RUaAiidSqDmUDq0jnmmutUOYWV0AroTzdNshYJmjgtQiD+eZTssClXdDFjFt0HKS4DJjEzZH36JIdhYxwy0v0KMl82yY4gWyCZOiEHQryDB/lGjXLGIW/yiFxYxNZlw6jJjza0nUM20LFjFcGakzZBNvS7pNcyw4m2xYwVeiKAs2OY3jiPm1IZAqiwQtqwjHC0MPjeMq6kRw98J8NQke5xlXU3rXGa0cOqI9imP6tRscrkxTdG5WSugsyiKWauVReaLnxkiRhovRJ0egzb4AOvmEaTC7pWe8qFladKX0PTpuLSeFhcfCHcbXx+ThjtJ5K9ScRcE03PdPOt3Zavxzogp39H5ONvHC0+n+E1uAC390kUcopf0BUEsNgbQikWSG9lupVcfTUwLW8kAgrLaG6AS/awQm0cUhE+XeGzcZjVow5fAw1QWh9VLt6P2UsUI661aqiDkxVyFL/22QWH1I9BT1lxnsk0ZIMIiFBRfyIHWC+KY5aG1hcq0OsDk5PTsaH79+NSb6pcjm6P+D/vXtPr/dRD+nWo8ZLLgs0cEAyO7clxYjcJ4XZngg+Dp6Enq1X3x66O6kQx+dnFQRWz8T9WpM9nkm6Ph1FbH8maCTM/Icn+MzcePPptV1HdJ3rWurp6hCZjpU2aW6srvlI9FaIld9htQAqoiFJMLs3D8daEfx0fFgHA/iVzfjs8nJD5PTs2Ecx7+ziK2KEN1NU8qaotcK2X6XJvsmfMJkgDe6/DL1LWbCYurvSvvZHH0qjoldGHzuCp2JWdPa3NN8Q1smR+2q0+8XD/2763WhpFB41zbku6M4vjsjkipiJ/HpfmO+VAsuRRbmtBt9j+rF12vLaK0+UK777H3Nfl99UROFe7ajbP+8VtJhWlrh12EaWw24EYP6fnI7pVGlQJ/rZpQL45vP2YSNHkx1Du2iHemC77u25LjKEr0aaoOKSpXkiaOSPOJGjBZUaR8iuDHPoMZy8DyA83wu1Pxp1HRrmGtyXu2fHfNs24IRvyD1hcb6fapmnsyRh35e0fdMB3DjkyuDiipO8OhivNcfPqBMdYE0lPscoSX/+8+/AqKdvUPAvYCr0oLRS7Q0OHKVwUziStCisL9XOOSFROfkGoTyOLc0BWRiLjyXoQvRbJ9ywxMhBYUokWlCW+hFuRvChxx9jpauvrO0p2S4QEmRDVLr+7A7aOCl10Xg0cgMS23vZyRSBByS0gmFzoFDbCGocq5ShNYXEWhLuwwqj9ZY4RC4KIh4pi3gbCZSQQ9TPlqeeii44nMkZhGQ3GSFbimyOimdB6dlGRQhjgWir1VUiJkbwk9igbXidJih50JiBvOSnogg1RlCk56khsogQefBEHuRYnjUeW49SFygDbEXPDkrpQSjqW4ILmkr6/uWHvKWK0clsxaodU1nPmM17QiBR8bXQ/ioPqprCpbSIQWAFOreTT6qAdx2YfYBEyc8Tr9v82G5XO7lwctdzIXweZmARaO3uHk4DFnTh3cfL1nEPNrCXc2uafNM22H1EZ6jQDxqqilPQzVtpj3KsTcPAVTZpEhROezVvvOL9+9gAcfDmEW9zP8CgUfvLn98++v1W3qXilmdf+NhPIzD/KidL7jqsdpZ3ptCuJO8m21j+J9u+00J9LjyIyO5CO2maf51q7hlO61iGrFcO0/nm03CHf5mZVXRcb1zUwPJhCNtt1v3Pa57/yMIk3I9MDxK2yzzW9IpfVhBtKGzRW1NJoY15jxN0fQZ7LXynX548faGRYyXPt/tBfehFzR/0OvtlVr33t5tErUA9JN0+ixgs6n7TFV19PXVo4hGwZaafDOtquofbaBvPQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Template","permalink":"/docs/API-docs/delete-template"},"next":{"title":"Get Webhook","permalink":"/docs/API-docs/get-webhook"}}');var s=i(74848),l=i(28453),n=i(33617),p=i.n(n),o=i(17543),r=i.n(o),m=i(86013),c=i.n(m),d=i(63723),u=i.n(d),f=(i(18766),i(79329),i(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:"eJzdWFtv2zYU/iunfNkKyLacWzs/NdiKLFixFEiGAkuNgJKOLTYUyZGULzD0tl+yn7ZfMhzqYjlu4mYr+rCXJCLPx3O/ZcM8nzs2uWU3WBjJPTo2jViGLrXCeKEVm7CbHOECPbQk8E44D+fvL4FLqZcO1roEr8GitwIXCBwkUegZ8AUXkicSwbfvD+EmFw5mpUrpfS6FX4OxeiEydMAV6AXahcBlwEu5RUaAiidSqDmUDq0jnmmutUOYWV0AroTzdNshYJmjgtQiD+eZTssClXdDFjFt0HKS4DJjEzZH36JIdhYxwy0v0KMl82yY4gWyCZOiEHQryDB/lGjXLGIW/yiFxYxNZlw6jJjza0nUM20LFjFcGakzZBNvS7pNcyw4m2xYwVeiKAs2OY3jiPm1IZAqiwQtqwjHC0MPjeMq6kRw98J8NQke5xlXU3rXGa0cOqI9imP6tRscrkxTdG5WSugsyiKWauVReaLnxkiRhovRJ0egzb4AOvmEaTC7pWe8qFladKX0PTpuLSeFhcfCHcbXx+ThjtJ5K9ScRcE03PdPOt3Zavxzogp39H5ONvHC0+n+E1uAC390kUcopf0BUEsNgbQikWSG9lupVcfTUwLW8kAgrLaG6AS/awQm0cUhE+XeGzcZjVow5fAw1QWh9VLt6P2UsUI661aqiDkxVyFL/22QWH1I9BT1lxnsk0ZIMIiFBRfyIHWC+KY5aG1hcq0OsDk5PTsaH79+NSb6pcjm6P+D/vXtPr/dRD+nWo8ZLLgs0cEAyO7clxYjcJ4XZngg+Dp6Enq1X3x66O6kQx+dnFQRWz8T9WpM9nkm6Ph1FbH8maCTM/Icn+MzcePPptV1HdJ3rWurp6hCZjpU2aW6srvlI9FaIld9htQAqoiFJMLs3D8daEfx0fFgHA/iVzfjs8nJD5PTs2Ecx7+ziK2KEN1NU8qaotcK2X6XJvsmfMJkgDe6/DL1LWbCYurvSvvZHH0qjoldGHzuCp2JWdPa3NN8Q1smR+2q0+8XD/2763WhpFB41zbku6M4vjsjkipiJ/HpfmO+VAsuRRbmtBt9j+rF12vLaK0+UK777H3Nfl99UROFe7ajbP+8VtJhWlrh12EaWw24EYP6fnI7pVGlQJ/rZpQL45vP2YSNHkx1Du2iHemC77u25LjKEr0aaoOKSpXkiaOSPOJGjBZUaR8iuDHPoMZy8DyA83wu1Pxp1HRrmGtyXu2fHfNs24IRvyD1hcb6fapmnsyRh35e0fdMB3DjkyuDiipO8OhivNcfPqBMdYE0lPscoSX/+8+/AqKdvUPAvYCr0oLRS7Q0OHKVwUziStCisL9XOOSFROfkGoTyOLc0BWRiLjyXoQvRbJ9ywxMhBYUokWlCW+hFuRvChxx9jpauvrO0p2S4QEmRDVLr+7A7aOCl10Xg0cgMS23vZyRSBByS0gmFzoFDbCGocq5ShNYXEWhLuwwqj9ZY4RC4KIh4pi3gbCZSQQ9TPlqeeii44nMkZhGQ3GSFbimyOimdB6dlGRQhjgWir1VUiJkbwk9igbXidJih50JiBvOSnogg1RlCk56khsogQefBEHuRYnjUeW49SFygDbEXPDkrpQSjqW4ILmkr6/uWHvKWK0clsxaodU1nPmM17QiBR8bXQ/ioPqprCpbSIQWAFOreTT6qAdx2YfYBEyc8Tr9v82G5XO7lwctdzIXweZmARaO3uHk4DFnTh3cfL1nEPNrCXc2uafNM22H1EZ6jQDxqqilPQzVtpj3KsTcPAVTZpEhROezVvvOL9+9gAcfDmEW9zP8CgUfvLn98++v1W3qXilmdf+NhPIzD/KidL7jqsdpZ3ptCuJO8m21j+J9u+00J9LjyIyO5CO2maf51q7hlO61iGrFcO0/nm03CHf5mZVXRcb1zUwPJhCNtt1v3Pa57/yMIk3I9MDxK2yzzW9IpfVhBtKGzRW1NJoY15jxN0fQZ7LXynX548faGRYyXPt/tBfehFzR/0OvtlVr33t5tErUA9JN0+ixgs6n7TFV19PXVo4hGwZaafDOtquofbaBvPQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,g={},x=[];function v(e){const t={p:"p",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.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)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(r(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,s.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},xml:{name:"template"},title:"template"}}},title:"inline_response_200_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,l.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/78b2b753.10d27add.js b/assets/js/78b2b753.10d27add.js new file mode 100644 index 000000000..e1c39c21f --- /dev/null +++ b/assets/js/78b2b753.10d27add.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1519],{30818:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>Y,contentTitle:()=>f,default:()=>v,frontMatter:()=>u,metadata:()=>n,toc:()=>k});const n=JSON.parse('{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/deletefolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletefolder","permalink":"/docs/API-docs/deletefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar_label":"Delete Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tuGzcQ/ZUJX5oAK2mlOGm7TzUaN3UTxEGdIkBtwRjtzkqMuCRDcnWBsG/9kn5av6SYvegSyUadFn2xJc79dma0EQGnXiQ34iejMnJiHImMfOqkDdJokYgPM4KMFAWChgXO318CKmWWHtamhGA6el7T+yISxpJDVnCZiUQ05IYqImHRYUGBHNvdCI0FiUQ05DuZiUhINmwxzMSX3pjJJ0rDZQYmh61CR59L6SgTSXAlRcKHtWKVXhZWkYgErawyGYkkR+WZIZ1RgSLZiLC2NWdwUk9FJHLjCgz7L7TCWksiJm+GaZ6NZnYiqmrMZr012pNnRaM45n+H3voyTcn7vFSwzYiIRGp0IB2YH61VMq0Jg0+ehTbH3jVBc+YcqwmyMdnl4rFx/Dz3o18sLS+tqKK2ONl5OKVmJzSKR897w7gXf/th+DI5+z558bIfx/HvIhKrQrFsW8cMA7HeIIPafd97kFpJTXdd9u5GcXw3HImqYqazU2nstaUG6UGbAFTYsI6A04hSe8hMWhakAxjX9eCt7sG1KSjMpJ7CkolLZ/Q0AqsIPUFwa8ApSg0KA7knt/+qMEbTVV5382GJyDnjHk7so0PjTEVfYehR6WAj4/trdhbHd8+3JTs7LlkbFYeUm1Jn/f+u7e8N9aGeP/bnoZY8i8/uvtuG9+I4vEu9QCWzGgqDmZN+8j/Et4vmhHl29XAQZcNU08VBsPvvTZCe0tLJsK5beNVDK3sNPbkZcx9w55gdlNcgHmYiEYMmsYPNFr4rwercooP30imRiFkI1ieDgUedTcyqbyxpL6da4cT3U1MM0MrBYii4sw8l0NpHcFPZe5yADziVevqw1HiXoWuuYlOogzxty4VWvqG1iLoy7HO1m21GyIuLEy91bmrhtjhXlvS1nOq6tIvh0f77SCo1BfHSDTOCjv2vP/6sJTq4qDvvCVyVDqxZkuMNhDqDXNFKThSd2OGesFDkvVqD1IGmDgNBJqcyoALOCiNHihYnUknuVWYzLO1gr919Hz7OKMzIMekbR4CQ0YIUtzgoY+asJxjAMpiittFB3NK4ec4uRYAwKb3U5D14ok6E9Ax1StDVImJURA2kAznrpCdAWTBzbhxQnstUsmIeTIdpgAI1TomNRcB+cxasMwuZkQdnJqUP4I0q60DYYkEUmhA1Ueb78EouqAmcHzMKKBVlMC1ZBeN2RtDOKYehM5iQD2DZvEypVuoDugCKFuTq3qsrmZdKgTUMIBIVnzf7tWVFwaH2jHGNQ11ptumzzvCxUdvIcN2HW32rGfSh9MQNoKSe+4Q34822zT7SxMtA46fdPCyXy6M5eHYo81qGWTkBR9bs5Kb1Yz01++LbL89EJAK5wl/l1+QWMqV2CO+xOaiZBy2sYlrDKhUoVTNjP3wpwBCnZEra0x4Inr9+/xYW8Lwfi2hv8v+Bw4O3lz9evLu+YL0MZs38DftxP+Yna3woUO+ZerV/JH85uJvddvi6i7pFl0CrMLAKZQ3pdUCbFotvxPYgTnbH9DgSM+MDkzebCXr6zamq4ufPJTkG/HEkFugkThiAbjYik54/Z9tr+d5Anv7aHt7P4ORdftLnDiY1Y+QCVcnfRCTmtD74FVCNq6hDSnaroZ+nKdmwJ3m0aQ/W1auLtxcfLkQksOQU7YP0vAbp9gMbOOnYIXo3PvBfXiQnBTabZgFU1Za/Id0r0cbYcXOWxlVV/Q3wsrwd","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/folderlist"}}');var i=o(74848),d=o(28453),r=o(33617),s=o.n(r),l=o(17543),a=o.n(l),c=o(86013),p=o.n(c),m=o(63723),I=o.n(m),h=(o(18766),o(79329),o(9303));const u={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tuGzcQ/ZUJX5oAK2mlOGm7TzUaN3UTxEGdIkBtwRjtzkqMuCRDcnWBsG/9kn5av6SYvegSyUadFn2xJc79dma0EQGnXiQ34iejMnJiHImMfOqkDdJokYgPM4KMFAWChgXO318CKmWWHtamhGA6el7T+yISxpJDVnCZiUQ05IYqImHRYUGBHNvdCI0FiUQ05DuZiUhINmwxzMSX3pjJJ0rDZQYmh61CR59L6SgTSXAlRcKHtWKVXhZWkYgErawyGYkkR+WZIZ1RgSLZiLC2NWdwUk9FJHLjCgz7L7TCWksiJm+GaZ6NZnYiqmrMZr012pNnRaM45n+H3voyTcn7vFSwzYiIRGp0IB2YH61VMq0Jg0+ehTbH3jVBc+YcqwmyMdnl4rFx/Dz3o18sLS+tqKK2ONl5OKVmJzSKR897w7gXf/th+DI5+z558bIfx/HvIhKrQrFsW8cMA7HeIIPafd97kFpJTXdd9u5GcXw3HImqYqazU2nstaUG6UGbAFTYsI6A04hSe8hMWhakAxjX9eCt7sG1KSjMpJ7CkolLZ/Q0AqsIPUFwa8ApSg0KA7knt/+qMEbTVV5382GJyDnjHk7so0PjTEVfYehR6WAj4/trdhbHd8+3JTs7LlkbFYeUm1Jn/f+u7e8N9aGeP/bnoZY8i8/uvtuG9+I4vEu9QCWzGgqDmZN+8j/Et4vmhHl29XAQZcNU08VBsPvvTZCe0tLJsK5beNVDK3sNPbkZcx9w55gdlNcgHmYiEYMmsYPNFr4rwercooP30imRiFkI1ieDgUedTcyqbyxpL6da4cT3U1MM0MrBYii4sw8l0NpHcFPZe5yADziVevqw1HiXoWuuYlOogzxty4VWvqG1iLoy7HO1m21GyIuLEy91bmrhtjhXlvS1nOq6tIvh0f77SCo1BfHSDTOCjv2vP/6sJTq4qDvvCVyVDqxZkuMNhDqDXNFKThSd2OGesFDkvVqD1IGmDgNBJqcyoALOCiNHihYnUknuVWYzLO1gr919Hz7OKMzIMekbR4CQ0YIUtzgoY+asJxjAMpiittFB3NK4ec4uRYAwKb3U5D14ok6E9Ax1StDVImJURA2kAznrpCdAWTBzbhxQnstUsmIeTIdpgAI1TomNRcB+cxasMwuZkQdnJqUP4I0q60DYYkEUmhA1Ueb78EouqAmcHzMKKBVlMC1ZBeN2RtDOKYehM5iQD2DZvEypVuoDugCKFuTq3qsrmZdKgTUMIBIVnzf7tWVFwaH2jHGNQ11ptumzzvCxUdvIcN2HW32rGfSh9MQNoKSe+4Q34822zT7SxMtA46fdPCyXy6M5eHYo81qGWTkBR9bs5Kb1Yz01++LbL89EJAK5wl/l1+QWMqV2CO+xOaiZBy2sYlrDKhUoVTNjP3wpwBCnZEra0x4Inr9+/xYW8Lwfi2hv8v+Bw4O3lz9evLu+YL0MZs38DftxP+Yna3woUO+ZerV/JH85uJvddvi6i7pFl0CrMLAKZQ3pdUCbFotvxPYgTnbH9DgSM+MDkzebCXr6zamq4ufPJTkG/HEkFugkThiAbjYik54/Z9tr+d5Anv7aHt7P4ORdftLnDiY1Y+QCVcnfRCTmtD74FVCNq6hDSnaroZ+nKdmwJ3m0aQ/W1auLtxcfLkQksOQU7YP0vAbp9gMbOOnYIXo3PvBfXiQnBTabZgFU1Za/Id0r0cbYcXOWxlVV/Q3wsrwd",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,Y={},k=[];function g(e){const t={p:"p",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,i.jsx)(s(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,i.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.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,i.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(I(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"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 v(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/78b2b753.5bb2f535.js b/assets/js/78b2b753.5bb2f535.js deleted file mode 100644 index f898c5269..000000000 --- a/assets/js/78b2b753.5bb2f535.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1519],{30818:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>u,contentTitle:()=>g,default:()=>U,frontMatter:()=>I,metadata:()=>l,toc:()=>b});const l=JSON.parse('{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","source":"@site/docs/API-docs/deletefolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletefolder","permalink":"/docs/API-docs/deletefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar_label":"Delete Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu20YQ/ZXJvjQBKIlSnLTlU43GTd0EcVCnCFBbMEbkUNpoubvZXeoCgW/9kn5av6QYXnSJZKNOi77Y4s79dmY2IuDUi+RG/GRURk6MI5GRT520QRotEvFhRpCRokDQsMD5+0tApczSw9qUEExHz2t6X0TCWHLICi4zkYiG3FBFJCw6LCiQY7sbobEgkYiGfCczEQnJhi2GmfjSGzP5RGm4zMDksFXo6HMpHWUiCa6kSPiwVqzSy8IqEpGglVUmI5HkqDwzpDMqUCQbEda25gxO6qmIRG5cgWH/hVZYa0nE5M0wzbPRzE5EVY3ZrLdGe/KsaBTH/O/QW1+mKXmflwq2GRGRSI0OpAPzo7VKpjVh8Mmz0ObYuyZozpxjNUE2JrtcPDaOn+d+9Iul5aUVVdQWJzsPp9TshEbx6HlvGPfibz8MXyZn3ycvXvbjOP5dRGJVKJZt65hhINYbZFC7770HqZXUdNdl724Ux3fDkagqZjo7lcZeW2qQHrQJQIUN6wg4jSi1h8ykZUE6gHFdD97qHlybgsJM6iksmbh0Rk8jsIrQEwS3Bpyi1KAwkHty+68KYzRd5XU3H5aInDPu4cQ+OjTOVPQVhh6VDjYyvr9mZ3F893xbsrPjkrVRcUi5KXXW/+/a/t5QH+r5Y38easmz+Ozuu214L47Du9QLVDKroTCYOekn/0N8u2hOmGdXDwdRNkw1XRwEu//eBOkpLZ0M67qFVz20stfQk5sx9wF3jtlBeQ3iYSYSMWgSO9hs4bsSrM4tOngvnRKJmIVgfTIYeNTZxKz6xpL2cqoVTnw/NcUArRwshoI7+1ACrX0Etw84lXrae1BqvAv4movS5P0g7G320co3tBZRl9V9rnZRzQh5D3Eepc5NLdzm+sqSvpZTXVdqMTxaZx9JpaYg3qFhRtCx//XHn7VEN/11Iz2Bq9KBNUtyvFBQZ5ArWsmJohMr2RMWirxXa5A60NRhIMjkVAZUwFlhIEjR4kQqya3HbIalHex1r+/DxxmFGTkmfeMIEDJakOKOBWXMnPUEA1gGU9Q2OsRaGjfP2aUIECall5q8B0/UiZCeoU4JulpEDHKogXQgZ530BCgLZs6NA8pzmUpWzHPmMA1QoMYpsbEI2G/OgnVmITPy4Myk9AG8UWUdCFssiEIToibKfB9eyQU1gfNjRgGlogymJatgGM4I2rHjMHQGE/IBLJuXKdVKfUAXQNGCXN17dSXzUimwhvFAouJrZb+2rCg41J4hq3GoK802fdYZvh1qGxmu+3CrbzVjOJSeuAGU1HOf8KK72bbZR5p4GWj8tJuH5XJ5NAfPDmVeyzArJ+DImp3ctH6sp2ZffPvxTEQikCv8VX5NbiFTaofwHpuDmnnQoiSmNUpSgVI1M/bDlwKMWEqmpD3tYdr56/dvYQHP+7GI9ib/Hzg8eHv548W76wvWy9jUzN+wH/djfrLGhwL1nqlX+zfvl4O72YH91x3ILboEWoWBVShrhK4D2rTQeiO2922yu43HkZgZH5i82UzQ029OVRU/fy7JMX6PI7FAJ3HCAHSzEZn0/DvbHr/3BvL01/aOfgYnz+yTPncwqRkjF6hK/hKRmNP64KivxlXUISW71dDP05Rs2JM8WpwH2+fVxduLDxciElhyivZBel6DdPuDDZx07BC9Gx/4Ly+SkwKbTbMAqmrL35DulWhj7Lg5S+Oqqv4G0heq8g==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"},"next":{"title":"Get folder list","permalink":"/docs/API-docs/folderlist"}}');var i=o(74848),n=o(28453),r=o(33617),s=o.n(r),d=o(17543),a=o.n(d),p=o(86013),c=o.n(p),m=o(63723),h=o.n(m),f=(o(18766),o(79329),o(9303));const I={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:"eJy9Vttu20YQ/ZXJvjQBKIlSnLTlU43GTd0EcVCnCFBbMEbkUNpoubvZXeoCgW/9kn5av6QYXnSJZKNOi77Y4s79dmY2IuDUi+RG/GRURk6MI5GRT520QRotEvFhRpCRokDQsMD5+0tApczSw9qUEExHz2t6X0TCWHLICi4zkYiG3FBFJCw6LCiQY7sbobEgkYiGfCczEQnJhi2GmfjSGzP5RGm4zMDksFXo6HMpHWUiCa6kSPiwVqzSy8IqEpGglVUmI5HkqDwzpDMqUCQbEda25gxO6qmIRG5cgWH/hVZYa0nE5M0wzbPRzE5EVY3ZrLdGe/KsaBTH/O/QW1+mKXmflwq2GRGRSI0OpAPzo7VKpjVh8Mmz0ObYuyZozpxjNUE2JrtcPDaOn+d+9Iul5aUVVdQWJzsPp9TshEbx6HlvGPfibz8MXyZn3ycvXvbjOP5dRGJVKJZt65hhINYbZFC7770HqZXUdNdl724Ux3fDkagqZjo7lcZeW2qQHrQJQIUN6wg4jSi1h8ykZUE6gHFdD97qHlybgsJM6iksmbh0Rk8jsIrQEwS3Bpyi1KAwkHty+68KYzRd5XU3H5aInDPu4cQ+OjTOVPQVhh6VDjYyvr9mZ3F893xbsrPjkrVRcUi5KXXW/+/a/t5QH+r5Y38easmz+Ozuu214L47Du9QLVDKroTCYOekn/0N8u2hOmGdXDwdRNkw1XRwEu//eBOkpLZ0M67qFVz20stfQk5sx9wF3jtlBeQ3iYSYSMWgSO9hs4bsSrM4tOngvnRKJmIVgfTIYeNTZxKz6xpL2cqoVTnw/NcUArRwshoI7+1ACrX0Etw84lXrae1BqvAv4movS5P0g7G320co3tBZRl9V9rnZRzQh5D3Eepc5NLdzm+sqSvpZTXVdqMTxaZx9JpaYg3qFhRtCx//XHn7VEN/11Iz2Bq9KBNUtyvFBQZ5ArWsmJohMr2RMWirxXa5A60NRhIMjkVAZUwFlhIEjR4kQqya3HbIalHex1r+/DxxmFGTkmfeMIEDJakOKOBWXMnPUEA1gGU9Q2OsRaGjfP2aUIECall5q8B0/UiZCeoU4JulpEDHKogXQgZ530BCgLZs6NA8pzmUpWzHPmMA1QoMYpsbEI2G/OgnVmITPy4Myk9AG8UWUdCFssiEIToibKfB9eyQU1gfNjRgGlogymJatgGM4I2rHjMHQGE/IBLJuXKdVKfUAXQNGCXN17dSXzUimwhvFAouJrZb+2rCg41J4hq3GoK802fdYZvh1qGxmu+3CrbzVjOJSeuAGU1HOf8KK72bbZR5p4GWj8tJuH5XJ5NAfPDmVeyzArJ+DImp3ctH6sp2ZffPvxTEQikCv8VX5NbiFTaofwHpuDmnnQoiSmNUpSgVI1M/bDlwKMWEqmpD3tYdr56/dvYQHP+7GI9ib/Hzg8eHv548W76wvWy9jUzN+wH/djfrLGhwL1nqlX+zfvl4O72YH91x3ILboEWoWBVShrhK4D2rTQeiO2922yu43HkZgZH5i82UzQ029OVRU/fy7JMX6PI7FAJ3HCAHSzEZn0/DvbHr/3BvL01/aOfgYnz+yTPncwqRkjF6hK/hKRmNP64KivxlXUISW71dDP05Rs2JM8WpwH2+fVxduLDxciElhyivZBel6DdPuDDZx07BC9Gx/4Ly+SkwKbTbMAqmrL35DulWhj7Lg5S+Oqqv4G0heq8g==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,u={},b=[];function H(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Delete Folder"}),"\n",(0,i.jsx)(s(),{method:"delete",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,i.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.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,i.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,i.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 U(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(H,{...e})}):H(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.5f0c09d6.js b/assets/js/7b076186.5f0c09d6.js deleted file mode 100644 index fba1c643e..000000000 --- a/assets/js/7b076186.5f0c09d6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9938],{90736:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>f,default:()=>x,frontMatter:()=>k,metadata:()=>a,toc:()=>y});const a=JSON.parse('{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/deletecontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletecontact","permalink":"/docs/API-docs/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVVm1v2zYQ/itXfmkLKLaTph2mT8vaoAtWrMWSocBSIziLZ4k1RbIk5RcY+rZfsp+2XzKcJNty7AQtMBTYl8Qi7/W5u+e4FhHzINJb8dqaiFkMYpwISSHzykVljUjFTUHwhjRFgk4ILj5cAWptFwFWtoJowVNp5wQIWScy9bbkS785mVg7G8DVtNEwFrQ1OXkwRBIQHPqoskrjVv5pAGWm1pfIcSQQCxUaxyXOKICKQBhW7Fu2wcWClAdPmfVyIBJhHflG90qKVLRCnW2RCIceS4rkOfu1MFiSSEV3f6ekSITi7B3GQtyH5IO3cyUJ7OQzZfFKgp1uE98GJBLh6UulPEmRRl9RIkJcaXYTVOk0C9DSaStJpFPUgQWygkoU6VrElWsko1cmF4lokeif0BIbK6lwxdmkOMMgRV2P2Wtw1gQKbOdsNOJ/+/Fv6tgGKiFUWUYhTCutV09E0sBAJrIiOqdV1uA4/BxYe30YZYsDo+oZ9aha3xt4juWzi/7nJcfufnEvRJ10dZIX8XGls9HZi5PT0cnoh5vTV+n5j+nLV4PRaPSnSMSy1KzbVVRiJLYbVdS77/pArC1ZX7A7qVn4/BiK17akWCiTw4JMhIW3Jk/AacJAEP0KMEdlQGMk/x+iSt5b/zg63xZZ3ctaGa0M3W1a6O58NLo73YJw/nArGRthaisjv2+mR9w/ns753dk2nZeH6VyZOWolG6K5sTMy3zedvvvYuj/sVdUKNfdiL9n+eZtkoKzyKq4aklueoFMn7X16O2au4D6xO35siDEWIhXDjs+G6x0n1oIN+vmGNCuvRSqKGF1Ih8OARk7scmAdmaByo3ESBpkth+jUcH4q6uS+Bjr3DdIhYq5MfvKo1niX8jWXpUV+L/Et/ujUr7QSyQbXvlTH/gWhJN/UgJdRo9yh/d6RuVa5aWo1Pz3YER9JZ7Yk3gexINiI//PX342GtFlVkolNKz2B95UHZxfkp5UGNBKmmpZqounIrg2EpaYQ9AqUiZR7jARS5SqiBkaFBz9DhxOlFTcfi9l2Gff6NwzgY0GxIM9XTz1vb0lz0tyzoK2dsZ1oAatoy8ZHFzMsrJ9NOaQEECZVUIZCgEC0USFToMkINrVIwHpAA2QieedVIEBVsvDUeqDpVGWKDXOveZ7nEg3mxM4S4LgZBddu3QDeTqoQIVhdNYmwx5IotinyiyIM4I2aU5s4H0qKqDRJyCs2kUBmJUE3eJyGkTChEMGxe5VRYzRE9BE0zck3vddUkrckOMuMoFDz6u/Xlg1Fjybwwm4D2pRmC5/zltdt40PiagCfzCfDnA1VIG4ArcwspJ/MCdxu2+wjTYKKNH62mYfFYnEwB8/3dd6qWFQT8OTsTi9vDpup6atvP56LRETyZXg/vSY/Vxl1Q/iAz2EjPOx4kl9XzHUlKt3O2E/3FZiztMrIBOqx2sXbD+9gDi8GI5H0Jv8rAh6+u3p9+dv1Jdtlbmrn73QwGoz4yNkQSzQ9V/uv2fuTu97x/f/27dsxXKRlHDqNqtkTDajrjuBvxe4tnPaeveNEFDZEFlivJxjoD6/rmo+/VOR5j4wTMUevcMI0eLsWUgX+LbeP2AfRfPZ79x5+Dl/7gj6ayIa/DZP3HHXFXyIRM1rtv+HrcZ1sOJxDbQUusoxc7KkeLPW9zfjm8t3lzaVIBFYMXH99zJr10f1gB0cj298rbQz8l1fcUYX1ul1Ndb2Vb68e1Ohy3EgzTOO6rv8FvfTXCQ==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"}}');var n=o(74848),i=o(28453),c=o(33617),s=o.n(c),l=o(17543),r=o.n(l),d=o(86013),p=o.n(d),I=o(63723),u=o.n(I),m=(o(18766),o(79329),o(9303));const k={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:"eJzVVm1v2zYQ/itXfmkLKLaTph2mT8vaoAtWrMWSocBSIziLZ4k1RbIk5RcY+rZfsp+2XzKcJNty7AQtMBTYl8Qi7/W5u+e4FhHzINJb8dqaiFkMYpwISSHzykVljUjFTUHwhjRFgk4ILj5cAWptFwFWtoJowVNp5wQIWScy9bbkS785mVg7G8DVtNEwFrQ1OXkwRBIQHPqoskrjVv5pAGWm1pfIcSQQCxUaxyXOKICKQBhW7Fu2wcWClAdPmfVyIBJhHflG90qKVLRCnW2RCIceS4rkOfu1MFiSSEV3f6ekSITi7B3GQtyH5IO3cyUJ7OQzZfFKgp1uE98GJBLh6UulPEmRRl9RIkJcaXYTVOk0C9DSaStJpFPUgQWygkoU6VrElWsko1cmF4lokeif0BIbK6lwxdmkOMMgRV2P2Wtw1gQKbOdsNOJ/+/Fv6tgGKiFUWUYhTCutV09E0sBAJrIiOqdV1uA4/BxYe30YZYsDo+oZ9aha3xt4juWzi/7nJcfufnEvRJ10dZIX8XGls9HZi5PT0cnoh5vTV+n5j+nLV4PRaPSnSMSy1KzbVVRiJLYbVdS77/pArC1ZX7A7qVn4/BiK17akWCiTw4JMhIW3Jk/AacJAEP0KMEdlQGMk/x+iSt5b/zg63xZZ3ctaGa0M3W1a6O58NLo73YJw/nArGRthaisjv2+mR9w/ns753dk2nZeH6VyZOWolG6K5sTMy3zedvvvYuj/sVdUKNfdiL9n+eZtkoKzyKq4aklueoFMn7X16O2au4D6xO35siDEWIhXDjs+G6x0n1oIN+vmGNCuvRSqKGF1Ih8OARk7scmAdmaByo3ESBpkth+jUcH4q6uS+Bjr3DdIhYq5MfvKo1niX8jWXpUV+L/Et/ujUr7QSyQbXvlTH/gWhJN/UgJdRo9yh/d6RuVa5aWo1Pz3YER9JZ7Yk3gexINiI//PX342GtFlVkolNKz2B95UHZxfkp5UGNBKmmpZqounIrg2EpaYQ9AqUiZR7jARS5SqiBkaFBz9DhxOlFTcfi9l2Gff6NwzgY0GxIM9XTz1vb0lz0tyzoK2dsZ1oAatoy8ZHFzMsrJ9NOaQEECZVUIZCgEC0USFToMkINrVIwHpAA2QieedVIEBVsvDUeqDpVGWKDXOveZ7nEg3mxM4S4LgZBddu3QDeTqoQIVhdNYmwx5IotinyiyIM4I2aU5s4H0qKqDRJyCs2kUBmJUE3eJyGkTChEMGxe5VRYzRE9BE0zck3vddUkrckOMuMoFDz6u/Xlg1Fjybwwm4D2pRmC5/zltdt40PiagCfzCfDnA1VIG4ArcwspJ/MCdxu2+wjTYKKNH62mYfFYnEwB8/3dd6qWFQT8OTsTi9vDpup6atvP56LRETyZXg/vSY/Vxl1Q/iAz2EjPOx4kl9XzHUlKt3O2E/3FZiztMrIBOqx2sXbD+9gDi8GI5H0Jv8rAh6+u3p9+dv1Jdtlbmrn73QwGoz4yNkQSzQ9V/uv2fuTu97x/f/27dsxXKRlHDqNqtkTDajrjuBvxe4tnPaeveNEFDZEFlivJxjoD6/rmo+/VOR5j4wTMUevcMI0eLsWUgX+LbeP2AfRfPZ79x5+Dl/7gj6ayIa/DZP3HHXFXyIRM1rtv+HrcZ1sOJxDbQUusoxc7KkeLPW9zfjm8t3lzaVIBFYMXH99zJr10f1gB0cj298rbQz8l1fcUYX1ul1Ndb2Vb68e1Ohy3EgzTOO6rv8FvfTXCQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,h={},y=[];function v(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:"Delete Contact"}),"\n",(0,n.jsx)(s(),{method:"delete",path:"/contact/{contact_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,n.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.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,n.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function 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/7b076186.8278821f.js b/assets/js/7b076186.8278821f.js new file mode 100644 index 000000000..f98ddbb15 --- /dev/null +++ b/assets/js/7b076186.8278821f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9938],{90736:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>b,default:()=>j,frontMatter:()=>I,metadata:()=>n,toc:()=>A});const n=JSON.parse('{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","source":"@site/docs/API-docs/deletecontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletecontact","permalink":"/docs/API-docs/deletecontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar_label":"Delete Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVVt1u2zYUfpVT3rQFFNtJ0w7T1bI26IIVa7FkKLDUCI7FY4k1RbIk5R8YutuT7NH2JMORZFuOnaAFhgK7SSzyO/+H3zlrETEPIr0Vr62JmMUgxomQFDKvXFTWiFTcFARvSFMk6EBw8eEKUGu7CLCyFUQLnko7J0DIOsjU25Iv/eZkYu1sAFfTRsJY0Nbk5MEQSUBw6KPKKo1b/NMAykytL5H9SCAWKjSGS5xRABWBMKzYtmydiwUpD54y6+VAJMI68o3slRSpaEGdbpEIhx5LiuQ5+rUwWJJIRXd/p6RIhOLoHcZC3E/JB2/nShLYyWfK4pUEO90GvnVIJMLTl0p5kiKNvqJEhLjSbCao0mkG0NJpK0mkU9SBAVlBJYp0LeLKNcjolclFItpM9E9oiY2WVLjibFKcYZCirsdsNThrAgXWczYa8b99/zd1bB2VEKosoxCmldarJyJp0kAmsiA6p1XW5HH4ObD0+tDLNg+cVc9Zj6q1vUnPsXh23v+8ZN/dL+6FqJOuTvIiPi50Njp7cXI6Ohn9cHP6Kj3/MX35ajAajf4UiViWmmW7ikqMxHqjinr3XR/A2pL1gd1JzeDzY1m8tiXFQpkcFmQiLLw1eQJOEwaC6FeAOSoDGiP5/zCr5L31j2fn2zyre1Ero5Whu00L3Z2PRnen2yScP9xKxkaY2srI7xvpEfOPh3N+d7YN5+VhOFdmjlrJhmhu7IzM9w2nbz625g97VbWg5l7sBds/b4MMlFVexVVDcssTdOqkvU9vx8wV3Cd2x48NMcZCpGLY8dlwvePEWrBCP9+QZuW1SEURowvpcBjQyIldDqwjE1RuNE7CILPlEJ0azk9FndyXQOe+AU3VybcJhIi5MvnjUuNdjq65jm2p9jK1LRg69SutRLIpRB/VjYuCUJJvisbTqxHuyvPekblWuWmKOz89GCofSWe2JB4gsSDYwP/56+9GQtqsKsnEpveewPvKg7ML8tNKAxoJU01LNdF0ZDgHwlJTCHoFykTKPUYCqXIVUQNnhZkiQ4cTpRV3K8NsO717DR8G8LGgWJDnq6eex72kOWluctDWzlhPtIBVtGVjo/MZFtbPpuxSAgiTKihDIUAg2oiQKdBkBJtaJGA9oAEykbzzKhCgKhk8tR5oOlWZYsXcnJ4JoESDObGxBNhvzoJrx3QAbydViBCsrppA2GJJFNsQeQUJA3ij5tQGzoeSIipNEvKKVSSQWUnQvVQOw0iYUIjg2LzKqFEaIvoImubkm95rKsljFZxlClGoeVfo15YVRY8m8IRvHdqUZps+5y3P58aGxNUAPplPhkkeqkDcAFqZWUg/mRO43bbZR5oEFWn8bPMeFovFwTt4vi/zVsWimoAnZ3dyeXPYvJq++PbjuUhEJF+G99Nr8nOVUfcIH7A5bMDDjlh5HWNyLFHp9o39dF+ASU6rjEygHg1evP3wDubwYjASSe/lf4XDw3dXry9/u75kvUxm7fs7HYwGIz5yNsQSTc/U/vp7/+WudwPif7ssdwwXaRmHTqNqBkuT1HU3EW7FbnlOe3vyOBGFDZEB6/UEA/3hdV3z8ZeKPA+ecSLm6BVOmAZv10KqwL/ldut9MJvPfu8W6OfwtSv30UA2/G2YvOeoK/4SiZjRan/pr8d1suFwdrUFXGQZudgTPdgC9kbpm8t3lzeXIhFYceL642PWjI/uBxs46tn+XGl94L884o4KrNftaKrrLb69elCii3GD5jSN67r+F+LK6DQ=","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"},"next":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"}}');var 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),u=o(63723),m=o.n(u),h=(o(18766),o(79329),o(9303));const I={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:"eJzVVt1u2zYUfpVT3rQFFNtJ0w7T1bI26IIVa7FkKLDUCI7FY4k1RbIk5R8YutuT7NH2JMORZFuOnaAFhgK7SSzyO/+H3zlrETEPIr0Vr62JmMUgxomQFDKvXFTWiFTcFARvSFMk6EBw8eEKUGu7CLCyFUQLnko7J0DIOsjU25Iv/eZkYu1sAFfTRsJY0Nbk5MEQSUBw6KPKKo1b/NMAykytL5H9SCAWKjSGS5xRABWBMKzYtmydiwUpD54y6+VAJMI68o3slRSpaEGdbpEIhx5LiuQ5+rUwWJJIRXd/p6RIhOLoHcZC3E/JB2/nShLYyWfK4pUEO90GvnVIJMLTl0p5kiKNvqJEhLjSbCao0mkG0NJpK0mkU9SBAVlBJYp0LeLKNcjolclFItpM9E9oiY2WVLjibFKcYZCirsdsNThrAgXWczYa8b99/zd1bB2VEKosoxCmldarJyJp0kAmsiA6p1XW5HH4ObD0+tDLNg+cVc9Zj6q1vUnPsXh23v+8ZN/dL+6FqJOuTvIiPi50Njp7cXI6Ohn9cHP6Kj3/MX35ajAajf4UiViWmmW7ikqMxHqjinr3XR/A2pL1gd1JzeDzY1m8tiXFQpkcFmQiLLw1eQJOEwaC6FeAOSoDGiP5/zCr5L31j2fn2zyre1Ero5Whu00L3Z2PRnen2yScP9xKxkaY2srI7xvpEfOPh3N+d7YN5+VhOFdmjlrJhmhu7IzM9w2nbz625g97VbWg5l7sBds/b4MMlFVexVVDcssTdOqkvU9vx8wV3Cd2x48NMcZCpGLY8dlwvePEWrBCP9+QZuW1SEURowvpcBjQyIldDqwjE1RuNE7CILPlEJ0azk9FndyXQOe+AU3VybcJhIi5MvnjUuNdjq65jm2p9jK1LRg69SutRLIpRB/VjYuCUJJvisbTqxHuyvPekblWuWmKOz89GCofSWe2JB4gsSDYwP/56+9GQtqsKsnEpveewPvKg7ML8tNKAxoJU01LNdF0ZDgHwlJTCHoFykTKPUYCqXIVUQNnhZkiQ4cTpRV3K8NsO717DR8G8LGgWJDnq6eex72kOWluctDWzlhPtIBVtGVjo/MZFtbPpuxSAgiTKihDIUAg2oiQKdBkBJtaJGA9oAEykbzzKhCgKhk8tR5oOlWZYsXcnJ4JoESDObGxBNhvzoJrx3QAbydViBCsrppA2GJJFNsQeQUJA3ij5tQGzoeSIipNEvKKVSSQWUnQvVQOw0iYUIjg2LzKqFEaIvoImubkm95rKsljFZxlClGoeVfo15YVRY8m8IRvHdqUZps+5y3P58aGxNUAPplPhkkeqkDcAFqZWUg/mRO43bbZR5oEFWn8bPMeFovFwTt4vi/zVsWimoAnZ3dyeXPYvJq++PbjuUhEJF+G99Nr8nOVUfcIH7A5bMDDjlh5HWNyLFHp9o39dF+ASU6rjEygHg1evP3wDubwYjASSe/lf4XDw3dXry9/u75kvUxm7fs7HYwGIz5yNsQSTc/U/vp7/+WudwPif7ssdwwXaRmHTqNqBkuT1HU3EW7FbnlOe3vyOBGFDZEB6/UEA/3hdV3z8ZeKPA+ecSLm6BVOmAZv10KqwL/ldut9MJvPfu8W6OfwtSv30UA2/G2YvOeoK/4SiZjRan/pr8d1suFwdrUFXGQZudgTPdgC9kbpm8t3lzeXIhFYceL642PWjI/uBxs46tn+XGl94L884o4KrNftaKrrLb69elCii3GD5jSN67r+F+LK6DQ=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,v={},A=[];function F(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"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)(h.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)(m(),{id:void 0,label:void 0,responses:{200:{description:"Contact deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Contact not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact not found!"}},title:"inline_response_404_2"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,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/8a725248.8dd48c73.js b/assets/js/8a725248.8dd48c73.js deleted file mode 100644 index 9309671b3..000000000 --- a/assets/js/8a725248.8dd48c73.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8672],{96752:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>z,frontMatter:()=>h,metadata:()=>n,toc:()=>j});const n=JSON.parse('{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/createcontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createcontact","permalink":"/docs/API-docs/createcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar_label":"Create Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV+tq5DYUfpWz+tMuOHNJslvqX5tulyW0NKFJWWh2CMf2GVuJLGkleS4M869P0kfrk5Qj23PLhQbKlkIIHuncb9/RSgQsvUhvxHujA+bBi0kiCvK5kzZIo0UqriuC944wEHREcHZ5DqiUmXtYmgaCAZpOjQuKvFdLyFtqTXPIO7EQKgyQowbmRw9elpqch6lxLMOBrK1xAXWAwuRNTTr4gUiEseSQLTkvRCpayZ1QkQhHXxry4QdTLEW6OjD80pmZLAgyUmYOFh3WFMixuZ2FW0H8RTqwELRWyTzqHN55lrQSPq+oRv5ijdJRwTGjGqUSidBYE8ctLC2JVJjsjqJQ69j6IMkzZ6RKVz2VD07qUiRialyNYfeEFlhbxUR3hs0nsU46ZS/nz4jedQeD3NQsylZGv9iU8fHJ8fhkfHI8Fut1IoIM8XgvI7cZJ2LN99s4BddQPPDWaN/G4ng0epivvrpakQX4Js/J+2mj1PLVS3L0fB7aYy6nlwXAVuOsWhzfWQ7h/zyZp+OT8XH8YxFdwM/CY2K2TMej45Oj8eho9N31+G16+n365u1gNBr9LhKxqNW2xEWBIXrZ10j/u7HFV9CzPiTrirOggFL5XYa+/9exZE8fK8orU1OopC5hTjrA3BldJmAVoScIbglYotSgMJD7F4uUnDPu+TC9zLLdnpVaSU23fUfeno5Gt+NNEMZPdyYqR1gsgRbSB/913X3KhucdG+849uahY+d6hkoWEdCuzT3pr+vTrvrQqn9YvrIlivdiz9nd89ZJT3njZFiK9GYlFkdo5VF7n95M1pNEcMUYBlJrfLQYQyVSMTzEVU9uRs5HMY1TIhVVCNanw6FHXWRmMTCWNGO4wszzKBqilcMZj5NDDrT2BdQ+YCl1efQs12Tr6RVnow34nr+bsKOVP9GyR+l0jyoRkqugIizIxdBzkn/dLhUf+lRtstEP8c0Mf2wsb6byHmqytqmJpnUpvLCkr2SpYwHMxuJw9fpEKjc18cYSKoKe/K8//owc/aIU6/MVXDQOrJmTmzYKUBcwVbSQmaJH9jVPWHfbmtSBSsfrUCFLGVDF3YznSo4WM6kkVzSTmXZT22kKP4BPFYWK4hL3jSNAKGhGihsBlDH3LCcYwCaYOurobIa5cfdTNikBhKzxUpP34Il6FtIV6pygz3QCxgFqIB3IWSc9AcqaiXmHpOlU5pIFcxU7nhQ1aiyJlSXAdnMUbLsTenAma3wAb1QTHWGNNVFoXdREhR/Aj3JGreN82AIIFVA2LCKB3BQEXd7ZDV1ARj6AZfUypyjUB3QBFM3IxcqOmeSdBqzhMSNRgZnu5ZYFBYfaM4S3BvWp2YTPOsPLUdRR4HIAn/VnzZAAjScuACX1vU8/6yO42ZTZJ8q8DDT5tu+2+Xz+oMte7/N8lKFqMnBkzZavjIexJ3fZNz9ei0QEcrW/mF6Rm8mcuhZ/QucwEg+74csziAdo12Bo5btDBu4mJXPSfrc5zz5e/gwzOBmMRLIzV/6BwcOfz99/+OXqA8vlydf233gwGozikmV8qFHvqNp/ER127moLIv/x+6mbgoEWYWgVygghMTSrbvrfHLyqJomoGB3SG7FaZejpN6fWaz7+0pBjaJkkYoZOYsZD7GayTvoJynBxT8sOrUmHo2tWz+SqaYfxAZ4yALQcZ3lONjxLuwtglxdX1yIRWffyq03BPA7n/CrEuUhFfDzG3o7vNj5bCYW6bLCMkzzK5KGPDcdhFzHuI2J0H+xVf6WXOxbuQ0nrBv9npx5lWK1aNFqvN/Tt1ZMcXWB7ak7fZL1e/w2TjHFk","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"}}');var o=a(74848),r=a(28453),s=a(33617),c=a.n(s),i=a(17543),l=a.n(i),p=a(86013),d=a.n(p),m=a(63723),u=a.n(m),f=(a(18766),a(79329),a(9303));const h={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+tq5DYUfpWz+tMuOHNJslvqX5tulyW0NKFJWWh2CMf2GVuJLGkleS4M869P0kfrk5Qj23PLhQbKlkIIHuncb9/RSgQsvUhvxHujA+bBi0kiCvK5kzZIo0UqriuC944wEHREcHZ5DqiUmXtYmgaCAZpOjQuKvFdLyFtqTXPIO7EQKgyQowbmRw9elpqch6lxLMOBrK1xAXWAwuRNTTr4gUiEseSQLTkvRCpayZ1QkQhHXxry4QdTLEW6OjD80pmZLAgyUmYOFh3WFMixuZ2FW0H8RTqwELRWyTzqHN55lrQSPq+oRv5ijdJRwTGjGqUSidBYE8ctLC2JVJjsjqJQ69j6IMkzZ6RKVz2VD07qUiRialyNYfeEFlhbxUR3hs0nsU46ZS/nz4jedQeD3NQsylZGv9iU8fHJ8fhkfHI8Fut1IoIM8XgvI7cZJ2LN99s4BddQPPDWaN/G4ng0epivvrpakQX4Js/J+2mj1PLVS3L0fB7aYy6nlwXAVuOsWhzfWQ7h/zyZp+OT8XH8YxFdwM/CY2K2TMej45Oj8eho9N31+G16+n365u1gNBr9LhKxqNW2xEWBIXrZ10j/u7HFV9CzPiTrirOggFL5XYa+/9exZE8fK8orU1OopC5hTjrA3BldJmAVoScIbglYotSgMJD7F4uUnDPu+TC9zLLdnpVaSU23fUfeno5Gt+NNEMZPdyYqR1gsgRbSB/913X3KhucdG+849uahY+d6hkoWEdCuzT3pr+vTrvrQqn9YvrIlivdiz9nd89ZJT3njZFiK9GYlFkdo5VF7n95M1pNEcMUYBlJrfLQYQyVSMTzEVU9uRs5HMY1TIhVVCNanw6FHXWRmMTCWNGO4wszzKBqilcMZj5NDDrT2BdQ+YCl1efQs12Tr6RVnow34nr+bsKOVP9GyR+l0jyoRkqugIizIxdBzkn/dLhUf+lRtstEP8c0Mf2wsb6byHmqytqmJpnUpvLCkr2SpYwHMxuJw9fpEKjc18cYSKoKe/K8//owc/aIU6/MVXDQOrJmTmzYKUBcwVbSQmaJH9jVPWHfbmtSBSsfrUCFLGVDF3YznSo4WM6kkVzSTmXZT22kKP4BPFYWK4hL3jSNAKGhGihsBlDH3LCcYwCaYOurobIa5cfdTNikBhKzxUpP34Il6FtIV6pygz3QCxgFqIB3IWSc9AcqaiXmHpOlU5pIFcxU7nhQ1aiyJlSXAdnMUbLsTenAma3wAb1QTHWGNNVFoXdREhR/Aj3JGreN82AIIFVA2LCKB3BQEXd7ZDV1ARj6AZfUypyjUB3QBFM3IxcqOmeSdBqzhMSNRgZnu5ZYFBYfaM4S3BvWp2YTPOsPLUdRR4HIAn/VnzZAAjScuACX1vU8/6yO42ZTZJ8q8DDT5tu+2+Xz+oMte7/N8lKFqMnBkzZavjIexJ3fZNz9ei0QEcrW/mF6Rm8mcuhZ/QucwEg+74csziAdo12Bo5btDBu4mJXPSfrc5zz5e/gwzOBmMRLIzV/6BwcOfz99/+OXqA8vlydf233gwGozikmV8qFHvqNp/ER127moLIv/x+6mbgoEWYWgVygghMTSrbvrfHLyqJomoGB3SG7FaZejpN6fWaz7+0pBjaJkkYoZOYsZD7GayTvoJynBxT8sOrUmHo2tWz+SqaYfxAZ4yALQcZ3lONjxLuwtglxdX1yIRWffyq03BPA7n/CrEuUhFfDzG3o7vNj5bCYW6bLCMkzzK5KGPDcdhFzHuI2J0H+xVf6WXOxbuQ0nrBv9npx5lWK1aNFqvN/Tt1ZMcXWB7ak7fZL1e/w2TjHFk",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,g={},j=[];function x(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(c(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,o.jsx)(f.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)(u(),{id:void 0,label:void 0,responses:{200:{description:"Contact created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"ph1bhx2jp"},name:{type:"string",format:"string",example:"joe bee"},email:{type:"string",format:"string",example:"joebee@example.com"},phone:{type:"string",format:"string",example:"4131231231"},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"contactdetails"},title:"contact"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Contact already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Contact already exists!"}},title:"inline_response_401_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function z(e={}){const{wrapper:t}={...(0,r.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/8a725248.f50392f4.js b/assets/js/8a725248.f50392f4.js new file mode 100644 index 000000000..4eba20262 --- /dev/null +++ b/assets/js/8a725248.f50392f4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8672],{96752:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>j,default:()=>T,frontMatter:()=>f,metadata:()=>n,toc:()=>g});const n=JSON.parse('{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","source":"@site/docs/API-docs/createcontact.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createcontact","permalink":"/docs/API-docs/createcontact","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar_label":"Create Contact","hide_title":true,"hide_table_of_contents":true,"api":"eJzVV+tq5DYUfpWz+tMuOHNJslvqX5tulyW0NKFJWWh2CMf2GVuJLGkleS4M869P0kfrk5Qj23PLhQbKlkIIHuncb9/RSgQsvUhvxHujA+bBi0kiCvK5kzZIo0UqriuC944wEHREcHZ5DqiUmXtYmgaCAZpOjQuKvFdLyFtqTXPIO7EQKgyQowbmRw9elpqch6lxLMOBrK1xAXWAwuRNTTr4gUiEseSQLTkvRCpayZ1QkQhHXxry4QdTLEW6OjD80pmZLAgyUmYOFh3WFMixuZ2FW0H8RTqwELRWyTzqHN55lrQSPq+oRv5ijdJRwTGjGqUSidBYE8ctLC2JVJjsjqJQ69j6IMkzZ6RKVz2VD07qUiRialyNYfeEFlhbxUR3hs0nsU46ZS/nz4jedQeD3NQsylZGv9iU8fHJ8fhkfHI8Fut1IoIM8XgvI7cZJ2LN99s4BddQPPDWaN/G4ng0epivvrpakQX4Js/J+2mj1PLVS3L0fB7aYy6nlwXAVuOsWhzfWQ7h/zyZp+OT8XH8YxFdwM/CY2K2TMej45Oj8eho9N31+G16+n365u1gNBr9LhKxqNW2xEWBIXrZ10j/u7HFV9CzPiTrirOggFL5XYa+/9exZE8fK8orU1OopC5hTjrA3BldJmAVoScIbglYotSgMJD7F4uUnDPu+TC9zLLdnpVaSU23fUfeno5Gt+NNEMZPdyYqR1gsgRbSB/913X3KhucdG+849uahY+d6hkoWEdCuzT3pr+vTrvrQqn9YvrIlivdiz9nd89ZJT3njZFiK9GYlFkdo5VF7n95M1pNEcMUYBlJrfLQYQyVSMTzEVU9uRs5HMY1TIhVVCNanw6FHXWRmMTCWNGO4wszzKBqilcMZj5NDDrT2BdTUHL2MwQcspS6f55psQ3PF6WsztBegTZ7Qyp9o2cN6ukeVCMllUxEW5GKuuCp+3W4hH/rcbtLXT/3N0H9sjm/G+B7MsrapiaZ1Ob+wpK9kqWPFzMbicFf7RCo3NfGKEyqCnvyvP/6MHP1mFQv6FVw0DqyZk5s2ClAXMFW0kJmiRxY8T1h3653UgUrH+1MhSxlQxWWOB1GOFjOpJLcAk5l2tdvpIj+ATxWFiuLW940jQChoRoo7B5Qx9ywnGMAmmDrq6GyGuXH3UzYpAYSs8VKT9+CJehbSFeqcoM90AsYBaiAdyFknPQHKmol56aTpVOaSBXPZOx4tNWosiZUlwHZzFGy7RHpwJmt8AG9UEx1hjTVRaF3URIUfwI9yRq3jfNgiDhVQNiwigdwUBF3e2Q1dQEY+gGX1Mqco1Ad0ARTNyMXKjpnkJQis4bkkUYGZ7uWWBQWH2jPmtwb1qdmEzzrD21TUUeByAJ/1Z80YAo0nLgAl9b1PP+sjuNmU2SfKvAw0+bbvtvl8/qDLXu/zfJShajJwZM2Wr4yHsSd32Tc/XotEBHK1v5hekZvJnLoWf0LnMBIPu2nNQ4snbtdgaOW7QwbuJiVz0n63Oc8+Xv4MMzgZjESyM1f+gcHDn8/ff/jl6gPL5VHZ9t94MBqM4lZmfKhR76jaf0Iddu5qizr/8YOrm4KBFmFoFcqIOTE0qw4ubg6eYZNEVAwn6Y1YrTL09JtT6zUff2nIMRZNEjFDJzHjIXYzWSf9BGV8uadlB++kw9E1q2dy1bTD+ACAGQBajrM8Jxuepd1FvMuLq2uRiKx7KtamYB6Hc35G4lykIr42Y2/Hhx6frYRCXTZYxkkeZfLQx4bjsIsY9xExug/2qr/Syx0L96GkdYP/s1OPMqxWLRqt1xv69upJji6wPTWnb7Jer/8GmNGCjw==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/get-user"},"next":{"title":"Get Contact","permalink":"/docs/API-docs/getcontact"}}');var o=a(74848),s=a(28453),r=a(33617),i=a.n(r),c=a(17543),l=a.n(c),p=a(86013),d=a.n(p),u=a(63723),m=a.n(u),h=(a(18766),a(79329),a(9303));const f={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+tq5DYUfpWz+tMuOHNJslvqX5tulyW0NKFJWWh2CMf2GVuJLGkleS4M869P0kfrk5Qj23PLhQbKlkIIHuncb9/RSgQsvUhvxHujA+bBi0kiCvK5kzZIo0UqriuC944wEHREcHZ5DqiUmXtYmgaCAZpOjQuKvFdLyFtqTXPIO7EQKgyQowbmRw9elpqch6lxLMOBrK1xAXWAwuRNTTr4gUiEseSQLTkvRCpayZ1QkQhHXxry4QdTLEW6OjD80pmZLAgyUmYOFh3WFMixuZ2FW0H8RTqwELRWyTzqHN55lrQSPq+oRv5ijdJRwTGjGqUSidBYE8ctLC2JVJjsjqJQ69j6IMkzZ6RKVz2VD07qUiRialyNYfeEFlhbxUR3hs0nsU46ZS/nz4jedQeD3NQsylZGv9iU8fHJ8fhkfHI8Fut1IoIM8XgvI7cZJ2LN99s4BddQPPDWaN/G4ng0epivvrpakQX4Js/J+2mj1PLVS3L0fB7aYy6nlwXAVuOsWhzfWQ7h/zyZp+OT8XH8YxFdwM/CY2K2TMej45Oj8eho9N31+G16+n365u1gNBr9LhKxqNW2xEWBIXrZ10j/u7HFV9CzPiTrirOggFL5XYa+/9exZE8fK8orU1OopC5hTjrA3BldJmAVoScIbglYotSgMJD7F4uUnDPu+TC9zLLdnpVaSU23fUfeno5Gt+NNEMZPdyYqR1gsgRbSB/913X3KhucdG+849uahY+d6hkoWEdCuzT3pr+vTrvrQqn9YvrIlivdiz9nd89ZJT3njZFiK9GYlFkdo5VF7n95M1pNEcMUYBlJrfLQYQyVSMTzEVU9uRs5HMY1TIhVVCNanw6FHXWRmMTCWNGO4wszzKBqilcMZj5NDDrT2BdTUHL2MwQcspS6f55psQ3PF6WsztBegTZ7Qyp9o2cN6ukeVCMllUxEW5GKuuCp+3W4hH/rcbtLXT/3N0H9sjm/G+B7MsrapiaZ1Ob+wpK9kqWPFzMbicFf7RCo3NfGKEyqCnvyvP/6MHP1mFQv6FVw0DqyZk5s2ClAXMFW0kJmiRxY8T1h3653UgUrH+1MhSxlQxWWOB1GOFjOpJLcAk5l2tdvpIj+ATxWFiuLW940jQChoRoo7B5Qx9ywnGMAmmDrq6GyGuXH3UzYpAYSs8VKT9+CJehbSFeqcoM90AsYBaiAdyFknPQHKmol56aTpVOaSBXPZOx4tNWosiZUlwHZzFGy7RHpwJmt8AG9UEx1hjTVRaF3URIUfwI9yRq3jfNgiDhVQNiwigdwUBF3e2Q1dQEY+gGX1Mqco1Ad0ARTNyMXKjpnkJQis4bkkUYGZ7uWWBQWH2jPmtwb1qdmEzzrD21TUUeByAJ/1Z80YAo0nLgAl9b1PP+sjuNmU2SfKvAw0+bbvtvl8/qDLXu/zfJShajJwZM2Wr4yHsSd32Tc/XotEBHK1v5hekZvJnLoWf0LnMBIPu2nNQ4snbtdgaOW7QwbuJiVz0n63Oc8+Xv4MMzgZjESyM1f+gcHDn8/ff/jl6gPL5VHZ9t94MBqM4lZmfKhR76jaf0Iddu5qizr/8YOrm4KBFmFoFcqIOTE0qw4ubg6eYZNEVAwn6Y1YrTL09JtT6zUff2nIMRZNEjFDJzHjIXYzWSf9BGV8uadlB++kw9E1q2dy1bTD+ACAGQBajrM8Jxuepd1FvMuLq2uRiKx7KtamYB6Hc35G4lykIr42Y2/Hhx6frYRCXTZYxkkeZfLQx4bjsIsY9xExug/2qr/Syx0L96GkdYP/s1OPMqxWLRqt1xv69upJji6wPTWnb7Jer/8GmNGCjw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,y={},g=[];function x(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Create Contact"}),"\n",(0,o.jsx)(i(),{method:"post",path:"/createcontact",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(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)(m(),{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 T(e={}){const{wrapper:t}={...(0,s.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/8a855f99.0210056e.js b/assets/js/8a855f99.0210056e.js deleted file mode 100644 index e2ab70aa7..000000000 --- a/assets/js/8a855f99.0210056e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9180],{31752:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>u,default:()=>j,frontMatter:()=>m,metadata:()=>r,toc:()=>S});const r=JSON.parse('{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/updatefolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/updatefolder","permalink":"/docs/API-docs/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oA8l4cJ231VDdNUzdBYsQOAtRZGJQ00jKmSIakdr1Y6K1f0k/rlxRDSrta78aogaYveyFnhjNnLodcM88rx9Ir9quWBVo2S1iBLrfCeKEVS9nlHOGDKbhHiCJwen4GXEq9dLDSDXgNjQ77ZdxXvEbgDpYoJX0bblH5qHxWjFjCtEHLyf5ZwVLWBOtRmSXMcMtr9GjJrTUjayxlcftaFCxhgvwy3M/ZXWd19hlzf1aALmFj0OKXRlgsWOptgwlzfiXJpBO1kcgShrdG6gJZWnLpSCCfY81ZumZ+ZYKkt0JVLGGltjX3wxW85cFKyrLX07wsjucmY207i8ei8z/rYkWmdh09t3ohCoQMpV7CJmQCM7e4BZMlLNfKo/JkgxsjRR6QG392ZGg9cHYb51UHV8BulvRhRHQIYksZ8AId6UXZtwHnh4WscNn72YbEDfL8UFusbRPmhZeDbGeEXdvSjkVntHLR4+PJZB9S1+Q5Olc2Ejb19RD47gepr6yHhvXbjTv+3eDyzBBEsdSLU3/IzFbpeHL89Gg6OZp8fzl9np78mD57PppMJn+whN3WknS7riBrbIBb/D9YEEoKhdc9etfHk8n1dNphenIIxgtdo58LVcESlYel1apKwEjkDsHbFfCKCwWSe7SP/jt80Vpt70flYZ7dh8IJobAB4WQfhH6SaQ+lblQYWt860PuqaN+f+8M7uf5hE96z/fDO1IJLUYRJ7vUNqv83kQeOJ1d3S1tEobDPdoIdrscgHeaNFX4VCOP2iBtxFPfTqxmNYqobTVRjmuAwUUfKxhHV8XrDLS0jW3bRc09jJUvZ3Hvj0vHYcVVk+nakDSonKiV55ka5rsfciPFiytrkrgY35gHSzvNKqOroXq3ZNtoLykgEfSfmDfTciNe4YkkP6VCqY9E58jC924RRot9vOetln65dghjO/P2RzyhTQpU6eNFl7J1BdSEqFfK9mO6R9keUua6RuM/PEXrxv//8K2gUOm9qVD6U4yN411gweomWBj1XBZQSb0Um8cC9xCGvJTonVyCUx8oSsRaiEp5LIHhpmOTc8ExIQQVMYpq0LQx6wI3g4xz9HC1tfWcROBS4QEl1D1LrG7LjNfDG6zqc0fkMS21vSnIpAQ5Z44RC58Ah9iqo5lzlCH1SE9AWuAJUHq2xwiFwUZNwqS1gWYpckGHqVstzDzVXvEI6LAHym1Aw8XbhwOqscR6clk0IhE6sEX0MUSEWbgS/iAXGwGmxQM+FxAKqhkwkkOsCoWteCkMVkKHzYOh4kWMw6jy3HiQu0IYiDpksGynBaJoqgku6kw1zS4a85crR4IsO9anZwGesJk4PZxR8NYJP6pMiHoDGIRWAFOrGpZ/UEVxtyuwjZk54nD3uG2u5XO411JNdnVfCz5sMLBq91avCYmi/ofrmzxOWMI+2du/KC7QLkWPXzV85cxyEx92s5XmYtVhzIWOz/nRXgbpJihyVw8FkPH11/gYW8HQ0YclghPwLh8dvzl68fHvxkuzSkIv9Nx1NRpNwgdPO11wNjtq5+N9t3PWWMr7JK6GbYh5v/dhILgINhHjX3Qjv77ksYen2gTBL2Fw7T9vrdcYdfrCybWn5S4OWSGKWsAW3gmc0n67WrBCOfhebF8BX43z8vrtkP4GDb42DPvfjWNEsXnDZhPtuwm5wtfOyaWdt0k9kcivuv4iHH12Sla3+HkcToUSN0zxH4++VHZLi+YdLlrCse6fU4SXELF/S04kvo6s6YBG4JqytmeSqanhFstEkcQhvKC1DAroJBNT9oKAOgrHLTDEK+qSYDiqs15Hc2nYjH7e+qtHh2ktTZmZt2/4Dl6U4kw==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/deletefolder"}}');var n=o(74848),d=o(28453),a=o(33617),s=o.n(a),l=o(17543),i=o.n(l),p=o(86013),c=o.n(p),f=o(63723),h=o.n(f),k=(o(18766),o(79329),o(9303));const m={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l4cJ231VDdNUzdBYsQOAtRZGJQ00jKmSIakdr1Y6K1f0k/rlxRDSrta78aogaYveyFnhjNnLodcM88rx9Ir9quWBVo2S1iBLrfCeKEVS9nlHOGDKbhHiCJwen4GXEq9dLDSDXgNjQ77ZdxXvEbgDpYoJX0bblH5qHxWjFjCtEHLyf5ZwVLWBOtRmSXMcMtr9GjJrTUjayxlcftaFCxhgvwy3M/ZXWd19hlzf1aALmFj0OKXRlgsWOptgwlzfiXJpBO1kcgShrdG6gJZWnLpSCCfY81ZumZ+ZYKkt0JVLGGltjX3wxW85cFKyrLX07wsjucmY207i8ei8z/rYkWmdh09t3ohCoQMpV7CJmQCM7e4BZMlLNfKo/JkgxsjRR6QG392ZGg9cHYb51UHV8BulvRhRHQIYksZ8AId6UXZtwHnh4WscNn72YbEDfL8UFusbRPmhZeDbGeEXdvSjkVntHLR4+PJZB9S1+Q5Olc2Ejb19RD47gepr6yHhvXbjTv+3eDyzBBEsdSLU3/IzFbpeHL89Gg6OZp8fzl9np78mD57PppMJn+whN3WknS7riBrbIBb/D9YEEoKhdc9etfHk8n1dNphenIIxgtdo58LVcESlYel1apKwEjkDsHbFfCKCwWSe7SP/jt80Vpt70flYZ7dh8IJobAB4WQfhH6SaQ+lblQYWt860PuqaN+f+8M7uf5hE96z/fDO1IJLUYRJ7vUNqv83kQeOJ1d3S1tEobDPdoIdrscgHeaNFX4VCOP2iBtxFPfTqxmNYqobTVRjmuAwUUfKxhHV8XrDLS0jW3bRc09jJUvZ3Hvj0vHYcVVk+nakDSonKiV55ka5rsfciPFiytrkrgY35gHSzvNKqOroXq3ZNtoLykgEfSfmDfTciNe4YkkP6VCqY9E58jC924RRot9vOetln65dghjO/P2RzyhTQpU6eNFl7J1BdSEqFfK9mO6R9keUua6RuM/PEXrxv//8K2gUOm9qVD6U4yN411gweomWBj1XBZQSb0Um8cC9xCGvJTonVyCUx8oSsRaiEp5LIHhpmOTc8ExIQQVMYpq0LQx6wI3g4xz9HC1tfWcROBS4QEl1D1LrG7LjNfDG6zqc0fkMS21vSnIpAQ5Z44RC58Ah9iqo5lzlCH1SE9AWuAJUHq2xwiFwUZNwqS1gWYpckGHqVstzDzVXvEI6LAHym1Aw8XbhwOqscR6clk0IhE6sEX0MUSEWbgS/iAXGwGmxQM+FxAKqhkwkkOsCoWteCkMVkKHzYOh4kWMw6jy3HiQu0IYiDpksGynBaJoqgku6kw1zS4a85crR4IsO9anZwGesJk4PZxR8NYJP6pMiHoDGIRWAFOrGpZ/UEVxtyuwjZk54nD3uG2u5XO411JNdnVfCz5sMLBq91avCYmi/ofrmzxOWMI+2du/KC7QLkWPXzV85cxyEx92s5XmYtVhzIWOz/nRXgbpJihyVw8FkPH11/gYW8HQ0YclghPwLh8dvzl68fHvxkuzSkIv9Nx1NRpNwgdPO11wNjtq5+N9t3PWWMr7JK6GbYh5v/dhILgINhHjX3Qjv77ksYen2gTBL2Fw7T9vrdcYdfrCybWn5S4OWSGKWsAW3gmc0n67WrBCOfhebF8BX43z8vrtkP4GDb42DPvfjWNEsXnDZhPtuwm5wtfOyaWdt0k9kcivuv4iHH12Sla3+HkcToUSN0zxH4++VHZLi+YdLlrCse6fU4SXELF/S04kvo6s6YBG4JqytmeSqanhFstEkcQhvKC1DAroJBNT9oKAOgrHLTDEK+qSYDiqs15Hc2nYjH7e+qtHh2ktTZmZt2/4Dl6U4kw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,g={},S=[];function H(e){const t={p:"p",...(0,d.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,n.jsx)(s(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,n.jsx)(k.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(i(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to create folder",content:{"application/json":{schema:{required:["foldername"],type:"object",properties:{folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:""}},title:"folder_body"}}}}}),"\n",(0,n.jsx)(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"},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 j(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(H,{...e})}):H(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a855f99.710b1f9e.js b/assets/js/8a855f99.710b1f9e.js new file mode 100644 index 000000000..0af994c09 --- /dev/null +++ b/assets/js/8a855f99.710b1f9e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9180],{31752:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>j,default:()=>F,frontMatter:()=>h,metadata:()=>d,toc:()=>b});const d=JSON.parse('{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","source":"@site/docs/API-docs/updatefolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/updatefolder","permalink":"/docs/API-docs/updatefolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar_label":"Update Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oA8l4cJ231VDdNUzdBYsQOAtRZGJQ00jKmSIakdr1Y6K1f0k/rlxRDSrta78aogaYveyFnhjNnLodcM88rx9Ir9quWBVo2S1iBLrfCeKEVS9nlHOGDKbhHiCJwen4GXEq9dLDSDXgNjQ77ZdxXvEbgDpYoJX0bblH5qHxWjFjCtEHLyf5ZwVLWBOtRmSXMcMtr9GjJrTUjayxlcftaFCxhgvwy3M/ZXWd19hlzf1aALmFj0OKXRlgsWOptgwlzfiXJpBO1kcgShrdG6gJZWnLpSCCfY81ZumZ+ZYKkt0JVLGGltjX3wxW85cFKyrLX07wsjucmY207i8ei8z/rYkWmdh09t3ohCoQMpV7CJmQCM7e4BZMlLNfKo/JkgxsjRR6QG392ZGg9cHYb51UHV8BulvRhRHQIYksZ8AId6UXZtwHnh4WscNn72YbEDfL8UFusbRPmhZeDbGeEXdvSjkVntHLR4+PJZB9S1+Q5Olc2Ejb19RD47gepr6yHhvXbjTv+3eDyzBBEsdSLU3/IzFbpeHL89Gg6OZp8fzl9np78mD57PppMJn+whN3WknS7riBrbIBb/D9YEEoKhdc9etfHk8n1dNphenIIxgtdo58LVcESlYel1apKwEjkDsHbFfCKCwWSe7SP/jt80Vpt70flYZ7dh8IJobAB4WQfhH6SaQ+lblQYWt860PuqaN+f+8M7uf5hE96z/fDO1IJLUYRJ7vUNqv83kQeOJ1d3S1tEobDPdoIdrscgHeaNFX4VCOP2iBtxFPfTqxmNYqobTVRjmuAwUUfKxhHV8XrDLS0jW3bRc09jJUvZ3Hvj0vHYcVVk+nakDSonKiV55ka5rsfciPFiytrkrgY35gHS2Bw9TMF5XglV3a8128JzQSmMWdoBaZMrbsRrXLGkz8FQqqPdOfIw7tuEUWW835Lcyz6/u4wyJIl9jmCUWqFKHbzoUvzOoLoQlQoFspjusfxHlLmukcjSzxF68b///CtoFDpvalQ+1O8jeNdYMHqJlpiBqwJKibcik3jgIuOQ1xKdkysQymNliYkLUQnPJRC8NH1ybngmpKCKJzFN2hYGTeNG8HGOfo6Wtr6zCBwKXKCkRgGp9Q3Z8Rp443Udzuh8hqW2NyW5lACHrHFCoXPgEHsVVHOucoQ+qQloC1wBKo/WWOEQuKhJuNQWsCxFLsgwtbfluYeaK14hHZYA+U0omHgdcWB11jgPTssmBEIn1og+hqgQCzeCX8QCY+C0WKDnQmIBVUMmEsh1gdB1O4WhCsjQeTB0vMgxGHWeWw8SF2hDEYdMlo2UYDSNIcElXeKGuSVD3nLlaFJGh/rUbOAzVtMlIJxR8NUIPqlPiogDGodUAFKoG5d+UkdwtSmzj5g54XH2uG+s5XK511BPdnVeCT9vMrBo9FavCouh/Ybqmz9PWMI82tq9Ky/QLkSOXTd/5cxxEB53w5nnYThjzYWMzfrTXQXqJilyVA4Ho/T01fkbWMDT0YQlgxHyLxwevzl78fLtxUuyS1Mx9t90NBlNwo1PO19zNThq56Vwt3HXW475Js+Kbop5vPVjI7kIvBHiXXczv78Ys4Sl2xfFLGFz7Txtr9cZd/jByral5S8NWmKVWcIW3Aqe0Xy6WrNCOPpdbJ4MX43z8fvuVv4EDj5ODvrcj2NFs3jBZRMuyAm7wdXOU6idtUk/kcmtuP8iHn50SVa2+nukToQSNU7zHI2/V3bIoucfLlnCsu5hU4enE7N8SW8tvoyu6oBF4JqwtmaSq6rhFclGk8QhvKG0DAnoJhBQ94OCOgjGLjPFKOiTYjqosF5HcmvbjXzc+qpGh2svTZmZtW37DwJYSb4=","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Folder","permalink":"/docs/API-docs/getfolder"},"next":{"title":"Delete Folder","permalink":"/docs/API-docs/deletefolder"}}');var l=o(74848),r=o(28453),n=o(33617),s=o.n(n),a=o(17543),i=o.n(a),p=o(86013),c=o.n(p),u=o(63723),f=o.n(u),m=(o(18766),o(79329),o(9303));const h={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l4cJ231VDdNUzdBYsQOAtRZGJQ00jKmSIakdr1Y6K1f0k/rlxRDSrta78aogaYveyFnhjNnLodcM88rx9Ir9quWBVo2S1iBLrfCeKEVS9nlHOGDKbhHiCJwen4GXEq9dLDSDXgNjQ77ZdxXvEbgDpYoJX0bblH5qHxWjFjCtEHLyf5ZwVLWBOtRmSXMcMtr9GjJrTUjayxlcftaFCxhgvwy3M/ZXWd19hlzf1aALmFj0OKXRlgsWOptgwlzfiXJpBO1kcgShrdG6gJZWnLpSCCfY81ZumZ+ZYKkt0JVLGGltjX3wxW85cFKyrLX07wsjucmY207i8ei8z/rYkWmdh09t3ohCoQMpV7CJmQCM7e4BZMlLNfKo/JkgxsjRR6QG392ZGg9cHYb51UHV8BulvRhRHQIYksZ8AId6UXZtwHnh4WscNn72YbEDfL8UFusbRPmhZeDbGeEXdvSjkVntHLR4+PJZB9S1+Q5Olc2Ejb19RD47gepr6yHhvXbjTv+3eDyzBBEsdSLU3/IzFbpeHL89Gg6OZp8fzl9np78mD57PppMJn+whN3WknS7riBrbIBb/D9YEEoKhdc9etfHk8n1dNphenIIxgtdo58LVcESlYel1apKwEjkDsHbFfCKCwWSe7SP/jt80Vpt70flYZ7dh8IJobAB4WQfhH6SaQ+lblQYWt860PuqaN+f+8M7uf5hE96z/fDO1IJLUYRJ7vUNqv83kQeOJ1d3S1tEobDPdoIdrscgHeaNFX4VCOP2iBtxFPfTqxmNYqobTVRjmuAwUUfKxhHV8XrDLS0jW3bRc09jJUvZ3Hvj0vHYcVVk+nakDSonKiV55ka5rsfciPFiytrkrgY35gHS2Bw9TMF5XglV3a8128JzQSmMWdoBaZMrbsRrXLGkz8FQqqPdOfIw7tuEUWW835Lcyz6/u4wyJIl9jmCUWqFKHbzoUvzOoLoQlQoFspjusfxHlLmukcjSzxF68b///CtoFDpvalQ+1O8jeNdYMHqJlpiBqwJKibcik3jgIuOQ1xKdkysQymNliYkLUQnPJRC8NH1ybngmpKCKJzFN2hYGTeNG8HGOfo6Wtr6zCBwKXKCkRgGp9Q3Z8Rp443Udzuh8hqW2NyW5lACHrHFCoXPgEHsVVHOucoQ+qQloC1wBKo/WWOEQuKhJuNQWsCxFLsgwtbfluYeaK14hHZYA+U0omHgdcWB11jgPTssmBEIn1og+hqgQCzeCX8QCY+C0WKDnQmIBVUMmEsh1gdB1O4WhCsjQeTB0vMgxGHWeWw8SF2hDEYdMlo2UYDSNIcElXeKGuSVD3nLlaFJGh/rUbOAzVtMlIJxR8NUIPqlPiogDGodUAFKoG5d+UkdwtSmzj5g54XH2uG+s5XK511BPdnVeCT9vMrBo9FavCouh/Ybqmz9PWMI82tq9Ky/QLkSOXTd/5cxxEB53w5nnYThjzYWMzfrTXQXqJilyVA4Ho/T01fkbWMDT0YQlgxHyLxwevzl78fLtxUuyS1Mx9t90NBlNwo1PO19zNThq56Vwt3HXW475Js+Kbop5vPVjI7kIvBHiXXczv78Ys4Sl2xfFLGFz7Txtr9cZd/jByral5S8NWmKVWcIW3Aqe0Xy6WrNCOPpdbJ4MX43z8fvuVv4EDj5ODvrcj2NFs3jBZRMuyAm7wdXOU6idtUk/kcmtuP8iHn50SVa2+nukToQSNU7zHI2/V3bIoucfLlnCsu5hU4enE7N8SW8tvoyu6oBF4JqwtmaSq6rhFclGk8QhvKG0DAnoJhBQ94OCOgjGLjPFKOiTYjqosF5HcmvbjXzc+qpGh2svTZmZtW37DwJYSb4=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,g={},b=[];function H(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Update Folder"}),"\n",(0,l.jsx)(s(),{method:"put",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\n",(0,l.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(i(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}]}),"\n",(0,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"}}}}}),"\n",(0,l.jsx)(f(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"Hks2JpewIp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_11"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},405:{description:"Invalid API token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function F(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(H,{...e})}):H(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.6ab5f53d.js b/assets/js/a2bc1463.6ab5f53d.js new file mode 100644 index 000000000..caefd9b4d --- /dev/null +++ b/assets/js/a2bc1463.6ab5f53d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1381],{47091:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>y,default:()=>N,frontMatter:()=>h,metadata:()=>o,toc:()=>v});const o=JSON.parse('{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/contactlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/contactlist","permalink":"/docs/API-docs/contactlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar_label":"Get Contact list","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tu20YQ/ZXJvrQBaIlyLkX5FCMNDKNBE8AuAtQRgiE5Itda7m53l7pA4Fu/pJ/WLylmScmUHad1EQQFDNvaud/OjHYiYOVFdi1eGx2wCF7ME1GSL5y0QRotMnFVEwxUeCt9gLP3F0CNNWtyHramhWDAUXCSVgQIinnMAopBYwLWmZUspa4AoTCNdVST9nJFsJK0Zl5UCnCFUmGu6CAJUrN+t3/IjVlORCKMJYfs3UUpMjEQ2axIhEWHDQVyHNVOaGxIZELJRjJVckC/t+S2IhGOfm+lo1JkC1SeEuHDVjH3wrhGJII2VpmSRBZcy9SipgZFthMNbmTTNiJ7kaaJCFvLQrptcnKiYzlsLCuapV1ycMEvpf1qHjxsM+3mrNdboz155j1NU/5zXFTfFgV5v2gVHLIpkphL0oH50Voli0iY3ngW2t13wOQ3VMS0O1YTZG/SkW9VGPGhc8gBy0CN/2f5/pmre+D0wUldiSSmBsP45RC7sPUsrzenN5ZT0uf9cQpuDEFOFDPaoFT/QT4nejU8TArTsCpbG/1oV57Pns1O4w+rKBxhoPIsfE7NrdBpevrsZJaepD9czV5mz3/MXrycpGn6m0jEponRDN1YYohRBhnU+HNry29gp7vLNsxwSQGl8mOBgSK6bvQotZKaPu3b/BO3eBc5nn+u2S9NQ6Fm/FmTDrB2RlcJWEXoCYLbAlYoNSgM5J58vSkg54z7ch4f59mXUvA8TT/NDkl4cT8JF3qFSpYRva/MkvS3jXRsPvTm77eB7JkiXRwFO37vg/RUtE6GbYT5zQlaedLTs+s5YyAn1vB+qKjfC6EWmZgebwtPbrVfFa1TIhN1CNZn06lHXeZmMzGWV1WlFeae53mKVk5XPJN3JdDaR3BTe/I4AR+wkrr6stT8Ni+XXLu+PEfZucVkK38mBuUh+WOuYU/VhCXvl44/L0wUHkryzpK+lJWOBV3NxN2r4QOpwjTEt0GoCfbsf/3xZ5QoTdE2pEPstyfwrnUQDwpeSKhLWCjaSL4FmBmVMuvDqeEJG0Xeqy1IHahyGAhKWcmACjgrPE4FWsylktyhzGb6Q2LU5H4CH2oKNTkmfef4dClpRYobG5QxS9YTDGAbTBNtDD7D2rjlgl1KACFvvdTkPXiivQjpGnVBsK9FAsYBaiAdyFknPQHKhpkXxgEtFrKQrJib0/Gd1aDGithYAuw3Z6G/osiDM3nrA3ij2hgIW2yIQh+iJir9BH7i8yoGzo89sFIJVcsqEihMSTBMJ4ehS8jJB7BsXhYUlfqALoCiFbnYe7GSi1YpsIZhQ6Li421cW1YUHGrPq613aF+aQ/qsM3x7RBslbifwUX/UjITQeuIGUFIvffZRn8D1oc0+UO5loPn3+3lYr9f35uDpscy5DHWbgyNrbuWq+BinZix++PBUJCKQa/y7xSW5lSxoGMIHbE4j83QAU15VDIj98cAz9uquAAObkgVpTyPoOzt//xZW8GySimQ0+f/C4enbi9dvfrl8w3oZzPr5m03SSRqPD+NDg3pk6pzC4aAfcPBodne3a+F/ePwP6BVoE6ZWoYyLIiZsN4D89dFXgnkiauMDP+92OXr61amu4+f+CmfoL6Vn27d3+JK2o28NK1Qt24yo/ADvcN7fss75g5PMG1dSskdTNtjLnBUF2bGBezv4aJGdv7kSicCWYxyj+DKi+PAPa9+T9Hak+xjeewf4N8f0WYHdrt8QXXfg70kPSgwB7rm5NPOu6/4GaUj7CQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"}}');var a=i(74848),n=i(28453),s=i(33617),r=i.n(s),l=i(17543),c=i.n(l),p=i(86013),m=i.n(p),d=i(63723),u=i.n(d),f=(i(18766),i(79329),i(9303));const h={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:"eJzNV9tu20YQ/ZXJvrQBaIlyLkX5FCMNDKNBE8AuAtQRgiE5Itda7m53l7pA4Fu/pJ/WLylmScmUHad1EQQFDNvaud/OjHYiYOVFdi1eGx2wCF7ME1GSL5y0QRotMnFVEwxUeCt9gLP3F0CNNWtyHramhWDAUXCSVgQIinnMAopBYwLWmZUspa4AoTCNdVST9nJFsJK0Zl5UCnCFUmGu6CAJUrN+t3/IjVlORCKMJYfs3UUpMjEQ2axIhEWHDQVyHNVOaGxIZELJRjJVckC/t+S2IhGOfm+lo1JkC1SeEuHDVjH3wrhGJII2VpmSRBZcy9SipgZFthMNbmTTNiJ7kaaJCFvLQrptcnKiYzlsLCuapV1ycMEvpf1qHjxsM+3mrNdboz155j1NU/5zXFTfFgV5v2gVHLIpkphL0oH50Voli0iY3ngW2t13wOQ3VMS0O1YTZG/SkW9VGPGhc8gBy0CN/2f5/pmre+D0wUldiSSmBsP45RC7sPUsrzenN5ZT0uf9cQpuDEFOFDPaoFT/QT4nejU8TArTsCpbG/1oV57Pns1O4w+rKBxhoPIsfE7NrdBpevrsZJaepD9czV5mz3/MXrycpGn6m0jEponRDN1YYohRBhnU+HNry29gp7vLNsxwSQGl8mOBgSK6bvQotZKaPu3b/BO3eBc5nn+u2S9NQ6Fm/FmTDrB2RlcJWEXoCYLbAlYoNSgM5J58vSkg54z7ch4f59mXUvA8TT/NDkl4cT8JF3qFSpYRva/MkvS3jXRsPvTm77eB7JkiXRwFO37vg/RUtE6GbYT5zQlaedLTs+s5YyAn1vB+qKjfC6EWmZgebwtPbrVfFa1TIhN1CNZn06lHXeZmMzGWV1WlFeae53mKVk5XPJN3JdDaR3BTe/I4AR+wkrr6stT8Ni+XXLu+PEfZucVkK38mBuUh+WOuYU/VhCXvl44/L0wUHkryzpK+lJWOBV3NxN2r4QOpwjTEt0GoCfbsf/3xZ5QoTdE2pEPstyfwrnUQDwpeSKhLWCjaSL4FmBmVMuvDqeEJG0Xeqy1IHahyGAhKWcmACjgrPE4FWsylktyhzGb6Q2LU5H4CH2oKNTkmfef4dClpRYobG5QxS9YTDGAbTBNtDD7D2rjlgl1KACFvvdTkPXiivQjpGnVBsK9FAsYBaiAdyFknPQHKhpkXxgEtFrKQrJib0/Gd1aDGithYAuw3Z6G/osiDM3nrA3ij2hgIW2yIQh+iJir9BH7i8yoGzo89sFIJVcsqEihMSTBMJ4ehS8jJB7BsXhYUlfqALoCiFbnYe7GSi1YpsIZhQ6Li421cW1YUHGrPq613aF+aQ/qsM3x7RBslbifwUX/UjITQeuIGUFIvffZRn8D1oc0+UO5loPn3+3lYr9f35uDpscy5DHWbgyNrbuWq+BinZix++PBUJCKQa/y7xSW5lSxoGMIHbE4j83QAU15VDIj98cAz9uquAAObkgVpTyPoOzt//xZW8GySimQ0+f/C4enbi9dvfrl8w3oZzPr5m03SSRqPD+NDg3pk6pzC4aAfcPBodne3a+F/ePwP6BVoE6ZWoYyLIiZsN4D89dFXgnkiauMDP+92OXr61amu4+f+CmfoL6Vn27d3+JK2o28NK1Qt24yo/ADvcN7fss75g5PMG1dSskdTNtjLnBUF2bGBezv4aJGdv7kSicCWYxyj+DKi+PAPa9+T9Hak+xjeewf4N8f0WYHdrt8QXXfg70kPSgwB7rm5NPOu6/4GaUj7CQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,g={},v=[];function C(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:"Get Contact list"}),"\n",(0,a.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,a.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,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(c(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,a.jsx)(m(),{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:{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 N(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(C,{...e})}):C(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.9fe35bff.js b/assets/js/a2bc1463.9fe35bff.js deleted file mode 100644 index 2613edc35..000000000 --- a/assets/js/a2bc1463.9fe35bff.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1381],{47091:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>S,contentTitle:()=>b,default:()=>y,frontMatter:()=>v,metadata:()=>a,toc:()=>g});const a=JSON.parse('{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","source":"@site/docs/API-docs/contactlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/contactlist","permalink":"/docs/API-docs/contactlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar_label":"Get Contact list","hide_title":true,"hide_table_of_contents":true,"api":"eJzNV9tu3DYQ/ZUJX9oA8q7WuRTVU4w0MIwGTQC7CFBnEYykWYleimRJai9Y6K1f0k/rlxRDaddaO07rIggKGLFFnrly5sxkJwJWXmTX4rXRAYvgxTwRJfnCSRuk0SITVzXBcAtvpQ9w9v4CqLFmTc7D1rQQDDgKTtKKAEExxiygGDQmYJ1ZyVLqChAK01hHNWkvVwQrSWvGolKAK5QKc0UHSZCa9bv9QW7MciISYSw5ZO8uSpGJ4ZLNikRYdNhQIMdR7YTGhkQmlGwk30oO6PeW3FYkwtHvrXRUimyBylMifNgqRi+Ma0QiaGOVKUlkwbV8W9TUoMh2osGNbNpGZC/SNBFha1lIt01OTnQsh41lRbO0Sw4u+KW0X82Dh22m3Zz1emu0J8/Y0zTlX8eP6tuiIO8XrYJDNkUSc0k6MB6tVbKIF9Mbz0K7+w6Y/IaKmHbHaoLsTTryrQojHDqHHLAM1Ph/lu+P+XUPSB+c1JVIYmowjE8OsQtbz/J6c3pjOSV93h+n4MYQ5EQxow1K9R/kc6JXw8GkMA2rsrXRj3bl+ezZ7DT+sIrCEQYqz8Ln1NwKnaanz05m6Un6w9XsZfb8x+zFy0mapr+JRGyaGM1QjSWGGGWQQY2/W1t+AzvdXdjQwyUFlMqPBYYb0XWjQ6mV1PRpX+afuMS7iHj+uWK/NA2FmvlnTTrA2hldJWAVoScIbgtYodSgMJB78vW6gJwz7st5fJxnX0rB8zT9NDsk4cX9JFzoFSpZRva+MkvS3zbSsfnQm79fBrIHxXtxFOz4vA/SU9E6GbaR5jcnaOVJf59dz5kDObGG50NF/VwItcjE9HhaeHKr/ahonRKZqEOwPptOPeoyN5uJsTyqKq0w99zPU7RyuuKevCuB1j4C7QNWUlcnX5Sa34Z5yU/RZ/so2FuKtfJnYo4dcjlGDWOnJix5XHT8vTBReMjwO0v6UlY6vs9qJu4uAR9IFaYhHvWhJtjD//rjzyhRmqJtSIdYPk/gXesg7gc8X1CXsFC0kTzaGYxKmfVhc/CEjSLv1RakDlQ5DASlrGRABZwV7o4CLeZSSS44hpl+LxjVrJ/Ah5pCTY6vvnO8iZS0IsV1CsqYJesJBrANpok2Bp9hbdxywS4lgJC3XmryHjzRXoR0jbog2L9FAsYBaiAdyFknPQHKhsEL44AWC1lIVsy15nhtalBjRWwsAfabs9AvReTBmbz1AbxRbQyELTZEoQ9RE5V+Aj/xthQD58OeJ6mEqmUVCRSmJBiajcPQJeTkA1g2LwuKSn1AF0DRilysvfiSi1YpsIZZQKLiXWz8tqwoONSeJ1Xv0P5pDumzzvAqEW2UuJ3AR/1RM7FB64kLQEm99NlHfQLXhzL7QLmXgebf7/thvV7f64OnxzLnMtRtDo6suZWr4mHsmrH44eOpSEQg1/h3i0tyK1nQ0IQP2JxG8HTgRp48zG/9LsA99uquAPOUkgVpTyMmOzt//xZW8GySimTU+f/C4enbi9dvfrl8w3qZm/r+m03SSRp3CeNDg3pk6pzCYT8faO2od3e3LP8/3OUH9gq0CVOrUEbejwnbDZx9fbThzxNRGx/4eLfL0dOvTnUdH/dLNTN5KT3bvl2rl7Qd/Sdghaplm5GVH8AO2/otdM4fTjI2Tphkz6ZssJc5KwqyYwP3RurRXDp/cyUSgS3HOGbxZWTx4Q/Wvr/S25HuY3rvHeB/OabPCux2/YTougO+v3pQYghwj+anmXdd9zfBK+ne","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Contact","permalink":"/docs/API-docs/deletecontact"},"next":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"}}');var o=n(74848),i=n(28453),s=n(33617),r=n.n(s),l=n(17543),c=n.n(l),p=n(86013),m=n.n(p),d=n(63723),u=n.n(d),h=(n(18766),n(79329),n(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:"eJzNV9tu3DYQ/ZUJX9oA8q7WuRTVU4w0MIwGTQC7CFBnEYykWYleimRJai9Y6K1f0k/rlxRDaddaO07rIggKGLFFnrly5sxkJwJWXmTX4rXRAYvgxTwRJfnCSRuk0SITVzXBcAtvpQ9w9v4CqLFmTc7D1rQQDDgKTtKKAEExxiygGDQmYJ1ZyVLqChAK01hHNWkvVwQrSWvGolKAK5QKc0UHSZCa9bv9QW7MciISYSw5ZO8uSpGJ4ZLNikRYdNhQIMdR7YTGhkQmlGwk30oO6PeW3FYkwtHvrXRUimyBylMifNgqRi+Ma0QiaGOVKUlkwbV8W9TUoMh2osGNbNpGZC/SNBFha1lIt01OTnQsh41lRbO0Sw4u+KW0X82Dh22m3Zz1emu0J8/Y0zTlX8eP6tuiIO8XrYJDNkUSc0k6MB6tVbKIF9Mbz0K7+w6Y/IaKmHbHaoLsTTryrQojHDqHHLAM1Ph/lu+P+XUPSB+c1JVIYmowjE8OsQtbz/J6c3pjOSV93h+n4MYQ5EQxow1K9R/kc6JXw8GkMA2rsrXRj3bl+ezZ7DT+sIrCEQYqz8Ln1NwKnaanz05m6Un6w9XsZfb8x+zFy0mapr+JRGyaGM1QjSWGGGWQQY2/W1t+AzvdXdjQwyUFlMqPBYYb0XWjQ6mV1PRpX+afuMS7iHj+uWK/NA2FmvlnTTrA2hldJWAVoScIbgtYodSgMJB78vW6gJwz7st5fJxnX0rB8zT9NDsk4cX9JFzoFSpZRva+MkvS3zbSsfnQm79fBrIHxXtxFOz4vA/SU9E6GbaR5jcnaOVJf59dz5kDObGG50NF/VwItcjE9HhaeHKr/ahonRKZqEOwPptOPeoyN5uJsTyqKq0w99zPU7RyuuKevCuB1j4C7QNWUlcnX5Sa34Z5yU/RZ/so2FuKtfJnYo4dcjlGDWOnJix5XHT8vTBReMjwO0v6UlY6vs9qJu4uAR9IFaYhHvWhJtjD//rjzyhRmqJtSIdYPk/gXesg7gc8X1CXsFC0kTzaGYxKmfVhc/CEjSLv1RakDlQ5DASlrGRABZwV7o4CLeZSSS44hpl+LxjVrJ/Ah5pCTY6vvnO8iZS0IsV1CsqYJesJBrANpok2Bp9hbdxywS4lgJC3XmryHjzRXoR0jbog2L9FAsYBaiAdyFknPQHKhsEL44AWC1lIVsy15nhtalBjRWwsAfabs9AvReTBmbz1AbxRbQyELTZEoQ9RE5V+Aj/xthQD58OeJ6mEqmUVCRSmJBiajcPQJeTkA1g2LwuKSn1AF0DRilysvfiSi1YpsIZZQKLiXWz8tqwoONSeJ1Xv0P5pDumzzvAqEW2UuJ3AR/1RM7FB64kLQEm99NlHfQLXhzL7QLmXgebf7/thvV7f64OnxzLnMtRtDo6suZWr4mHsmrH44eOpSEQg1/h3i0tyK1nQ0IQP2JxG8HTgRp48zG/9LsA99uquAPOUkgVpTyMmOzt//xZW8GySimTU+f/C4enbi9dvfrl8w3qZm/r+m03SSRp3CeNDg3pk6pzCYT8faO2od3e3LP8/3OUH9gq0CVOrUEbejwnbDZx9fbThzxNRGx/4eLfL0dOvTnUdH/dLNTN5KT3bvl2rl7Qd/Sdghaplm5GVH8AO2/otdM4fTjI2Tphkz6ZssJc5KwqyYwP3RurRXDp/cyUSgS3HOGbxZWTx4Q/Wvr/S25HuY3rvHeB/OabPCux2/YTougO+v3pQYghwj+anmXdd9zfBK+ne",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,S={},g=[];function R(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Contact list"}),"\n",(0,o.jsx)(r(),{method:"get",path:"/contactlist",context:"endpoint"}),"\n",(0,o.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,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(c(),{parameters:[{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,o.jsx)(m(),{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:"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 y(e={}){const{wrapper:t}={...(0,i.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/a88a3db3.0b93ed81.js b/assets/js/a88a3db3.0b93ed81.js deleted file mode 100644 index 6912c19de..000000000 --- a/assets/js/a88a3db3.0b93ed81.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3605],{29993:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>P,contentTitle:()=>A,default:()=>y,frontMatter:()=>u,metadata:()=>l,toc:()=>b});const l=JSON.parse('{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/delete-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/delete-template","permalink":"/docs/API-docs/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNVttu3DYQ/ZUJX5oA8u7acVJUT3VrIzUaNEHtIkCdhcGVRhJjimTJ0V6w0Fu/pJ/WLymGkvbqGA1QBH3Zlai5nbmc4VqQLINI78Qt1k5LwiCmicgxZF45UtaIVNxWCJeokRAGKbh4fw3O27nKMcDKNrBQVAFVCHKmtKIVkAWPtZ0jSAgOM1WoDGjQL7yto/hwEkZwXYDcSqgAxoK2pkQPBjHHXCTCOvSS47rORSryGNUQlEiEk17WSOgZ01oYWaNIxWDzXrEJxZicpEocAr2+BFvsRQVUSYreAwOaIXQu2Y7HPxrlMRcp+QYTEWil2VtQtdMcDC6dtjmKtJA6sEBWYS1Fuha0clGSvDKlSERhfS1pe9K2U7YfnDUBA2ucTSb8d1CYIco+KAhNlmEIRaP16plIRGYNoSHWlM5plcXUjT8FVl8fB2RnnzAjzqPnRJPqnHfHnPHj0HEpI9xU/LCszmRwP7mXok360uQX9LTS2eTs5cnp5GTy7e3p6/T8u/TV69FkMvldJGJZa9bta5hzgdtEkCK9fW+PxKLbPcH+pGXh88fSeGNrpEqZEhZoCBbemjIBp1EGBPIrkKVUBjjT/j/MKnpv/dPZ+bLI2h3Uymhl8H7oofvzyeT+dJOE8yd6yViCwjYm/7pQH/P/NKDz+9cbQK+OAV2budQqj0x1ax/QfF08u+6pc3/craoTit/FHtjd8w5kwKzxilaR2JYn0qmT7nt6N2W64E6xW1KMZEiVSMV4ILPxeocIW8Em/XygysZrkYqKyIV0PA7S5DO7HFmHJqjSaDkLo8zWY+nUeH4q2uRQQzr3BdKBZKlMefKk1nQL+oYL0+V+D/qmAtKpn3ElkiGzu1I95Vcoc/SxCsoUNir3+X7n0Nyo0sRqzU+PFsMH1JmtkVcAb4dB/O8//4oauc2aGg3FZnoG7xoPzi7QF40GaXIoNC7VTHdbU2ptF93OJAsBZa0xBL0CZQhLH+lclYqkBs4KD38mXbdVFQYWs6ztYaeDwwg+VEgVev70jeelm+McNXctaGsf2A5ZkA3ZOvroY4aF9Q8Fh5SAhFkTlMEQICAOKmgqaTKEoRYJWA/SABpC77wKCFLVLFxYD1gUKlNsmGfNy4yglkaWyM4S4Lj37g7ezppAEKxuIhD2WCNSBzFu3hFcqjl2wPkwR5JKYw5lwyYSyGyO0I8ewzA5zDAQOHavMoxGA0lPoHGOPvZerCRvSnCWOUFJzdt/t7ZsiLw0gfdzF9BQmk36nLe8cqOPXK5G8NF8NMzb0ATkBtDKPIT0ozmBu02bfcBZUITT58M8LBaLozl4sa/zRlHVzMCjs1u9Mh7GqdlV37y8EIkg9HV4V9ygn6sM+yH8jM9xFB73TCmzyJRYS6W7Gfv+UIFZS6sMTcAdXrt48/4tzOHlaCKSncn/FwGP317/ePXLzRXbZW7q5u90NBlN+MjZQLU0O64OLqaHo7veUv7/6h7b0xbhksZOSxXpP2Zq3fP23ebaKhKR7l5hp4mobCAWWa9nMuBvXrctH//RoOcFMU3EXHolZ8xud2uRq8DP+eYq+tkcPf+1v9W+gC+7DT8KaCBnw8w8l7rhN5GIB1wdXMvbaZsMDM0RdxIXWYaOdnSPlvbe5ru8ent1eyUSIRvO4O5yeIjLoX9gB4+Gtr81uhj4lxfYowrrdbd42nYj3336rEaPcZDmPE3btv0Hq2W5Hw==","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/gettemplatelist"}}');var o=a(74848),n=a(28453),i=a(33617),p=a.n(i),s=a(17543),d=a.n(s),c=a(86013),r=a.n(c),m=a(63723),h=a.n(m),I=(a(18766),a(79329),a(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:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUT3VrIzUaNEHtIkCdhcGVRhJjimTJ0V6w0Fu/pJ/WLymGkvbqGA1QBH3Zlai5nbmc4VqQLINI78Qt1k5LwiCmicgxZF45UtaIVNxWCJeokRAGKbh4fw3O27nKMcDKNrBQVAFVCHKmtKIVkAWPtZ0jSAgOM1WoDGjQL7yto/hwEkZwXYDcSqgAxoK2pkQPBjHHXCTCOvSS47rORSryGNUQlEiEk17WSOgZ01oYWaNIxWDzXrEJxZicpEocAr2+BFvsRQVUSYreAwOaIXQu2Y7HPxrlMRcp+QYTEWil2VtQtdMcDC6dtjmKtJA6sEBWYS1Fuha0clGSvDKlSERhfS1pe9K2U7YfnDUBA2ucTSb8d1CYIco+KAhNlmEIRaP16plIRGYNoSHWlM5plcXUjT8FVl8fB2RnnzAjzqPnRJPqnHfHnPHj0HEpI9xU/LCszmRwP7mXok360uQX9LTS2eTs5cnp5GTy7e3p6/T8u/TV69FkMvldJGJZa9bta5hzgdtEkCK9fW+PxKLbPcH+pGXh88fSeGNrpEqZEhZoCBbemjIBp1EGBPIrkKVUBjjT/j/MKnpv/dPZ+bLI2h3Uymhl8H7oofvzyeT+dJOE8yd6yViCwjYm/7pQH/P/NKDz+9cbQK+OAV2budQqj0x1ax/QfF08u+6pc3/craoTit/FHtjd8w5kwKzxilaR2JYn0qmT7nt6N2W64E6xW1KMZEiVSMV4ILPxeocIW8Em/XygysZrkYqKyIV0PA7S5DO7HFmHJqjSaDkLo8zWY+nUeH4q2uRQQzr3BdKBZKlMefKk1nQL+oYL0+V+D/qmAtKpn3ElkiGzu1I95Vcoc/SxCsoUNir3+X7n0Nyo0sRqzU+PFsMH1JmtkVcAb4dB/O8//4oauc2aGg3FZnoG7xoPzi7QF40GaXIoNC7VTHdbU2ptF93OJAsBZa0xBL0CZQhLH+lclYqkBs4KD38mXbdVFQYWs6ztYaeDwwg+VEgVev70jeelm+McNXctaGsf2A5ZkA3ZOvroY4aF9Q8Fh5SAhFkTlMEQICAOKmgqaTKEoRYJWA/SABpC77wKCFLVLFxYD1gUKlNsmGfNy4yglkaWyM4S4Lj37g7ezppAEKxuIhD2WCNSBzFu3hFcqjl2wPkwR5JKYw5lwyYSyGyO0I8ewzA5zDAQOHavMoxGA0lPoHGOPvZerCRvSnCWOUFJzdt/t7ZsiLw0gfdzF9BQmk36nLe8cqOPXK5G8NF8NMzb0ATkBtDKPIT0ozmBu02bfcBZUITT58M8LBaLozl4sa/zRlHVzMCjs1u9Mh7GqdlV37y8EIkg9HV4V9ygn6sM+yH8jM9xFB73TCmzyJRYS6W7Gfv+UIFZS6sMTcAdXrt48/4tzOHlaCKSncn/FwGP317/ePXLzRXbZW7q5u90NBlN+MjZQLU0O64OLqaHo7veUv7/6h7b0xbhksZOSxXpP2Zq3fP23ebaKhKR7l5hp4mobCAWWa9nMuBvXrctH//RoOcFMU3EXHolZ8xud2uRq8DP+eYq+tkcPf+1v9W+gC+7DT8KaCBnw8w8l7rhN5GIB1wdXMvbaZsMDM0RdxIXWYaOdnSPlvbe5ru8ent1eyUSIRvO4O5yeIjLoX9gB4+Gtr81uhj4lxfYowrrdbd42nYj3336rEaPcZDmPE3btv0Hq2W5Hw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},A=void 0,P={},b=[];function x(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(I.default,{as:"h1",className:"openapi__heading",children:"Delete Template"}),"\n",(0,o.jsx)(p(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,o.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,o.jsx)(I.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 deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,o.jsx)(r(),{title:"Body",body:void 0}),"\n",(0,o.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 y(e={}){const{wrapper:t}={...(0,n.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/a88a3db3.862db0b2.js b/assets/js/a88a3db3.862db0b2.js new file mode 100644 index 000000000..918285e5d --- /dev/null +++ b/assets/js/a88a3db3.862db0b2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3605],{29993:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>j,contentTitle:()=>f,default:()=>x,frontMatter:()=>I,metadata:()=>l,toc:()=>g});const l=JSON.parse('{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","source":"@site/docs/API-docs/delete-template.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/delete-template","permalink":"/docs/API-docs/delete-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar_label":"Delete Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzNVttu3DYQ/ZUJX5oA8u7acVJUT3VrIzUaJEHtIkCdhcGVRhJjimTI0V6w0Fu/pJ/WLymGkvbidYwaKIK+7ErU3IdzzqwFyTKI9EZcY+20JAximogcQ+aVI2WNSMV1hXCOGglhkIKzD5fgvJ2rHAOsbAMLRRVQhSBnSitaAVnwWNs5goTgMFOFyoAG/cLbOooPJ2EElwXIrYQKYCxoa0r0YBBzzEUirEMvOa7LXKQij1ENQYlEOOlljYSec1oLI2sUqRhs3io2oTgnJ6kS9xO9PAdb7EUFVEmK3gMnNEPoXLIdj18a5TEXKfkGExFopdlbULXTHAwunbY5irSQOrBAVmEtRboWtHJRkrwypUhEYX0taXvStlO2H5w1AQNrnEwm/HevMUOUfVAQmizDEIpG69UzkYjMGkJDrCmd0yqLpRt/Dqy+PgzIzj5jRlxHz4Um1Tnvjrnih6HjUsZ0U/HTsjqRwf3iXoo26VuTn9HjSieTk5dHx5OjyffXx6/T0x/SV69Hk8nkD5GIZa1Zt+9hzg1uE0GK9Pa9PRCLbvcE+5OWhU8fKuOVrZEqZUpYoCFYeGvKBJxGGRDIr0CWUhngSvv/sKrovfWPV+dpkbU7WSujlcHb4Q7dnk4mt8ebIpw+cpeMJShsY/Jvm+pD/h9P6PT29SahV4cJXZq51CqPSHVt79B823x23VPn/vC2qk4ofhd7ye6ed0kGzBqvaBWBbXkknTrqvqc3U4YLvil2C4oRDKkSqRgPYDZe7wBhK9iknw9Q2XgtUlERuZCOx0GafGaXI+vQBFUaLWdhlNl6LJ0az49Fm9zXkM49QRqbo6cpBJKlMuXjWtNtla64k12z9mq1aZl06ldciWRoxa5UzxEVyhx9bJsyhY3KfYPeOzRXqjSxvfPjAyb5iDqzNTJnMJ0M4n//+VfUyG3W1Ggo3r5n8L7x4OwCfdFokCaHQuNSzXRHs1Jru+hIliwElLXGEPQKlCEsfcR/VSqSGrgqjBaZdB0NKwwsZlnbw86VDyP4WCFV6PnTd55ZOsc5ar7moK29YztkQTZk6+ijjxkW1t8VHFICEmZNUAZDgIA4qKCppMkQhl4kYD1IA2gIvfMqIEhVs3BhPWBRqEyxYR5OLzOCWhpZIjtLgOPeWza8nTWBIFjdxETYY41IXYqRqkdwrubYJc6HOZJUGnMoGzaRQGZzhH5WOQ2TwwwDgWP3KsNoNJD0BBrn6OPdi51kagVnGUSU1Lwu7PaWDZGXJjChdwENrdmUz3nLHB195HI1gk/mk2GghyYgXwCtzF1IP5kjuNlcs484C4pw+nyYh8VicTAHL/Z13iiqmhl4dHarV8bDODW76puXFyIRhL4O74sr9HOVYT+EX/E5jsLjHlplFqEVa6l0N2M/3ldgmNMqQxNwBwjP3nx4C3N4OZqIZGfy/0XA47eXP1+8u7pguwxm3fwdjyajCR85G6iWZsfVvU32/uiutxzxv1p8e9giXNLYaakiX8RKrXugv9nsuSIR6e7OO01EZQOxyHo9kwF/97pt+fhLg54ZZZqIufRKzhjdbtYiV4Gf883u+tUaPf+tX4NfwNPW5wcTGsDZMDLPpW74TSTiDlf39vh22iYDQnPEncRZlqGjHd0Dlt+jyvOLtxfXFyIRsuEK7pLDXSSH/oEdPBjaPmt0MfAvE9iDCut1Rzxtu5HvPn1Vo89xkOY6Tdu2/Qclu8pK","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Update Template","permalink":"/docs/API-docs/update-template"},"next":{"title":"Get Template list","permalink":"/docs/API-docs/gettemplatelist"}}');var i=a(74848),n=a(28453),o=a(33617),s=a.n(o),p=a(17543),d=a.n(p),r=a(86013),m=a.n(r),c=a(63723),h=a.n(c),u=(a(18766),a(79329),a(9303));const I={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUT3VrIzUaJEHtIkCdhcGVRhJjimTI0V6w0Fu/pJ/WLymGkvbidYwaKIK+7ErU3IdzzqwFyTKI9EZcY+20JAximogcQ+aVI2WNSMV1hXCOGglhkIKzD5fgvJ2rHAOsbAMLRRVQhSBnSitaAVnwWNs5goTgMFOFyoAG/cLbOooPJ2EElwXIrYQKYCxoa0r0YBBzzEUirEMvOa7LXKQij1ENQYlEOOlljYSec1oLI2sUqRhs3io2oTgnJ6kS9xO9PAdb7EUFVEmK3gMnNEPoXLIdj18a5TEXKfkGExFopdlbULXTHAwunbY5irSQOrBAVmEtRboWtHJRkrwypUhEYX0taXvStlO2H5w1AQNrnEwm/HevMUOUfVAQmizDEIpG69UzkYjMGkJDrCmd0yqLpRt/Dqy+PgzIzj5jRlxHz4Um1Tnvjrnih6HjUsZ0U/HTsjqRwf3iXoo26VuTn9HjSieTk5dHx5OjyffXx6/T0x/SV69Hk8nkD5GIZa1Zt+9hzg1uE0GK9Pa9PRCLbvcE+5OWhU8fKuOVrZEqZUpYoCFYeGvKBJxGGRDIr0CWUhngSvv/sKrovfWPV+dpkbU7WSujlcHb4Q7dnk4mt8ebIpw+cpeMJShsY/Jvm+pD/h9P6PT29SahV4cJXZq51CqPSHVt79B823x23VPn/vC2qk4ofhd7ye6ed0kGzBqvaBWBbXkknTrqvqc3U4YLvil2C4oRDKkSqRgPYDZe7wBhK9iknw9Q2XgtUlERuZCOx0GafGaXI+vQBFUaLWdhlNl6LJ0az49Fm9zXkM49QRqbo6cpBJKlMuXjWtNtla64k12z9mq1aZl06ldciWRoxa5UzxEVyhx9bJsyhY3KfYPeOzRXqjSxvfPjAyb5iDqzNTJnMJ0M4n//+VfUyG3W1Ggo3r5n8L7x4OwCfdFokCaHQuNSzXRHs1Jru+hIliwElLXGEPQKlCEsfcR/VSqSGrgqjBaZdB0NKwwsZlnbw86VDyP4WCFV6PnTd55ZOsc5ar7moK29YztkQTZk6+ijjxkW1t8VHFICEmZNUAZDgIA4qKCppMkQhl4kYD1IA2gIvfMqIEhVs3BhPWBRqEyxYR5OLzOCWhpZIjtLgOPeWza8nTWBIFjdxETYY41IXYqRqkdwrubYJc6HOZJUGnMoGzaRQGZzhH5WOQ2TwwwDgWP3KsNoNJD0BBrn6OPdi51kagVnGUSU1Lwu7PaWDZGXJjChdwENrdmUz3nLHB195HI1gk/mk2GghyYgXwCtzF1IP5kjuNlcs484C4pw+nyYh8VicTAHL/Z13iiqmhl4dHarV8bDODW76puXFyIRhL4O74sr9HOVYT+EX/E5jsLjHlplFqEVa6l0N2M/3ldgmNMqQxNwBwjP3nx4C3N4OZqIZGfy/0XA47eXP1+8u7pguwxm3fwdjyajCR85G6iWZsfVvU32/uiutxzxv1p8e9giXNLYaakiX8RKrXugv9nsuSIR6e7OO01EZQOxyHo9kwF/97pt+fhLg54ZZZqIufRKzhjdbtYiV4Gf883u+tUaPf+tX4NfwNPW5wcTGsDZMDLPpW74TSTiDlf39vh22iYDQnPEncRZlqGjHd0Dlt+jyvOLtxfXFyIRsuEK7pLDXSSH/oEdPBjaPmt0MfAvE9iDCut1Rzxtu5HvPn1Vo89xkOY6Tdu2/Qclu8pK",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,j={},g=[];function k(e){const t={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:"Delete Template"}),"\n",(0,i.jsx)(s(),{method:"delete",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,i.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(d(),{parameters:[{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,i.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Template deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.6f58abda.js b/assets/js/a9f09360.6f58abda.js new file mode 100644 index 000000000..142676e85 --- /dev/null +++ b/assets/js/a9f09360.6f58abda.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>f,default:()=>b,frontMatter:()=>x,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyGzmuv4Ltl0xcLdlSnEzWT5tJ5uzxnjlj18SpqVO2y0N1QxLjbrKHZFvWuPS2X7Kftl+yBZBsdetiO5ed9dRRHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/VczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvzt/cmPMNamFK4Pp0Vt02a5XBrMXDH307spNrt6ZiM1rDNSTVIoxTXRSzr4tZbZNW3bosrpLw18c3rMtNrbe19XlTYOc/jZb+Fob496vsNCz0AYZPhMl6VWUAkjSnR8YFPhuNvgr7U0mIdjKYpIi6ML1YO9PTev8GhvD45VLjMiBk9IraDHAbbvQYlIBPq+wkyOZQBtkQ60gtlUZlOmyUz486wKkXk0DdoKMydvsDvxbQpzmvgdKh0xmGojf9PKiYKP4waNk5ko2sdGCBKodcI4ImelpXKxNawA/xeOh06PDyXwFaGWE7FKqbjHItyIokYbsJqlMCWsfsLKoGVmD/MSIVUOU5ST6db1RP6xtq4zMdSW0GxjEdaKp8TkRSbbWBQWQY47tCzFNbZWA81CLIo+fDeHHMeiLlwKkjjOmRr78KN2IKqqkJkYFUicCyQ8wtUGe3zKgR0CIkqUfManLNNoQUAux2M0JJzUyVOEMRE74rOlEmDJcVOhQKuVg850oc06C3Fzl46QaeVQuT68uRGyYOT9Zi1IlRV1jjAqRHadwqioMQWDuRfcOZLiSj2/MwgIG2jO9AGLBXGhVoS/0mF5acEGrPI+nE2lXcoTdUZS8yLStqkapHasaWUiQRQxwFLIImXCpfBRj8BJV2BKAlsJNU9JY2IKDm/dSN+mkE0xu+ZfRuRSw6h2Tiu/sdzoKtczFWg51spZ+dsGiYw9n07RYQqHKbxK4XUKg4MUBsMUBocpDF6lMHidwvAgheEwheFhCsNXHq3h6zSq/EjgNgKDoaey++NQl/TuD9KyZJPCtI0OnnV08KAPe3uNNFHbL7/8cqHuLhTARULCdZEcwUXSgFwkqe8jnUl9g/B9Sx8vht+Gzzl9vhq+Dp8zBh0chs8pfQ4HF2oRFrxQQ8bEibK6Bwvq/qoYhK/ARNTGi1Jb1GfUSIoojR10Vh18qGPR3ssL2otU0klR2O3biRBPaEdLlNY2dUibYnbdviPufkLbaeNDPawmfRer1VZXFHjGYri2+5f9cLNs37xf9snsvYXOl239FW2dVNMZqabt+2+01xMiwipOX0aJb/tsALBm3k6HAPCEqNDF6Mto8JpoQJfSdgJQ7xPafQsd6gg3vO87OOwNXvaGB8PDDgXIN/IAZdnL8958Pv8a1CObJyxPJk+0UL1lR37p2Ohyg/vB3sESKthE/Dua7P9Lhvoo2rCYk9/HjkW0WBqPr21lO52L+TPrp4pDG+OM4Jem2byFJncRHuz9ZlMts4A8wUSTbEQOXp9o0GNK7uf5fouS1JjnvbLsrTTSZ48J32osy36e91cg107HN5aQ5ymsN29sz3Moy3JLs2+/SNik+jOxfrDEtnN/APi9BGDJ592F7xUOigdoVfDa7KRtlo6VK2QqVegIrAIrAAYndSEM3pK3aaVWHvrrS04UnKW9zt4pO3bs+3tSwDcnwSZ/HpiattCdgFoeHre2s/YkBid4y3NktXW6JGRkLmiGFGydTcl7E9H0J7ov4zT8lYlKUpSgQOe4FV3W34SEP7WWh02nuupgW3SdzQgLceQGH5uPn9l7cMDXW3Aw7rnfAsQTUvErKFGnD1dQ9/lFUgq2AIjLcPlbuymai+SyGeO9aswfGHv5CDmayhwLMcJivevRMtDeS+CnFmGoo5SqiQQwvgdpq1PcrnT6vsUG2fI7bjN1VOJRNCKJoZA2xkK69GqPDsEiDuEpRI4KjhDiAAq5Rsn9UjZvEHscn3stEA7ngSUIDhiwCdTF1R5YoXMwbcLQHKVUsqzLJuI4bmaNJCvDbd6mF42kSHZcoX26ayuI2wdWoPDe9gUu1IAjAzGicI+tFyCekDJYQel+Of0cNdG5I7/S5fawAMZttQVww5VIoP4ybITPbpe+PpzQBURRTj+I4lZZhpWjGNeXimaD8qOvII4C+cjWdxzZ2s557fjXE+K+DWj9mzkwwP0+XNje3h+IEztoP5obfRyvFJN7nF3ufkL8F/BZOdwkTXRFb59Sq+M8OUpyei2Nj3tJyjOjdd/pfJ4c3SUh0E4/QxibRu5/tPTcepfYbIqloF8RI3qgpffRJE043kJvtESk5CjRo4+Y0RqVIRycREsjGfroLkL5Z8UkDd53cpT498YkTfBWlBUBJysPslU+ThZxwfumalqWU1n+0bxv0jz0cveZ0/xIQxcrz9KfNdO71gy8txLP9FtNfQ7fibltzeuv92T1NZzGEPNnYRTkYm5JnmrrLbFMFFldkCePt5U08yaswO58iysafJuVGnwHLxcpPwugaaMkjBHzJE2kw7LdvoUJjP70k8tQE2U4tvupYz9qHCH+JTTQ2zsfvCg/GYuPGmGEfOjVVKtPHj8YvhgMBy8GQ5ohPMp8Ph197zoGXcZ4Qz4o5tE67y3fUVPgt4z+Qzwa4XnbYoIPM+PZtvf11rOeneq6yOnBDIXp8zP3Z2dQdPm7uYP6D3DzIk1uH97MLWS6Fx/v4ZsCxw7qqkIDmTYKzfN2BO/JbG54eLhIk/nD25v/Ibf3LR3e7OHd/cxZD8uMkP8Eri9eL9Jk+jCu/93kZfwHkT18tVjerklmUDiMl8PVSOfzq6i3Fg8BxouC4Ma6yNGQFbKur5aqhjQM5RNdrer5kdYFCrVB0XQe5EPuFxmDZAeGEPZsimRLL21Enn1plgar0WNLj/y4EmGUlqw/U+NF0ofjccvI5QDBak5AhOX3eaXhGa93ZWtW48/2wzfR6Fk794nSUZah+4gCA4PDsio4eWgmi4Lwpnu9D80/NvcaShIC8bqMCz98Vbz1kUxeMAzqZt5AsBj78FaoJvuim+UAd3cNGzB3LBZwd0eniuaKLt3FIl020FqdBr5XfYvBDOVNZ1TThMuBTVtrqDdxrsjE8Q3hNayNgJwoqSZXtSkWi/4aGy7P6NF0WyNTODua5P8BxQidY3VicjSPkNzjsffTNDwjZn0WouJMGWmsC/Lo2T0g7B+3tlA5ZDGQe/d9I9+2HlmCUnG+pfw4IycTpAzDAMGDQ04QimzqNQNjJcYk2pw1aPBG6tpG9KbCNiZ3ThDSi4tUk66b2aIOp2y1997fJLqKkohOzk4fQUt2gnteE3kP0u/SzwEnZ6eUhyjHwaPrwwfbUCKSVnRAgHwtuJEi5io15tvcxylRMUW82uwkjfZDBmAP1hHKpd2IUbp8KWnydtcmXiaq0hHp2lGGrAzpV9ZhZTt0ZCwaQp7p+jFc+QAlBUxqfmh1dCtH1civN8s8QqmsM7WP0UJem5g6GdiCIDO0dkmnSBUCas2fAirrhwsYC+vQpFArSZQ3NYVIminxtkIjUWW4kQQGPelIch/WZt2kvA8//RDSk+MeolCOSAL9xJhDXTHXsCQ0yaLx5Fa3vlF3BLX1MIJ0QXNKZwjPV2isVkCpmGYilPzNszA7HdqSxzYVhQcNqoKeqQkfkvAuMtGc+uff/9HCa6vbuY6YX0HkOb0ZPoAhh8g8w1No3mBFGlB3MaL50Pxl1c4j7FhorkqdN4JkH8/jp5RB7GyjF53mjHMs0CfIxzfMRt/aNOpYGzxHeso0/ORIxHa6ov3irbSule4YkxLW9cNPSHTMWjiwp0FSTTyv5m0Bb/AKaZXL6dgGlN1U2cbSXZGFlsXaCYb5i54t2mVwK2hiyv7Wynqfe3hwQH+6FG3qD4IVTLQjPh/XRTH/U5I+PrJ2v8PfYCs32tH3OfHTj3L42212MzwlxtmiB+6dIPgctSmopoAEo9ecAfNji7ZSFVLhFZP4KtfZlUF7NTw4uBoQjRdpcriJjO91iW7KrEPEnBlNJQdVgYJS4M0cxERIBWQGm69IVTRGm/v9kk/DbAMlIg9dHXaI8HKdCMeKH365lOVMX6P6fXfaXt755QnV25IZxuvnRHog7k86m223+01azGoj3Tw5Or9Lbnuikj3ff3R+ubhMEyKspuB0pS1jLNw0OUr2V2PVFs0NRx3P7zz7NhxphcrpcXbNExaV3L8ZJIt0dcRGv3krNNa9TxtgnZhINbl/1OWSNO/p+PwJdQi0jAtW8n+QAoOB/m2oNJHENlMUZHcTxYkrflpG9r+PZxuj75sC6sszXA2Rxwh5J+i9eqVsCGNvjmIPXrbix+cxFMzR3Sa4uyle22w9RmCbAGwrptoKqZ4vebyJXsbg5YCjfsPDQw6PfTvgONKL1xyiOXy1YK5chiuSpBuS4BeYVcc6SboOYxzUuENh1NKm98+BHeM0NHWNtThTYxx1LJRVA2WrsbDFVogGolRjzfwWmOCkQvWe7G9SAzeD9agaFpkumxKHCP7Pv/+DR0Tm4WX+BCe1gUrP0IxrXycxLvBWksXbqteLMRsUZYHWFnMgQ3fClXu5nHCqVDQjM1GJkSwk6TUC0/4No6UabR9+XkZ9nhmfNXaDBalDKLTmMjYyeWqnS14j3uEzba7HhFJKxYBU+USGnEWMQ1BNhcoocOTFl40gKtsjw7wy0iIIWRIwOQg4HstMsnGglTMic1AKJSZszaQc3SMqVLFuyegR+VdWF7X3IKh6CtH5LfJ7ah/ekcfGG+e3G3R07Ll3HmzqnbcgPqEscESOckXLywztMr+0wBs0rK68610XBVTaeXeYzLn22dJEzghlyVAI70bhaBryBROf18jFvA/0qEr3Jxm6xACFVNe+iO+8YbOfcWSlw2VkczabranO590xf5VuWo/IaNbLcRNuZEXbHt58PCe9hKa0J+P3aG5kFk2bLWvuM/B+uIKFD6JFYROV3GiWFzJDZbF1Yb756+kPcAMv+gdJ2rosHoHw/g/Hb7//8f33NC/df17+Bv2D/gE/x2jrSqFaS3UrYlclt/XIu6uf3dXP7upnd/Wzu/rZP06F565+dlc/u6uf3dXP7upnd/Wz/z4i7Opnd/Wzu/rZXf3srn52Vz+7q5/d1c/u6md39bO7+tld/ezXq17c1c/u6md39bNPnRN39bMxiYSswv2qEFK1sud8ptL5SlXtZZpMKZPp6Dy5u6PXvw+ULU/Nv9ZoKA3qMk1uhJEU4+YkqDQm71DWyjVS+shbH7LvndHyqed2fnBeyf2i3CM/4g2f+r2w7WSr05P3Z0maxPKGUuc0xogZVQWLmc87CcTkkk3BtVaFUJOak2gSPyflG4naTbvJStecrBR+tHJxhJq3MOxmMflt0P+0qY0D7u58ItRi0cD7rq0jAmEjNB3f5WKx+Bd66w0c","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"}}');var s=t(74848),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:"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:"eJztO9tyGzmuv4Ltl0xcLdlSnEzWT5tJ5uzxnjlj18SpqVO2y0N1QxLjbrKHZFvWuPS2X7Kftl+yBZBsdetiO5ed9dRRHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/VczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvzt/cmPMNamFK4Pp0Vt02a5XBrMXDH307spNrt6ZiM1rDNSTVIoxTXRSzr4tZbZNW3bosrpLw18c3rMtNrbe19XlTYOc/jZb+Fob496vsNCz0AYZPhMl6VWUAkjSnR8YFPhuNvgr7U0mIdjKYpIi6ML1YO9PTev8GhvD45VLjMiBk9IraDHAbbvQYlIBPq+wkyOZQBtkQ60gtlUZlOmyUz486wKkXk0DdoKMydvsDvxbQpzmvgdKh0xmGojf9PKiYKP4waNk5ko2sdGCBKodcI4ImelpXKxNawA/xeOh06PDyXwFaGWE7FKqbjHItyIokYbsJqlMCWsfsLKoGVmD/MSIVUOU5ST6db1RP6xtq4zMdSW0GxjEdaKp8TkRSbbWBQWQY47tCzFNbZWA81CLIo+fDeHHMeiLlwKkjjOmRr78KN2IKqqkJkYFUicCyQ8wtUGe3zKgR0CIkqUfManLNNoQUAux2M0JJzUyVOEMRE74rOlEmDJcVOhQKuVg850oc06C3Fzl46QaeVQuT68uRGyYOT9Zi1IlRV1jjAqRHadwqioMQWDuRfcOZLiSj2/MwgIG2jO9AGLBXGhVoS/0mF5acEGrPI+nE2lXcoTdUZS8yLStqkapHasaWUiQRQxwFLIImXCpfBRj8BJV2BKAlsJNU9JY2IKDm/dSN+mkE0xu+ZfRuRSw6h2Tiu/sdzoKtczFWg51spZ+dsGiYw9n07RYQqHKbxK4XUKg4MUBsMUBocpDF6lMHidwvAgheEwheFhCsNXHq3h6zSq/EjgNgKDoaey++NQl/TuD9KyZJPCtI0OnnV08KAPe3uNNFHbL7/8cqHuLhTARULCdZEcwUXSgFwkqe8jnUl9g/B9Sx8vht+Gzzl9vhq+Dp8zBh0chs8pfQ4HF2oRFrxQQ8bEibK6Bwvq/qoYhK/ARNTGi1Jb1GfUSIoojR10Vh18qGPR3ssL2otU0klR2O3biRBPaEdLlNY2dUibYnbdviPufkLbaeNDPawmfRer1VZXFHjGYri2+5f9cLNs37xf9snsvYXOl239FW2dVNMZqabt+2+01xMiwipOX0aJb/tsALBm3k6HAPCEqNDF6Mto8JpoQJfSdgJQ7xPafQsd6gg3vO87OOwNXvaGB8PDDgXIN/IAZdnL8958Pv8a1CObJyxPJk+0UL1lR37p2Ohyg/vB3sESKthE/Dua7P9Lhvoo2rCYk9/HjkW0WBqPr21lO52L+TPrp4pDG+OM4Jem2byFJncRHuz9ZlMts4A8wUSTbEQOXp9o0GNK7uf5fouS1JjnvbLsrTTSZ48J32osy36e91cg107HN5aQ5ymsN29sz3Moy3JLs2+/SNik+jOxfrDEtnN/APi9BGDJ592F7xUOigdoVfDa7KRtlo6VK2QqVegIrAIrAAYndSEM3pK3aaVWHvrrS04UnKW9zt4pO3bs+3tSwDcnwSZ/HpiattCdgFoeHre2s/YkBid4y3NktXW6JGRkLmiGFGydTcl7E9H0J7ov4zT8lYlKUpSgQOe4FV3W34SEP7WWh02nuupgW3SdzQgLceQGH5uPn9l7cMDXW3Aw7rnfAsQTUvErKFGnD1dQ9/lFUgq2AIjLcPlbuymai+SyGeO9aswfGHv5CDmayhwLMcJivevRMtDeS+CnFmGoo5SqiQQwvgdpq1PcrnT6vsUG2fI7bjN1VOJRNCKJoZA2xkK69GqPDsEiDuEpRI4KjhDiAAq5Rsn9UjZvEHscn3stEA7ngSUIDhiwCdTF1R5YoXMwbcLQHKVUsqzLJuI4bmaNJCvDbd6mF42kSHZcoX26ayuI2wdWoPDe9gUu1IAjAzGicI+tFyCekDJYQel+Of0cNdG5I7/S5fawAMZttQVww5VIoP4ybITPbpe+PpzQBURRTj+I4lZZhpWjGNeXimaD8qOvII4C+cjWdxzZ2s557fjXE+K+DWj9mzkwwP0+XNje3h+IEztoP5obfRyvFJN7nF3ufkL8F/BZOdwkTXRFb59Sq+M8OUpyei2Nj3tJyjOjdd/pfJ4c3SUh0E4/QxibRu5/tPTcepfYbIqloF8RI3qgpffRJE043kJvtESk5CjRo4+Y0RqVIRycREsjGfroLkL5Z8UkDd53cpT498YkTfBWlBUBJysPslU+ThZxwfumalqWU1n+0bxv0jz0cveZ0/xIQxcrz9KfNdO71gy8txLP9FtNfQ7fibltzeuv92T1NZzGEPNnYRTkYm5JnmrrLbFMFFldkCePt5U08yaswO58iysafJuVGnwHLxcpPwugaaMkjBHzJE2kw7LdvoUJjP70k8tQE2U4tvupYz9qHCH+JTTQ2zsfvCg/GYuPGmGEfOjVVKtPHj8YvhgMBy8GQ5ohPMp8Ph197zoGXcZ4Qz4o5tE67y3fUVPgt4z+Qzwa4XnbYoIPM+PZtvf11rOeneq6yOnBDIXp8zP3Z2dQdPm7uYP6D3DzIk1uH97MLWS6Fx/v4ZsCxw7qqkIDmTYKzfN2BO/JbG54eLhIk/nD25v/Ibf3LR3e7OHd/cxZD8uMkP8Eri9eL9Jk+jCu/93kZfwHkT18tVjerklmUDiMl8PVSOfzq6i3Fg8BxouC4Ma6yNGQFbKur5aqhjQM5RNdrer5kdYFCrVB0XQe5EPuFxmDZAeGEPZsimRLL21Enn1plgar0WNLj/y4EmGUlqw/U+NF0ofjccvI5QDBak5AhOX3eaXhGa93ZWtW48/2wzfR6Fk794nSUZah+4gCA4PDsio4eWgmi4Lwpnu9D80/NvcaShIC8bqMCz98Vbz1kUxeMAzqZt5AsBj78FaoJvuim+UAd3cNGzB3LBZwd0eniuaKLt3FIl020FqdBr5XfYvBDOVNZ1TThMuBTVtrqDdxrsjE8Q3hNayNgJwoqSZXtSkWi/4aGy7P6NF0WyNTODua5P8BxQidY3VicjSPkNzjsffTNDwjZn0WouJMGWmsC/Lo2T0g7B+3tlA5ZDGQe/d9I9+2HlmCUnG+pfw4IycTpAzDAMGDQ04QimzqNQNjJcYk2pw1aPBG6tpG9KbCNiZ3ThDSi4tUk66b2aIOp2y1997fJLqKkohOzk4fQUt2gnteE3kP0u/SzwEnZ6eUhyjHwaPrwwfbUCKSVnRAgHwtuJEi5io15tvcxylRMUW82uwkjfZDBmAP1hHKpd2IUbp8KWnydtcmXiaq0hHp2lGGrAzpV9ZhZTt0ZCwaQp7p+jFc+QAlBUxqfmh1dCtH1civN8s8QqmsM7WP0UJem5g6GdiCIDO0dkmnSBUCas2fAirrhwsYC+vQpFArSZQ3NYVIminxtkIjUWW4kQQGPelIch/WZt2kvA8//RDSk+MeolCOSAL9xJhDXTHXsCQ0yaLx5Fa3vlF3BLX1MIJ0QXNKZwjPV2isVkCpmGYilPzNszA7HdqSxzYVhQcNqoKeqQkfkvAuMtGc+uff/9HCa6vbuY6YX0HkOb0ZPoAhh8g8w1No3mBFGlB3MaL50Pxl1c4j7FhorkqdN4JkH8/jp5RB7GyjF53mjHMs0CfIxzfMRt/aNOpYGzxHeso0/ORIxHa6ov3irbSule4YkxLW9cNPSHTMWjiwp0FSTTyv5m0Bb/AKaZXL6dgGlN1U2cbSXZGFlsXaCYb5i54t2mVwK2hiyv7Wynqfe3hwQH+6FG3qD4IVTLQjPh/XRTH/U5I+PrJ2v8PfYCs32tH3OfHTj3L42212MzwlxtmiB+6dIPgctSmopoAEo9ecAfNji7ZSFVLhFZP4KtfZlUF7NTw4uBoQjRdpcriJjO91iW7KrEPEnBlNJQdVgYJS4M0cxERIBWQGm69IVTRGm/v9kk/DbAMlIg9dHXaI8HKdCMeKH365lOVMX6P6fXfaXt755QnV25IZxuvnRHog7k86m223+01azGoj3Tw5Or9Lbnuikj3ff3R+ubhMEyKspuB0pS1jLNw0OUr2V2PVFs0NRx3P7zz7NhxphcrpcXbNExaV3L8ZJIt0dcRGv3krNNa9TxtgnZhINbl/1OWSNO/p+PwJdQi0jAtW8n+QAoOB/m2oNJHENlMUZHcTxYkrflpG9r+PZxuj75sC6sszXA2Rxwh5J+i9eqVsCGNvjmIPXrbix+cxFMzR3Sa4uyle22w9RmCbAGwrptoKqZ4vebyJXsbg5YCjfsPDQw6PfTvgONKL1xyiOXy1YK5chiuSpBuS4BeYVcc6SboOYxzUuENh1NKm98+BHeM0NHWNtThTYxx1LJRVA2WrsbDFVogGolRjzfwWmOCkQvWe7G9SAzeD9agaFpkumxKHCP7Pv/+DR0Tm4WX+BCe1gUrP0IxrXycxLvBWksXbqteLMRsUZYHWFnMgQ3fClXu5nHCqVDQjM1GJkSwk6TUC0/4No6UabR9+XkZ9nhmfNXaDBalDKLTmMjYyeWqnS14j3uEzba7HhFJKxYBU+USGnEWMQ1BNhcoocOTFl40gKtsjw7wy0iIIWRIwOQg4HstMsnGglTMic1AKJSZszaQc3SMqVLFuyegR+VdWF7X3IKh6CtH5LfJ7ah/ekcfGG+e3G3R07Ll3HmzqnbcgPqEscESOckXLywztMr+0wBs0rK68610XBVTaeXeYzLn22dJEzghlyVAI70bhaBryBROf18jFvA/0qEr3Jxm6xACFVNe+iO+8YbOfcWSlw2VkczabranO590xf5VuWo/IaNbLcRNuZEXbHt58PCe9hKa0J+P3aG5kFk2bLWvuM/B+uIKFD6JFYROV3GiWFzJDZbF1Yb756+kPcAMv+gdJ2rosHoHw/g/Hb7//8f33NC/df17+Bv2D/gE/x2jrSqFaS3UrYlclt/XIu6uf3dXP7upnd/Wzu/rZP06F565+dlc/u6uf3dXP7upnd/Wz/z4i7Opnd/Wzu/rZXf3srn52Vz+7q5/d1c/u6md39bO7+tld/ezXq17c1c/u6md39bNPnRN39bMxiYSswv2qEFK1sud8ptL5SlXtZZpMKZPp6Dy5u6PXvw+ULU/Nv9ZoKA3qMk1uhJEU4+YkqDQm71DWyjVS+shbH7LvndHyqed2fnBeyf2i3CM/4g2f+r2w7WSr05P3Z0maxPKGUuc0xogZVQWLmc87CcTkkk3BtVaFUJOak2gSPyflG4naTbvJStecrBR+tHJxhJq3MOxmMflt0P+0qY0D7u58ItRi0cD7rq0jAmEjNB3f5WKx+Bd66w0c",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=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,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function 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/a9f09360.e942082e.js b/assets/js/a9f09360.e942082e.js deleted file mode 100644 index e2d5a8afd..000000000 --- a/assets/js/a9f09360.e942082e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3213],{20730:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","source":"@site/docs/API-docs/draftdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/draftdocument","permalink":"/docs/API-docs/draftdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar_label":"Draft Document","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyGzmuv4Ltl0xcLdlSnEzWT5tJ5uzxnjlj18SpqVO2y0N1QxLjbrKHZFvWuPS2X7Kftl+yBZBsdetiO5ed9dRRHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/VczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvzt/cmPMNamFK4Pp0Vt02a5XBrMXDH307spNrt6ZiM1rDNSTVIoxTXRSzr4tZbZNW3bosrpLw18c3rMtNrbe19XlTYOc/jZb+Fob496vsNCz0AYZPhMl6VWUAkjSnR8YFPhuNvgr7U0mIdjKYpIi6ML1YO9PTev8GhvD45VLjMiBk9IraDHAbbvQYlIBPq+wkyOZQBtkQ60gtlUZlOmyUz486wKkXk0DdoKMydvsDvxbQpzmvgdKh0xmGojf9PKiYKP4waNk5ko2sdGCBKodcI4ImelpXKxNawA/xeOh06PDyXwFaGWE7FKqbjHItyIokYbsJqlMCWsfsLKoGVmD/MSIVUOU5ST6db1RP6xtq4zMdSW0GxjEdaKp8TkRSbbWBQWQY47tCzFNbZWA81CLIo+fDeHHMeiLlwKkjjOmRr78KN2IKqqkJkYFUicCyQ8wtUGe3zKgR0CIkqUfManLNNoQUAux2M0JJzUyVOEMRE74rOlEmDJcVOhQKuVg850oc06C3Fzl46QaeVQuT68uRGyYOT9Zi1IlRV1jjAqRHadwqioMQWDuRfcOZLiSj2/MwgIG2jO9AGLBXGhVoS/0mF5acEGrPI+nE2lXcoTdUZS8yLStqkapHasaWUiQRQxwFLIImXCpfBRj8BJV2BKAlsJNU9JY2IKDm/dSN+mkE0xu+ZfRuRSw6h2Tiu/sdzoKtczFWg51spZ+dsGiYw9n07RYQqHKbxK4XUKg4MUBsMUBocpDF6lMHidwvAgheEwheFhCsNXHq3h6zSq/EjgNgKDoaey++NQl/TuD9KyZJPCtI0OnnV08KAPe3uNNFHbL7/8cqHuLhTARULCdZEcwUXSgFwkqe8jnUl9g/B9Sx8vht+Gzzl9vhq+Dp8zBh0chs8pfQ4HF2oRFrxQQ8bEibK6Bwvq/qoYhK/ARNTGi1Jb1GfUSIoojR10Vh18qGPR3ssL2otU0klR2O3biRBPaEdLlNY2dUibYnbdviPufkLbaeNDPawmfRer1VZXFHjGYri2+5f9cLNs37xf9snsvYXOl239FW2dVNMZqabt+2+01xMiwipOX0aJb/tsALBm3k6HAPCEqNDF6Mto8JpoQJfSdgJQ7xPafQsd6gg3vO87OOwNXvaGB8PDDgXIN/IAZdnL8958Pv8a1CObJyxPJk+0UL1lR37p2Ohyg/vB3sESKthE/Dua7P9Lhvoo2rCYk9/HjkW0WBqPr21lO52L+TPrp4pDG+OM4Jem2byFJncRHuz9ZlMts4A8wUSTbEQOXp9o0GNK7uf5fouS1JjnvbLsrTTSZ48J32osy36e91cg107HN5aQ5ymsN29sz3Moy3JLs2+/SNik+jOxfrDEtnN/APi9BGDJ592F7xUOigdoVfDa7KRtlo6VK2QqVegIrAIrAAYndSEM3pK3aaVWHvrrS04UnKW9zt4pO3bs+3tSwDcnwSZ/HpiattCdgFoeHre2s/YkBid4y3NktXW6JGRkLmiGFGydTcl7E9H0J7ov4zT8lYlKUpSgQOe4FV3W34SEP7WWh02nuupgW3SdzQgLceQGH5uPn9l7cMDXW3Aw7rnfAsQTUvErKFGnD1dQ9/lFUgq2AIjLcPlbuymai+SyGeO9aswfGHv5CDmayhwLMcJivevRMtDeS+CnFmGoo5SqiQQwvgdpq1PcrnT6vsUG2fI7bjN1VOJRNCKJoZA2xkK69GqPDsEiDuEpRI4KjhDiAAq5Rsn9UjZvEHscn3stEA7ngSUIDhiwCdTF1R5YoXMwbcLQHKVUsqzLJuI4bmaNJCvDbd6mF42kSHZcoX26ayuI2wdWoPDe9gUu1IAjAzGicI+tFyCekDJYQel+Of0cNdG5I7/S5fawAMZttQVww5VIoP4ybITPbpe+PpzQBURRTj+I4lZZhpWjGNeXimaD8qOvII4C+cjWdxzZ2s557fjXE+K+DWj9mzkwwP0+XNje3h+IEztoP5obfRyvFJN7nF3ufkL8F/BZOdwkTXRFb59Sq+M8OUpyei2Nj3tJyjOjdd/pfJ4c3SUh0E4/QxibRu5/tPTcepfYbIqloF8RI3qgpffRJE043kJvtESk5CjRo4+Y0RqVIRycREsjGfroLkL5Z8UkDd53cpT498YkTfBWlBUBJysPslU+ThZxwfumalqWU1n+0bxv0jz0cveZ0/xIQxcrz9KfNdO71gy8txLP9FtNfQ7fibltzeuv92T1NZzGEPNnYRTkYm5JnmrrLbFMFFldkCePt5U08yaswO58iysafJuVGnwHLxcpPwugaaMkjBHzJE2kw7LdvoUJjP70k8tQE2U4tvupYz9qHCH+JTTQ2zsfvCg/GYuPGmGEfOjVVKtPHj8YvhgMBy8GQ5ohPMp8Ph197zoGXcZ4Qz4o5tE67y3fUVPgt4z+Qzwa4XnbYoIPM+PZtvf11rOeneq6yOnBDIXp8zP3Z2dQdPm7uYP6D3DzIk1uH97MLWS6Fx/v4ZsCxw7qqkIDmTYKzfN2BO/JbG54eLhIk/nD25v/Ibf3LR3e7OHd/cxZD8uMkP8Eri9eL9Jk+jCu/93kZfwHkT18tVjerklmUDiMl8PVSOfzq6i3Fg8BxouC4Ma6yNGQFbKur5aqhjQM5RNdrer5kdYFCrVB0XQe5EPuFxmDZAeGEPZsimRLL21Enn1plgar0WNLj/y4EmGUlqw/U+NF0ofjccvI5QDBak5AhOX3eaXhGa93ZWtW48/2wzfR6Fk794nSUZah+4gCA4PDsio4eWgmi4Lwpnu9D80/NvcaShIC8bqMCz98Vbz1kUxeMAzqZt5AsBj78FaoJvuim+UAd3cNGzB3LBZwd0eniuaKLt3FIl020FqdBr5XfYvBDOVNZ1TThMuBTVtrqDdxrsjE8Q3hNayNgJwoqSZXtSkWi/4aGy7P6NF0WyNTODua5P8BxQidY3VicjSPkNzjsffTNDwjZn0WouJMGWmsC/Lo2T0g7B+3tlA5ZDGQe/d9I9+2HlmCUnG+pfw4IycTpAzDAMGDQ04QimzqNQNjJcYk2pw1aPBG6tpG9KbCNiZ3ThDSi4tUk66b2aIOp2y1997fJLqKkohOzk4fQUt2gnteE3kP0u/SzwEnZ6eUhyjHwaPrwwfbUCKSVnRAgHwtuJEi5io15tvcxylRMUW82uwkjfZDBmAP1hHKpd2IUbp8KWnydtcmXiaq0hHp2lGGrAzpV9ZhZTt0ZCwaQp7p+jFc+QAlBUxqfmh1dCtH1civN8s8QqmsM7WP0UJem5g6GdiCIDO0dkmnSBUCas2fAirrhwsYC+vQpFArSZQ3NYVIminxtkIjUWW4kQQGPelIch/WZt2kvA8//RDSk+MeolCOSAL9xJhDXTHXsCQ0yaLx5Fa3vlF3BLX1MIJ0QXNKZwjPV2isVkCpmGYilPzNszA7HdqSxzYVhQcNqoKeqQkfkvAuMtGc+uff/9HCa6vbuY6YX0HkOb0ZPoAhh8g8w1No3mBFGlB3MaL50Pxl1c4j7FhorkqdN4JkH8/jp5RB7GyjF53mjHMs0CfIxzfMRt/aNOpYGzxHeso0/ORIxHa6ov3irbSule4YkxLW9cNPSHTMWjiwp0FSTTyv5m0Bb/AKaZXL6dgGlN1U2cbSXZGFlsXaCYb5i54t2mVwK2hiyv7Wynqfe3hwQH+6FG3qD4IVTLQjPh/XRTH/U5I+PrJ2v8PfYCs32tH3OfHTj3L42212MzwlxtmiB+6dIPgctSmopoAEo9ecAfNji7ZSFVLhFZP4KtfZlUF7NTw4uBoQjRdpcriJjO91iW7KrEPEnBlNJQdVgYJS4M0cxERIBWQGm69IVTRGm/v9kk/DbAMlIg9dHXaI8HKdCMeKH365lOVMX6P6fXfaXt755QnV25IZxuvnRHog7k86m223+01azGoj3Tw5Or9Lbnuikj3ff3R+ubhMEyKspuB0pS1jLNw0OUr2V2PVFs0NRx3P7zz7NhxphcrpcXbNExaV3L8ZJIt0dcRGv3krtHViItWkd++oy+VO39NpeIJ39rsM81Xyf5DifIGcbag0kcQFUxRkRhMB6ZB/Wgbqv49HFYPpm+LjyyNZjXjHgHcnhr16Q2yISm8OSg9etsLB5zGyy8HaJla7KfzabD0GVJt4aitE2oqQni9ZtglGxljkgIN4w8NDjnZ9O+Cw0IvXHHE5fLVgJltGH5KkG2HgB5VVPzlJuv5fHNR4N2HU0kT3r3sdWzM0dW2vOFNj63QMjlV7Y+vdv+Xqj/aeVGPN/BaY4KRC9Z7MaZLqm8F6kAyLTJdNxUIE/+ff/8EjIvPwMn+Ck9pApWdoxrUvexgXeCvJgG2V38UQDIqyQGuLOZDdOuFCvFxOOPMpWoWZqMRIFpLUFIFp/yTR0nS2Dz8vgzjPjE8Cu8GCtBsUWnNVGlkwtdMlrxGv5Jk212NCKaXaPipkIrvMIsYhqKZCZRQH8uLLNg1V4ZGdXRlpEYQsCZjsfRyPZSb5rtfKGZE5KIUSEzZOUg7WERWqWIZk9IjcJauL2jsEVAyF6PwW+Xm0D+/IAeON81MMOjr23PsCNvW+WBCfUOU3Ir+3ouVlhnaZLlrgDRpWV96TrosCKu28d0vWWftsaSJnhLJ074dnoHA0DfmCxc5r5GLeB3ojpeuQ7FZigEKqa1+Td96w2c84stLhMlA5m83WVOfz7pi/SjetR2QD6+W4CTeyom0Pbz6ek15CU9qT8Xs0NzKLlsqWNfcZeD/cqMLHxKKwiUputLILmaGy2Lr/3vz19Ae4gRf9gyRtXRaPQHj/h+O33//4/nual64zL3+D/kH/gF9XtHWlUK2lugWuq5LberPdlcPuymF35bC7cthdOewfp2BzVw67K4fdlcPuymF35bC7cth/HxF25bC7cthdOeyuHHZXDrsrh92Vw+7KYXflsLty2F057K4c9usVI+7KYXflsLty2KfOibty2JhEQlbhflUIqVrJcD7x6HylSPYyTaaUmHR0ntzd0evfB0p+p+ZfazSU1XSZJjfCSIpxc05TGpN3KGvlGil95K0P2ffOaPnUczs/OK+kclHukR/xhk/9Xth27tTpyfuzJE1itUKpcxpjxIyKfMXM550EYnIFpuDSqUKoSc1JNImfk/KNRO2m3WSla05WCj9auThCzVsYdrOY/Dbof9rUxgF3dz4RarFo4H3X1hGBsBGaju9ysVj8Czgy++I=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Self Sign","permalink":"/docs/API-docs/selfsign"},"next":{"title":"Create Document","permalink":"/docs/API-docs/createdocument"}}');var s=t(74848),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 f={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:"eJztO9tyGzmuv4Ltl0xcLdlSnEzWT5tJ5uzxnjlj18SpqVO2y0N1QxLjbrKHZFvWuPS2X7Kftl+yBZBsdetiO5ed9dRRHmI1CZIgCIAACNwlTkxscnSevNNZXaJyNrlMkxxtZmTlpFbJUXI2RXhnxNhBBII3p8cgikLPLNQWjQWnYYIKjXAICmeQx+lgNIfK6BuZSzWBXDgBM+mmIGAkLL46BFSZzjGHsSywf6Eu1JmsjuBDVWiRw1zXBk7f/VczHy1Ebed7e+9wVE/gw/He3uU3U+cqe7S/L6qqrytUVk5UIUa2n+lyPyfAKh8/T2E2RYM0K2RCAQorizmIPIeZzCfobApuigoyXc0h09rkUgmHNoVKTBBUXY7Q2BSEyqHUBkEqEGBQ5POe073aIvzt/cmPMNamFK4Pp0Vt02a5XBrMXDH307spNrt6ZiM1rDNSTVIoxTXRSzr4tZbZNW3bosrpLw18c3rMtNrbe19XlTYOc/jZb+Fob496vsNCz0AYZPhMl6VWUAkjSnR8YFPhuNvgr7U0mIdjKYpIi6ML1YO9PTev8GhvD45VLjMiBk9IraDHAbbvQYlIBPq+wkyOZQBtkQ60gtlUZlOmyUz486wKkXk0DdoKMydvsDvxbQpzmvgdKh0xmGojf9PKiYKP4waNk5ko2sdGCBKodcI4ImelpXKxNawA/xeOh06PDyXwFaGWE7FKqbjHItyIokYbsJqlMCWsfsLKoGVmD/MSIVUOU5ST6db1RP6xtq4zMdSW0GxjEdaKp8TkRSbbWBQWQY47tCzFNbZWA81CLIo+fDeHHMeiLlwKkjjOmRr78KN2IKqqkJkYFUicCyQ8wtUGe3zKgR0CIkqUfManLNNoQUAux2M0JJzUyVOEMRE74rOlEmDJcVOhQKuVg850oc06C3Fzl46QaeVQuT68uRGyYOT9Zi1IlRV1jjAqRHadwqioMQWDuRfcOZLiSj2/MwgIG2jO9AGLBXGhVoS/0mF5acEGrPI+nE2lXcoTdUZS8yLStqkapHasaWUiQRQxwFLIImXCpfBRj8BJV2BKAlsJNU9JY2IKDm/dSN+mkE0xu+ZfRuRSw6h2Tiu/sdzoKtczFWg51spZ+dsGiYw9n07RYQqHKbxK4XUKg4MUBsMUBocpDF6lMHidwvAgheEwheFhCsNXHq3h6zSq/EjgNgKDoaey++NQl/TuD9KyZJPCtI0OnnV08KAPe3uNNFHbL7/8cqHuLhTARULCdZEcwUXSgFwkqe8jnUl9g/B9Sx8vht+Gzzl9vhq+Dp8zBh0chs8pfQ4HF2oRFrxQQ8bEibK6Bwvq/qoYhK/ARNTGi1Jb1GfUSIoojR10Vh18qGPR3ssL2otU0klR2O3biRBPaEdLlNY2dUibYnbdviPufkLbaeNDPawmfRer1VZXFHjGYri2+5f9cLNs37xf9snsvYXOl239FW2dVNMZqabt+2+01xMiwipOX0aJb/tsALBm3k6HAPCEqNDF6Mto8JpoQJfSdgJQ7xPafQsd6gg3vO87OOwNXvaGB8PDDgXIN/IAZdnL8958Pv8a1CObJyxPJk+0UL1lR37p2Ohyg/vB3sESKthE/Dua7P9Lhvoo2rCYk9/HjkW0WBqPr21lO52L+TPrp4pDG+OM4Jem2byFJncRHuz9ZlMts4A8wUSTbEQOXp9o0GNK7uf5fouS1JjnvbLsrTTSZ48J32osy36e91cg107HN5aQ5ymsN29sz3Moy3JLs2+/SNik+jOxfrDEtnN/APi9BGDJ592F7xUOigdoVfDa7KRtlo6VK2QqVegIrAIrAAYndSEM3pK3aaVWHvrrS04UnKW9zt4pO3bs+3tSwDcnwSZ/HpiattCdgFoeHre2s/YkBid4y3NktXW6JGRkLmiGFGydTcl7E9H0J7ov4zT8lYlKUpSgQOe4FV3W34SEP7WWh02nuupgW3SdzQgLceQGH5uPn9l7cMDXW3Aw7rnfAsQTUvErKFGnD1dQ9/lFUgq2AIjLcPlbuymai+SyGeO9aswfGHv5CDmayhwLMcJivevRMtDeS+CnFmGoo5SqiQQwvgdpq1PcrnT6vsUG2fI7bjN1VOJRNCKJoZA2xkK69GqPDsEiDuEpRI4KjhDiAAq5Rsn9UjZvEHscn3stEA7ngSUIDhiwCdTF1R5YoXMwbcLQHKVUsqzLJuI4bmaNJCvDbd6mF42kSHZcoX26ayuI2wdWoPDe9gUu1IAjAzGicI+tFyCekDJYQel+Of0cNdG5I7/S5fawAMZttQVww5VIoP4ybITPbpe+PpzQBURRTj+I4lZZhpWjGNeXimaD8qOvII4C+cjWdxzZ2s557fjXE+K+DWj9mzkwwP0+XNje3h+IEztoP5obfRyvFJN7nF3ufkL8F/BZOdwkTXRFb59Sq+M8OUpyei2Nj3tJyjOjdd/pfJ4c3SUh0E4/QxibRu5/tPTcepfYbIqloF8RI3qgpffRJE043kJvtESk5CjRo4+Y0RqVIRycREsjGfroLkL5Z8UkDd53cpT498YkTfBWlBUBJysPslU+ThZxwfumalqWU1n+0bxv0jz0cveZ0/xIQxcrz9KfNdO71gy8txLP9FtNfQ7fibltzeuv92T1NZzGEPNnYRTkYm5JnmrrLbFMFFldkCePt5U08yaswO58iysafJuVGnwHLxcpPwugaaMkjBHzJE2kw7LdvoUJjP70k8tQE2U4tvupYz9qHCH+JTTQ2zsfvCg/GYuPGmGEfOjVVKtPHj8YvhgMBy8GQ5ohPMp8Ph197zoGXcZ4Qz4o5tE67y3fUVPgt4z+Qzwa4XnbYoIPM+PZtvf11rOeneq6yOnBDIXp8zP3Z2dQdPm7uYP6D3DzIk1uH97MLWS6Fx/v4ZsCxw7qqkIDmTYKzfN2BO/JbG54eLhIk/nD25v/Ibf3LR3e7OHd/cxZD8uMkP8Eri9eL9Jk+jCu/93kZfwHkT18tVjerklmUDiMl8PVSOfzq6i3Fg8BxouC4Ma6yNGQFbKur5aqhjQM5RNdrer5kdYFCrVB0XQe5EPuFxmDZAeGEPZsimRLL21Enn1plgar0WNLj/y4EmGUlqw/U+NF0ofjccvI5QDBak5AhOX3eaXhGa93ZWtW48/2wzfR6Fk794nSUZah+4gCA4PDsio4eWgmi4Lwpnu9D80/NvcaShIC8bqMCz98Vbz1kUxeMAzqZt5AsBj78FaoJvuim+UAd3cNGzB3LBZwd0eniuaKLt3FIl020FqdBr5XfYvBDOVNZ1TThMuBTVtrqDdxrsjE8Q3hNayNgJwoqSZXtSkWi/4aGy7P6NF0WyNTODua5P8BxQidY3VicjSPkNzjsffTNDwjZn0WouJMGWmsC/Lo2T0g7B+3tlA5ZDGQe/d9I9+2HlmCUnG+pfw4IycTpAzDAMGDQ04QimzqNQNjJcYk2pw1aPBG6tpG9KbCNiZ3ThDSi4tUk66b2aIOp2y1997fJLqKkohOzk4fQUt2gnteE3kP0u/SzwEnZ6eUhyjHwaPrwwfbUCKSVnRAgHwtuJEi5io15tvcxylRMUW82uwkjfZDBmAP1hHKpd2IUbp8KWnydtcmXiaq0hHp2lGGrAzpV9ZhZTt0ZCwaQp7p+jFc+QAlBUxqfmh1dCtH1civN8s8QqmsM7WP0UJem5g6GdiCIDO0dkmnSBUCas2fAirrhwsYC+vQpFArSZQ3NYVIminxtkIjUWW4kQQGPelIch/WZt2kvA8//RDSk+MeolCOSAL9xJhDXTHXsCQ0yaLx5Fa3vlF3BLX1MIJ0QXNKZwjPV2isVkCpmGYilPzNszA7HdqSxzYVhQcNqoKeqQkfkvAuMtGc+uff/9HCa6vbuY6YX0HkOb0ZPoAhh8g8w1No3mBFGlB3MaL50Pxl1c4j7FhorkqdN4JkH8/jp5RB7GyjF53mjHMs0CfIxzfMRt/aNOpYGzxHeso0/ORIxHa6ov3irbSule4YkxLW9cNPSHTMWjiwp0FSTTyv5m0Bb/AKaZXL6dgGlN1U2cbSXZGFlsXaCYb5i54t2mVwK2hiyv7Wynqfe3hwQH+6FG3qD4IVTLQjPh/XRTH/U5I+PrJ2v8PfYCs32tH3OfHTj3L42212MzwlxtmiB+6dIPgctSmopoAEo9ecAfNji7ZSFVLhFZP4KtfZlUF7NTw4uBoQjRdpcriJjO91iW7KrEPEnBlNJQdVgYJS4M0cxERIBWQGm69IVTRGm/v9kk/DbAMlIg9dHXaI8HKdCMeKH365lOVMX6P6fXfaXt755QnV25IZxuvnRHog7k86m223+01azGoj3Tw5Or9Lbnuikj3ff3R+ubhMEyKspuB0pS1jLNw0OUr2V2PVFs0NRx3P7zz7NhxphcrpcXbNExaV3L8ZJIt0dcRGv3krtHViItWkd++oy+VO39NpeIJ39rsM81Xyf5DifIGcbag0kcQFUxRkRhMB6ZB/Wgbqv49HFYPpm+LjyyNZjXjHgHcnhr16Q2yISm8OSg9etsLB5zGyy8HaJla7KfzabD0GVJt4aitE2oqQni9ZtglGxljkgIN4w8NDjnZ9O+Cw0IvXHHE5fLVgJltGH5KkG2HgB5VVPzlJuv5fHNR4N2HU0kT3r3sdWzM0dW2vOFNj63QMjlV7Y+vdv+Xqj/aeVGPN/BaY4KRC9Z7MaZLqm8F6kAyLTJdNxUIE/+ff/8EjIvPwMn+Ck9pApWdoxrUvexgXeCvJgG2V38UQDIqyQGuLOZDdOuFCvFxOOPMpWoWZqMRIFpLUFIFp/yTR0nS2Dz8vgzjPjE8Cu8GCtBsUWnNVGlkwtdMlrxGv5Jk212NCKaXaPipkIrvMIsYhqKZCZRQH8uLLNg1V4ZGdXRlpEYQsCZjsfRyPZSb5rtfKGZE5KIUSEzZOUg7WERWqWIZk9IjcJauL2jsEVAyF6PwW+Xm0D+/IAeON81MMOjr23PsCNvW+WBCfUOU3Ir+3ouVlhnaZLlrgDRpWV96TrosCKu28d0vWWftsaSJnhLJ074dnoHA0DfmCxc5r5GLeB3ojpeuQ7FZigEKqa1+Td96w2c84stLhMlA5m83WVOfz7pi/SjetR2QD6+W4CTeyom0Pbz6ek15CU9qT8Xs0NzKLlsqWNfcZeD/cqMLHxKKwiUputLILmaGy2Lr/3vz19Ae4gRf9gyRtXRaPQHj/h+O33//4/nual64zL3+D/kH/gF9XtHWlUK2lugWuq5LberPdlcPuymF35bC7cthdOewfp2BzVw67K4fdlcPuymF35bC7cth/HxF25bC7cthdOeyuHHZXDrsrh92Vw+7KYXflsLty2F057K4c9usVI+7KYXflsLty2KfOibty2JhEQlbhflUIqVrJcD7x6HylSPYyTaaUmHR0ntzd0evfB0p+p+ZfazSU1XSZJjfCSIpxc05TGpN3KGvlGil95K0P2ffOaPnUczs/OK+kclHukR/xhk/9Xth27tTpyfuzJE1itUKpcxpjxIyKfMXM550EYnIFpuDSqUKoSc1JNImfk/KNRO2m3WSla05WCj9auThCzVsYdrOY/Dbof9rUxgF3dz4RarFo4H3X1hGBsBGaju9ysVj8Czgy++I=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=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,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Draft Document"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/draftdocument",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio Button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"createdocument_body_signers"}},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"draftdocument_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{document_id:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-send-document.com"}},title:"inline_draft_doc_res_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function 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/ada7accb.915a6c10.js b/assets/js/ada7accb.915a6c10.js new file mode 100644 index 000000000..2506ad73b --- /dev/null +++ b/assets/js/ada7accb.915a6c10.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9983],{96522:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>b,contentTitle:()=>x,default:()=>y,frontMatter:()=>I,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/getfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getfolder","permalink":"/docs/API-docs/getfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar_label":"Get Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oA8l4cJ231VKNNXbdBEtQuAtRZGJQ0WjGmSIYc7QULvfVL+mn9kmIo7VrrdYy6CPJirzT325nRRpCcB5FeiZ+tLtCLWSIKDLlXjpQ1IhWXFcIZEnR0OH13DlJruwywtg2QBY/kFS4QCiSpdACZ2YZAQnCYq1LlUEbRkUiEdeglKz4vRCrmSB1JJMJJL2sk9OzMRhhZo0hFR75WhUiEYm+cpErcddFmHzGn8wJsCTuFHj81ymMhUvINJiLQWrPKoGqnUSQCV07bAkVaSh2YIa+wliLdCFq7yElemblIRGl9LWn4BlcyakmF+2WaVflx5TLRtjM2G5w1AQMrOp5M+N++t6HJcwyhbDTs0iESkVtDaIj5pXNa5ZEw/hhYaHPoXRc0Z86zGlKdyW0uHh1HNc2q1fFHJ9qkT/ubWIPHqTG43JagjUVFQ13nPN6lX4+NDC9u1Du8q+v/ehaabOBd7lESFqd0n6pbwePJ8fOj6eRo8u3l9GV68n364uVoMpn8KRKxqjXL9s1aSIqekiI9fG5c8RXsDF70U+MxiLZlwsl9fXhha6RKmTks0RAsvTXzBJxGGRDIr0HOpTKgJaF/8uUaFL23/uFMPM6zYeTKaGXwejuE1yeTyfV0l4STwyR0qQJjCUrbmGL0FQJ9qEsP/Xk4vJPr73bhvTgM79wspFZFRO1Le4Pm6xZyaJ468+zqfjurjinSxV6ww/ddkAHzxitaxx2xOpJOHXX09GrG6Mt9Y/vVEpcKVSIV4y6r481unbSCdfnFdt00XotUVEQupONxkKbI7GpkHZqg5kbLLIxyW4+lU+PFVLTJXQnp3CO4sTl6nEAgOVdm/rDU7DY9F1zCrkp7SdrVSjr1G65Fsq3BkKvftBXKiJMtP5c2CveVeevQXKi5iXVdTA/28XvUua2RjwOqELbs//z1d5QobN7UaCi23RN423hwdomeN6I0BZQaVyrTeM+tEVDWGkPQa1CGcO4lIRRqrkhq4KwwaOTSyUxpxY3KbJalPQx6PYzgfYVUoWfSNx5BQoEL1NzfoK29YT1kQTZk62ij9xmW1t+U7FICErImKIMhQEDciqCppMkRtrVIwHqQBtAQeudVQJCqZubSesCyVLlixTyVXuYEtTRyjmwsAfabs+C8XagCA3ibNYEgWN3EQNhijUhdiAaxCCP4SS2wC5xfdmcZFjBvWEUCuS0Q+iHlMEwBGQYCx+ZVjlFpIOkJNC7Qx96LlSwbrcFZRg8lNZ9bw9qyIvLSBAa4zqFtaXbpc97y8RNtFHI9gg/mg2G8hyYgN4BW5iakH8wRXO3a7D1mQRHOnm7nYblcHszBs32ZM0VVk4FHZ2/l5vFlnJqh+O7hmUgEoa/D2/IC/ULl2A/hZ2yOI/O4x1SZR0zFWirdzdgPdwUY37TK0QQcIODp2bvXsIDno4lIBpP/Hxwevz7/8dWbi1esl8Gsm7/paDKaxJvJBqqlGZi6veTvTu3mdi982Zu/hxzCFY2dliqCfIxy0wP0ldhd7entxT9LRGUDMXmzyWTAP7xuW379qUHPK2CWiIX0SmaMSlcbUajAv4vdSf/ZAJ/+3n8dPIN7Px7u9XmLnYaBcyF1w08iETe43vtUaWdtsoVPdqujn+Y5OhpIHuzevQV29upSJEI2nJ8hbN9E2O5/sPZ7vdrH884B/sur5V6BzaZbCW274+9In5XoA9xyc4pmbdv+C5eT9Ew=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"}}');var l=a(74848),r=a(28453),o=a(33617),d=a.n(o),n=a(17543),s=a.n(n),p=a(86013),c=a.n(p),m=a(63723),u=a.n(m),h=(a(18766),a(79329),a(9303));const I={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l4cJ231VKNNXbdBEtQuAtRZGJQ0WjGmSIYc7QULvfVL+mn9kmIo7VrrdYy6CPJirzT325nRRpCcB5FeiZ+tLtCLWSIKDLlXjpQ1IhWXFcIZEnR0OH13DlJruwywtg2QBY/kFS4QCiSpdACZ2YZAQnCYq1LlUEbRkUiEdeglKz4vRCrmSB1JJMJJL2sk9OzMRhhZo0hFR75WhUiEYm+cpErcddFmHzGn8wJsCTuFHj81ymMhUvINJiLQWrPKoGqnUSQCV07bAkVaSh2YIa+wliLdCFq7yElemblIRGl9LWn4BlcyakmF+2WaVflx5TLRtjM2G5w1AQMrOp5M+N++t6HJcwyhbDTs0iESkVtDaIj5pXNa5ZEw/hhYaHPoXRc0Z86zGlKdyW0uHh1HNc2q1fFHJ9qkT/ubWIPHqTG43JagjUVFQ13nPN6lX4+NDC9u1Du8q+v/ehaabOBd7lESFqd0n6pbwePJ8fOj6eRo8u3l9GV68n364uVoMpn8KRKxqjXL9s1aSIqekiI9fG5c8RXsDF70U+MxiLZlwsl9fXhha6RKmTks0RAsvTXzBJxGGRDIr0HOpTKgJaF/8uUaFL23/uFMPM6zYeTKaGXwejuE1yeTyfV0l4STwyR0qQJjCUrbmGL0FQJ9qEsP/Xk4vJPr73bhvTgM79wspFZFRO1Le4Pm6xZyaJ468+zqfjurjinSxV6ww/ddkAHzxitaxx2xOpJOHXX09GrG6Mt9Y/vVEpcKVSIV4y6r481unbSCdfnFdt00XotUVEQupONxkKbI7GpkHZqg5kbLLIxyW4+lU+PFVLTJXQnp3CO4sTl6nEAgOVdm/rDU7DY9F1zCrkp7SdrVSjr1G65Fsq3BkKvftBXKiJMtP5c2CveVeevQXKi5iXVdTA/28XvUua2RjwOqELbs//z1d5QobN7UaCi23RN423hwdomeN6I0BZQaVyrTeM+tEVDWGkPQa1CGcO4lIRRqrkhq4KwwaOTSyUxpxY3KbJalPQx6PYzgfYVUoWfSNx5BQoEL1NzfoK29YT1kQTZk62ij9xmW1t+U7FICErImKIMhQEDciqCppMkRtrVIwHqQBtAQeudVQJCqZubSesCyVLlixTyVXuYEtTRyjmwsAfabs+C8XagCA3ibNYEgWN3EQNhijUhdiAaxCCP4SS2wC5xfdmcZFjBvWEUCuS0Q+iHlMEwBGQYCx+ZVjlFpIOkJNC7Qx96LlSwbrcFZRg8lNZ9bw9qyIvLSBAa4zqFtaXbpc97y8RNtFHI9gg/mg2G8hyYgN4BW5iakH8wRXO3a7D1mQRHOnm7nYblcHszBs32ZM0VVk4FHZ2/l5vFlnJqh+O7hmUgEoa/D2/IC/ULl2A/hZ2yOI/O4x1SZR0zFWirdzdgPdwUY37TK0QQcIODp2bvXsIDno4lIBpP/Hxwevz7/8dWbi1esl8Gsm7/paDKaxJvJBqqlGZi6veTvTu3mdi982Zu/hxzCFY2dliqCfIxy0wP0ldhd7entxT9LRGUDMXmzyWTAP7xuW379qUHPK2CWiIX0SmaMSlcbUajAv4vdSf/ZAJ/+3n8dPIN7Px7u9XmLnYaBcyF1w08iETe43vtUaWdtsoVPdqujn+Y5OhpIHuzevQV29upSJEI2nJ8hbN9E2O5/sPZ7vdrH884B/sur5V6BzaZbCW274+9In5XoA9xyc4pmbdv+C5eT9Ew=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,b={},f=[];function F(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,l.jsx)(d(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,l.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.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,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:"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 y(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(F,{...e})}):F(e)}}}]); \ No newline at end of file diff --git a/assets/js/ada7accb.b4126a82.js b/assets/js/ada7accb.b4126a82.js deleted file mode 100644 index 6bc6b9737..000000000 --- a/assets/js/ada7accb.b4126a82.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9983],{96522:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>v,contentTitle:()=>f,default:()=>k,frontMatter:()=>y,metadata:()=>i,toc:()=>Q});const i=JSON.parse('{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/getfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getfolder","permalink":"/docs/API-docs/getfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar_label":"Get Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oA8l4cJ231VKNNXbdBEtQuAtRZGJQ0WjGmSIYc7QULvfVL+mn9kmIo7VrrdYy6CPKyK3Huw5kzo40gOQ8ivRI/W12gF7NEFBhyrxwpa0QqLiuEMyTo6HD67hyk1nYZYG0bIAseyStcIBRIUukAMrMNgYTgMFelyqGMoiORCOvQS1Z8XohUzJE6kkiEk17WSOjZmY0wskaRio58rQqRCMXeOEmVuOuizT5iTucF2BJ2Cj1+apTHQqTkG0xEoLVmlUHVTqNIBK6ctgWKtJQ6MENeYS1FuhG0dpGTvDJzkYjS+lrS8ARXMmpJhftlmlX5ceUy0bYzNhucNQEDKzqeTPhv39vQ5DmGUDYadukQicitITTE/NI5rfJIGH8MLLQ59K4LmjPnWQ2pzuQ2F4+Oo5pm1er4oxNt0qf9TbyDx6kxuNxeQRsvFQ11lfN4l349NjK8uFHv8K6u/+tZaLKBd7lHSVic0n2qbgWPJ8fPj6aTo8m3l9OX6cn36YuXo8lk8qdIxKrWLNsXayEpekqK9PC9ccVXsDM46LvGYxBty4ST++rwwtZIlTJzWKIhWHpr5gk4jTIgkF+DnEtlQEtC/+TLFSh6b/3DmXicZ8PIldHK4PW2Ca9PJpPr6S4JJ4dJ6FIFxhKUtjHF6CsE+lCVHvrzcHgn19/twntxGN65WUitiojal/YGzde9yKF56syzq/vlrDqmSBd7wQ7PuyAD5o1XtI4zYnUknTrq6OnVjNGX68b2oyUOFapEKsZdVseb3ThpBevyi+24abwWqaiIXEjH4yBNkdnVyDo0Qc2NllkY5bYeS6fGi6lok7sS0rlHcAeSc2XmRw9KzW6jveAb6ZK+F/Mu9dKp33Atkm1Kh1z94KxQRthr+b20UbhP9FuH5kLNTbymxfRgvL5HndsaedZThbBl/+evv6NEYfOmRkOxip7A28aDs0v0POCkKaDUuFKZxntWh4Cy1hiCXoMyhHMvCaFQc0VSA2eFMSCXTmZKK647ZrMs7WFQumEE7yukCj2TvvEIEgpcoOZyBW3tDeshC7IhW0cbvc+wtP6mZJcSkJA1QRkMAQLiVgRNJU2OsL2LBKwHaQANoXdeBQSpamYurQcsS5UrVsxN5mVOUEsj58jGEmC/OQvO24UqMIC3WRMIgtVNDIQt1ojUhWgQizCCn9QCu8D5sNuysIB5wyoSyG2B0Pcch2EKyDAQODavcoxKA0lPoHGBPtZevMmy0RqcZTBQUvP2NLxbVkRemsB41Tm0vZpd+py3vMtEG4Vcj+CD+WAYvqEJyAWglbkJ6QdzBFe7MnuPWVCEs6fbflgulwd98Gxf5kxR1WTg0dlbuXk8jF0zFN+9PBOJIPR1eFteoF+oHPsm/IzNcWQe9xAp8wiRWEulux774a4Aw5VWOZqAA0A7PXv3GhbwfDQRyaDz/4PD49fnP756c/GK9TI2df03HU1Gk7gC2UC1NANTt4v53a7d3ML8l13he8ghXNHYaakiZscoNz3eXondEp7eLvCzRFQ2EJM3m0wG/MPrtuXjTw16RvRZIhbSK5kxKl1tRKECPxe7Df2zAT79vV/2n8G93wL3+rzFTsPAuZC64TeRiBtc7315tLM22cInu9XRT/McHQ0kD0bp3jw6e3UpEiEbzs8Qtm8ibPcPrP1er/bxvHOAf3m03Cuw2XQjoW13/B3psxJ9gFtuTtGsbdt/Ac1w4yE=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"}}');var r=o(74848),s=o(28453),l=o(33617),a=o.n(l),n=o(17543),d=o.n(n),c=o(86013),p=o.n(c),m=o(63723),u=o.n(m),h=(o(18766),o(79329),o(9303));const y={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l4cJ231VKNNXbdBEtQuAtRZGJQ0WjGmSIYc7QULvfVL+mn9kmIo7VrrdYy6CPKyK3Huw5kzo40gOQ8ivRI/W12gF7NEFBhyrxwpa0QqLiuEMyTo6HD67hyk1nYZYG0bIAseyStcIBRIUukAMrMNgYTgMFelyqGMoiORCOvQS1Z8XohUzJE6kkiEk17WSOjZmY0wskaRio58rQqRCMXeOEmVuOuizT5iTucF2BJ2Cj1+apTHQqTkG0xEoLVmlUHVTqNIBK6ctgWKtJQ6MENeYS1FuhG0dpGTvDJzkYjS+lrS8ARXMmpJhftlmlX5ceUy0bYzNhucNQEDKzqeTPhv39vQ5DmGUDYadukQicitITTE/NI5rfJIGH8MLLQ59K4LmjPnWQ2pzuQ2F4+Oo5pm1er4oxNt0qf9TbyDx6kxuNxeQRsvFQ11lfN4l349NjK8uFHv8K6u/+tZaLKBd7lHSVic0n2qbgWPJ8fPj6aTo8m3l9OX6cn36YuXo8lk8qdIxKrWLNsXayEpekqK9PC9ccVXsDM46LvGYxBty4ST++rwwtZIlTJzWKIhWHpr5gk4jTIgkF+DnEtlQEtC/+TLFSh6b/3DmXicZ8PIldHK4PW2Ca9PJpPr6S4JJ4dJ6FIFxhKUtjHF6CsE+lCVHvrzcHgn19/twntxGN65WUitiojal/YGzde9yKF56syzq/vlrDqmSBd7wQ7PuyAD5o1XtI4zYnUknTrq6OnVjNGX68b2oyUOFapEKsZdVseb3ThpBevyi+24abwWqaiIXEjH4yBNkdnVyDo0Qc2NllkY5bYeS6fGi6lok7sS0rlHcAeSc2XmRw9KzW6jveAb6ZK+F/Mu9dKp33Atkm1Kh1z94KxQRthr+b20UbhP9FuH5kLNTbymxfRgvL5HndsaedZThbBl/+evv6NEYfOmRkOxip7A28aDs0v0POCkKaDUuFKZxntWh4Cy1hiCXoMyhHMvCaFQc0VSA2eFMSCXTmZKK647ZrMs7WFQumEE7yukCj2TvvEIEgpcoOZyBW3tDeshC7IhW0cbvc+wtP6mZJcSkJA1QRkMAQLiVgRNJU2OsL2LBKwHaQANoXdeBQSpamYurQcsS5UrVsxN5mVOUEsj58jGEmC/OQvO24UqMIC3WRMIgtVNDIQt1ojUhWgQizCCn9QCu8D5sNuysIB5wyoSyG2B0Pcch2EKyDAQODavcoxKA0lPoHGBPtZevMmy0RqcZTBQUvP2NLxbVkRemsB41Tm0vZpd+py3vMtEG4Vcj+CD+WAYvqEJyAWglbkJ6QdzBFe7MnuPWVCEs6fbflgulwd98Gxf5kxR1WTg0dlbuXk8jF0zFN+9PBOJIPR1eFteoF+oHPsm/IzNcWQe9xAp8wiRWEulux774a4Aw5VWOZqAA0A7PXv3GhbwfDQRyaDz/4PD49fnP756c/GK9TI2df03HU1Gk7gC2UC1NANTt4v53a7d3ML8l13he8ghXNHYaakiZscoNz3eXondEp7eLvCzRFQ2EJM3m0wG/MPrtuXjTw16RvRZIhbSK5kxKl1tRKECPxe7Df2zAT79vV/2n8G93wL3+rzFTsPAuZC64TeRiBtc7315tLM22cInu9XRT/McHQ0kD0bp3jw6e3UpEiEbzs8Qtm8ibPcPrP1er/bxvHOAf3m03Cuw2XQjoW13/B3psxJ9gFtuTtGsbdt/Ac1w4yE=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,v={},Q=[];function b(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,r.jsx)(a(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,r.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(d(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(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"},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,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.1ad16e94.js b/assets/js/ae010e44.1ad16e94.js new file mode 100644 index 000000000..448ebc2b1 --- /dev/null +++ b/assets/js/ae010e44.1ad16e94.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6685],{73320:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>u,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/selfsign.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/selfsign","permalink":"/docs/API-docs/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztG11zG7fxr2zuxbHmSIm07Lh8imOnqds09kTKZDKSRgHvljxYOOAC4EQyGs70oT+jfclPyy/pLD6Od/wQ7SSTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cXb1zBFiZpZNMDgm6+/BFswCyjZWKCBiUY0diEQCJ7LKagJMMjD/H34TtWQMQlMGAVcZqLOEZRbjAmoNPZynHCJOcx4PkVrUpgVPCvAFn5O1G485tyC0oDziskc6kpJYAYkYo55H84LbqDS6pbnDtGIDc4r1BxlRpOVXDANVrm5f/7Hv86IxO9UrYnen//xb5gINQMuXf+bCqUDYFXVv5SX8pxXI/imEorlsFC1hrev/twQSrNS28XR0Ssc11P45vXR0dXHhbWVGR0f0xyqQkloCTY2/UyVxzkBVvnkMZGMGmlWTyszXCyA5S2m2AIlZKpaQKaUzrmkHUmhYlMEWZdj1CYF4kypNBINDDSyfNGzqlcbhL+evfkKJkqXzPbhrahN2iyXc42ZFQs/PdEeqXpkYMwMPjsFYzWX0xRKdkNs5RZ+qHl2Q2QblHlk6ou3rx2vjo7O6qpS2mIO33oSRkdH1PMZEo+ZRgefqbJUEiqmWYkWtfHSRd0af6i5dnJhC2BCRF6MLmUPjo7sosLR0RG8ljnPnHjShNRKIuhh+x6UmESgZxVmfMIDaIt1oGSQOuLJjPn9rATLPJoaTYWZ5bfYnXiewoImfoVSRQwKpfmPSlom3HbcorY8Y6K9bYSgE2/LtCV2VopLG1vDCs3Jod1zmxLkilDLiVkll67HINwyUaMJWM1SKAirr7HSaOiUx3mJkTKHAvm02Lkey9/VxnYmhtoQmm0swlpxlxx70bFtwoRB4JMOL0t2g63VGg3Qh88WkOOE1cKmwEnirK6xD18pSydP8IwUDUmuO9PM1hp7bpeDOAREJCvdHr9d6YCcTyao6XBSp5sijInYkZx5pUHkuZNjCyZBybWNzpRQelOEXHOXj5ApaZ3me3HLuHDIe2JNo/7GgmU3KYxFjSlozP3BXaAQapZ6eXcgpOA8zx1/SC2TFCpJ+EsVlucGTMCqUYTxPFFno2xpEW7aXA2ndqJoZWJBPGKAJeMidYxL4Z0ag+VWYEoHtmJykULOLKZgcW7Hap5CVmB2M1bzwK+JktbwH7ecutjz4VwbpnCawrMUnqcwOElhMExhcJrC4FkKg+cpDE9SGA5TGJ6mMHzmeTp8HvjJGia2ERgMPSftw+Ig6c8vuXEnlBSfaXTprKNLB304OmpOBbV9//33l/LuUgJcJnRILpMRXCYNyGWS+j7SfdQ3CN9z+ngy/CR8Lujz2fB5+Jw50MFp+Czoczi4lMuw4KUcOkwsK6t7sKDu3xSD8BUEhdrcotQW9RI1kkJJYwftRwcf6li2aXlCtHDJLWfC7CYnQjwgilYobRB1SkQ5kdxNket+QOS08aEep+58l1OPra54qB0Www3qn/bDDbGbeL/sg6G9hc6vI/0ZkU7q55zUz276Gw31gJiwjtOv48QnfXeRO+27mw8B4AFxoYvRr+PBc+IBXTy7GUC9D4j6FjrUEW5x33dy2hs87Q1PhqcdDpCP4wHKspfnvcVi8Vtwj+yasDyZNdHS9BYaswgTrcotboSz8ldQwe5xv6Pp/XcyuMfRFsU8+qCNVdJ4bm1r2aqcLR4ZP1Uc2hhgBL8yvxYtNF0X4eG82KxQPAvIE0w0u8bkqPWJBz3HyeM8P25xkhrzvFeWvbVG+uw5xrcay7Kf5/01yI3d8Y0l5HkKm81b2/McyrLc0ezbLxNnUv2JRD9YW7ulPwD8XgdgJefdhe89HOTXKync2s7Z2n461q6QgsvQEUQF1gA0TmvBNM7JazRcSQ/925+ceHBWNrnzMp2D5nx4zwr4+E2wux8HoSYSuhNQy/5xG5S1J9E4xbmbI6uNVSUhw3NGM6Rg6qwgL4xF8574voq3uK+MVZy8fYHWula0WX8bEn7XWp4y7eq6o2zQdohhBuLILb6y234n3oMTd70FJ+Ke+y1APCAVv4YSdfqwA3VfXCYlcxYASRmufitboL5Mrpox3jvGfM/Yq/c4RwXPUbAxis2u9z4DbVqCPLUYQx0ll41H7/A9SVudbL7W6fuWW86Wp7gt1FGJx6MRWQyCmxjT6PKrPToEfVwojgKsJJdjhDgAxo0Y/moxbxB7Pzn3WiBszp4lCA4cYBNwa3zs+1fobEybMTRHySUv67KJHE6aWSPLynCbt/lFI2uDOq7Q3t2NFdh8zwoUptu9wKUcuMgAL9n0HkPPdT8gNRDwWZPvJE1URfkHruTrPBklMTeRpG5SNPYzlS+S0V0SYkj0M0RoaNDxO0N5jbvEZAWWjH5FZCgTMuECkzTxmQaTpIlzOCgtQpxKRokav8PMJildmxUFc9HQHG7c6C5C+fh4kgbzMxklPnCepAnOWVkRcGgClJkiI6/KJ8kyLnjfVE3LairjfjSBepqHQtC/cJqvaOhyLRP0i2Z61ZrB0VbiuXqpqM/iK7YwrXm9fCfrCSgaQ+c3C6MgZwtDYbfaeFWUMZHVgkxZnFdcLxq72tmzDUta+DYrNfgOni7jprcw2rHXWn34BmWoiAEuhvGhY98pHCN+GhooV+T2l5UfjMU7hTBGt7dVoeQHjx8MnwyGgyeDIc0Qgo+tOZjWbJGkCbdYmv189L2bGHT3/wXZWpjHW6i3ivun4GJ2/X2iGOEd2WyK+2XufFc+qBWiNoWqRU7BX2S679Iyvzjj1xVjWsRR298jtMs0me8nZg6Z6sVkE3wscGKhripKpCotUT9ue6oPhrjh6ekyTRb7yVv8V5L3CW3ebD9137os3SqD+Ufg+uT5Mk2K/bj+pckj/oHInj5bri7RJNPILMY74Hqs8sV11FvLNmA0I7qg4UZY0ooiR00Wx6a+WqkagqT89/W6nh8rJZDJLYqmk1xyfqVxZisZxSFUMyuQnJuVNetmN40ZHkxob7JQwgrXPGluyNLTNV4mfXg9WfHSG8Lr+a0I6/JbUsEjt961qZ0af3QcvolDj9q5ekqfrkJUEQUHDBbLSrhk94wLQXjT9d2H5p8z7RpOEgLxuowL778qXnqP3S0YBnUzxRBMxD68ZLLJJHYzdnB31wiBk47lEu7uaFdRX9Olu1ymqwZaq9Pg7lXfojFDftsZ1TThamDT1hrqLZlrsmR8Q4j6thHwJS3XtRbLZX9DDFd79N5822BT2Dua5P+BY66G6VzV+j0OrvMwe/7weAfHC7afBBhMaxe5taT+ogy6cNCqwIBLY3XtnT7Iax1rKmKxUqVVhsb0QwlFD3JufJa5wPb8KaA0fjiDCTMWdQq15NKi1nVFHuFm/VOHfrfAkjwoX/xDLNovNt1MPtWC+bqlVqlWPOxxYgylWsGYb6pIYtnUOulbtWuQj/0IkiZ0tR7B369QGyWpbEzpKZP8R+cReutOGTKNCyY8qJd8TnFvwoeUbBeZeG/9/M+fWnjttO83EfMrsDynIOQeDJ2XT+68cb6+xkoswKouRjQf6k/XL9Rk7zXnb8KVFxyUL1U5KWm8rT48OaH/umTEskEI1yzFR2nbJrUQi4+S9P1d8PsdBd+8/fK9z/Iv3vHhj/PsdviWtmiHTN87QTBUai2ocI4412tqGdd5y6XgEq8j266HJyfXA+LtMk1Ot7HvTJVoC1clQkycaUUldZVARiVeegFsyrgEujb1b8hN1Frp++2YD8PsPiacdpjwdJMJr6ULiLrS0nN1g/L3pbS9vPXLE6rz0smKVzMJ90CuP+kQ2273RBrMas3tIhld3CXzHqt4z/ePLq6WV2lCjFUUuKqUcRgzWySj5LgVxzKobyn4RDM4oW3k0DCZU7xyw2hmFT++HSTLdH3EVhN7JzTWvQ8bYCybcjm9f9TViitntHN+czq8WYUQKv43pBhCYH0bKk04SUyBLCejfJkmJBBfr6J+n8dtjfG4bSG2ljJcC5rFmFknDLauurcEtrbHtQZP2xElHzNyYaAmCrQtsNMQHkM1TaSmFXxpxV4uVsLdhDlilGPgwgPD01PnR38ycA7nk+fOlzt9trzquDVJ0nVdXFR23QBPkq5h6b5bZpPPjayZEXHm5tru3J3rV+fua4y2f6KcrIQNbGqy6fTeDjadZxSZKpuqvAj+8z9/ciPixjvl8hG8qTVUaoZ6UvvSvonAOSd7i4DXXDNkpUBjxALIzJpSQTzkfOoyf9GIyVjFxlxwUkcEpnxEsqXRTB++XTl3j7RPgt6iIC0GQilXXW0VsNqq0q0Rr9yZ0jdUn05l3jCmglwyIwxiHIKyYK7OPRy9lKwKqiYns7DS3CAwXhIwmac4mfCMu7tcSatZZqFkkk2RFkudE09caErqtRpTWsMoUXv7lYp6Ea0nkbJEpg+vqELaEe4isWhpa3NvuhoqfcwpZuuEP1Srj8nrqGh5nqFZlUsIvEXtVI33PWohoFJ0R3AmyHhq7y1NZDWThq72EAUOW9OwLxiYbo2cLfpAeRK69sjMIgEQXN742vKLRsy+xbHhFlcBjNlstqH2HnfHfMFtUY/JZFOrcVPX6JRke3jz8Zh0CurSvJmcob7lWTRGdqx57ICPw83JvK8cDxSr+NbTJHiG0mDrnnvxxdsv4Rae9E+StKXo3wPh4y9fv/z8q7PPaV66u/z5G/RP+icu6qqMLZlsLXWGYgJn/r5bSzM0l//h7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7ckfVpp7eHtyeHtyeHtyeHuyv2b+8Pbk8Pbk8Pbk8Pbk8Pbk8Pbkf+ftSci1kkY8rgTjslVY4jP5F6sXKVdpUlCSf3SR3N1R8PobKjyj5h9q1FQhcJUmt0xzCt+4+oA0Jrcpr3uDlGF96aNRvXNaOfXayCV11soiKDfvR7zIMqzsvbDtOoS3b87OkzSJlYKlymmMZjN6UcNmPn8b+Ogy2cyVLQsmp7VLMyd+TsrHs9oW3WT+jUvmhx+tbDWTixaG3Sy/J4P+ElFbB9zd+UKB5bKB9107RwTGRmjauavlcvkfnCKo6w==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"}}');var s=t(74848),r=t(28453),o=t(33617),l=t.n(o),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),m=t.n(h),x=(t(18766),t(79329),t(9303));const u={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:"eJztG11zG7fxr2zuxbHmSIm07Lh8imOnqds09kTKZDKSRgHvljxYOOAC4EQyGs70oT+jfclPyy/pLD6Od/wQ7SSTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cXb1zBFiZpZNMDgm6+/BFswCyjZWKCBiUY0diEQCJ7LKagJMMjD/H34TtWQMQlMGAVcZqLOEZRbjAmoNPZynHCJOcx4PkVrUpgVPCvAFn5O1G485tyC0oDziskc6kpJYAYkYo55H84LbqDS6pbnDtGIDc4r1BxlRpOVXDANVrm5f/7Hv86IxO9UrYnen//xb5gINQMuXf+bCqUDYFXVv5SX8pxXI/imEorlsFC1hrev/twQSrNS28XR0Ssc11P45vXR0dXHhbWVGR0f0xyqQkloCTY2/UyVxzkBVvnkMZGMGmlWTyszXCyA5S2m2AIlZKpaQKaUzrmkHUmhYlMEWZdj1CYF4kypNBINDDSyfNGzqlcbhL+evfkKJkqXzPbhrahN2iyXc42ZFQs/PdEeqXpkYMwMPjsFYzWX0xRKdkNs5RZ+qHl2Q2QblHlk6ou3rx2vjo7O6qpS2mIO33oSRkdH1PMZEo+ZRgefqbJUEiqmWYkWtfHSRd0af6i5dnJhC2BCRF6MLmUPjo7sosLR0RG8ljnPnHjShNRKIuhh+x6UmESgZxVmfMIDaIt1oGSQOuLJjPn9rATLPJoaTYWZ5bfYnXiewoImfoVSRQwKpfmPSlom3HbcorY8Y6K9bYSgE2/LtCV2VopLG1vDCs3Jod1zmxLkilDLiVkll67HINwyUaMJWM1SKAirr7HSaOiUx3mJkTKHAvm02Lkey9/VxnYmhtoQmm0swlpxlxx70bFtwoRB4JMOL0t2g63VGg3Qh88WkOOE1cKmwEnirK6xD18pSydP8IwUDUmuO9PM1hp7bpeDOAREJCvdHr9d6YCcTyao6XBSp5sijInYkZx5pUHkuZNjCyZBybWNzpRQelOEXHOXj5ApaZ3me3HLuHDIe2JNo/7GgmU3KYxFjSlozP3BXaAQapZ6eXcgpOA8zx1/SC2TFCpJ+EsVlucGTMCqUYTxPFFno2xpEW7aXA2ndqJoZWJBPGKAJeMidYxL4Z0ag+VWYEoHtmJykULOLKZgcW7Hap5CVmB2M1bzwK+JktbwH7ecutjz4VwbpnCawrMUnqcwOElhMExhcJrC4FkKg+cpDE9SGA5TGJ6mMHzmeTp8HvjJGia2ERgMPSftw+Ig6c8vuXEnlBSfaXTprKNLB304OmpOBbV9//33l/LuUgJcJnRILpMRXCYNyGWS+j7SfdQ3CN9z+ngy/CR8Lujz2fB5+Jw50MFp+Czoczi4lMuw4KUcOkwsK6t7sKDu3xSD8BUEhdrcotQW9RI1kkJJYwftRwcf6li2aXlCtHDJLWfC7CYnQjwgilYobRB1SkQ5kdxNket+QOS08aEep+58l1OPra54qB0Www3qn/bDDbGbeL/sg6G9hc6vI/0ZkU7q55zUz276Gw31gJiwjtOv48QnfXeRO+27mw8B4AFxoYvRr+PBc+IBXTy7GUC9D4j6FjrUEW5x33dy2hs87Q1PhqcdDpCP4wHKspfnvcVi8Vtwj+yasDyZNdHS9BYaswgTrcotboSz8ldQwe5xv6Pp/XcyuMfRFsU8+qCNVdJ4bm1r2aqcLR4ZP1Uc2hhgBL8yvxYtNF0X4eG82KxQPAvIE0w0u8bkqPWJBz3HyeM8P25xkhrzvFeWvbVG+uw5xrcay7Kf5/01yI3d8Y0l5HkKm81b2/McyrLc0ezbLxNnUv2JRD9YW7ulPwD8XgdgJefdhe89HOTXKync2s7Z2n461q6QgsvQEUQF1gA0TmvBNM7JazRcSQ/925+ceHBWNrnzMp2D5nx4zwr4+E2wux8HoSYSuhNQy/5xG5S1J9E4xbmbI6uNVSUhw3NGM6Rg6qwgL4xF8574voq3uK+MVZy8fYHWula0WX8bEn7XWp4y7eq6o2zQdohhBuLILb6y234n3oMTd70FJ+Ke+y1APCAVv4YSdfqwA3VfXCYlcxYASRmufitboL5Mrpox3jvGfM/Yq/c4RwXPUbAxis2u9z4DbVqCPLUYQx0ll41H7/A9SVudbL7W6fuWW86Wp7gt1FGJx6MRWQyCmxjT6PKrPToEfVwojgKsJJdjhDgAxo0Y/moxbxB7Pzn3WiBszp4lCA4cYBNwa3zs+1fobEybMTRHySUv67KJHE6aWSPLynCbt/lFI2uDOq7Q3t2NFdh8zwoUptu9wKUcuMgAL9n0HkPPdT8gNRDwWZPvJE1URfkHruTrPBklMTeRpG5SNPYzlS+S0V0SYkj0M0RoaNDxO0N5jbvEZAWWjH5FZCgTMuECkzTxmQaTpIlzOCgtQpxKRokav8PMJildmxUFc9HQHG7c6C5C+fh4kgbzMxklPnCepAnOWVkRcGgClJkiI6/KJ8kyLnjfVE3LairjfjSBepqHQtC/cJqvaOhyLRP0i2Z61ZrB0VbiuXqpqM/iK7YwrXm9fCfrCSgaQ+c3C6MgZwtDYbfaeFWUMZHVgkxZnFdcLxq72tmzDUta+DYrNfgOni7jprcw2rHXWn34BmWoiAEuhvGhY98pHCN+GhooV+T2l5UfjMU7hTBGt7dVoeQHjx8MnwyGgyeDIc0Qgo+tOZjWbJGkCbdYmv189L2bGHT3/wXZWpjHW6i3ivun4GJ2/X2iGOEd2WyK+2XufFc+qBWiNoWqRU7BX2S679Iyvzjj1xVjWsRR298jtMs0me8nZg6Z6sVkE3wscGKhripKpCotUT9ue6oPhrjh6ekyTRb7yVv8V5L3CW3ebD9137os3SqD+Ufg+uT5Mk2K/bj+pckj/oHInj5bri7RJNPILMY74Hqs8sV11FvLNmA0I7qg4UZY0ooiR00Wx6a+WqkagqT89/W6nh8rJZDJLYqmk1xyfqVxZisZxSFUMyuQnJuVNetmN40ZHkxob7JQwgrXPGluyNLTNV4mfXg9WfHSG8Lr+a0I6/JbUsEjt961qZ0af3QcvolDj9q5ekqfrkJUEQUHDBbLSrhk94wLQXjT9d2H5p8z7RpOEgLxuowL778qXnqP3S0YBnUzxRBMxD68ZLLJJHYzdnB31wiBk47lEu7uaFdRX9Olu1ymqwZaq9Pg7lXfojFDftsZ1TThamDT1hrqLZlrsmR8Q4j6thHwJS3XtRbLZX9DDFd79N5822BT2Dua5P+BY66G6VzV+j0OrvMwe/7weAfHC7afBBhMaxe5taT+ogy6cNCqwIBLY3XtnT7Iax1rKmKxUqVVhsb0QwlFD3JufJa5wPb8KaA0fjiDCTMWdQq15NKi1nVFHuFm/VOHfrfAkjwoX/xDLNovNt1MPtWC+bqlVqlWPOxxYgylWsGYb6pIYtnUOulbtWuQj/0IkiZ0tR7B369QGyWpbEzpKZP8R+cReutOGTKNCyY8qJd8TnFvwoeUbBeZeG/9/M+fWnjttO83EfMrsDynIOQeDJ2XT+68cb6+xkoswKouRjQf6k/XL9Rk7zXnb8KVFxyUL1U5KWm8rT48OaH/umTEskEI1yzFR2nbJrUQi4+S9P1d8PsdBd+8/fK9z/Iv3vHhj/PsdviWtmiHTN87QTBUai2ocI4412tqGdd5y6XgEq8j266HJyfXA+LtMk1Ot7HvTJVoC1clQkycaUUldZVARiVeegFsyrgEujb1b8hN1Frp++2YD8PsPiacdpjwdJMJr6ULiLrS0nN1g/L3pbS9vPXLE6rz0smKVzMJ90CuP+kQ2273RBrMas3tIhld3CXzHqt4z/ePLq6WV2lCjFUUuKqUcRgzWySj5LgVxzKobyn4RDM4oW3k0DCZU7xyw2hmFT++HSTLdH3EVhN7JzTWvQ8bYCybcjm9f9TViitntHN+czq8WYUQKv43pBhCYH0bKk04SUyBLCejfJkmJBBfr6J+n8dtjfG4bSG2ljJcC5rFmFknDLauurcEtrbHtQZP2xElHzNyYaAmCrQtsNMQHkM1TaSmFXxpxV4uVsLdhDlilGPgwgPD01PnR38ycA7nk+fOlzt9trzquDVJ0nVdXFR23QBPkq5h6b5bZpPPjayZEXHm5tru3J3rV+fua4y2f6KcrIQNbGqy6fTeDjadZxSZKpuqvAj+8z9/ciPixjvl8hG8qTVUaoZ6UvvSvonAOSd7i4DXXDNkpUBjxALIzJpSQTzkfOoyf9GIyVjFxlxwUkcEpnxEsqXRTB++XTl3j7RPgt6iIC0GQilXXW0VsNqq0q0Rr9yZ0jdUn05l3jCmglwyIwxiHIKyYK7OPRy9lKwKqiYns7DS3CAwXhIwmac4mfCMu7tcSatZZqFkkk2RFkudE09caErqtRpTWsMoUXv7lYp6Ea0nkbJEpg+vqELaEe4isWhpa3NvuhoqfcwpZuuEP1Srj8nrqGh5nqFZlUsIvEXtVI33PWohoFJ0R3AmyHhq7y1NZDWThq72EAUOW9OwLxiYbo2cLfpAeRK69sjMIgEQXN742vKLRsy+xbHhFlcBjNlstqH2HnfHfMFtUY/JZFOrcVPX6JRke3jz8Zh0CurSvJmcob7lWTRGdqx57ICPw83JvK8cDxSr+NbTJHiG0mDrnnvxxdsv4Rae9E+StKXo3wPh4y9fv/z8q7PPaV66u/z5G/RP+icu6qqMLZlsLXWGYgJn/r5bSzM0l//h7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7cnh7ckfVpp7eHtyeHtyeHtyeHuyv2b+8Pbk8Pbk8Pbk8Pbk8Pbk8Pbkf+ftSci1kkY8rgTjslVY4jP5F6sXKVdpUlCSf3SR3N1R8PobKjyj5h9q1FQhcJUmt0xzCt+4+oA0Jrcpr3uDlGF96aNRvXNaOfXayCV11soiKDfvR7zIMqzsvbDtOoS3b87OkzSJlYKlymmMZjN6UcNmPn8b+Ogy2cyVLQsmp7VLMyd+TsrHs9oW3WT+jUvmhx+tbDWTixaG3Sy/J4P+ElFbB9zd+UKB5bKB9107RwTGRmjauavlcvkfnCKo6w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-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,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.56305cd9.js b/assets/js/ae010e44.56305cd9.js deleted file mode 100644 index 759cdc07d..000000000 --- a/assets/js/ae010e44.56305cd9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6685],{73320:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>y,contentTitle:()=>g,default:()=>j,frontMatter:()=>u,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","source":"@site/docs/API-docs/selfsign.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/selfsign","permalink":"/docs/API-docs/selfsign","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar_label":"Self Sign","hide_title":true,"hide_table_of_contents":true,"api":"eJztG11zG7fxr2zuxbHmSIm07Lh8imOnqds09kTKZDKSRgHvljxYOOAC4EQyGs70oT+jfclPyy/pLD6Od/wQ7SSTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cXb1zBFiZpZNMDgm6+/BFswCyjZWKCBiUY0diEQCJ7LKagJMMjD/H34TtWQMQlMGAVcZqLOEZRbjAmoNPZynHCJOcx4PkVrUpgVPCvAFn5O1G485tyC0oDziskc6kpJYAYkYo55H84LbqDS6pbnDtGIDc4r1BxlRpOVXDANVrm5f/7Hv86IxO9UrYnen//xb5gINQMuXf+bCqUDYFXVv5SX8pxXI/imEorlsFC1hrev/twQSrNS28XR0Ssc11P45vXR0dXHhbWVGR0f0xyqQkloCTY2/UyVxzkBVvnkMZGMGmlWTyszXCyA5S2m2AIlZKpaQKaUzrmkHUmhYlMEWZdj1CYF4kypNBINDDSyfNGzqlcbhL+evfkKJkqXzPbhrahN2iyXc42ZFQs/PdEeqXpkYMwMPjsFYzWX0xRKdkNs5RZ+qHl2Q2QblHlk6ou3rx2vjo7O6qpS2mIO33oSRkdH1PMZEo+ZRgefqbJUEiqmWYkWtfHSRd0af6i5dnJhC2BCRF6MLmUPjo7sosLR0RG8ljnPnHjShNRKIuhh+x6UmESgZxVmfMIDaIt1oGSQOuLJjPn9rATLPJoaTYWZ5bfYnXiewoImfoVSRQwKpfmPSlom3HbcorY8Y6K9bYSgE2/LtCV2VopLG1vDCs3Jod1zmxLkilDLiVkll67HINwyUaMJWM1SKAirr7HSaOiUx3mJkTKHAvm02Lkey9/VxnYmhtoQmm0swlpxlxx70bFtwoRB4JMOL0t2g63VGg3Qh88WkOOE1cKmwEnirK6xD18pSydP8IwUDUmuO9PM1hp7bpeDOAREJCvdHr9d6YCcTyao6XBSp5sijInYkZx5pUHkuZNjCyZBybWNzpRQelOEXHOXj5ApaZ3me3HLuHDIe2JNo/7GgmU3KYxFjSlozP3BXaAQapZ6eXcgpOA8zx1/SC2TFCpJ+EsVlucGTMCqUYTxPFFno2xpEW7aXA2ndqJoZWJBPGKAJeMidYxL4Z0ag+VWYEoHtmJykULOLKZgcW7Hap5CVmB2M1bzwK+JktbwH7ecutjz4VwbpnCawrMUnqcwOElhMExhcJrC4FkKg+cpDE9SGA5TGJ6mMHzmeTp8HvjJGia2ERgMPSftw+Ig6c8vuXEnlBSfaXTprKNLB304OmpOBbV9//33l/LuUgJcJnRILpMRXCYNyGWS+j7SfdQ3CN9z+ngy/CR8Lujz2fB5+Jw50MFp+Czoczi4lMuw4KUcOkwsK6t7sKDu3xSD8BUEhdrcotQW9RI1kkJJYwftRwcf6li2aXlCtHDJLWfC7CYnQjwgilYobRB1SkQ5kdxNket+QOS08aEep+58l1OPra54qB0Www3qn/bDDbGbeL/sg6G9hc6vI/0ZkU7q55zUz276Gw31gJiwjtOv48QnfXeRO+27mw8B4AFxoYvRr+PBc+IBXTy7GUC9D4j6FjrUEW5x33dy2hs87Q1PhqcdDpCP4wHKspfnvcVi8Vtwj+yasDyZNdHS9BYaswgTrcotboSz8ldQwe5xv6Pp/XcyuMfRFsU8+qCNVdJ4bm1r2aqcLR4ZP1Uc2hhgBL8yvxYtNF0X4eG82KxQPAvIE0w0u8bkqPWJBz3HyeM8P25xkhrzvFeWvbVG+uw5xrcay7Kf5/01yI3d8Y0l5HkKm81b2/McyrLc0ezbLxNnUv2JRD9YW7ulPwD8XgdgJefdhe89HOTXKync2s7Z2n461q6QgsvQEUQF1gA0TmvBNM7JazRcSQ/925+ceHBWNrnzMp2D5nx4zwr4+E2wux8HoSYSuhNQy/5xG5S1J9E4xbmbI6uNVSUhw3NGM6Rg6qwgL4xF8574voq3uK+MVZy8fYHWula0WX8bEn7XWp4y7eq6o2zQdohhBuLILb6y234n3oMTd70FJ+Ke+y1APCAVv4YSdfqwA3VfXCYlcxYASRmufitboL5Mrpox3jvGfM/Yq/c4RwXPUbAxis2u9z4DbVqCPLUYQx0ll41H7/A9SVudbL7W6fuWW86Wp7gt1FGJx6MRWQyCmxjT6PKrPToEfVwojgKsJJdjhDgAxo0Y/moxbxB7Pzn3WiBszp4lCA4cYBNwa3zs+1fobEybMTRHySUv67KJHE6aWSPLynCbt/lFI2uDOq7Q3t2NFdh8zwoUptu9wKUcuMgAL9n0HkPPdT8gNRDwWZPvJE1URfkHruTrPBklMTeRpG5SNPYzlS+S0V0SYkj0M0RoaNDxO0N5jbvEZAWWjH5FZCgTMuECkzTxmQaTpIlzOCgtQpxKRokav8PMJildmxUFc9HQHG7c6C5C+fh4kgbzMxklPnCepAnOWVkRcGgClJkiI6/KJ8kyLnjfVE3LairjfjSBepqHQtC/cJqvaOhyLRP0i2Z61ZrB0VbiuXqpqM/iK7YwrXm9fCfrCSgaQ+c3C6MgZwtDYbfaeFWUMZHVgkxZnFdcLxq72tmzDUta+DYrNfgOni7jprcw2rHXWn34BmWoiAEuhvGhY98pHCN+GhooV+T2l5UfjMU7hTBGt7dVoeQHjx8MnwyGgyeDIc0Qgo+tOZjWbJGkCbdYmv189L2bGHT3/wXZWpjHW6i3ivun4GJ2/X2iGOEd2WyK+2XufFc+qBWiNoWqRU7BX2S679Iyvzjj1xVjWsRR298jtMs0me8nZg6Z6sVkE3wscGKhripKpCotUT9ue6oPhrjh6ekyTRb7yVv8V5L3CW3ebD9137os3SqD+Ufg+uT5Mk2K/bj+pckj/oHInj5bri7RJNPILMY74Hqs8sV11FvLNmA0I7qg4UZY0ooiR00Wx6a+WqkagqT89/W6nh8rJZDJLYqmk1xyfqVxZisZxSFUMyuQnJuVNetmN40ZHkxob7JQwgrXPGluyNLTNV4mfXg9WfHSG8Lr+a0I6/JbUsEjt961qZ0af3QcvolDj9q5ekqfrkJUEQUHDBbLSrhk94wLQXjT9d2H5p8z7RpOEgLxuowL778qXnqP3S0YBnUzxRBMxD68ZLLJJHYzdnB31wiBk47lEu7uaFdRX9Olu1ymqwZaq9Pg7lXfojFDftsZ1TThamDT1hrqLZlrsmR8Q4j6thHwJS3XtRbLZX9DDFd79N5822BT2Dua5P+BY66G6VzV+j0OrvMwe/7weAfHC7afBBhMaxe5taT+ogy6cNCqwIBLY3XtnT7Iax1rKmKxUqVVhsb0QwlFD3JufJa5wPb8KaA0fjiDCTMWdQq15NKi1nVFHuFm/VOHfrfAkjwoX/xDLNovNt1MPtWC+bqlVqlWPOxxYgylWsGYb6pIYtnUOulbtWuQj/0IkiZ0tR7B369QGyWpbEzpKZP8R+cReutOGTKNCyY8qJd8TnFvwoeUbBeZeG/9/M+fWnjttO83EfMrsDynIOQeDJ2XT+68cb6+xkoswKouRjQf6k/XL9Rk7zXnb8KVFxyUL1U5KWm8rT48OaH/umTEskEI1yzFR2nbJrUQi4+S9P1d8PsdBd+8/fK9z/Iv3vHhj/PsdviWtmiHTN87QTBUai2ocI4412tqGdd5y6XgEq8j266HJyfXA+LtMk1Ot7HvTJVoC1clQkycaUUldZVARiVeegFsyrgEujb1b8hN1Frp++2YD8PsPiacdpjwdJMJr6ULiLrS0nN1g/L3pbS9vPXLE6rz0smKVzMJ90CuP+kQ2273RBrMas3tIhld3CXzHqt4z/ePLq6WV2lCjFUUuKqUcRgzWySj5LgVxzKobyn4RDM4oW3k0DCZU7xyw2hmFT++HSTLdH3EVhN7J7SxbMrltHfvqKsVkWe0EZ7XHVJXEYGK/w0pJBA42YZKE04CUCDLycZepgnt79erIN7ncZdieG1bxKyl29ZiYDEE1olqrWviLXGq7WGqwdN2gMiHgFxUpwnqbIvTNITHyEsTeGnFUlqhlIuVrDZRixi0GDhvf3h66tziTwbOf3zy3Llmp8+WVx0vJUm6nogLsq7b00nStRPdd8sK8qmONasgztzcwp2rcP0m3H0r0fZPlJOVsIFNiTUdxtvBpi+MIlNlU2QXwX/+509uRNx4pys+gje1hkrNUE9qX6k3ETjnZD4R8JqnhawUaIxYAFlNU6pvh5xPXSIv2iQZq9iYC07ahcCUDzC2FJTpw7crX+2R9jnNWxSklEAo5YqlrQJWW1W6NeINOlP6hsrNqWobxlRfS1aBQYxDUBbMla2Ho5eSkUDF4WTlVZobBMZLAiZrEycTnnF3NStpNcsslEyyKdJiqfPJiQtNhbxWY8pSGCVqb45SjS6i9SRS0sf04RUVPDvCXWAVLW1t7i1RQ5WMOYVgnfCH4vMxOREVLc8zNKvqB4G3qJ2q8a5ELQRUilQ+Z4Jsofbe0kRWM2nopg5B3bA1DfuCvejWyNmiD5T2oFuMrCYSAMHljS8Vv2jE7FscG25xFY+YzWYbau9xd8wX3Bb1mCwwtRo3dY1OSbaHNx+PSaegLs2byRnqW55F22LHmscO+DhchMy7vvFAsYpvPU2CZygNtq6tF1+8/RJu4Un/JElbiv49ED7+8vXLz786+5zmpavIn79B/6R/4oKoytiSydZSZygmcOavr7WsQXOXH56SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6S/GGVtoenJIenJIenJIenJPtL4A9PSQ5PSQ5PSQ5PSQ5PSQ5PSf53npKEXCtpxONKMC5bdSI+MX+xemBylSYF5exHF8ndHQWvv6E6Mmr+oUZNCf+rNLllmlP4xqX705jcprzuDVKG9aWPRvXOaeXUayOX1FmrcqDcvB/xIsuwsvfCtssK3r45O0/SJBb+lSqnMZrN6IEMm/n8beCjy2QzV4UsmJzWLs2c+DkpH89qW3ST+TcumR9+tLLVTC5aGHaz/J4M+ktEbR1wd+cLBZbLBt537RwRGBuhaeeulsvlfwCFWZfA","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Contact list","permalink":"/docs/API-docs/contactlist"},"next":{"title":"Draft Document","permalink":"/docs/API-docs/draftdocument"}}');var s=t(74848),o=t(28453),r=t(33617),l=t.n(r),a=t(17543),d=t.n(a),c=t(86013),p=t.n(c),h=t(63723),x=t.n(h),m=(t(18766),t(79329),t(9303));const u={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:"eJztG11zG7fxr2zuxbHmSIm07Lh8imOnqds09kTKZDKSRgHvljxYOOAC4EQyGs70oT+jfclPyy/pLD6Od/wQ7SSTqC39IPOABbC7WCz2C3eJZVOTjC6SVyqrS5TWJFdpkqPJNK8sVzIZJecFgkExMXwq4cXb1zBFiZpZNMDgm6+/BFswCyjZWKCBiUY0diEQCJ7LKagJMMjD/H34TtWQMQlMGAVcZqLOEZRbjAmoNPZynHCJOcx4PkVrUpgVPCvAFn5O1G485tyC0oDziskc6kpJYAYkYo55H84LbqDS6pbnDtGIDc4r1BxlRpOVXDANVrm5f/7Hv86IxO9UrYnen//xb5gINQMuXf+bCqUDYFXVv5SX8pxXI/imEorlsFC1hrev/twQSrNS28XR0Ssc11P45vXR0dXHhbWVGR0f0xyqQkloCTY2/UyVxzkBVvnkMZGMGmlWTyszXCyA5S2m2AIlZKpaQKaUzrmkHUmhYlMEWZdj1CYF4kypNBINDDSyfNGzqlcbhL+evfkKJkqXzPbhrahN2iyXc42ZFQs/PdEeqXpkYMwMPjsFYzWX0xRKdkNs5RZ+qHl2Q2QblHlk6ou3rx2vjo7O6qpS2mIO33oSRkdH1PMZEo+ZRgefqbJUEiqmWYkWtfHSRd0af6i5dnJhC2BCRF6MLmUPjo7sosLR0RG8ljnPnHjShNRKIuhh+x6UmESgZxVmfMIDaIt1oGSQOuLJjPn9rATLPJoaTYWZ5bfYnXiewoImfoVSRQwKpfmPSlom3HbcorY8Y6K9bYSgE2/LtCV2VopLG1vDCs3Jod1zmxLkilDLiVkll67HINwyUaMJWM1SKAirr7HSaOiUx3mJkTKHAvm02Lkey9/VxnYmhtoQmm0swlpxlxx70bFtwoRB4JMOL0t2g63VGg3Qh88WkOOE1cKmwEnirK6xD18pSydP8IwUDUmuO9PM1hp7bpeDOAREJCvdHr9d6YCcTyao6XBSp5sijInYkZx5pUHkuZNjCyZBybWNzpRQelOEXHOXj5ApaZ3me3HLuHDIe2JNo/7GgmU3KYxFjSlozP3BXaAQapZ6eXcgpOA8zx1/SC2TFCpJ+EsVlucGTMCqUYTxPFFno2xpEW7aXA2ndqJoZWJBPGKAJeMidYxL4Z0ag+VWYEoHtmJykULOLKZgcW7Hap5CVmB2M1bzwK+JktbwH7ecutjz4VwbpnCawrMUnqcwOElhMExhcJrC4FkKg+cpDE9SGA5TGJ6mMHzmeTp8HvjJGia2ERgMPSftw+Ig6c8vuXEnlBSfaXTprKNLB304OmpOBbV9//33l/LuUgJcJnRILpMRXCYNyGWS+j7SfdQ3CN9z+ngy/CR8Lujz2fB5+Jw50MFp+Czoczi4lMuw4KUcOkwsK6t7sKDu3xSD8BUEhdrcotQW9RI1kkJJYwftRwcf6li2aXlCtHDJLWfC7CYnQjwgilYobRB1SkQ5kdxNket+QOS08aEep+58l1OPra54qB0Www3qn/bDDbGbeL/sg6G9hc6vI/0ZkU7q55zUz276Gw31gJiwjtOv48QnfXeRO+27mw8B4AFxoYvRr+PBc+IBXTy7GUC9D4j6FjrUEW5x33dy2hs87Q1PhqcdDpCP4wHKspfnvcVi8Vtwj+yasDyZNdHS9BYaswgTrcotboSz8ldQwe5xv6Pp/XcyuMfRFsU8+qCNVdJ4bm1r2aqcLR4ZP1Uc2hhgBL8yvxYtNF0X4eG82KxQPAvIE0w0u8bkqPWJBz3HyeM8P25xkhrzvFeWvbVG+uw5xrcay7Kf5/01yI3d8Y0l5HkKm81b2/McyrLc0ezbLxNnUv2JRD9YW7ulPwD8XgdgJefdhe89HOTXKync2s7Z2n461q6QgsvQEUQF1gA0TmvBNM7JazRcSQ/925+ceHBWNrnzMp2D5nx4zwr4+E2wux8HoSYSuhNQy/5xG5S1J9E4xbmbI6uNVSUhw3NGM6Rg6qwgL4xF8574voq3uK+MVZy8fYHWula0WX8bEn7XWp4y7eq6o2zQdohhBuLILb6y234n3oMTd70FJ+Ke+y1APCAVv4YSdfqwA3VfXCYlcxYASRmufitboL5Mrpox3jvGfM/Yq/c4RwXPUbAxis2u9z4DbVqCPLUYQx0ll41H7/A9SVudbL7W6fuWW86Wp7gt1FGJx6MRWQyCmxjT6PKrPToEfVwojgKsJJdjhDgAxo0Y/moxbxB7Pzn3WiBszp4lCA4cYBNwa3zs+1fobEybMTRHySUv67KJHE6aWSPLynCbt/lFI2uDOq7Q3t2NFdh8zwoUptu9wKUcuMgAL9n0HkPPdT8gNRDwWZPvJE1URfkHruTrPBklMTeRpG5SNPYzlS+S0V0SYkj0M0RoaNDxO0N5jbvEZAWWjH5FZCgTMuECkzTxmQaTpIlzOCgtQpxKRokav8PMJildmxUFc9HQHG7c6C5C+fh4kgbzMxklPnCepAnOWVkRcGgClJkiI6/KJ8kyLnjfVE3LairjfjSBepqHQtC/cJqvaOhyLRP0i2Z61ZrB0VbiuXqpqM/iK7YwrXm9fCfrCSgaQ+c3C6MgZwtDYbfaeFWUMZHVgkxZnFdcLxq72tmzDUta+DYrNfgOni7jprcw2rHXWn34BmWoiAEuhvGhY98pHCN+GhooV+T2l5UfjMU7hTBGt7dVoeQHjx8MnwyGgyeDIc0Qgo+tOZjWbJGkCbdYmv189L2bGHT3/wXZWpjHW6i3ivun4GJ2/X2iGOEd2WyK+2XufFc+qBWiNoWqRU7BX2S679Iyvzjj1xVjWsRR298jtMs0me8nZg6Z6sVkE3wscGKhripKpCotUT9ue6oPhrjh6ekyTRb7yVv8V5L3CW3ebD9137os3SqD+Ufg+uT5Mk2K/bj+pckj/oHInj5bri7RJNPILMY74Hqs8sV11FvLNmA0I7qg4UZY0ooiR00Wx6a+WqkagqT89/W6nh8rJZDJLYqmk1xyfqVxZisZxSFUMyuQnJuVNetmN40ZHkxob7JQwgrXPGluyNLTNV4mfXg9WfHSG8Lr+a0I6/JbUsEjt961qZ0af3QcvolDj9q5ekqfrkJUEQUHDBbLSrhk94wLQXjT9d2H5p8z7RpOEgLxuowL778qXnqP3S0YBnUzxRBMxD68ZLLJJHYzdnB31wiBk47lEu7uaFdRX9Olu1ymqwZaq9Pg7lXfojFDftsZ1TThamDT1hrqLZlrsmR8Q4j6thHwJS3XtRbLZX9DDFd79N5822BT2Dua5P+BY66G6VzV+j0OrvMwe/7weAfHC7afBBhMaxe5taT+ogy6cNCqwIBLY3XtnT7Iax1rKmKxUqVVhsb0QwlFD3JufJa5wPb8KaA0fjiDCTMWdQq15NKi1nVFHuFm/VOHfrfAkjwoX/xDLNovNt1MPtWC+bqlVqlWPOxxYgylWsGYb6pIYtnUOulbtWuQj/0IkiZ0tR7B369QGyWpbEzpKZP8R+cReutOGTKNCyY8qJd8TnFvwoeUbBeZeG/9/M+fWnjttO83EfMrsDynIOQeDJ2XT+68cb6+xkoswKouRjQf6k/XL9Rk7zXnb8KVFxyUL1U5KWm8rT48OaH/umTEskEI1yzFR2nbJrUQi4+S9P1d8PsdBd+8/fK9z/Iv3vHhj/PsdviWtmiHTN87QTBUai2ocI4412tqGdd5y6XgEq8j266HJyfXA+LtMk1Ot7HvTJVoC1clQkycaUUldZVARiVeegFsyrgEujb1b8hN1Frp++2YD8PsPiacdpjwdJMJr6ULiLrS0nN1g/L3pbS9vPXLE6rz0smKVzMJ90CuP+kQ2273RBrMas3tIhld3CXzHqt4z/ePLq6WV2lCjFUUuKqUcRgzWySj5LgVxzKobyn4RDM4oW3k0DCZU7xyw2hmFT++HSTLdH3EVhN7J7SxbMrltHfvqKsVkWe0EZ7XHVJXEYGK/w0pJBA42YZKE04CUCDLycZepgnt79erIN7ncZdieG1bxKyl29ZiYDEE1olqrWviLXGq7WGqwdN2gMiHgFxUpwnqbIvTNITHyEsTeGnFUlqhlIuVrDZRixi0GDhvf3h66tziTwbOf3zy3Llmp8+WVx0vJUm6nogLsq7b00nStRPdd8sK8qmONasgztzcwp2rcP0m3H0r0fZPlJOVsIFNiTUdxtvBpi+MIlNlU2QXwX/+509uRNx4pys+gje1hkrNUE9qX6k3ETjnZD4R8JqnhawUaIxYAFlNU6pvh5xPXSIv2iQZq9iYC07ahcCUDzC2FJTpw7crX+2R9jnNWxSklEAo5YqlrQJWW1W6NeINOlP6hsrNqWobxlRfS1aBQYxDUBbMla2Ho5eSkUDF4WTlVZobBMZLAiZrEycTnnF3NStpNcsslEyyKdJiqfPJiQtNhbxWY8pSGCVqb45SjS6i9SRS0sf04RUVPDvCXWAVLW1t7i1RQ5WMOYVgnfCH4vMxOREVLc8zNKvqB4G3qJ2q8a5ELQRUilQ+Z4Jsofbe0kRWM2nopg5B3bA1DfuCvejWyNmiD5T2oFuMrCYSAMHljS8Vv2jE7FscG25xFY+YzWYbau9xd8wX3Bb1mCwwtRo3dY1OSbaHNx+PSaegLs2byRnqW55F22LHmscO+DhchMy7vvFAsYpvPU2CZygNtq6tF1+8/RJu4Un/JElbiv49ED7+8vXLz786+5zmpavIn79B/6R/4oKoytiSydZSZygmcOavr7WsQXOXH56SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6SHJ6S/GGVtoenJIenJIenJIenJPtL4A9PSQ5PSQ5PSQ5PSQ5PSQ5PSf53npKEXCtpxONKMC5bdSI+MX+xemBylSYF5exHF8ndHQWvv6E6Mmr+oUZNCf+rNLllmlP4xqX705jcprzuDVKG9aWPRvXOaeXUayOX1FmrcqDcvB/xIsuwsvfCtssK3r45O0/SJBb+lSqnMZrN6IEMm/n8beCjy2QzV4UsmJzWLs2c+DkpH89qW3ST+TcumR9+tLLVTC5aGHaz/J4M+ktEbR1wd+cLBZbLBt537RwRGBuhaeeulsvlfwCFWZfA",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-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)(m.default,{as:"h1",className:"openapi__heading",children:"Self Sign"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/selfsign",context:"endpoint"}),"\n",(0,s.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(d(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{title:"Body",body:{content:{"application/json":{schema:{required:["file","signers","title"],type:"object",properties:{file:{type:"string",format:"base64",example:"base64 encoded pdf"},title:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"sample Note"},description:{type:"string",format:"string",example:"sample Description"},timeToCompleteDays:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15},signer:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:"joebee@example.com"},name:{type:"string",format:"string",example:"joe bee"},phone:{type:"string",format:"string",example:"123121312"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createdocument_body_widgets"}}},title:"selfsigndocument_body_signer"},folderId:{type:"string",example:""},send_email:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0},email_subject:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},email_body:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}},title:"selfsigndocument_body"}}},required:!0}}),"\n",(0,s.jsx)(x(),{id:void 0,label:void 0,responses:{200:{description:"Document created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"hji2zxcv2P"},url:{type:"string",format:"string",example:"https://url-to-sign-document.com"}},title:"inline_response_200_1"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.2a34d737.js b/assets/js/bbdfc22d.2a34d737.js new file mode 100644 index 000000000..e0d15a435 --- /dev/null +++ b/assets/js/bbdfc22d.2a34d737.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3844],{60092:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>y,default:()=>j,frontMatter:()=>x,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/createtemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createtemplate","permalink":"/docs/API-docs/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyIzeuv4Ltl8m4WrKlcSZz/LSTy9md3Ww8lfFUast2OVQ3pGbcTXZItmXFpbf9kv20/ZJTAMlWty6253KyTpVebDUJkgAIgAAI3iVOzGxycp6cYVWXwqFNLtMkR5sZWTupVXKSnBUIsRu+MSioHV6/fQOiLPXcQmPRWHAaMupEyBrrdCV/E5MSwcWJU5gXMivAorlBEBYmZYO1kcpZmGoDM1RohJNqBrnOmgqpYy5dAbXBHKdSYQ7WmSZzjUE7hPe1VmCbLENrp03ZruTRkFql4ApkRA26xigLAholf20QDg4i9JXMDw7AFcJBJhRMkMjJiZqAEHbQmQjq04ontjVmcioJOMw1vFAX6kzWJ/C+LrXIYaEbA2+//d92CpqX2s4PDr7FSTOD928ODi6/KJyr7cnhoajroa5RWTlTpZjYYaarw5wA63z6nDiIBmlWxhWFleUCRJ7DXOYzdJYpVpDpegGZ1iaXyrO+FjME1VQTNDYFoXKotEGQCgQYFPli4PSgsQh/e3f6A21HJdwQ3paNTdvlcmkwc+XCT08ciFQ985x5eUz7I9UshUpc00ZKB782Mrsmsi0qZmvYE+bVwcG7pq61cZjDT56Ek4MD6vkaSz0HYZDhM11VWkEtjKjQsbTRhlG3wV8baTD3oiLKMvLi5EINaJ8XNZ4cHMAblcuMmMETUivoaYAdelBiEoG+CxvrQTuso533Qkw8mQu/n3UpMo+mQZIJJ2+wP/FtCgua+FtUOmJQaCN/08qJkrfjBo2TmSi720YIsqA5YVgvai2Vi61hBfhn2B7aPd6UIFeEWk7MqqTiHotwI8oGbcBqnkJBWP2ItUHL8h3mJUaqHAqUs2LneiL/pbGuNzE0ltDsYhHWirvE7EVm21SUFkFOe7ysxDV2VgPNRkiUQ/h6ATlORVO6FCRJnDMNDuEH7UDUdSkztjZkSEh5BNmIAe9yEIeAiBIV7/Fbo29kjmQScjmdoiHlpE6eIoyJ2JGc1TyAyGPNcYVQoNXaRme61GZThLi5z0fItHKo3BBe3whZMvKeWAtSZWWTI0xKkV2nbCdTMJh7xV0gWd3UyzuDkDH1PGf+gMWSpFArwl/psLy0K4s1hLNC2pU+UWdkNS8ibZerQWunmlYmFkQVA6yELFNmXAq/6Ak46UpMSWFroRYp5MJhCg5v3UTfppAVmF3zLyNyqWHSOEeGmtbMja5zPVeBl1OtnJW/bdHI2PPhHB2ncJzCyxRepTA6SmE0TmF0nMLoZQqjVymMj1IYj1MYH6cwfunRGr8KvBYtg7sIjMaey+6Pw12yu99Ly5pNBtO2Nnjes8GjIRwctNpEbT///POFurtQABcJKddFcgIXSQtykaS+j2wm9Y3C9y19vBh/FT4X9Ply/Cp8zhl0dBw+C/ocjy7UMix4ocaMiRNVfQ8W1P1ZMQhfQYiojReltmjPqJEMURo7aK96+FDHskvLC6JFKumkKO1uciLEE6JohdIGUcdEFIvrboq4+wmR08WHethM+i42q52uqPCMxXiD+i+H4WTZTbxf9snQ3kHn00h/SaSTaToj07Sb/tZ6PSEmrOP0aZz4asgOAFvm3XwIAE+IC32MPo0Hr4gHdCjtZgD1PiHqO+hQRzjhfd/R8WD05WB8ND7ucYBiIw9QVYM8HywWi8/BPfJ5wvLk8kQP1Xt2FIZOja62hB8cHayggk/Ev6PL/g9y1CfRh8Wc4r5+BBsjvq6X7XQuFs+snyoObZ0zgl+5ZosOmtxFeHD0mxVaZgF5goku2YQCvCHxYMCcPMzzww4nqTHPB1U1WGukzwEzvtNYVcM8H65BbuyOb6wgz1PYbN7anudQVdWOZt9+kbBL9T9DTiqwJ7Zb+gPA76UAKznvL3yvclA+QKuS1+Ygbbt2rB0hhVShI4gKrAEYnDWlMHhL0aaVWnnoz685UXFW/jpHpxzYcezvWQFfnAaf/HkQaiKhPwG1PDxug7LuJAZneMtz+LQYISPzkJ+yTVZQ9Cai6098X+Vp+CsTtaQsQYnOcSu6bLgNCb9rnQibdnU9wLboesQIC3Hklhibt5/Fe3TEx1sIMO453wLEEzLxayhRp09XUPf5RVIJ9gBIynD1W7sCzUVy2Y7xUTXmD4y9fIQeFTLHUkyw3Ox6tA50aQny1GEMdVRStZkAxvco7XSK27VO37fcolue4q5QRyMeVSOyGEppYy6kz6/u6JAs4hSeQp9snSDEATBpxfCTxbxF7HFy7q1A2JwHliA4YMA2URdXe2CF3sZ0GUNzVFLJqqnajOO0nTWyrAqneZdfNJLS8HGF7u5urCBuH1ghJMJ3LHChRpwZiBmFe3y9APGEjMEaSvfr6ceYid4Z+ZkOt4cVMJLVVcAtRyKB+sOwVT67W/uGcEoHEGU5/SDKW2UZ1o5yXJ+qmi3Kjz6COAvUzWztlrwu1BOSvi1o/T9LYID7faSwS94fSBJ7aD9aGn0erxKze4Jd7n5C8hfwWdvcJE10zXevWr3Jk5PE3+PGW80k5anRuq91vkhO7pKQaaefIY9NQw9/sXRffJfYrMBK0K+IEt0wT2VJU1GyGI1N0oRTL3TdTPxKThI9+QUzl6QUQNR0HYaW5uBxJ3cRyt8wJmkIxJOTxF89JmmCt6KqCTg0AapMU7jLUyzjivfN1bas5rL8o73jpXnoFu8jp+Ghy7Ur9o+aqTvDcsXX1WTCGLFI1m/z4/VdjNL8uPZ+olxELZGOdKG9U2KwJE2kw6q7yo5dM/rDOZ2hJko4L/uhY3lbRPXBa9K4utDqowaG65ItPH8kl3zv5sL9LXtN0SHm0W8erG44U+BbhuFDEhPhmVox667pvcCNNc923Xx3LtxsoZsyp6ssFGbIF9AfXdvA5SOizBqu4GhPhx5lLaotZaNlmtw+TMwtZHoQr9XhixKnDpq6RgOZNgrN825u7ckQNz4+XqbJ4mHyFn9I8r6izZs/TN1PXI+wqtX4b+D64tUyTYqHcf1rWzHxX0T2+OVyddatneVXE50vrqLdWj4EGA8VgqP6nTfq1ORoOoyYaF2iUBuceDP17pWGZ+SLPAvJLL7olsbGAwXmsizBYIZUNMM56WirIDgd/hYcwuUjeWXfUQN7i7aZWIJScT7rJ5wgOCNnM6TCoADBg8NVPgouRKNiGsJKTOmWnot9DN5I3diIXiEs37aXSA6pK1D6+hKpZn3vsMMdrrTo0j7s7g610CGn6O7/9OztI3jJvusAXNHWEXgq/RxwevaWyofkNPhhQ3hvW05E1ooeCJBfBDdSxBKD1rYvfHoBFXNEM7G9Wq9hKNwZwCZCubRbMUpXCc62VnBj4lV9GW2RbhwVtslQNWEd1rbHR8aiZeSZbh4jlQ9wUsCs4fsRRyoba4k46boq/5HKFyFy5JM3JlY8BbEgSKpIXPEpcoWAOvOngMr64QKmwjo0KZUnEudNQ5FNOyXe1mgkqgy3ssCgZ91VY7b6TX0e9Gtp3v/4fagqjDREpZyQBvqJMYemZqlhTWhrvOLOrZO+4SiRdqC52uWgbboeXIkVsmo1GqsVUAWVmQklf/MizB6JtggTLETpQYOpoNslwoc0vI9MtLX/+de/O3jt9Dg3EfMriDynVP8DGHJk6wWePG6DNVlA3ceI5kPz5/VDgLBjpbmqdN4qkn28jL+lwj9nW7voNBeKYom+lDVePbT21qbRxtrgVtINhOGbAi551TXRi7fSuk6VUrxL3LQPPyLxMevgwG4IaTXJvFp0FbzFK1RDrabjWirZr3Brj8E1Xbj/OPPn3SomDaaYqja1st4jHx8d0b+1je9VFpNitlXH5eJPSfr4gPj+cMA3Uwi+KYorifm6GP/V1qrKChKSCq3te/RbhjxAQJdvUpVS4VVkytX46OjqS+LcMk2OtzHnna7QFSwRZAvmRlMBcF2ioIJUswAxE1IBLW8+I6/QGG3up/rDMLuPCcdHR1ejlglfbjLhjeJrGC42P9PXqH5fSrvLO788oXpbsVXzZjeRHoj7kx6x3XZPpMWsMdItkpPzu+R2IGo58P0n55fLS5I6V2hKFdXaMsbCFclJcriROeJqf0pLnN8lfDwl0fW1QuV0V7Lh/opaHt6MkmW6PmKrs7wTGpvBhw2wTsykmt0/6nLFm3e0f36LehxaJQNq+XekbEDYgC5UmkiSmwIF+dPEchKLH1d5tu/i5sYM2Nak1moX19NUMUvVSzytnxVbUkmdTNJ5TONwZqZNzCQripI2eUI/23TI+UpW28xDTDyMOGIfHx9zaPvViGPAF684vDp+ubz0HO6EGpzK7PrLPkPec/xCU98RSpI1x6N3+q8f/jsP4h3ncHS+pJpq3vOwD6c1qnfk25Iu3ow2w1ksM121Vb8R/D//+jePiOceL/MnOG0M1HqOhh64UBnvtMRbSd5k5/0NZes4nS2qEq2lFJ5yOPNvV+SMqweii5aJWkxkKcm4EJj2VTod+2SH8FOBdKlAXc+ML6S4wZJsEpRa88sOcicap6vu+xiYa3M9JZRSEDChxwDkJFnEOARVIVRGKX6vQuxg0EsWcnprIy2CkBUBk/ON06nMJE1MltSIzEEllJixp5ByWE1cqGMpv9ETil2sLhvvndODAkTnSeQrhiF8S9EQE06NOTra9tw75jb1gVEwrOGlzISC0JqWlxnaVclViTdo2GT4sLYpS6i186EmuUrdvaWJnBHKUuDuEYpb07IvuM+8Ri4WQ6B7BjrEyIkkASiluvbvWs5bMfsJJ1Y6XKUU5vP5hvl63h/zF+mKZkIOqV6Nm3EjG7vu8PbjORkbNJU9nb5DcyMzDLZzx5qHDHwYzkGR8TkYlU3UcqvLW8oMlcXOqfX6L2+/hxt4MTxK0o7BfgTCh9+/+ea7H959R/PSGeT1bzQ8Gh5xHlRbVwnVWeob/3ztbGVC17L07YG+fxO3fxO3fxO3fxO3fxO3fxO3fxO3fxO3fxO3fxO3QdT+Tdz+Tdz+Tdz+Tdz+Tdz+Tdz+Tdz+Tdz+Tdz+TdxTMfH7N3H7N3H7N3H7N3H7N3FP6iXS/k3c7yGB+zdx+zdxj3gTF0pYyCs8rEshuWgqlNj6eqfz9Zdyl2lSUEHUyXlyd0fXf+9NuVxS868NGqqmukyTG2EkJbm5liqNJUBUNHONC7qG9jn7wRmtn3px5yvztRIyqmDyI17ztt8L263Zenv67ixJk0l4zVfpnMYYMaeXfmLuK2cCN/ktl+BnGqVQs4ZreBI/J1UticYV/ZKnay55Cj86pUBCLToY9muhPBn0l4jaOuDuzpdTLZctvO/aOSIwNkLT/l0ul8v/Azl31h4=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/get-template"}}');var s=t(74848),r=t(28453),o=t(33617),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:"eJztO9tyIzeuv4Ltl8m4WrKlcSZz/LSTy9md3Ww8lfFUast2OVQ3pGbcTXZItmXFpbf9kv20/ZJTAMlWty6253KyTpVebDUJkgAIgAAI3iVOzGxycp6cYVWXwqFNLtMkR5sZWTupVXKSnBUIsRu+MSioHV6/fQOiLPXcQmPRWHAaMupEyBrrdCV/E5MSwcWJU5gXMivAorlBEBYmZYO1kcpZmGoDM1RohJNqBrnOmgqpYy5dAbXBHKdSYQ7WmSZzjUE7hPe1VmCbLENrp03ZruTRkFql4ApkRA26xigLAholf20QDg4i9JXMDw7AFcJBJhRMkMjJiZqAEHbQmQjq04ontjVmcioJOMw1vFAX6kzWJ/C+LrXIYaEbA2+//d92CpqX2s4PDr7FSTOD928ODi6/KJyr7cnhoajroa5RWTlTpZjYYaarw5wA63z6nDiIBmlWxhWFleUCRJ7DXOYzdJYpVpDpegGZ1iaXyrO+FjME1VQTNDYFoXKotEGQCgQYFPli4PSgsQh/e3f6A21HJdwQ3paNTdvlcmkwc+XCT08ciFQ985x5eUz7I9UshUpc00ZKB782Mrsmsi0qZmvYE+bVwcG7pq61cZjDT56Ek4MD6vkaSz0HYZDhM11VWkEtjKjQsbTRhlG3wV8baTD3oiLKMvLi5EINaJ8XNZ4cHMAblcuMmMETUivoaYAdelBiEoG+CxvrQTuso533Qkw8mQu/n3UpMo+mQZIJJ2+wP/FtCgua+FtUOmJQaCN/08qJkrfjBo2TmSi720YIsqA5YVgvai2Vi61hBfhn2B7aPd6UIFeEWk7MqqTiHotwI8oGbcBqnkJBWP2ItUHL8h3mJUaqHAqUs2LneiL/pbGuNzE0ltDsYhHWirvE7EVm21SUFkFOe7ysxDV2VgPNRkiUQ/h6ATlORVO6FCRJnDMNDuEH7UDUdSkztjZkSEh5BNmIAe9yEIeAiBIV7/Fbo29kjmQScjmdoiHlpE6eIoyJ2JGc1TyAyGPNcYVQoNXaRme61GZThLi5z0fItHKo3BBe3whZMvKeWAtSZWWTI0xKkV2nbCdTMJh7xV0gWd3UyzuDkDH1PGf+gMWSpFArwl/psLy0K4s1hLNC2pU+UWdkNS8ibZerQWunmlYmFkQVA6yELFNmXAq/6Ak46UpMSWFroRYp5MJhCg5v3UTfppAVmF3zLyNyqWHSOEeGmtbMja5zPVeBl1OtnJW/bdHI2PPhHB2ncJzCyxRepTA6SmE0TmF0nMLoZQqjVymMj1IYj1MYH6cwfunRGr8KvBYtg7sIjMaey+6Pw12yu99Ly5pNBtO2Nnjes8GjIRwctNpEbT///POFurtQABcJKddFcgIXSQtykaS+j2wm9Y3C9y19vBh/FT4X9Ply/Cp8zhl0dBw+C/ocjy7UMix4ocaMiRNVfQ8W1P1ZMQhfQYiojReltmjPqJEMURo7aK96+FDHskvLC6JFKumkKO1uciLEE6JohdIGUcdEFIvrboq4+wmR08WHethM+i42q52uqPCMxXiD+i+H4WTZTbxf9snQ3kHn00h/SaSTaToj07Sb/tZ6PSEmrOP0aZz4asgOAFvm3XwIAE+IC32MPo0Hr4gHdCjtZgD1PiHqO+hQRzjhfd/R8WD05WB8ND7ucYBiIw9QVYM8HywWi8/BPfJ5wvLk8kQP1Xt2FIZOja62hB8cHayggk/Ev6PL/g9y1CfRh8Wc4r5+BBsjvq6X7XQuFs+snyoObZ0zgl+5ZosOmtxFeHD0mxVaZgF5goku2YQCvCHxYMCcPMzzww4nqTHPB1U1WGukzwEzvtNYVcM8H65BbuyOb6wgz1PYbN7anudQVdWOZt9+kbBL9T9DTiqwJ7Zb+gPA76UAKznvL3yvclA+QKuS1+Ygbbt2rB0hhVShI4gKrAEYnDWlMHhL0aaVWnnoz685UXFW/jpHpxzYcezvWQFfnAaf/HkQaiKhPwG1PDxug7LuJAZneMtz+LQYISPzkJ+yTVZQ9Cai6098X+Vp+CsTtaQsQYnOcSu6bLgNCb9rnQibdnU9wLboesQIC3Hklhibt5/Fe3TEx1sIMO453wLEEzLxayhRp09XUPf5RVIJ9gBIynD1W7sCzUVy2Y7xUTXmD4y9fIQeFTLHUkyw3Ox6tA50aQny1GEMdVRStZkAxvco7XSK27VO37fcolue4q5QRyMeVSOyGEppYy6kz6/u6JAs4hSeQp9snSDEATBpxfCTxbxF7HFy7q1A2JwHliA4YMA2URdXe2CF3sZ0GUNzVFLJqqnajOO0nTWyrAqneZdfNJLS8HGF7u5urCBuH1ghJMJ3LHChRpwZiBmFe3y9APGEjMEaSvfr6ceYid4Z+ZkOt4cVMJLVVcAtRyKB+sOwVT67W/uGcEoHEGU5/SDKW2UZ1o5yXJ+qmi3Kjz6COAvUzWztlrwu1BOSvi1o/T9LYID7faSwS94fSBJ7aD9aGn0erxKze4Jd7n5C8hfwWdvcJE10zXevWr3Jk5PE3+PGW80k5anRuq91vkhO7pKQaaefIY9NQw9/sXRffJfYrMBK0K+IEt0wT2VJU1GyGI1N0oRTL3TdTPxKThI9+QUzl6QUQNR0HYaW5uBxJ3cRyt8wJmkIxJOTxF89JmmCt6KqCTg0AapMU7jLUyzjivfN1bas5rL8o73jpXnoFu8jp+Ghy7Ur9o+aqTvDcsXX1WTCGLFI1m/z4/VdjNL8uPZ+olxELZGOdKG9U2KwJE2kw6q7yo5dM/rDOZ2hJko4L/uhY3lbRPXBa9K4utDqowaG65ItPH8kl3zv5sL9LXtN0SHm0W8erG44U+BbhuFDEhPhmVox667pvcCNNc923Xx3LtxsoZsyp6ssFGbIF9AfXdvA5SOizBqu4GhPhx5lLaotZaNlmtw+TMwtZHoQr9XhixKnDpq6RgOZNgrN825u7ckQNz4+XqbJ4mHyFn9I8r6izZs/TN1PXI+wqtX4b+D64tUyTYqHcf1rWzHxX0T2+OVyddatneVXE50vrqLdWj4EGA8VgqP6nTfq1ORoOoyYaF2iUBuceDP17pWGZ+SLPAvJLL7olsbGAwXmsizBYIZUNMM56WirIDgd/hYcwuUjeWXfUQN7i7aZWIJScT7rJ5wgOCNnM6TCoADBg8NVPgouRKNiGsJKTOmWnot9DN5I3diIXiEs37aXSA6pK1D6+hKpZn3vsMMdrrTo0j7s7g610CGn6O7/9OztI3jJvusAXNHWEXgq/RxwevaWyofkNPhhQ3hvW05E1ooeCJBfBDdSxBKD1rYvfHoBFXNEM7G9Wq9hKNwZwCZCubRbMUpXCc62VnBj4lV9GW2RbhwVtslQNWEd1rbHR8aiZeSZbh4jlQ9wUsCs4fsRRyoba4k46boq/5HKFyFy5JM3JlY8BbEgSKpIXPEpcoWAOvOngMr64QKmwjo0KZUnEudNQ5FNOyXe1mgkqgy3ssCgZ91VY7b6TX0e9Gtp3v/4fagqjDREpZyQBvqJMYemZqlhTWhrvOLOrZO+4SiRdqC52uWgbboeXIkVsmo1GqsVUAWVmQklf/MizB6JtggTLETpQYOpoNslwoc0vI9MtLX/+de/O3jt9Dg3EfMriDynVP8DGHJk6wWePG6DNVlA3ceI5kPz5/VDgLBjpbmqdN4qkn28jL+lwj9nW7voNBeKYom+lDVePbT21qbRxtrgVtINhOGbAi551TXRi7fSuk6VUrxL3LQPPyLxMevgwG4IaTXJvFp0FbzFK1RDrabjWirZr3Brj8E1Xbj/OPPn3SomDaaYqja1st4jHx8d0b+1je9VFpNitlXH5eJPSfr4gPj+cMA3Uwi+KYorifm6GP/V1qrKChKSCq3te/RbhjxAQJdvUpVS4VVkytX46OjqS+LcMk2OtzHnna7QFSwRZAvmRlMBcF2ioIJUswAxE1IBLW8+I6/QGG3up/rDMLuPCcdHR1ejlglfbjLhjeJrGC42P9PXqH5fSrvLO788oXpbsVXzZjeRHoj7kx6x3XZPpMWsMdItkpPzu+R2IGo58P0n55fLS5I6V2hKFdXaMsbCFclJcriROeJqf0pLnN8lfDwl0fW1QuV0V7Lh/opaHt6MkmW6PmKrs7wTGpvBhw2wTsykmt0/6nLFm3e0f36LehxaJQNq+XekbEDYgC5UmkiSmwIF+dPEchKLH1d5tu/i5sYM2Nak1moX19NUMUvVSzytnxVbUkmdTNJ5TONwZqZNzCQripI2eUI/23TI+UpW28xDTDyMOGIfHx9zaPvViGPAF684vDp+ubz0HO6EGpzK7PrLPkPec/xCU98RSpI1x6N3+q8f/jsP4h3ncHS+pJpq3vOwD6c1qnfk25Iu3ow2w1ksM121Vb8R/D//+jePiOceL/MnOG0M1HqOhh64UBnvtMRbSd5k5/0NZes4nS2qEq2lFJ5yOPNvV+SMqweii5aJWkxkKcm4EJj2VTod+2SH8FOBdKlAXc+ML6S4wZJsEpRa88sOcicap6vu+xiYa3M9JZRSEDChxwDkJFnEOARVIVRGKX6vQuxg0EsWcnprIy2CkBUBk/ON06nMJE1MltSIzEEllJixp5ByWE1cqGMpv9ETil2sLhvvndODAkTnSeQrhiF8S9EQE06NOTra9tw75jb1gVEwrOGlzISC0JqWlxnaVclViTdo2GT4sLYpS6i186EmuUrdvaWJnBHKUuDuEYpb07IvuM+8Ri4WQ6B7BjrEyIkkASiluvbvWs5bMfsJJ1Y6XKUU5vP5hvl63h/zF+mKZkIOqV6Nm3EjG7vu8PbjORkbNJU9nb5DcyMzDLZzx5qHDHwYzkGR8TkYlU3UcqvLW8oMlcXOqfX6L2+/hxt4MTxK0o7BfgTCh9+/+ea7H959R/PSGeT1bzQ8Gh5xHlRbVwnVWeob/3ztbGVC17L07YG+fxO3fxO3fxO3fxO3fxO3fxO3fxO3fxO3fxO3fxO3QdT+Tdz+Tdz+Tdz+Tdz+Tdz+Tdz+Tdz+Tdz+Tdz+TdxTMfH7N3H7N3H7N3H7N3H7N3FP6iXS/k3c7yGB+zdx+zdxj3gTF0pYyCs8rEshuWgqlNj6eqfz9Zdyl2lSUEHUyXlyd0fXf+9NuVxS868NGqqmukyTG2EkJbm5liqNJUBUNHONC7qG9jn7wRmtn3px5yvztRIyqmDyI17ztt8L263Zenv67ixJk0l4zVfpnMYYMaeXfmLuK2cCN/ktl+BnGqVQs4ZreBI/J1UticYV/ZKnay55Cj86pUBCLToY9muhPBn0l4jaOuDuzpdTLZctvO/aOSIwNkLT/l0ul8v/Azl31h4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,g={},f=[];function b(e){const n={a:"a",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(l(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(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 file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},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,s.jsx)(n,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.b0216893.js b/assets/js/bbdfc22d.b0216893.js deleted file mode 100644 index 1ca69aef8..000000000 --- a/assets/js/bbdfc22d.b0216893.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3844],{60092:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>x,contentTitle:()=>g,default:()=>b,frontMatter:()=>y,metadata:()=>i,toc:()=>f});const i=JSON.parse('{"id":"API-docs/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","source":"@site/docs/API-docs/createtemplate.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/createtemplate","permalink":"/docs/API-docs/createtemplate","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar_label":"Create Template","hide_title":true,"hide_table_of_contents":true,"api":"eJztO9tyIzeuv4Ltl8m4WrKlcSZz/LSTy9md3Ww8lfFUast2OVQ3pGbcTXZItmXFpbf9kv20/ZJTAMlWty6253KyTpVebDUJkgAIgAAI3iVOzGxycp6cYVWXwqFNLtMkR5sZWTupVXKSnBUIsRu+MSioHV6/fQOiLPXcQmPRWHAaMupEyBrrdCV/E5MSwcWJU5gXMivAorlBEBYmZYO1kcpZmGoDM1RohJNqBrnOmgqpYy5dAbXBHKdSYQ7WmSZzjUE7hPe1VmCbLENrp03ZruTRkFql4ApkRA26xigLAholf20QDg4i9JXMDw7AFcJBJhRMkMjJiZqAEHbQmQjq04ontjVmcioJOMw1vFAX6kzWJ/C+LrXIYaEbA2+//d92CpqX2s4PDr7FSTOD928ODi6/KJyr7cnhoajroa5RWTlTpZjYYaarw5wA63z6nDiIBmlWxhWFleUCRJ7DXOYzdJYpVpDpegGZ1iaXyrO+FjME1VQTNDYFoXKotEGQCgQYFPli4PSgsQh/e3f6A21HJdwQ3paNTdvlcmkwc+XCT08ciFQ985x5eUz7I9UshUpc00ZKB782Mrsmsi0qZmvYE+bVwcG7pq61cZjDT56Ek4MD6vkaSz0HYZDhM11VWkEtjKjQsbTRhlG3wV8baTD3oiLKMvLi5EINaJ8XNZ4cHMAblcuMmMETUivoaYAdelBiEoG+CxvrQTuso533Qkw8mQu/n3UpMo+mQZIJJ2+wP/FtCgua+FtUOmJQaCN/08qJkrfjBo2TmSi720YIsqA5YVgvai2Vi61hBfhn2B7aPd6UIFeEWk7MqqTiHotwI8oGbcBqnkJBWP2ItUHL8h3mJUaqHAqUs2LneiL/pbGuNzE0ltDsYhHWirvE7EVm21SUFkFOe7ysxDV2VgPNRkiUQ/h6ATlORVO6FCRJnDMNDuEH7UDUdSkztjZkSEh5BNmIAe9yEIeAiBIV7/Fbo29kjmQScjmdoiHlpE6eIoyJ2JGc1TyAyGPNcYVQoNXaRme61GZThLi5z0fItHKo3BBe3whZMvKeWAtSZWWTI0xKkV2nbCdTMJh7xV0gWd3UyzuDkDH1PGf+gMWSpFArwl/psLy0K4s1hLNC2pU+UWdkNS8ibZerQWunmlYmFkQVA6yELFNmXAq/6Ak46UpMSWFroRYp5MJhCg5v3UTfppAVmF3zLyNyqWHSOEeGmtbMja5zPVeBl1OtnJW/bdHI2PPhHB2ncJzCyxRepTA6SmE0TmF0nMLoZQqjVymMj1IYj1MYH6cwfunRGr8KvBYtg7sIjMaey+6Pw12yu99Ly5pNBtO2Nnjes8GjIRwctNpEbT///POFurtQABcJKddFcgIXSQtykaS+j2wm9Y3C9y19vBh/FT4X9Ply/Cp8zhl0dBw+C/ocjy7UMix4ocaMiRNVfQ8W1P1ZMQhfQYiojReltmjPqJEMURo7aK96+FDHskvLC6JFKumkKO1uciLEE6JohdIGUcdEFIvrboq4+wmR08WHethM+i42q52uqPCMxXiD+i+H4WTZTbxf9snQ3kHn00h/SaSTaToj07Sb/tZ6PSEmrOP0aZz4asgOAFvm3XwIAE+IC32MPo0Hr4gHdCjtZgD1PiHqO+hQRzjhfd/R8WD05WB8ND7ucYBiIw9QVYM8HywWi8/BPfJ5wvLk8kQP1Xt2FIZOja62hB8cHayggk/Ev6PL/g9y1CfRh8Wc4r5+BBsjvq6X7XQuFs+snyoObZ0zgl+5ZosOmtxFeHD0mxVaZgF5goku2YQCvCHxYMCcPMzzww4nqTHPB1U1WGukzwEzvtNYVcM8H65BbuyOb6wgz1PYbN7anudQVdWOZt9+kbBL9T9DTiqwJ7Zb+gPA76UAKznvL3yvclA+QKuS1+Ygbbt2rB0hhVShI4gKrAEYnDWlMHhL0aaVWnnoz685UXFW/jpHpxzYcezvWQFfnAaf/HkQaiKhPwG1PDxug7LuJAZneMtz+LQYISPzkJ+yTVZQ9Cai6098X+Vp+CsTtaQsQYnOcSu6bLgNCb9rnQibdnU9wLboesQIC3Hklhibt5/Fe3TEx1sIMO453wLEEzLxayhRp09XUPf5RVIJ9gBIynD1W7sCzUVy2Y7xUTXmD4y9fIQeFTLHUkyw3Ox6tA50aQny1GEMdVRStZkAxvco7XSK27VO37fcolue4q5QRyMeVSOyGEppYy6kz6/u6JAs4hSeQp9snSDEATBpxfCTxbxF7HFy7q1A2JwHliA4YMA2URdXe2CF3sZ0GUNzVFLJqqnajOO0nTWyrAqneZdfNJLS8HGF7u5urCBuH1ghJMJ3LHChRpwZiBmFe3y9APGEjMEaSvfr6ceYid4Z+ZkOt4cVMJLVVcAtRyKB+sOwVT67W/uGcEoHEGU5/SDKW2UZ1o5yXJ+qmi3Kjz6COAvUzWztlrwu1BOSvi1o/T9LYID7faSwS94fSBJ7aD9aGn0erxKze4Jd7n5C8hfwWdvcJE10zXevWr3Jk5PE3+PGW80k5anRuq91vkhO7pKQaaefIY9NQw9/sXRffJfYrMBK0K+IEt0wT2VJU1GyGI1N0oRTL3TdTPxKThI9+QUzl6QUQNR0HYaW5uBxJ3cRyt8wJmkIxJOTxF89JmmCt6KqCTg0AapMU7jLUyzjivfN1bas5rL8o73jpXnoFu8jp+Ghy7Ur9o+aqTvDcsXX1WTCGLFI1m/z4/VdjNL8uPZ+olxELZGOdKG9U2KwJE2kw6q7yo5dM/rDOZ2hJko4L/uhY3lbRPXBa9K4utDqowaG65ItPH8kl3zv5sL9LXtN0SHm0W8erG44U+BbhuFDEhPhmVox667pvcCNNc923Xx3LtxsoZsyp6ssFGbIF9AfXdvA5SOizBqu4GhPhx5lLaotZaNlmtw+TMwtZHoQr9XhixKnDpq6RgOZNgrN825u7ckQNz4+XqbJ4mHyFn9I8r6izZs/TN1PXI+wqtX4b+D64tUyTYqHcf1rWzHxX0T2+OVyddatneVXE50vrqLdWj4EGA8VgqP6nTfq1ORoOoyYaF2iUBuceDP17pWGZ+SLPAvJLL7olsbGAwXmsizBYIZUNMM56WirIDgd/hYcwuUjeWXfUQN7i7aZWIJScT7rJ5wgOCNnM6TCoADBg8NVPgouRKNiGsJKTOmWnot9DN5I3diIXiEs37aXSA6pK1D6+hKpZn3vsMMdrrTo0j7s7g610CGn6O7/9OztI3jJvusAXNHWEXgq/RxwevaWyofkNPhhQ3hvW05E1ooeCJBfBDdSxBKD1rYvfHoBFXNEM7G9Wq9hKNwZwCZCubRbMUpXCc62VnBj4lV9GW2RbhwVtslQNWEd1rbHR8aiZeSZbh4jlQ9wUsCs4fsRRyoba4k46boq/5HKFyFy5JM3JlY8BbEgSKpIXPEpcoWAOvOngMr64QKmwjo0KZUnEudNQ5FNOyXe1mgkqgy3ssCgZ91VY7b6TX0e9Gtp3v/4fagqjDREpZyQBvqJMYemZqlhTWhrvOLOrZO+4SiRdqC52uWgbboeXIkVsmo1GqsVUAWVmQklf/MizB6JtggTLETpQYOpoNslwoc0vI9MtLX/+de/O3jt9Dg3EfMriDynVP8DGHJk6wWePG6DNVlA3ceI5kPz5/VDgLBjpbmqdN4qkn28jL+lwj9nW7voNBeKYom+lDVePbT21qbRxtrgVtINhOGbAi551TXRi7fSuk6VUrxL3LQPPyLxMevgwG4IaTXJvFp0FbzFK1RDrabjWirZr3Brj8E1Xbj/OPPn3SomDaaYqja1st4jHx8d0b+1je9VFpNitlXH5eJPSfr4gPj+cMA3Uwi+KYorifm6GP/V1qrKChKSCq3te/RbhjxAQJdvUpVS4VVkytX46OjqS+LcMk2OtzHnna7QFSwRZAvmRlMBcF2ioIJUswAxE1IBLW8+I6/QGG3up/rDMLuPCcdHR1ejlglfbjLhjeJrGC42P9PXqH5fSrvLO788oXpbsVXzZjeRHoj7kx6x3XZPpMWsMdItkpPzu+R2IGo58P0n55fLS5I6V2hKFdXaMsbCFclJcriROeJqf0pLnN8lfDwl0fW1QuV0V7Lh/opaHt6MkmW6PmKrs7wT2joxk2o2uHfU5YrUd7QdnuM9glexfS3/jhTcB352odJEkhgUKMg9Jg7SLv+4Spt9F/cqJrS25qhWm7KedYpJp14ead30b8kMdRJD5zErw4mWNs+SrChK2lwI/WyzG+cr0WsTCTGPMOIAfHx8zJHqVyMO6V684mjp+OXy0nO4EzlwZrLr/vqEd8+PC019vyZJ1vyI3mG+fpbvPFd3HKvRl5JqqnnPwz6c1qjekatKqnUz2oxOscx01RbxRvD//OvfPCIeY7zMn+C0MVDrORp6r0JVudMSbyU5h53nNJR84+y0qEq0ljJyyuHMP0WRMy4GiB5XJmoxkaUkW0Fg2hfddMyNHcJPBdIdAXU9M74u4gZLMjFQas0PNcg7aJyuus9dYK7N9ZRQSkHAhGr7yeexiHEIqkKojDL2XoXYX6CHKeTD1kZaBCErAiZfGqdTmUmamAyjEZmDSigx44M/5SiZuFDHynyjJxSKWF023tmm9wGIzpPINwZD+JaCGyacGnN0tO2597Nt6uOcYCfDw5cJxZQ1LS8ztKsKqhJv0LDJ8FFqU5ZQa+cjR/J8untLEzkjlKU43CMUt6ZlX/CGeY1cLIZA1wZ0JpFPSAJQSnXtn6mct2L2E06sdLjKEMzn8w3z9bw/5i/SFc2E/Eu9GjfjRjZ23eHtx3MyNmgqezp9h+ZGZhhs5441Dxn4MBxrIuNjLSqbqOVWD7aUGSqLnUPo9V/efg838GJ4lKQdg/0IhA+/f/PNdz+8+47mpSPF699oeDQ84rSmtq4SqrPUN/412tnKhK4l3dvzef/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/EbYOo/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3p2Li90/c9k/c9k/c9k/c9k/cntTDov0Tt99DAvdP3PZP3B7xxC2UsJBXeFiXQnINVKiY9eVL5+sP3y7TpKD6ppPz5O6Orv/em3K5pOZfGzRUHHWZJjfCSEpyc2lUGkuAqGjmGhd0De1z9oMzWj/14s5X5msVYVTB5Ee85m2/F7ZbgvX29N1ZkiaT8Div0jmNMWJOD/fE3FfOBG7y0yzBry5KoWYN1/Akfk6qWhKNK/olT9dc8hR+dEqBhFp0MOzXQnky6C8RtXXA3Z0vp1ouW3jftXNEYGyEpv27XC6X/wfuWsTz","sidebar_class_name":"post api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Draft Template","permalink":"/docs/API-docs/drafttemplate"},"next":{"title":"Get Template","permalink":"/docs/API-docs/get-template"}}');var s=t(74848),r=t(28453),o=t(33617),a=t.n(o),l=t(17543),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 y={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:"eJztO9tyIzeuv4Ltl8m4WrKlcSZz/LSTy9md3Ww8lfFUast2OVQ3pGbcTXZItmXFpbf9kv20/ZJTAMlWty6253KyTpVebDUJkgAIgAAI3iVOzGxycp6cYVWXwqFNLtMkR5sZWTupVXKSnBUIsRu+MSioHV6/fQOiLPXcQmPRWHAaMupEyBrrdCV/E5MSwcWJU5gXMivAorlBEBYmZYO1kcpZmGoDM1RohJNqBrnOmgqpYy5dAbXBHKdSYQ7WmSZzjUE7hPe1VmCbLENrp03ZruTRkFql4ApkRA26xigLAholf20QDg4i9JXMDw7AFcJBJhRMkMjJiZqAEHbQmQjq04ontjVmcioJOMw1vFAX6kzWJ/C+LrXIYaEbA2+//d92CpqX2s4PDr7FSTOD928ODi6/KJyr7cnhoajroa5RWTlTpZjYYaarw5wA63z6nDiIBmlWxhWFleUCRJ7DXOYzdJYpVpDpegGZ1iaXyrO+FjME1VQTNDYFoXKotEGQCgQYFPli4PSgsQh/e3f6A21HJdwQ3paNTdvlcmkwc+XCT08ciFQ985x5eUz7I9UshUpc00ZKB782Mrsmsi0qZmvYE+bVwcG7pq61cZjDT56Ek4MD6vkaSz0HYZDhM11VWkEtjKjQsbTRhlG3wV8baTD3oiLKMvLi5EINaJ8XNZ4cHMAblcuMmMETUivoaYAdelBiEoG+CxvrQTuso533Qkw8mQu/n3UpMo+mQZIJJ2+wP/FtCgua+FtUOmJQaCN/08qJkrfjBo2TmSi720YIsqA5YVgvai2Vi61hBfhn2B7aPd6UIFeEWk7MqqTiHotwI8oGbcBqnkJBWP2ItUHL8h3mJUaqHAqUs2LneiL/pbGuNzE0ltDsYhHWirvE7EVm21SUFkFOe7ysxDV2VgPNRkiUQ/h6ATlORVO6FCRJnDMNDuEH7UDUdSkztjZkSEh5BNmIAe9yEIeAiBIV7/Fbo29kjmQScjmdoiHlpE6eIoyJ2JGc1TyAyGPNcYVQoNXaRme61GZThLi5z0fItHKo3BBe3whZMvKeWAtSZWWTI0xKkV2nbCdTMJh7xV0gWd3UyzuDkDH1PGf+gMWSpFArwl/psLy0K4s1hLNC2pU+UWdkNS8ibZerQWunmlYmFkQVA6yELFNmXAq/6Ak46UpMSWFroRYp5MJhCg5v3UTfppAVmF3zLyNyqWHSOEeGmtbMja5zPVeBl1OtnJW/bdHI2PPhHB2ncJzCyxRepTA6SmE0TmF0nMLoZQqjVymMj1IYj1MYH6cwfunRGr8KvBYtg7sIjMaey+6Pw12yu99Ly5pNBtO2Nnjes8GjIRwctNpEbT///POFurtQABcJKddFcgIXSQtykaS+j2wm9Y3C9y19vBh/FT4X9Ply/Cp8zhl0dBw+C/ocjy7UMix4ocaMiRNVfQ8W1P1ZMQhfQYiojReltmjPqJEMURo7aK96+FDHskvLC6JFKumkKO1uciLEE6JohdIGUcdEFIvrboq4+wmR08WHethM+i42q52uqPCMxXiD+i+H4WTZTbxf9snQ3kHn00h/SaSTaToj07Sb/tZ6PSEmrOP0aZz4asgOAFvm3XwIAE+IC32MPo0Hr4gHdCjtZgD1PiHqO+hQRzjhfd/R8WD05WB8ND7ucYBiIw9QVYM8HywWi8/BPfJ5wvLk8kQP1Xt2FIZOja62hB8cHayggk/Ev6PL/g9y1CfRh8Wc4r5+BBsjvq6X7XQuFs+snyoObZ0zgl+5ZosOmtxFeHD0mxVaZgF5goku2YQCvCHxYMCcPMzzww4nqTHPB1U1WGukzwEzvtNYVcM8H65BbuyOb6wgz1PYbN7anudQVdWOZt9+kbBL9T9DTiqwJ7Zb+gPA76UAKznvL3yvclA+QKuS1+Ygbbt2rB0hhVShI4gKrAEYnDWlMHhL0aaVWnnoz685UXFW/jpHpxzYcezvWQFfnAaf/HkQaiKhPwG1PDxug7LuJAZneMtz+LQYISPzkJ+yTVZQ9Cai6098X+Vp+CsTtaQsQYnOcSu6bLgNCb9rnQibdnU9wLboesQIC3Hklhibt5/Fe3TEx1sIMO453wLEEzLxayhRp09XUPf5RVIJ9gBIynD1W7sCzUVy2Y7xUTXmD4y9fIQeFTLHUkyw3Ox6tA50aQny1GEMdVRStZkAxvco7XSK27VO37fcolue4q5QRyMeVSOyGEppYy6kz6/u6JAs4hSeQp9snSDEATBpxfCTxbxF7HFy7q1A2JwHliA4YMA2URdXe2CF3sZ0GUNzVFLJqqnajOO0nTWyrAqneZdfNJLS8HGF7u5urCBuH1ghJMJ3LHChRpwZiBmFe3y9APGEjMEaSvfr6ceYid4Z+ZkOt4cVMJLVVcAtRyKB+sOwVT67W/uGcEoHEGU5/SDKW2UZ1o5yXJ+qmi3Kjz6COAvUzWztlrwu1BOSvi1o/T9LYID7faSwS94fSBJ7aD9aGn0erxKze4Jd7n5C8hfwWdvcJE10zXevWr3Jk5PE3+PGW80k5anRuq91vkhO7pKQaaefIY9NQw9/sXRffJfYrMBK0K+IEt0wT2VJU1GyGI1N0oRTL3TdTPxKThI9+QUzl6QUQNR0HYaW5uBxJ3cRyt8wJmkIxJOTxF89JmmCt6KqCTg0AapMU7jLUyzjivfN1bas5rL8o73jpXnoFu8jp+Ghy7Ur9o+aqTvDcsXX1WTCGLFI1m/z4/VdjNL8uPZ+olxELZGOdKG9U2KwJE2kw6q7yo5dM/rDOZ2hJko4L/uhY3lbRPXBa9K4utDqowaG65ItPH8kl3zv5sL9LXtN0SHm0W8erG44U+BbhuFDEhPhmVox667pvcCNNc923Xx3LtxsoZsyp6ssFGbIF9AfXdvA5SOizBqu4GhPhx5lLaotZaNlmtw+TMwtZHoQr9XhixKnDpq6RgOZNgrN825u7ckQNz4+XqbJ4mHyFn9I8r6izZs/TN1PXI+wqtX4b+D64tUyTYqHcf1rWzHxX0T2+OVyddatneVXE50vrqLdWj4EGA8VgqP6nTfq1ORoOoyYaF2iUBuceDP17pWGZ+SLPAvJLL7olsbGAwXmsizBYIZUNMM56WirIDgd/hYcwuUjeWXfUQN7i7aZWIJScT7rJ5wgOCNnM6TCoADBg8NVPgouRKNiGsJKTOmWnot9DN5I3diIXiEs37aXSA6pK1D6+hKpZn3vsMMdrrTo0j7s7g610CGn6O7/9OztI3jJvusAXNHWEXgq/RxwevaWyofkNPhhQ3hvW05E1ooeCJBfBDdSxBKD1rYvfHoBFXNEM7G9Wq9hKNwZwCZCubRbMUpXCc62VnBj4lV9GW2RbhwVtslQNWEd1rbHR8aiZeSZbh4jlQ9wUsCs4fsRRyoba4k46boq/5HKFyFy5JM3JlY8BbEgSKpIXPEpcoWAOvOngMr64QKmwjo0KZUnEudNQ5FNOyXe1mgkqgy3ssCgZ91VY7b6TX0e9Gtp3v/4fagqjDREpZyQBvqJMYemZqlhTWhrvOLOrZO+4SiRdqC52uWgbboeXIkVsmo1GqsVUAWVmQklf/MizB6JtggTLETpQYOpoNslwoc0vI9MtLX/+de/O3jt9Dg3EfMriDynVP8DGHJk6wWePG6DNVlA3ceI5kPz5/VDgLBjpbmqdN4qkn28jL+lwj9nW7voNBeKYom+lDVePbT21qbRxtrgVtINhOGbAi551TXRi7fSuk6VUrxL3LQPPyLxMevgwG4IaTXJvFp0FbzFK1RDrabjWirZr3Brj8E1Xbj/OPPn3SomDaaYqja1st4jHx8d0b+1je9VFpNitlXH5eJPSfr4gPj+cMA3Uwi+KYorifm6GP/V1qrKChKSCq3te/RbhjxAQJdvUpVS4VVkytX46OjqS+LcMk2OtzHnna7QFSwRZAvmRlMBcF2ioIJUswAxE1IBLW8+I6/QGG3up/rDMLuPCcdHR1ejlglfbjLhjeJrGC42P9PXqH5fSrvLO788oXpbsVXzZjeRHoj7kx6x3XZPpMWsMdItkpPzu+R2IGo58P0n55fLS5I6V2hKFdXaMsbCFclJcriROeJqf0pLnN8lfDwl0fW1QuV0V7Lh/opaHt6MkmW6PmKrs7wT2joxk2o2uHfU5YrUd7QdnuM9glexfS3/jhTcB352odJEkhgUKMg9Jg7SLv+4Spt9F/cqJrS25qhWm7KedYpJp14ead30b8kMdRJD5zErw4mWNs+SrChK2lwI/WyzG+cr0WsTCTGPMOIAfHx8zJHqVyMO6V684mjp+OXy0nO4EzlwZrLr/vqEd8+PC019vyZJ1vyI3mG+fpbvPFd3HKvRl5JqqnnPwz6c1qjekatKqnUz2oxOscx01RbxRvD//OvfPCIeY7zMn+C0MVDrORp6r0JVudMSbyU5h53nNJR84+y0qEq0ljJyyuHMP0WRMy4GiB5XJmoxkaUkW0Fg2hfddMyNHcJPBdIdAXU9M74u4gZLMjFQas0PNcg7aJyuus9dYK7N9ZRQSkHAhGr7yeexiHEIqkKojDL2XoXYX6CHKeTD1kZaBCErAiZfGqdTmUmamAyjEZmDSigx44M/5SiZuFDHynyjJxSKWF023tmm9wGIzpPINwZD+JaCGyacGnN0tO2597Nt6uOcYCfDw5cJxZQ1LS8ztKsKqhJv0LDJ8FFqU5ZQa+cjR/J8untLEzkjlKU43CMUt6ZlX/CGeY1cLIZA1wZ0JpFPSAJQSnXtn6mct2L2E06sdLjKEMzn8w3z9bw/5i/SFc2E/Eu9GjfjRjZ23eHtx3MyNmgqezp9h+ZGZhhs5441Dxn4MBxrIuNjLSqbqOVWD7aUGSqLnUPo9V/efg838GJ4lKQdg/0IhA+/f/PNdz+8+47mpSPF699oeDQ84rSmtq4SqrPUN/412tnKhK4l3dvzef/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/Ebf/EbYOo/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3/RO3p2Li90/c9k/c9k/c9k/c9k/cntTDov0Tt99DAvdP3PZP3B7xxC2UsJBXeFiXQnINVKiY9eVL5+sP3y7TpKD6ppPz5O6Orv/em3K5pOZfGzRUHHWZJjfCSEpyc2lUGkuAqGjmGhd0De1z9oMzWj/14s5X5msVYVTB5Ee85m2/F7ZbgvX29N1ZkiaT8Div0jmNMWJOD/fE3FfOBG7y0yzBry5KoWYN1/Akfk6qWhKNK/olT9dc8hR+dEqBhFp0MOzXQnky6C8RtXXA3Z0vp1ouW3jftXNEYGyEpv27XC6X/wfuWsTz",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={},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)(u.default,{as:"h1",className:"openapi__heading",children:"Create Template"}),"\n",(0,s.jsx)(a(),{method:"post",path:"/createtemplate",context:"endpoint"}),"\n",(0,s.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,s.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,s.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,s.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,s.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,s.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"signature"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "signature",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"stamp"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "stamp",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "stamp"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"initials"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "initials",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "initials"\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"email"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "email",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"5",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"name"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "name",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"job Title"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "job title",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"7",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"company"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "company",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ol,{start:"8",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"date"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "date",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"mm/dd/yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,s.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,s.jsx)(n.li,{children:'"dd mmmm, yyy".'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"9",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"textbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "textbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"10",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"checkbox"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "checkbox",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": ["male", "female"],\n "readonly": false,\n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0,\n "maxselections": 0\n }\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"11",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"dropdown"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "dropdown",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"12",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"radio button"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "radio button",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "radio button",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,s.jsxs)(n.ol,{start:"13",children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.strong,{children:"image"})}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "type": "image",\n "page": 1,\n "x": 327,\n "y": 628,\n "w": 114,\n "h": 21,\n "options": {\n "required": true,\n "name": "image"\n }\n}\n'})}),"\n",(0,s.jsx)(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 file"},title:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"sample note"},description:{type:"string",format:"string",example:"sample description"},signers:{type:"array",description:"You can provide signer optionally if you it as default signer",items:{type:"object",properties:{role:{type:"string",format:"string",example:"ceo"},email:{type:"string",format:"string",example:""},name:{type:"string",format:"string",example:""},phone:{type:"string",format:"string",example:""},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},page:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1},x:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244},y:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71},w:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38},h:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}},title:"createtemplate_body_widgets"}}},title:"createtemplate_body_signers"}},sendInOrder:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},redirect_url:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""},sender_name:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"},sender_email:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"createtemplate_body"}}},required:!0}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,responses:{200:{description:"Template created successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bh2Hspnmch"},message:{type:"string",example:"Template created successfully!"}},title:"inline_response_200_5"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.f69d6817.js b/assets/js/bfe4b778.f69d6817.js deleted file mode 100644 index ad13d2ba2..000000000 --- a/assets/js/bfe4b778.f69d6817.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4948],{55151:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>P,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>o,toc:()=>g});const o=JSON.parse('{"id":"API-docs/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/update-document.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/update-document","permalink":"/docs/API-docs/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWF9vGzcS/ypTvlwKrCXZcVtUT5c2QWtcURuxgwDnGMZoOatlzSVZkitZEPR2n+Q+Wj9JMeSutLIUN7kWd8C9GDJ3/v44nPmRaxFxHsT0Vry2ZduQiUHcFUJSKL1yUVkjpuKmJnjnJEaCXgpeXV0Aam2XAdpAPkC00FipqhWgkdBm8VgTSIqodABbAUJwVKpKlSA7QyP42SZBjBBrFZJha/Sqtx5tbwyhoiU49NhQJB8KWNkWSjTGRihrNPPssFKawJqSQMUcQR+0ClB6wkhyJAphHXnkFC+kmIrspM9PFGLnSExv18JgQ2Iqelv3SopCKIbHYazFU8wuXnPCe95TjoZIpqRm1OXFdjz92ipPUkyjb6kQIa40ewuqcZpEIejRaStJTCvUgQXKmhoU07WIK5cko1dmLgpRWd9g3K1sNnfZPoX4nZUr1tkP9crbhZIEM9J2gO8A+UiN0xgpwAuMoAlDBGtoINsn8KUoRGlNZAina4HOaVUmkMe/BPa2Pgzdzn6hMiHueUuiosBfM+B/nCCDgwmmqQjpxxZysSmEsfGzzVxxigSeFoqWqZ6Dmptcn0Pbezh+nottVQxtbFhHS/JckYf2dtosSQZnmi5vrgaiM2s1oTmoRq4qOMkJ2LQIS6U1ZBtweXMFC/J8MNNejeBdOtNJxlNJasHHbygCpZUEC4VADSpdwLJWZc0Fv4KmDRHIdDXUQUeDI5+KGE7gMCCpwtGIitwOlJnv2s2BYZDKUxn1CpYq1raNgFIqVkcNIZILoyGKKYotkDe29X8eSYR5qyRJiLb1UFmfokzNyqVjxhkoE6JvS1YOIFve3ZQHi/Jv521JIexw6lFhoYH9AsiErI5QYYjkC2iNYuR96yLJrUl6dOQVmZKOQpDAvU/9uwM8fDoWV+QbFUOfKW8NSgmkKc0TCG1ZA+bvGFtPoQBlVFSoQwEhYuNCAdZDpEfuKxCt4+ZJjypEDn6p5JxiAPWxOnpLfEbKQQyVt03afcbGrIaFsI0r2ifmbnhTVeimVoWtjrBA3R7DbFOIqOLeUb4fzIb7GbfazYblPAVnTchd7WwyOezA26naTQSGjCugarVeffHXtdS8/EfNBYM8+zFcnf/ouM10Ib2KzyudTc5enpxOTibf3Jx+PT3/dvrV16PJZPJPUYjHRu/6uWBrYohe+n+woIxWhu571O7PJpP7lx2U58fQ67q168bYArWSUCnSEthn+AsBJO+t/w+nyTPxPZc+p9wnf/5M6TAJqmxr5P863WMRPZ/g+f35NsWvDlO8MBkyZoY39oHMfyPDXT5D9zG751D3q1plofRd7CU7XM9JBipbr+Iq0crHE3TqJH+f3t4xWWso1pYpqWszD421mIpx313G60Gf2Qi25xc9S229FlNRx+jCdDwOaOTMPo6sI8OdUeMsjErbjNGp8eJUbIqnGujcZ0iHiHNl5ifPat3tMr7mXcnA7+W9hR+d+getRNHDOpTq2HZNKMmnLeDNfrtjtm/6LdvuylM62LPBTyN4T8fdUco2ZGxC7LGyjqoP6UW3dHTc9rNYmcomSLoSunRkrjk6LsDF6UFY70mXtqF+nPXiv/3r30mjjzq5+QIuWw/OLslXrU6JV5oeFZOLwY2O71VMsAgbTSHoFTCnmHu+C0g1V5H5VMcsSnQ4U1rxiWIxy9oeBocyjOB9TbEmz5/+5pklSVqQ5oMI2tqHRIAsYBttk3z0SC+tf6g4pAIQZm1QhkKAQNSrkKmRb3p9hSUegSazT+dVIEDVsDBzMaoqVSo2zO3DYxmhQYPzRAgK4LgZha5TB/B2xlQ2WN1mssaXXKKYU0xXuRG8ZnKcEufFfNslmXlaKDJP7roJp2EkzChEcOxelZSpbETPF6sF+XSi8j221Rqc5TanUDMjGu4tG4oeTeBenAPqt2YLX0ckkw+JqxF8MB/MNRdLG4gLQCvzEKYfzAncbsvsPc2CinT3oj/ly+Xy4HR/ua/zg4p1OwNPzu705mkx9YKh+vYfvitG8k24rK7JL1RJXWv5iM9xEh53zR/L1PzT7SN3jr8/VeBGrFVJJgybwqsfrn6CBbwcTUQx6GefEPD4p4vv3/x8/YbtcsfN5+90NBlNeMnZEBs0A1dPHk2eHt31bor9v76xdH2dmf3YaVRpOCbQ191guxWDhjsdPq/cFaK2IbLIej3DQO+83mx4+deWPI/Pu0Is0Cvur2n6dfckuW20H4X7xdv+wQI+76XmaEL99DI8utKNIQ+DB1o9eTLa3G2KfoRxxFni+xzXyQ3b2Vk4IDY8gbPGq7IkF5+VHTKJq3c3ohCz7vmnSS9JwuOSn55wmYPNt9k0nNPaWmg08xbnLJtN8tDFlndtOLEf0sTufnBSR+HYH+U5C/7LOR1VWK8zG9hstvL500c1Olx7ad6bu81m8zvLylmf","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/revokedocument"}}');var i=n(74848),s=n(28453),a=n(33617),d=n.n(a),p=n(17543),c=n.n(p),r=n(86013),l=n.n(r),m=n(63723),u=n.n(m),f=(n(18766),n(79329),n(9303));const h={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:"eJzdWF9vGzcS/ypTvlwKrCXZcVtUT5c2QWtcURuxgwDnGMZoOatlzSVZkitZEPR2n+Q+Wj9JMeSutLIUN7kWd8C9GDJ3/v44nPmRaxFxHsT0Vry2ZduQiUHcFUJSKL1yUVkjpuKmJnjnJEaCXgpeXV0Aam2XAdpAPkC00FipqhWgkdBm8VgTSIqodABbAUJwVKpKlSA7QyP42SZBjBBrFZJha/Sqtx5tbwyhoiU49NhQJB8KWNkWSjTGRihrNPPssFKawJqSQMUcQR+0ClB6wkhyJAphHXnkFC+kmIrspM9PFGLnSExv18JgQ2Iqelv3SopCKIbHYazFU8wuXnPCe95TjoZIpqRm1OXFdjz92ipPUkyjb6kQIa40ewuqcZpEIejRaStJTCvUgQXKmhoU07WIK5cko1dmLgpRWd9g3K1sNnfZPoX4nZUr1tkP9crbhZIEM9J2gO8A+UiN0xgpwAuMoAlDBGtoINsn8KUoRGlNZAina4HOaVUmkMe/BPa2Pgzdzn6hMiHueUuiosBfM+B/nCCDgwmmqQjpxxZysSmEsfGzzVxxigSeFoqWqZ6Dmptcn0Pbezh+nottVQxtbFhHS/JckYf2dtosSQZnmi5vrgaiM2s1oTmoRq4qOMkJ2LQIS6U1ZBtweXMFC/J8MNNejeBdOtNJxlNJasHHbygCpZUEC4VADSpdwLJWZc0Fv4KmDRHIdDXUQUeDI5+KGE7gMCCpwtGIitwOlJnv2s2BYZDKUxn1CpYq1raNgFIqVkcNIZILoyGKKYotkDe29X8eSYR5qyRJiLb1UFmfokzNyqVjxhkoE6JvS1YOIFve3ZQHi/Jv521JIexw6lFhoYH9AsiErI5QYYjkC2iNYuR96yLJrUl6dOQVmZKOQpDAvU/9uwM8fDoWV+QbFUOfKW8NSgmkKc0TCG1ZA+bvGFtPoQBlVFSoQwEhYuNCAdZDpEfuKxCt4+ZJjypEDn6p5JxiAPWxOnpLfEbKQQyVt03afcbGrIaFsI0r2ifmbnhTVeimVoWtjrBA3R7DbFOIqOLeUb4fzIb7GbfazYblPAVnTchd7WwyOezA26naTQSGjCugarVeffHXtdS8/EfNBYM8+zFcnf/ouM10Ib2KzyudTc5enpxOTibf3Jx+PT3/dvrV16PJZPJPUYjHRu/6uWBrYohe+n+woIxWhu571O7PJpP7lx2U58fQ67q168bYArWSUCnSEthn+AsBJO+t/w+nyTPxPZc+p9wnf/5M6TAJqmxr5P863WMRPZ/g+f35NsWvDlO8MBkyZoY39oHMfyPDXT5D9zG751D3q1plofRd7CU7XM9JBipbr+Iq0crHE3TqJH+f3t4xWWso1pYpqWszD421mIpx313G60Gf2Qi25xc9S229FlNRx+jCdDwOaOTMPo6sI8OdUeMsjErbjNGp8eJUbIqnGujcZ0iHiHNl5ifPat3tMr7mXcnA7+W9hR+d+getRNHDOpTq2HZNKMmnLeDNfrtjtm/6LdvuylM62LPBTyN4T8fdUco2ZGxC7LGyjqoP6UW3dHTc9rNYmcomSLoSunRkrjk6LsDF6UFY70mXtqF+nPXiv/3r30mjjzq5+QIuWw/OLslXrU6JV5oeFZOLwY2O71VMsAgbTSHoFTCnmHu+C0g1V5H5VMcsSnQ4U1rxiWIxy9oeBocyjOB9TbEmz5/+5pklSVqQ5oMI2tqHRIAsYBttk3z0SC+tf6g4pAIQZm1QhkKAQNSrkKmRb3p9hSUegSazT+dVIEDVsDBzMaoqVSo2zO3DYxmhQYPzRAgK4LgZha5TB/B2xlQ2WN1mssaXXKKYU0xXuRG8ZnKcEufFfNslmXlaKDJP7roJp2EkzChEcOxelZSpbETPF6sF+XSi8j221Rqc5TanUDMjGu4tG4oeTeBenAPqt2YLX0ckkw+JqxF8MB/MNRdLG4gLQCvzEKYfzAncbsvsPc2CinT3oj/ly+Xy4HR/ua/zg4p1OwNPzu705mkx9YKh+vYfvitG8k24rK7JL1RJXWv5iM9xEh53zR/L1PzT7SN3jr8/VeBGrFVJJgybwqsfrn6CBbwcTUQx6GefEPD4p4vv3/x8/YbtcsfN5+90NBlNeMnZEBs0A1dPHk2eHt31bor9v76xdH2dmf3YaVRpOCbQ191guxWDhjsdPq/cFaK2IbLIej3DQO+83mx4+deWPI/Pu0Is0Cvur2n6dfckuW20H4X7xdv+wQI+76XmaEL99DI8utKNIQ+DB1o9eTLa3G2KfoRxxFni+xzXyQ3b2Vk4IDY8gbPGq7IkF5+VHTKJq3c3ohCz7vmnSS9JwuOSn55wmYPNt9k0nNPaWmg08xbnLJtN8tDFlndtOLEf0sTufnBSR+HYH+U5C/7LOR1VWK8zG9hstvL500c1Olx7ad6bu81m8zvLylmf",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,P={},g=[];function I(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,i.jsx)(f.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}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.fa51d361.js b/assets/js/bfe4b778.fa51d361.js new file mode 100644 index 000000000..5704a9af6 --- /dev/null +++ b/assets/js/bfe4b778.fa51d361.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4948],{55151:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>I,default:()=>g,frontMatter:()=>f,metadata:()=>a,toc:()=>y});const a=JSON.parse('{"id":"API-docs/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/update-document.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/update-document","permalink":"/docs/API-docs/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWFFvI7cR/isTvvQCrCXZ56SonnrNHRKjQWycfTigPsMYLWe1jLkkQ3IlC4Le+kv60/JLgiF3pZWlc85t0AJ9MWTuzHDmm+HMR65FxHkQ01vx1pZtQyYGcVcISaH0ykVljZiKm5rgg5MYCXopeHN1Aai1XQZoA/kA0UJjpapWgEZCm8VjTSApotIBbAUIwVGpKlWC7AyN4CebBDFCrFVIhq3Rq956tL0xhIqW4NBjQ5F8KGBlWyjRGBuhrNHM84aV0gTWlAQqZg96p1WA0hNGkiNRCOvII4d4IcVU5E36+EQhdhuJ6e1aGGxITEVv615JUQjF8DiMtXiK2cVbDnhv9xSjIZIpqBl1cbEdT7+0ypMU0+hbKkSIK827BdU4TaIQ9Oi0lSSmFerAAmVNDYrpWsSVS5LRKzMXhaisbzDuVjabu2yfQvyblSvW2Xf1ytuFkgQz0naA7wD5SI3TGCnAK4ygCUMEa2gg2wfwtShEaU1kCKdrgc5pVSaQxz8H3m196Lqd/UxlQtxzSqKiwF8z4L8fIIODCaapCOnHFnKxKYSx8cVmrjhEAk8LRctUz0HNTa7Poe09HF+2xbYqhjY2rKMlea7IQ3s7bZYkgzNNlzdXA9GZtZrQHFQjVxWc5ABsWoSl0hqyDbi8uYIFeT6YKVcj+JDOdJLxVJJa8PEbikBpJcFCIVCDShewrFVZc8GvoGlDBDJdDXXQ0eDIpyKGEzh0SKpw1KMitwNl5rt2c2AYpPJURr2CpYq1bSOglIrVUUOI5MJoiGLyYgvkjW39f44kwrxVkiRE23qorE9epmbl0jHjCJQJ0bclKweQLWc3xcGi/Nt5W1IIO5x6VFhoYL8AMiGrI1QYIvkCWqMYed+6SHJrkh4deUWmpKMQJHDvU//uAA9fjsUV+UbF0EfKqUEpgTSleQKhLWvA/B1j6ykUoIyKCnUoIERsXCjAeoj0yH0FonXcPOlRhcjOL5WcUwygPldH74nPSDnwofK2SdlnbMxqWAhbv6J9Yu6Gk6pCN7UqbHWEBer2GGabQkQV947y/WA23M+41W42LOcpOGtC7mpnk8lhB95O1W4iMGRcAVWr9eqrP66l5uXfay4Y5NkP4er8B8dtpnPpTXxe6Wxy9vrkdHIy+fPN6bfT879Mv/l2NJlM/iEK8djoXT8XbE0M0Uv/DxaU0crQfY/a/dlkcv+6g/L8GHpdt3bdGFugVhIqRVoC7xn+QADJe+v/zWnyjH/Phc8h98GfP1M6TIIq2xr5vw73mEfPB3h+f74N8ZvDEC9MhoyZ4Y19IPPfiHAXz3D7mLdnV/erWmWh9F3sBTtcz0EGKluv4irRyscTdOokf5/e3jFZayjWlimpazMPjbWYinHfXcbrQZ/ZCLbnFz1Lbb0WU1HH6MJ0PA5o5Mw+jqwjw51R4yyMStuM0anx4lRsiqca6NwLpKk9eZlCiDhXZv681t0OomtOY87UHlDbfKFTf6eVKPo8DKU6el4TSvIpZ1wd73dU+F2f420an/LHnj5+GSN8Oh+PcrwhxRNij8Z13H7IR7qlo/O5H97KVDZB0tXcpSNzzd5xxS5OD9z6SLq0DfXzrxf/9Z//Shq912mbr+Cy9eDsknzV6hR4pelRMRsZXAH5IsaMjLDRFIJeAZOQuefLg1RzFZmAdVSkRIczpRUfQRazrO1hcIrDCD7WFGvy/OlPnmmVpAVpPrmgrX1IjMkCttE2aY8e6aX1DxW7VADCrA3KUAgQiHoVMjXy1bCvsEQ80GS66rwKBKgaFmbyRlWlSsWGud94LCM0aHCeGEQB7Dej0LX2AN7OmPsGq9vM7vhWTBRziOnuN4K3zKZT4LyYr8ckM7ELRSbWXfvhMIyEGYUIjrdXJWXuG9HzTWxBPp2ofPFttQZnuS8q1EyhhrllQ9GjCdy8s0N9arbwdcwz7SFxNYJP5pO55mJpA3EBaGUewvSTOYHbbZl9pFlQke5e9ad8uVwenO6v93W+V7FuZ+DJ2Z3ePC2mXjBU3/7Dl8tIvgmX1TX5hSqpay2f2XOchMfdtMAyTYt0Xcmd469PFbhza1WSCcOm8Ob7qx9hAa9HE1EM+tkXODz+8eK7dz9dv2O73KLz+TsdTUYTXnI2xAbNYKsnryxPj+56N/b+Xx9lur7OV4Gx06jSNE2gr7tJeCsGDXc6fI+5K0RtQ2SR9XqGgT54vdnw8i8teZ63d4VYoFfcX9O47C5WcttoPwv3q/f9Cwe87GnnaED99DI8utIVIw+DB1o9eWPa3G2KfoSxx1niu+zXyQ3b2Vk4YEI8gbPGm7IkF5+VHVKPqw83ohCz7r2oSU9PwuOS36pwmZ3N1980nNPaWmg08xbnLJtN8tDFlrM2nNgPaWJ3Pzioo3Dsj/IcBf/lmI4qrNeZDWw2W/n86bMaHa69NOfmbrPZ/AbxRGrK","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/revokedocument"}}');var o=n(74848),i=n(28453),s=n(33617),d=n.n(s),r=n(17543),c=n.n(r),l=n(86013),p=n.n(l),m=n(63723),u=n.n(m),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:"eJzdWFFvI7cR/isTvvQCrCXZ56SonnrNHRKjQWycfTigPsMYLWe1jLkkQ3IlC4Le+kv60/JLgiF3pZWlc85t0AJ9MWTuzHDmm+HMR65FxHkQ01vx1pZtQyYGcVcISaH0ykVljZiKm5rgg5MYCXopeHN1Aai1XQZoA/kA0UJjpapWgEZCm8VjTSApotIBbAUIwVGpKlWC7AyN4CebBDFCrFVIhq3Rq956tL0xhIqW4NBjQ5F8KGBlWyjRGBuhrNHM84aV0gTWlAQqZg96p1WA0hNGkiNRCOvII4d4IcVU5E36+EQhdhuJ6e1aGGxITEVv615JUQjF8DiMtXiK2cVbDnhv9xSjIZIpqBl1cbEdT7+0ypMU0+hbKkSIK827BdU4TaIQ9Oi0lSSmFerAAmVNDYrpWsSVS5LRKzMXhaisbzDuVjabu2yfQvyblSvW2Xf1ytuFkgQz0naA7wD5SI3TGCnAK4ygCUMEa2gg2wfwtShEaU1kCKdrgc5pVSaQxz8H3m196Lqd/UxlQtxzSqKiwF8z4L8fIIODCaapCOnHFnKxKYSx8cVmrjhEAk8LRctUz0HNTa7Poe09HF+2xbYqhjY2rKMlea7IQ3s7bZYkgzNNlzdXA9GZtZrQHFQjVxWc5ABsWoSl0hqyDbi8uYIFeT6YKVcj+JDOdJLxVJJa8PEbikBpJcFCIVCDShewrFVZc8GvoGlDBDJdDXXQ0eDIpyKGEzh0SKpw1KMitwNl5rt2c2AYpPJURr2CpYq1bSOglIrVUUOI5MJoiGLyYgvkjW39f44kwrxVkiRE23qorE9epmbl0jHjCJQJ0bclKweQLWc3xcGi/Nt5W1IIO5x6VFhoYL8AMiGrI1QYIvkCWqMYed+6SHJrkh4deUWmpKMQJHDvU//uAA9fjsUV+UbF0EfKqUEpgTSleQKhLWvA/B1j6ykUoIyKCnUoIERsXCjAeoj0yH0FonXcPOlRhcjOL5WcUwygPldH74nPSDnwofK2SdlnbMxqWAhbv6J9Yu6Gk6pCN7UqbHWEBer2GGabQkQV947y/WA23M+41W42LOcpOGtC7mpnk8lhB95O1W4iMGRcAVWr9eqrP66l5uXfay4Y5NkP4er8B8dtpnPpTXxe6Wxy9vrkdHIy+fPN6bfT879Mv/l2NJlM/iEK8djoXT8XbE0M0Uv/DxaU0crQfY/a/dlkcv+6g/L8GHpdt3bdGFugVhIqRVoC7xn+QADJe+v/zWnyjH/Phc8h98GfP1M6TIIq2xr5vw73mEfPB3h+f74N8ZvDEC9MhoyZ4Y19IPPfiHAXz3D7mLdnV/erWmWh9F3sBTtcz0EGKluv4irRyscTdOokf5/e3jFZayjWlimpazMPjbWYinHfXcbrQZ/ZCLbnFz1Lbb0WU1HH6MJ0PA5o5Mw+jqwjw51R4yyMStuM0anx4lRsiqca6NwLpKk9eZlCiDhXZv681t0OomtOY87UHlDbfKFTf6eVKPo8DKU6el4TSvIpZ1wd73dU+F2f420an/LHnj5+GSN8Oh+PcrwhxRNij8Z13H7IR7qlo/O5H97KVDZB0tXcpSNzzd5xxS5OD9z6SLq0DfXzrxf/9Z//Shq912mbr+Cy9eDsknzV6hR4pelRMRsZXAH5IsaMjLDRFIJeAZOQuefLg1RzFZmAdVSkRIczpRUfQRazrO1hcIrDCD7WFGvy/OlPnmmVpAVpPrmgrX1IjMkCttE2aY8e6aX1DxW7VADCrA3KUAgQiHoVMjXy1bCvsEQ80GS66rwKBKgaFmbyRlWlSsWGud94LCM0aHCeGEQB7Dej0LX2AN7OmPsGq9vM7vhWTBRziOnuN4K3zKZT4LyYr8ckM7ELRSbWXfvhMIyEGYUIjrdXJWXuG9HzTWxBPp2ofPFttQZnuS8q1EyhhrllQ9GjCdy8s0N9arbwdcwz7SFxNYJP5pO55mJpA3EBaGUewvSTOYHbbZl9pFlQke5e9ad8uVwenO6v93W+V7FuZ+DJ2Z3ePC2mXjBU3/7Dl8tIvgmX1TX5hSqpay2f2XOchMfdtMAyTYt0Xcmd469PFbhza1WSCcOm8Ob7qx9hAa9HE1EM+tkXODz+8eK7dz9dv2O73KLz+TsdTUYTXnI2xAbNYKsnryxPj+56N/b+Xx9lur7OV4Gx06jSNE2gr7tJeCsGDXc6fI+5K0RtQ2SR9XqGgT54vdnw8i8teZ63d4VYoFfcX9O47C5WcttoPwv3q/f9Cwe87GnnaED99DI8utIVIw+DB1o9eWPa3G2KfoSxx1niu+zXyQ3b2Vk4YEI8gbPGm7IkF5+VHVKPqw83ohCz7r2oSU9PwuOS36pwmZ3N1980nNPaWmg08xbnLJtN8tDFlrM2nNgPaWJ3Pzioo3Dsj/IcBf/lmI4qrNeZDWw2W/n86bMaHa69NOfmbrPZ/AbxRGrK",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},I=void 0,b={},y=[];function x(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,o.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(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,o.jsx)(p(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample document"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"document description"},folderId:{type:"string",example:""},enableOTP:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1},enableTour:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1},allow_modifications:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}},title:"document_document_id_body"}}}}}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Document not found!"}},title:"inline_response_404_4"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function g(e={}){const{wrapper:t}={...(0,i.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/f0ff4a36.c0d4e545.js b/assets/js/f0ff4a36.c0d4e545.js new file mode 100644 index 000000000..b27a13311 --- /dev/null +++ b/assets/js/f0ff4a36.c0d4e545.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7315],{56397:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>f,default:()=>A,frontMatter:()=>x,metadata:()=>o,toc:()=>y});const o=JSON.parse('{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/getdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getdocument","permalink":"/docs/API-docs/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9GNtu2zb0V1i+rAUUXxI37fzUYO2ybMVSLCkKLDUMSjqW2FAkRx7ZMQy97Uv2afuS4VCXyImb1FvXl8Qiz/1+uOEoMs+nV/y1ScoCNHo+i3gKPnHSojSaT/llDuwUkLUg7OTdGQMtYgWerU3J0DAH6CQsgaWAQirPRGxKZIJ5C4lcyISlDfaAR9xYcIKon6V8yjPA9pJH3AonCkBwJNaGa1EAn/IWYC5THnFJYlmBOb8rq4k/QYJnKTOLTl4ecQd/lNJByqfoSoi4x7Uisl4WVgGPONxYZVLg04VQngCSHArBpxuOaxsg0Umd8YgvjCsE9k/gRgQqU25/Gsd5cpjbmFfVjNh6a7QHT4QORyP6ty2vL5MEvF+UinVG4RFPjEaSfLrhwlolk3Ax/OQJaXNfulptsp4jMihrlh4Fln5fLaQ+sM5kDrznVdSZdF8yP57K68OjOH//M1FZSDrcj0KOaP10OGxOSqcGiSmIWkI6Lsgs/5poj0SPMErcX04fflCEEwlt9hfKKhAemJeZ7hIlWM2oFNzjjv46PqpzbT8KtYQsoFa3BrxN2EYFCqSV3tLli+h/MsBiAMIn64Sy0FEQzok11QOEwj9uJWd2+/aWWwLmIUPsFAsKIdWj0DHAq+agjTWbG/0Im8nz48Px0csXY4JfyTQD/A/617f3+W2XpBOlzApSthSqBM8OQlQKLB1EzKMo7OCxdGjhSeibHkNdFjG4PnZ30mEfTiZVxNd7Yr0Yk332RDp6WUU83xNpckyeExnsiTfuJwdCYZVAmF/UIT1vXVs9BBXyy4NOz/S52y4LsTEKhO4zpEZHldKBQEhP8OFAOxwdHh2MRwejF5fj4+nk++nz48FoNPqdR/ymCNHdNmIquf08b75Lm34TPvXccWnKL1PfQSodJDgv3c4cfSiOiZ2gZJgXJq1bhTTaP8w3zA/kqDvqNOVwJTFvuvKOYtm/DaEw2TUzXJgCMJc6YyuaxlbO6CxiTQtBt2YiE1IzCh335OsNE+Cc2Vm+by22n2T9WJdaSQ3zdmCaT0aj+bgzwuS+EbphVBtkC1Pq9Nuquov/wwpN5kedQs/vK3Sml0LJNAzXl+Ya9LfVp88ea/b3o1jWQOGebynbP6+V9JCUTuI6TPE3B8LKg/p+ejWj2ZgixTTjfxj7MedTPmxTYbjpjfwVJ3pu2S4FIZm7Sc4LncbmZmAsaOo9SsSeeuxQWDlcUuu8iyGs3QMayoP9EDyKTOrsYazZrYkuyI21p7YMddvnrfwFqNE3fuhDNdtQDiKMWRV9L0xAbrxzbkFTCwm+XY7vNfwPoBJTAK1xmANrwf/+86+A0fohhN4Tdl46Zs0KHO0sQqdsoeBGxgoCcKiX3VboQRQKvFdrJjVC5gQCS2UmUagwVlCpSIQVsVSSgpXADGE71ot3P2AfcsAcHF1954AJlsISFMU4U8ZcEx00TJRoisCjzc6VcdcLEiligsWllxq8Zx6gRQGdC50Aa30RMeOY0Aw0grNOemBCFgS8MI7BYiETSYQpM51IkBVCiwyIWcRIbrKCdWYpU/DMmbj0yLxRZVCEOBYAWKuoAVI/YK/lEmrF6bBeoCFlWUkkIpaYFFiTqKSGTlkMHpkl9jKBQNSjcMgULMGF2AueXJRKMWuogkihaCXu+5YIoRPaUw+sBWpd05nPOkPraeCRivWAfdQfNVV5VnqgAFBSX/vpR33Arrow+wCxlwizp20+rFare3nwbBvnVGJexsyBNbd4WTgMWdNH7z6e8YgjuMKfLy7ALWXS7nef4TkMwMOmrook1NVmfKcce3UXgWqckgloD70qeHL67i1bsqPBiEe9zP8CgYdvz3548+vFG6JLxazOv/FgNBiFhcB4LITuseo/u9zN281td/gfnmiayoNwg0OrhAz1vhmi6lp9xXuvNtP+A80s4rnxSCCbTSw8vHeqquj4jxIcdYRZxJfCSZIvFPRUevqddu8vn9X06W/NU84z9pm3np2St4VUUxUNmw0NeBG/hvWd16VqRltBXU1JtBriJEnAYg/3Xjve6mmnby55xEWJ+XYVvw5VvPlB1HfKtV3eawHoL3WanQibTd0hqqqDr68+i9Eo2EKTkWZVVf0D3IrsDQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/update-document"}}');var i=n(74848),a=n(28453),s=n(33617),r=n.n(s),p=n(17543),l=n.n(p),m=n(86013),d=n.n(m),c=n(63723),u=n.n(c),g=(n(18766),n(79329),n(9303));const x={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9GNtu2zb0V1i+rAUUXxI37fzUYO2ybMVSLCkKLDUMSjqW2FAkRx7ZMQy97Uv2afuS4VCXyImb1FvXl8Qiz/1+uOEoMs+nV/y1ScoCNHo+i3gKPnHSojSaT/llDuwUkLUg7OTdGQMtYgWerU3J0DAH6CQsgaWAQirPRGxKZIJ5C4lcyISlDfaAR9xYcIKon6V8yjPA9pJH3AonCkBwJNaGa1EAn/IWYC5THnFJYlmBOb8rq4k/QYJnKTOLTl4ecQd/lNJByqfoSoi4x7Uisl4WVgGPONxYZVLg04VQngCSHArBpxuOaxsg0Umd8YgvjCsE9k/gRgQqU25/Gsd5cpjbmFfVjNh6a7QHT4QORyP6ty2vL5MEvF+UinVG4RFPjEaSfLrhwlolk3Ax/OQJaXNfulptsp4jMihrlh4Fln5fLaQ+sM5kDrznVdSZdF8yP57K68OjOH//M1FZSDrcj0KOaP10OGxOSqcGiSmIWkI6Lsgs/5poj0SPMErcX04fflCEEwlt9hfKKhAemJeZ7hIlWM2oFNzjjv46PqpzbT8KtYQsoFa3BrxN2EYFCqSV3tLli+h/MsBiAMIn64Sy0FEQzok11QOEwj9uJWd2+/aWWwLmIUPsFAsKIdWj0DHAq+agjTWbG/0Im8nz48Px0csXY4JfyTQD/A/617f3+W2XpBOlzApSthSqBM8OQlQKLB1EzKMo7OCxdGjhSeibHkNdFjG4PnZ30mEfTiZVxNd7Yr0Yk332RDp6WUU83xNpckyeExnsiTfuJwdCYZVAmF/UIT1vXVs9BBXyy4NOz/S52y4LsTEKhO4zpEZHldKBQEhP8OFAOxwdHh2MRwejF5fj4+nk++nz48FoNPqdR/ymCNHdNmIquf08b75Lm34TPvXccWnKL1PfQSodJDgv3c4cfSiOiZ2gZJgXJq1bhTTaP8w3zA/kqDvqNOVwJTFvuvKOYtm/DaEw2TUzXJgCMJc6YyuaxlbO6CxiTQtBt2YiE1IzCh335OsNE+Cc2Vm+by22n2T9WJdaSQ3zdmCaT0aj+bgzwuS+EbphVBtkC1Pq9Nuquov/wwpN5kedQs/vK3Sml0LJNAzXl+Ya9LfVp88ea/b3o1jWQOGebynbP6+V9JCUTuI6TPE3B8LKg/p+ejWj2ZgixTTjfxj7MedTPmxTYbjpjfwVJ3pu2S4FIZm7Sc4LncbmZmAsaOo9SsSeeuxQWDlcUuu8iyGs3QMayoP9EDyKTOrsYazZrYkuyI21p7YMddvnrfwFqNE3fuhDNdtQDiKMWRV9L0xAbrxzbkFTCwm+XY7vNfwPoBJTAK1xmANrwf/+86+A0fohhN4Tdl46Zs0KHO0sQqdsoeBGxgoCcKiX3VboQRQKvFdrJjVC5gQCS2UmUagwVlCpSIQVsVSSgpXADGE71ot3P2AfcsAcHF1954AJlsISFMU4U8ZcEx00TJRoisCjzc6VcdcLEiligsWllxq8Zx6gRQGdC50Aa30RMeOY0Aw0grNOemBCFgS8MI7BYiETSYQpM51IkBVCiwyIWcRIbrKCdWYpU/DMmbj0yLxRZVCEOBYAWKuoAVI/YK/lEmrF6bBeoCFlWUkkIpaYFFiTqKSGTlkMHpkl9jKBQNSjcMgULMGF2AueXJRKMWuogkihaCXu+5YIoRPaUw+sBWpd05nPOkPraeCRivWAfdQfNVV5VnqgAFBSX/vpR33Arrow+wCxlwizp20+rFare3nwbBvnVGJexsyBNbd4WTgMWdNH7z6e8YgjuMKfLy7ALWXS7nef4TkMwMOmrook1NVmfKcce3UXgWqckgloD70qeHL67i1bsqPBiEe9zP8CgYdvz3548+vFG6JLxazOv/FgNBiFhcB4LITuseo/u9zN281td/gfnmiayoNwg0OrhAz1vhmi6lp9xXuvNtP+A80s4rnxSCCbTSw8vHeqquj4jxIcdYRZxJfCSZIvFPRUevqddu8vn9X06W/NU84z9pm3np2St4VUUxUNmw0NeBG/hvWd16VqRltBXU1JtBriJEnAYg/3Xjve6mmnby55xEWJ+XYVvw5VvPlB1HfKtV3eawHoL3WanQibTd0hqqqDr68+i9Eo2EKTkWZVVf0D3IrsDQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,b={},y=[];function j(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},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 A(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.c4f1b7a2.js b/assets/js/f0ff4a36.c4f1b7a2.js deleted file mode 100644 index 7550b92c1..000000000 --- a/assets/js/f0ff4a36.c4f1b7a2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7315],{56397:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>h,default:()=>x,frontMatter:()=>y,metadata:()=>i,toc:()=>I});const i=JSON.parse('{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/getdocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getdocument","permalink":"/docs/API-docs/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9WNtuGzcQ/RWGL02AtS624qR6itGkrtugDmoHAeoIAnd3tMuYS7LkrGRB2Ld+ST+tX1IM9+KVrdhRm+bF1pJz58yZITccReb59Iq/NklZgEbPZxFPwSdOWpRG8ym/zIGdArKWhJ28O2OgRazAs7UpGRrmAJ2EJbAUUEjlmYhNiUwwbyGRC5mwtOEe8IgbC06Q9LOUT3kG2G7yiFvhRAEIjszacC0K4FPeEsxlyiMuySwrMOd3bTXxJ0jwLGVm0dnLI+7gj1I6SPkUXQkR97hWJNbLwirgEYcbq0wKfLoQyhNBkkMh+HTDcW0DJTqpMx7xhXGFwP4K3IggZcrtT+M4Tw5zG/OqmpFab4324EnQ4WhE/7bt9WWSgPeLUrEuKDziidFIlk83XFirZBI2hp88MW3uW1e7TdFzJAZlrdKjwNLv64XUB9aZzIH3vIq6kO4r5sdTeX14FOfvfyYpC0mL+0nIEa2fDofNSunUIDEFSUvIxwWF5V8L7YnoCUaJ+9vpww/KcBKhzf5GWQXCA/My012hhKgZlYJ7/KC/zhnVtbafhNpCFlir2wDeFmzjAiXSSm/58kXyPxlgMQDxU3QCLHQShHNiTXiAUPjHo+TM7rO91ZaAeSgQO82CQkj1KHUM8KpZaHPN5kY/omby/PhwfPTyxZjoVzLNAP+D//XufX3bkHSilFlBypZCleDZQchKgaWDiHkUhR08Vg4tPRl901OoyyIG1+fuVjruw8mkivh6T64XY4rPnkxHL6uI53syTY7p5EQGe/KN+8WBUFglEOYXdUrP26OtHqIK9eVBp2f63G3DQmyMAqH7CqnREVI6EAjpCT6caIejw6OD8ehg9OJyfDydfD99fjwYjUa/84jfFCG720ZMkNuv8+a7tOk30VPPHZem/DL3HaTSQYLz0u2s0YfymNQJKoZ5YdK6VUij/cN6w/xAB3XHnQYOVxLzpivvAMv+bkiFya6Z4cIUgLnUGVvRNLZyRmcRa1oIujUTmZCaUeq4J19vmADnzE74vo3Yfpb1c11qJTXM24FpPhmN5uMuCJP7QeiGUW2QLUyp02/r6i79Dzs0mR91Dj2/79CZXgol0zBcX5pr0N/Wn756rNXfz2JZE4V9vuVsf7120kNSOonrMMXfHAgrD+r96dWMZmPKFNOM/2Hsx5xP+bAtheGmN/JXnOS5ZXspCMXcTXJe6DQ2NwNjQVPvUSL21GOHwsrhklrnXQ5h7R7UHkUmdXbwINfs1uMLOpU68Ft+37ZtK38B6ttNWPtUzeUmBxGmpoq+FyYwN8E+t6CpI4SjWo7v9e8PoBJTAN3KMAfWkv/951+Bow1ryKQn7Lx0zJoVOLqCCJ2yhYIbGSsIxAH+ukueB1Eo8F6tmdQImRMILJWZRKHClECVnwgrYqkk5R6RGeJ2rJe+fsA+5IA5ONr6zgETLIUlKEpZpoy5JjlomCjRFEFHW2wr464XZFLEBItLLzV4zzxAywI6FzoB1p5FxIxjQjPQCM466YEJWRDxwjgGi4VMJAmmQnMiQVYILTIgZREjuykK1pmlTMEzZ+LSI/NGlcER0lgAYO2iBkj9gL2WS6gdp8X6Pgwpy0oSEbHEpMCauiM3dMpi8MgsqZcJBKEehUOmYAku5F44yUWpFLOGAEEKRTfc/tmSIHRCe2pptUHt0XThs87QbTPoSMV6wD7qj5pAm5UeKAGU1Nd++lEfsKsuzT5A7CXC7GlbD6vV6l4dPNvmOZWYlzFzYM0tXxYWQ9X02buPZzziCK7w54sLcEuZtNe1z+gcBuJhA5MiCTDZTONUY6/uMhBkKZmA9tADtZPTd2/Zkh0NRjzqVf4XGDx8e/bDm18v3pBcwqa6/saD0WAU5nvjsRC6p6r/inK3bje3YP8/vLg0yINwg0OrhAzw3cxENfRe8d4jzLT/3jKLeG48EslmEwsP752qKlr+owRHAD+L+FI4SfYFfE6lp99p95zyWU+f/ta8zDxjn3m62Wl5C6SaUDRcVGhei/g1rO88FlUzGvJrNCXTaoqTJAGLPd573XWrRZ2+ueQRFyXm2yh+HVC8+UHSd9q1De+1AfSXOs1Ohs2m7hBV1dHXW5/laBxsqSlIs6qq/gHc3Nri","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/update-document"}}');var o=n(74848),r=n(28453),a=n(33617),p=n.n(a),s=n(17543),m=n.n(s),l=n(86013),c=n.n(l),d=n(63723),u=n.n(d),g=(n(18766),n(79329),n(9303));const y={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WNtuGzcQ/RWGL02AtS624qR6itGkrtugDmoHAeoIAnd3tMuYS7LkrGRB2Ld+ST+tX1IM9+KVrdhRm+bF1pJz58yZITccReb59Iq/NklZgEbPZxFPwSdOWpRG8ym/zIGdArKWhJ28O2OgRazAs7UpGRrmAJ2EJbAUUEjlmYhNiUwwbyGRC5mwtOEe8IgbC06Q9LOUT3kG2G7yiFvhRAEIjszacC0K4FPeEsxlyiMuySwrMOd3bTXxJ0jwLGVm0dnLI+7gj1I6SPkUXQkR97hWJNbLwirgEYcbq0wKfLoQyhNBkkMh+HTDcW0DJTqpMx7xhXGFwP4K3IggZcrtT+M4Tw5zG/OqmpFab4324EnQ4WhE/7bt9WWSgPeLUrEuKDziidFIlk83XFirZBI2hp88MW3uW1e7TdFzJAZlrdKjwNLv64XUB9aZzIH3vIq6kO4r5sdTeX14FOfvfyYpC0mL+0nIEa2fDofNSunUIDEFSUvIxwWF5V8L7YnoCUaJ+9vpww/KcBKhzf5GWQXCA/My012hhKgZlYJ7/KC/zhnVtbafhNpCFlir2wDeFmzjAiXSSm/58kXyPxlgMQDxU3QCLHQShHNiTXiAUPjHo+TM7rO91ZaAeSgQO82CQkj1KHUM8KpZaHPN5kY/omby/PhwfPTyxZjoVzLNAP+D//XufX3bkHSilFlBypZCleDZQchKgaWDiHkUhR08Vg4tPRl901OoyyIG1+fuVjruw8mkivh6T64XY4rPnkxHL6uI53syTY7p5EQGe/KN+8WBUFglEOYXdUrP26OtHqIK9eVBp2f63G3DQmyMAqH7CqnREVI6EAjpCT6caIejw6OD8ehg9OJyfDydfD99fjwYjUa/84jfFCG720ZMkNuv8+a7tOk30VPPHZem/DL3HaTSQYLz0u2s0YfymNQJKoZ5YdK6VUij/cN6w/xAB3XHnQYOVxLzpivvAMv+bkiFya6Z4cIUgLnUGVvRNLZyRmcRa1oIujUTmZCaUeq4J19vmADnzE74vo3Yfpb1c11qJTXM24FpPhmN5uMuCJP7QeiGUW2QLUyp02/r6i79Dzs0mR91Dj2/79CZXgol0zBcX5pr0N/Wn756rNXfz2JZE4V9vuVsf7120kNSOonrMMXfHAgrD+r96dWMZmPKFNOM/2Hsx5xP+bAtheGmN/JXnOS5ZXspCMXcTXJe6DQ2NwNjQVPvUSL21GOHwsrhklrnXQ5h7R7UHkUmdXbwINfs1uMLOpU68Ft+37ZtK38B6ttNWPtUzeUmBxGmpoq+FyYwN8E+t6CpI4SjWo7v9e8PoBJTAN3KMAfWkv/951+Bow1ryKQn7Lx0zJoVOLqCCJ2yhYIbGSsIxAH+ukueB1Eo8F6tmdQImRMILJWZRKHClECVnwgrYqkk5R6RGeJ2rJe+fsA+5IA5ONr6zgETLIUlKEpZpoy5JjlomCjRFEFHW2wr464XZFLEBItLLzV4zzxAywI6FzoB1p5FxIxjQjPQCM466YEJWRDxwjgGi4VMJAmmQnMiQVYILTIgZREjuykK1pmlTMEzZ+LSI/NGlcER0lgAYO2iBkj9gL2WS6gdp8X6Pgwpy0oSEbHEpMCauiM3dMpi8MgsqZcJBKEehUOmYAku5F44yUWpFLOGAEEKRTfc/tmSIHRCe2pptUHt0XThs87QbTPoSMV6wD7qj5pAm5UeKAGU1Nd++lEfsKsuzT5A7CXC7GlbD6vV6l4dPNvmOZWYlzFzYM0tXxYWQ9X02buPZzziCK7w54sLcEuZtNe1z+gcBuJhA5MiCTDZTONUY6/uMhBkKZmA9tADtZPTd2/Zkh0NRjzqVf4XGDx8e/bDm18v3pBcwqa6/saD0WAU5nvjsRC6p6r/inK3bje3YP8/vLg0yINwg0OrhAzw3cxENfRe8d4jzLT/3jKLeG48EslmEwsP752qKlr+owRHAD+L+FI4SfYFfE6lp99p95zyWU+f/ta8zDxjn3m62Wl5C6SaUDRcVGhei/g1rO88FlUzGvJrNCXTaoqTJAGLPd573XWrRZ2+ueQRFyXm2yh+HVC8+UHSd9q1De+1AfSXOs1Ohs2m7hBV1dHXW5/laBxsqSlIs6qq/gHc3Nri",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,f={},I=[];function b(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,o.jsx)(p(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,o.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.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,o.jsx)(c(),{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:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},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 x(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.0711c505.js b/assets/js/fa40969b.0711c505.js deleted file mode 100644 index 10c41da35..000000000 --- a/assets/js/fa40969b.0711c505.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[724],{17556:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>h,default:()=>y,frontMatter:()=>x,metadata:()=>s,toc:()=>j});const s=JSON.parse('{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/getdocumentlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getdocumentlist","permalink":"/docs/API-docs/getdocumentlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar_label":"Get Document list from status","hide_title":true,"hide_table_of_contents":true,"api":"eJztWN1u2zgWfhUOe7HTQrblxGlnfTXBtBtkd7AtmgwKbGMYlHRssaFIDnnkHxi62yeZR5snWRxKsuXYSePZQa/mJrHI88/v/JAbjmLu+fgzf2vSsgCNnk8inoFPnbQojeZj/uLFC9Zus9u1BT++0x8BnYQFMMGU9MjMjGWtCJYIDxkzmuHawp2+08M+e/XqrRMz3Ery41ev7jRjjPV2awxzgUw4YGnpHGhUayY1ywKnR4Gl75O8M5J3rXsfnJk78P4PSbUNc5B4ThJ/MoVVgJA9R14uFsASAM18mabg/axUas3SrYylxJwJpZiDX0vpIGNezrXA0kGtc0Q6361s2HuuRmjohc6CS9owZfQcHBPBCpkoCNIvQswhVVKf6lDWciVrhjmw0oPr32kecWPBCcLFdcbHfA7YHjqBgEfcCicKQHAEqg3XogA+5plJCQk84pIAZQXm/CHKbnMIcNlHEhrmGqTxiLeB5GN0JUTc41qRfC8p5jzisLLKZMDHM6E8EaQ5FIKPNzzoH3OPTuo5UeqyINwHaAXDWjjwiG/PsBYZVJK9dVT4pKqirW9KFhJbz34twa33DG0NaSydGVd07Wz82JpZiJUsyLKLOI5ao3VZJOB4RXwieDoexh0T/L20f5oFj+uMqwnJ9dZoD55oz+KY/u0f5C4b2BYtIaYaQSPRC2uVTMPG4Isnps2hASb5AmmAlCMxKGuVDnypsEMnnBPksEQo/Nf562VC7yEmKDQC91DS+s7/cSXvz86T/Jd/UkxmkhZPk5AjWj8eDJqV0ql+agqShhJPF+fDD0oVEqENnizBKhAeQlHaZlxwzqgM3LcKZY3h0yTUFrLAWu0CyFsvpo0LVcTNUu/58iz5X0wohMRP0QnV7I8CzpnjZ7vTloJ5KhBHzYJCSPVV6gTgx2ahxZrNjf6KmtHF67Ph+Q9vhkS/lNkc8P/wv9491LdfNC6VMkvI2EKoEjzr7VplRH2/sP2vpUNLT0avDgtZh3u7suU+G42qiK9P5HozpPicyHT+QxXx/ESm0Ws6OTGHE/mG3eRAKKwSCNObGtLT9mirp6hCfnnQ2bV+7/bLQmKMAqG7CqmZVBFPHQiE7BKfBtpZfHbeG8a9+M3t8PV49Pfxxet+HMf/4RFfFQHd7fwgEHg3z5vv0mbfRA9okSi4NeXz3HeQSQcpTkt3NEefwjGpE5QM08Jkcta0Sf+03tDi6aAeuNMp6g9L5P6pS02TzbRt7tOzOJ6OiKSK+CgeHTb5j2CNQ6YNMrEQUlF8vvvzujw4Z45W7V2gjlvwlFOjeDS92Dp1cejUtV4IJTN2+eGa3Zp70N/Wo656rNUfnqmsicI+33O2u1476SEtncR1GMVXPWFlr94ff57QLFcA5qaZ48Psjjkf80F3pB9smtm94iTPLdrJPkB7O9N4obPErPrGgqZKrETiqeMMhJWDBTWShxzC2hOoPYq51PPek1yTncc3dCp14Pf83jUxK/8F1MWasHapmkk6BxFmiIq+ZyYwN8F+b0FTfQxHtRgedLNPoFJTAN1e6PrUkv/+398CRxvggKTv2PvSMWuW4GhkpmvdTMGKrnGBOBQDz9amJHEeRKHA+3CDRZg7gcAyOZcoVOiZUs9ZKqxIpJKEPSIzxO1YB76+zz7lgDk42vqbo2t8BgtQBFmmjLknOWiYKNEUQUf7ALA07n5GJkVMsKT0UtP92wO0LKBzoVNg7VlEzDgmNAON4KyTHpiQBRHPjGMwm8lUkmBKNCdSZIXQYg6kLGJkN0XBOrOQGXjmTFJ6ZN6oMjhCGgsArF3UAJnvs7dyAbXjtJgBCqkgY/OSREQsNRndo0PekRs6Ywl4ZJbUyxSCUI/CIVOwABewF06SrvjMGioIUii6qnbPlgShE9pTga8Nao9mGz7rDN2Ogo5MrPuMruo3BJbSAwFASX1PDyw99nkLs0+QeIkw+b7Nh+VyeZAHL/d5riTmZcIcWLPjm4fFkDVd9u3HSx5xBFf497MbcAuZtheXR3QOAvGgKZMiDWWymU0px358yEAlS8kUtIdOUbu8+vAzW7DzfsyjTuY/w+DBz9c/vfv3zTuSS7Wpzr9hP+7HYdo1HguhO6quYPcEVb9czZwpmrelh4m82VX/v17B/noF276CNU0EYYUDq4QMnbgZ9uou+pk/eBgbt29gk4jnxiORbDYEkV+cqiparp9uqLlm0tM4s3u8uYd156kpXJLqWfFR2uZNaEc6oQ8nifa4jkeR//3H5uResuc80h0NTtt29bprVGtsG5tqQpejuu+SjfXuZZqC7fp9MIftDTNX7255xEWJ+X6/vw/9vvlB0o/atD8I1AbQXwr1UYbNpp4lqmpLX289ytE42FJTgCZVVf0PkO4YjQ==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"}}');var i=n(74848),r=n(28453),o=n(33617),l=n.n(o),p=n(17543),a=n.n(p),m=n(86013),c=n.n(m),u=n(63723),d=n.n(u),g=(n(18766),n(79329),n(9303));const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1u2zgWfhUOe7HTQrblxGlnfTXBtBtkd7AtmgwKbGMYlHRssaFIDnnkHxi62yeZR5snWRxKsuXYSePZQa/mJrHI88/v/JAbjmLu+fgzf2vSsgCNnk8inoFPnbQojeZj/uLFC9Zus9u1BT++0x8BnYQFMMGU9MjMjGWtCJYIDxkzmuHawp2+08M+e/XqrRMz3Ery41ev7jRjjPV2awxzgUw4YGnpHGhUayY1ywKnR4Gl75O8M5J3rXsfnJk78P4PSbUNc5B4ThJ/MoVVgJA9R14uFsASAM18mabg/axUas3SrYylxJwJpZiDX0vpIGNezrXA0kGtc0Q6361s2HuuRmjohc6CS9owZfQcHBPBCpkoCNIvQswhVVKf6lDWciVrhjmw0oPr32kecWPBCcLFdcbHfA7YHjqBgEfcCicKQHAEqg3XogA+5plJCQk84pIAZQXm/CHKbnMIcNlHEhrmGqTxiLeB5GN0JUTc41qRfC8p5jzisLLKZMDHM6E8EaQ5FIKPNzzoH3OPTuo5UeqyINwHaAXDWjjwiG/PsBYZVJK9dVT4pKqirW9KFhJbz34twa33DG0NaSydGVd07Wz82JpZiJUsyLKLOI5ao3VZJOB4RXwieDoexh0T/L20f5oFj+uMqwnJ9dZoD55oz+KY/u0f5C4b2BYtIaYaQSPRC2uVTMPG4Isnps2hASb5AmmAlCMxKGuVDnypsEMnnBPksEQo/Nf562VC7yEmKDQC91DS+s7/cSXvz86T/Jd/UkxmkhZPk5AjWj8eDJqV0ql+agqShhJPF+fDD0oVEqENnizBKhAeQlHaZlxwzqgM3LcKZY3h0yTUFrLAWu0CyFsvpo0LVcTNUu/58iz5X0wohMRP0QnV7I8CzpnjZ7vTloJ5KhBHzYJCSPVV6gTgx2ahxZrNjf6KmtHF67Ph+Q9vhkS/lNkc8P/wv9491LdfNC6VMkvI2EKoEjzr7VplRH2/sP2vpUNLT0avDgtZh3u7suU+G42qiK9P5HozpPicyHT+QxXx/ESm0Ws6OTGHE/mG3eRAKKwSCNObGtLT9mirp6hCfnnQ2bV+7/bLQmKMAqG7CqmZVBFPHQiE7BKfBtpZfHbeG8a9+M3t8PV49Pfxxet+HMf/4RFfFQHd7fwgEHg3z5vv0mbfRA9okSi4NeXz3HeQSQcpTkt3NEefwjGpE5QM08Jkcta0Sf+03tDi6aAeuNMp6g9L5P6pS02TzbRt7tOzOJ6OiKSK+CgeHTb5j2CNQ6YNMrEQUlF8vvvzujw4Z45W7V2gjlvwlFOjeDS92Dp1cejUtV4IJTN2+eGa3Zp70N/Wo656rNUfnqmsicI+33O2u1476SEtncR1GMVXPWFlr94ff57QLFcA5qaZ48Psjjkf80F3pB9smtm94iTPLdrJPkB7O9N4obPErPrGgqZKrETiqeMMhJWDBTWShxzC2hOoPYq51PPek1yTncc3dCp14Pf83jUxK/8F1MWasHapmkk6BxFmiIq+ZyYwN8F+b0FTfQxHtRgedLNPoFJTAN1e6PrUkv/+398CRxvggKTv2PvSMWuW4GhkpmvdTMGKrnGBOBQDz9amJHEeRKHA+3CDRZg7gcAyOZcoVOiZUs9ZKqxIpJKEPSIzxO1YB76+zz7lgDk42vqbo2t8BgtQBFmmjLknOWiYKNEUQUf7ALA07n5GJkVMsKT0UtP92wO0LKBzoVNg7VlEzDgmNAON4KyTHpiQBRHPjGMwm8lUkmBKNCdSZIXQYg6kLGJkN0XBOrOQGXjmTFJ6ZN6oMjhCGgsArF3UAJnvs7dyAbXjtJgBCqkgY/OSREQsNRndo0PekRs6Ywl4ZJbUyxSCUI/CIVOwABewF06SrvjMGioIUii6qnbPlgShE9pTga8Nao9mGz7rDN2Ogo5MrPuMruo3BJbSAwFASX1PDyw99nkLs0+QeIkw+b7Nh+VyeZAHL/d5riTmZcIcWLPjm4fFkDVd9u3HSx5xBFf497MbcAuZtheXR3QOAvGgKZMiDWWymU0px358yEAlS8kUtIdOUbu8+vAzW7DzfsyjTuY/w+DBz9c/vfv3zTuSS7Wpzr9hP+7HYdo1HguhO6quYPcEVb9czZwpmrelh4m82VX/v17B/noF276CNU0EYYUDq4QMnbgZ9uou+pk/eBgbt29gk4jnxiORbDYEkV+cqiparp9uqLlm0tM4s3u8uYd156kpXJLqWfFR2uZNaEc6oQ8nifa4jkeR//3H5uResuc80h0NTtt29bprVGtsG5tqQpejuu+SjfXuZZqC7fp9MIftDTNX7255xEWJ+X6/vw/9vvlB0o/atD8I1AbQXwr1UYbNpp4lqmpLX289ytE42FJTgCZVVf0PkO4YjQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,f={},j=[{value:"Document Types:",id:"document-types",level:3}];function b(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(a(),{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)(c(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(d(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},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 y(e={}){const{wrapper:t}={...(0,r.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/fa40969b.72df7255.js b/assets/js/fa40969b.72df7255.js new file mode 100644 index 000000000..fee92d3e0 --- /dev/null +++ b/assets/js/fa40969b.72df7255.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[724],{17556:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>h,default:()=>j,frontMatter:()=>x,metadata:()=>s,toc:()=>b});const s=JSON.parse('{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","source":"@site/docs/API-docs/getdocumentlist.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getdocumentlist","permalink":"/docs/API-docs/getdocumentlist","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar_label":"Get Document list from status","hide_title":true,"hide_table_of_contents":true,"api":"eJztWN1u2zgWfpUz7MVOC9mWE6ed9dUE026Q3cG2aDIosI1hUNKxxYYiOSTlHxi62yeZR5snWRxKsuXYSePZQa/mpo2p83++80NumOdzx8af2VudlgUq79gkYhm61ArjhVZszF68eAHtZ7hdG3TjO/URvRW4QOAghfOgZ5C1IiDhDjPQCvza4J26U8M+vHr11vKZ30py41ev7hQAQG93Bj7nHrhFSEtrUXm5BqEgC5zOc1+6Psk7I3nXqvfB6rlF5/6QVNMwB4nnJPEnXRiJHrPnyMv5AiFBVODKNEXnZqWUa0i3MpbC58ClBIu/lsJiBk7MFfelxVrniHS+W5nw7bkasaHnKgsuKQ1Sqzla4MEKkUgM0i9CzDGVQp3qUNZyJWvwOULp0PbvFIuYNmg54eI6Y2M2R98mnUDAIma45QV6tASqDVO8QDZmmU4JCSxiggBluM/ZQ5Td5hjgso8kr8E2SGMRawPJxt6WGDHn15LkO0ExZxHDlZE6QzaecemIIM2x4Gy8YUH/mDlvhZoTpSoLwn2AVjCshQOL2DaHtcigkuyto8ImVRVtfZOiEL717NcS7XrP0NaQxtKZtkXXzsaPrZkFX4mCLLuI46g1WpVFgpZVxMeDp+Nh3DHB3Qvzp1nwuM64mpBcZ7Ry6Ij2LI7pv/1E7qoBtmgJMVUelSd6bowUafgw+OKIaXNogE6+YBogZUmMF7VKi66UvkPHreXksPBYuK/z18eE3kNMUGi430NJ6zv7x5W4PztP8l/+STGZCTo8TULuvXHjwaA5Ka3sp7ogaV7408W58AeVColQ2p8swUjkDkNT2lZccE7LDO23CmWN4dMk1BZCYK12AWStF9PGhSpieqn2fHmW/C86NELip+iEbvZHAWf18dzutKWonwrEUbOw4EJ+lTpB/LE5aLFmcq2+omZ08fpseP7DmyHRL0U2R/9/+F9/PdS33zQupdRLzGDBZYkOertRGdHcL0z/a+XQ0pPRq8NG1uHenmy5z0ajKmLrE7neDCk+JzKd/1BFLD+RafSaMsfneCLfsFscHgsjucfpTQ3paZva6imqUF8OVXat3tv9tpBoLZGrrkIaJlXEUovcY3bpnwbaWXx23hvGvfjN7fD1ePT38cXrfhzH/2ERWxUB3e3+wD2ybp03v0uTfRM9qHgi8VaXz3PfYiYspn5a2qM1+hSOSR2nYpgWOhOzZky6p/WGEU+JeuBOp6k/bJH7WReKNptpO9ynZ3E8HRFJFbFRPDoc8h/RaOtBaQ98wYWk+Hz35015tFYf7dq7QB234CmnRvFoerF16uLQqWu14FJkcPnhGm71Papv61FXva/VH+ZU1EThO9tztnteO+kwLa3w67CKr3rciF79ffx5QrtcgT7XzR4fdnefszEbdFf6wabZ3StG8uyi3ewDtLc7jeMqS/Sqrw0q6sSSJ44mzoAbMVjQIHnIwY05gRrL3mkMzvO5UPOnuSa7EN1QGutM7QVqN/WM+BfS2Gvy0KVqVu8ceVg6Kvo904G5yc57g4oaasjtYngw/j6hTHWBdN2h+1ZL/vt/fwscbUYC9L6D96UFo5doaceme+BM4orufYE4dA8Ha12SOIe8kOhcuPJ6nFvuETIxF57LMGSFmkPKDU+EFARWItPEbaGDd9eHTzn6HC19+pule3+GC5SEcZBa35Mcr4GXXhdBR/tisNT2fkYmRcAhKZ1QdGF3iC0LqpyrFKHNRQTaAleAyqM1VjgELgoinmkLOJuJVJBgqkzLUw8FV3yOpCwCspuiYKxeiAwdWJ2UzoPTsgyOkMYC0dcuKsTM9eGtWGDtOB1m6LmQmMG8JBERpDqji3coVHJDZZCg82BIvUgxCHWeWw8SF2gD9kIm6U0AjKYOIriku203tyTIW64cTYTaoDY12/AZq+k6FXRkfN0HutvfEFhKhwQAKdQ9vcj04PMWZp8wccLj5Pu2HpbL5UEdvNznuRI+LxOwaPSObx4OQ9V02bc/XrKIebSFez+7QbsQaXvTeUTnIBAPmr7K09BXm2WWauzHhwzU46RIUTnsdMHLqw8/wwLO+zGLOpX/DIMHP1//9O7fN+9ILjWzuv6G/bgfh/VYO19w1VF1hbs3q/qpa2Z10TxGPSzkzW5c/PVs9tez2fbZrBkiHld+YCQXYXQ322E9dj+zBy9p4/bRbBKxXDtPJJsNQeQXK6uKjuu3HprGmXC0/+xee+5x3XmbCreqerl8lLZ5RNqRTuiHFUR7XMejyP/+Y5O5l/CcV72jwWnHrlp3jWqNbWNTTeg2Vc9dsrH+epmmaLp+Hyxue9vP1btbFjFe+nx/3t+Hed/8QdKP2rS/CNQG0L8U6qMMm029S1TVlr7+9ChH42BLTQGaVFX1Px/tKbg=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"},"next":{"title":"Resend request mail","permalink":"/docs/API-docs/resendrequestmail"}}');var r=n(74848),i=n(28453),a=n(33617),o=n.n(a),p=n(17543),l=n.n(p),m=n(86013),c=n.n(m),d=n(63723),u=n.n(d),g=(n(18766),n(79329),n(9303));const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1u2zgWfpUz7MVOC9mWE6ed9dUE026Q3cG2aDIosI1hUNKxxYYiOSTlHxi62yeZR5snWRxKsuXYSePZQa/mpo2p83++80NumOdzx8af2VudlgUq79gkYhm61ArjhVZszF68eAHtZ7hdG3TjO/URvRW4QOAghfOgZ5C1IiDhDjPQCvza4J26U8M+vHr11vKZ30py41ev7hQAQG93Bj7nHrhFSEtrUXm5BqEgC5zOc1+6Psk7I3nXqvfB6rlF5/6QVNMwB4nnJPEnXRiJHrPnyMv5AiFBVODKNEXnZqWUa0i3MpbC58ClBIu/lsJiBk7MFfelxVrniHS+W5nw7bkasaHnKgsuKQ1Sqzla4MEKkUgM0i9CzDGVQp3qUNZyJWvwOULp0PbvFIuYNmg54eI6Y2M2R98mnUDAIma45QV6tASqDVO8QDZmmU4JCSxiggBluM/ZQ5Td5hjgso8kr8E2SGMRawPJxt6WGDHn15LkO0ExZxHDlZE6QzaecemIIM2x4Gy8YUH/mDlvhZoTpSoLwn2AVjCshQOL2DaHtcigkuyto8ImVRVtfZOiEL717NcS7XrP0NaQxtKZtkXXzsaPrZkFX4mCLLuI46g1WpVFgpZVxMeDp+Nh3DHB3Qvzp1nwuM64mpBcZ7Ry6Ij2LI7pv/1E7qoBtmgJMVUelSd6bowUafgw+OKIaXNogE6+YBogZUmMF7VKi66UvkPHreXksPBYuK/z18eE3kNMUGi430NJ6zv7x5W4PztP8l/+STGZCTo8TULuvXHjwaA5Ka3sp7ogaV7408W58AeVColQ2p8swUjkDkNT2lZccE7LDO23CmWN4dMk1BZCYK12AWStF9PGhSpieqn2fHmW/C86NELip+iEbvZHAWf18dzutKWonwrEUbOw4EJ+lTpB/LE5aLFmcq2+omZ08fpseP7DmyHRL0U2R/9/+F9/PdS33zQupdRLzGDBZYkOertRGdHcL0z/a+XQ0pPRq8NG1uHenmy5z0ajKmLrE7neDCk+JzKd/1BFLD+RafSaMsfneCLfsFscHgsjucfpTQ3paZva6imqUF8OVXat3tv9tpBoLZGrrkIaJlXEUovcY3bpnwbaWXx23hvGvfjN7fD1ePT38cXrfhzH/2ERWxUB3e3+wD2ybp03v0uTfRM9qHgi8VaXz3PfYiYspn5a2qM1+hSOSR2nYpgWOhOzZky6p/WGEU+JeuBOp6k/bJH7WReKNptpO9ynZ3E8HRFJFbFRPDoc8h/RaOtBaQ98wYWk+Hz35015tFYf7dq7QB234CmnRvFoerF16uLQqWu14FJkcPnhGm71Papv61FXva/VH+ZU1EThO9tztnteO+kwLa3w67CKr3rciF79ffx5QrtcgT7XzR4fdnefszEbdFf6wabZ3StG8uyi3ewDtLc7jeMqS/Sqrw0q6sSSJ44mzoAbMVjQIHnIwY05gRrL3mkMzvO5UPOnuSa7EN1QGutM7QVqN/WM+BfS2Gvy0KVqVu8ceVg6Kvo904G5yc57g4oaasjtYngw/j6hTHWBdN2h+1ZL/vt/fwscbUYC9L6D96UFo5doaceme+BM4orufYE4dA8Ha12SOIe8kOhcuPJ6nFvuETIxF57LMGSFmkPKDU+EFARWItPEbaGDd9eHTzn6HC19+pule3+GC5SEcZBa35Mcr4GXXhdBR/tisNT2fkYmRcAhKZ1QdGF3iC0LqpyrFKHNRQTaAleAyqM1VjgELgoinmkLOJuJVJBgqkzLUw8FV3yOpCwCspuiYKxeiAwdWJ2UzoPTsgyOkMYC0dcuKsTM9eGtWGDtOB1m6LmQmMG8JBERpDqji3coVHJDZZCg82BIvUgxCHWeWw8SF2gD9kIm6U0AjKYOIriku203tyTIW64cTYTaoDY12/AZq+k6FXRkfN0HutvfEFhKhwQAKdQ9vcj04PMWZp8wccLj5Pu2HpbL5UEdvNznuRI+LxOwaPSObx4OQ9V02bc/XrKIebSFez+7QbsQaXvTeUTnIBAPmr7K09BXm2WWauzHhwzU46RIUTnsdMHLqw8/wwLO+zGLOpX/DIMHP1//9O7fN+9ILjWzuv6G/bgfh/VYO19w1VF1hbs3q/qpa2Z10TxGPSzkzW5c/PVs9tez2fbZrBkiHld+YCQXYXQ322E9dj+zBy9p4/bRbBKxXDtPJJsNQeQXK6uKjuu3HprGmXC0/+xee+5x3XmbCreqerl8lLZ5RNqRTuiHFUR7XMejyP/+Y5O5l/CcV72jwWnHrlp3jWqNbWNTTeg2Vc9dsrH+epmmaLp+Hyxue9vP1btbFjFe+nx/3t+Hed/8QdKP2rS/CNQG0L8U6qMMm029S1TVlr7+9ChH42BLTQGaVFX1Px/tKbg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,f={},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,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,r.jsx)(o(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,r.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,r.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.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,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1}},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 j(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.f2037354.js b/assets/js/runtime~main.a26d6e51.js similarity index 85% rename from assets/js/runtime~main.f2037354.js rename to assets/js/runtime~main.a26d6e51.js index 072b189bb..fe8cfd056 100644 --- a/assets/js/runtime~main.f2037354.js +++ b/assets/js/runtime~main.a26d6e51.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,b,r={},d={};function t(e){var a=d[e];if(void 0!==a)return a.exports;var c=d[e]={id:e,loaded:!1,exports:{}};return r[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=r,t.c=d,e=[],t.O=(a,c,f,b)=>{if(!c){var r=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(d=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var r={};a=a||[null,c({}),c([]),c(c)];for(var d=2&f&&e;"object"==typeof d&&!~a.indexOf(d);d=c(d))Object.getOwnPropertyNames(d).forEach((a=>r[a]=()=>e[a]));return r.default=()=>e,t.d(b,r),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({157:"8001f939",291:"4f7a2d40",490:"ce589067",560:"500027af",724:"fa40969b",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",962:"046910c8",1019:"5ce9853b",1179:"489b8a4d",1235:"a7456010",1381:"a2bc1463",1440:"277a78f5",1519:"78b2b753",1640:"c9fa5aa5",1688:"9640838e",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2089:"c7b98810",2131:"299c7a47",2223:"5a2de241",2264:"17e5210b",2634:"c4f5d8e4",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3213:"a9f09360",3249:"ccc49370",3276:"e5aefb32",3381:"42f80fc5",3392:"reactPlayerVidyard",3451:"70853c19",3605:"a88a3db3",3637:"f4f34a3a",3694:"8717b14a",3841:"56b5f4f8",3844:"bbdfc22d",3976:"0e384e19",4134:"393be207",4212:"621db11d",4317:"0028a090",4469:"52d5c0f9",4553:"451a5132",4584:"f82cd581",4813:"6875c492",4948:"bfe4b778",5277:"8320e026",5378:"38e3d9c8",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5772:"28b19cd2",5970:"0f8cf55d",6007:"611db08b",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6197:"1aff3f87",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6382:"5c04ee3b",6463:"reactPlayerKaltura",6473:"4c5e977b",6648:"0c0943c7",6653:"f214d5ff",6685:"ae010e44",6743:"e226bb09",6792:"4d665321",6887:"reactPlayerFacebook",6969:"14eb3368",7068:"e92d0461",7098:"a7bd4aaa",7315:"f0ff4a36",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7605:"770b40a9",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7910:"e4f5c862",8025:"5e90a9b3",8097:"ab2a161b",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8209:"01a85c17",8211:"1f73ca32",8446:"reactPlayerYouTube",8462:"3217192f",8472:"13fdae3b",8503:"012b45bf",8609:"925b3f96",8669:"05632a52",8672:"8a725248",8734:"reactPlayerPreview",8737:"7661071f",8790:"2304e9ae",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9180:"8a855f99",9190:"6cb65baf",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9426:"38ec836e",9441:"377084eb",9599:"2c586be5",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9938:"7b076186",9979:"reactPlayerSoundCloud",9983:"ada7accb"}[e]||e)+"."+{157:"be2f595e",291:"fb6bc395",490:"06dc6e05",560:"d65f3f92",724:"0711c505",746:"33cab0ea",841:"42868966",849:"7fa088b2",850:"3ac080ec",962:"abe7aaf7",1019:"b628cd80",1179:"b551b44c",1235:"e0fce024",1381:"9fe35bff",1440:"5dc69857",1463:"6c989e27",1519:"5bb2f535",1640:"d2ce80bf",1688:"be33b996",1903:"9c2000d9",1924:"7f7bb4f2",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2089:"11b02d02",2131:"d7f2b515",2223:"7898036f",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"cecb2797",3021:"eb474160",3042:"040aac0d",3073:"732a63bb",3213:"e942082e",3249:"d6c50b29",3276:"00ab24d9",3381:"a7f76393",3392:"a7951473",3451:"5d1e4741",3605:"0b93ed81",3637:"ffa80471",3694:"4d710693",3841:"6784ed33",3844:"b0216893",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"7b36bcdc",4469:"b91649d3",4553:"c012dd2f",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"f69d6817",5013:"b10f6f78",5277:"6e628336",5378:"73b1ae3a",5550:"def3ac1b",5557:"dffbf1c4",5597:"dccc1a9f",5742:"ac359952",5772:"45ebbf79",5970:"91dc704f",6007:"fe62cc08",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6197:"b8553e32",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"aea9ee55",6382:"08676753",6463:"665cb544",6473:"0243df4f",6648:"152274c2",6653:"fdbc0c47",6685:"56305cd9",6743:"a3fe848c",6792:"3e46ed7a",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b2ebdef8",7098:"c920e4e4",7315:"c4f1b7a2",7318:"5b9bda16",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7605:"49352e31",7627:"df6df631",7643:"4bb958af",7696:"6ededead",7757:"ad93b050",7910:"61af651f",8025:"18e81984",8097:"43a7d9e8",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8209:"b9e31ef1",8211:"48f7e73e",8446:"594ab8ca",8462:"d040ed86",8472:"7a8c2a64",8503:"45b8fe0a",8609:"6bdc8628",8669:"96765119",8672:"8dd48c73",8734:"1f259505",8737:"f138d21c",8790:"7b709933",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9180:"0210056e",9190:"dd359a70",9241:"77521554",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9426:"4597631d",9441:"5276d129",9599:"b0969c28",9611:"9a74cba2",9647:"2f22c378",9858:"939e017f",9938:"5f0c09d6",9979:"84827225",9983:"b4126a82"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,r)=>{if(f[e])f[e].push(a);else{var d,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{d.onerror=d.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],d.parentNode&&d.parentNode.removeChild(d),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=u.bind(null,d.onerror),d.onload=u.bind(null,d.onload),o&&document.head.appendChild(d)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325","8001f939":"157","4f7a2d40":"291",ce589067:"490","500027af":"560",fa40969b:"724",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","046910c8":"962","5ce9853b":"1019","489b8a4d":"1179",a7456010:"1235",a2bc1463:"1381","277a78f5":"1440","78b2b753":"1519",c9fa5aa5:"1640","9640838e":"1688",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",c7b98810:"2089","299c7a47":"2131","5a2de241":"2223","17e5210b":"2264",c4f5d8e4:"2634","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",a9f09360:"3213",ccc49370:"3249",e5aefb32:"3276","42f80fc5":"3381",reactPlayerVidyard:"3392","70853c19":"3451",a88a3db3:"3605",f4f34a3a:"3637","8717b14a":"3694","56b5f4f8":"3841",bbdfc22d:"3844","0e384e19":"3976","393be207":"4134","621db11d":"4212","0028a090":"4317","52d5c0f9":"4469","451a5132":"4553",f82cd581:"4584","6875c492":"4813",bfe4b778:"4948","8320e026":"5277","38e3d9c8":"5378","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","28b19cd2":"5772","0f8cf55d":"5970","611db08b":"6007","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173","1aff3f87":"6197",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353","5c04ee3b":"6382",reactPlayerKaltura:"6463","4c5e977b":"6473","0c0943c7":"6648",f214d5ff:"6653",ae010e44:"6685",e226bb09:"6743","4d665321":"6792",reactPlayerFacebook:"6887","14eb3368":"6969",e92d0461:"7068",a7bd4aaa:"7098",f0ff4a36:"7315",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570","770b40a9":"7605",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757",e4f5c862:"7910","5e90a9b3":"8025",ab2a161b:"8097","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","1f73ca32":"8211",reactPlayerYouTube:"8446","3217192f":"8462","13fdae3b":"8472","012b45bf":"8503","925b3f96":"8609","05632a52":"8669","8a725248":"8672",reactPlayerPreview:"8734","7661071f":"8737","2304e9ae":"8790",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","8a855f99":"9180","6cb65baf":"9190","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","38ec836e":"9426","377084eb":"9441","2c586be5":"9599","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858","7b076186":"9938",reactPlayerSoundCloud:"9979",ada7accb:"9983"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var r=t.p+t.u(a),d=new Error;t.l(r,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),r=c&&c.target&&c.target.src;d.message="Loading chunk "+a+" failed.\n("+b+": "+r+")",d.name="ChunkLoadError",d.type=b,d.request=r,f[1](d)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,r=c[0],d=c[1],o=c[2],l=0;if(r.some((a=>0!==e[a]))){for(f in d)t.o(d,f)&&(t.m[f]=d[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,f,b,r={},d={};function t(e){var a=d[e];if(void 0!==a)return a.exports;var c=d[e]={id:e,loaded:!1,exports:{}};return r[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=r,t.c=d,e=[],t.O=(a,c,f,b)=>{if(!c){var r=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(d=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var r={};a=a||[null,c({}),c([]),c(c)];for(var d=2&f&&e;"object"==typeof d&&!~a.indexOf(d);d=c(d))Object.getOwnPropertyNames(d).forEach((a=>r[a]=()=>e[a]));return r.default=()=>e,t.d(b,r),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({157:"8001f939",291:"4f7a2d40",490:"ce589067",560:"500027af",724:"fa40969b",746:"cf03142d",841:"d1393a72",849:"0058b4c6",850:"c6b74119",962:"046910c8",1019:"5ce9853b",1179:"489b8a4d",1235:"a7456010",1381:"a2bc1463",1440:"277a78f5",1519:"78b2b753",1640:"c9fa5aa5",1688:"9640838e",1903:"acecf23e",1924:"d8b805fb",1972:"73664a40",2042:"reactPlayerTwitch",2089:"c7b98810",2131:"299c7a47",2223:"5a2de241",2264:"17e5210b",2634:"c4f5d8e4",2711:"9e4087bc",2723:"reactPlayerMux",2908:"2c416566",2959:"50ea61d6",3021:"4cff09f6",3073:"e9e778b7",3213:"a9f09360",3249:"ccc49370",3276:"e5aefb32",3381:"42f80fc5",3392:"reactPlayerVidyard",3451:"70853c19",3605:"a88a3db3",3637:"f4f34a3a",3694:"8717b14a",3841:"56b5f4f8",3844:"bbdfc22d",3976:"0e384e19",4134:"393be207",4212:"621db11d",4317:"0028a090",4469:"52d5c0f9",4553:"451a5132",4584:"f82cd581",4813:"6875c492",4948:"bfe4b778",5277:"8320e026",5378:"38e3d9c8",5550:"14716de7",5557:"d9f32620",5597:"b18842e4",5742:"aba21aa0",5772:"28b19cd2",5970:"0f8cf55d",6007:"611db08b",6061:"1f391b9e",6157:"3973fcf3",6173:"reactPlayerVimeo",6197:"1aff3f87",6295:"d91ad230",6318:"bb4fa758",6328:"reactPlayerDailyMotion",6353:"5e1bb91e",6382:"5c04ee3b",6463:"reactPlayerKaltura",6473:"4c5e977b",6648:"0c0943c7",6653:"f214d5ff",6685:"ae010e44",6743:"e226bb09",6792:"4d665321",6887:"reactPlayerFacebook",6969:"14eb3368",7068:"e92d0461",7098:"a7bd4aaa",7315:"f0ff4a36",7318:"e76c28ee",7458:"reactPlayerFilePlayer",7472:"814f3328",7477:"36994c47",7570:"reactPlayerMixcloud",7605:"770b40a9",7627:"reactPlayerStreamable",7643:"a6aa9e1f",7696:"1ee58ee1",7757:"eb56c656",7910:"e4f5c862",8025:"5e90a9b3",8097:"ab2a161b",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8209:"01a85c17",8211:"1f73ca32",8446:"reactPlayerYouTube",8462:"3217192f",8472:"13fdae3b",8503:"012b45bf",8609:"925b3f96",8669:"05632a52",8672:"8a725248",8734:"reactPlayerPreview",8737:"7661071f",8790:"2304e9ae",8927:"b0378e01",8947:"ef8b811a",9024:"e5a49157",9048:"a94703ab",9180:"8a855f99",9190:"6cb65baf",9241:"11b7b3d8",9325:"59362658",9328:"e273c56f",9340:"reactPlayerWistia",9426:"38ec836e",9441:"377084eb",9599:"2c586be5",9611:"06b6ef6a",9647:"5e95c892",9858:"1f7895dc",9938:"7b076186",9979:"reactPlayerSoundCloud",9983:"ada7accb"}[e]||e)+"."+{157:"be2f595e",291:"fb6bc395",490:"06dc6e05",560:"d65f3f92",724:"72df7255",746:"33cab0ea",841:"42868966",849:"7fa088b2",850:"3ac080ec",962:"abe7aaf7",1019:"efc3024a",1179:"b551b44c",1235:"e0fce024",1381:"6ab5f53d",1440:"5dc69857",1463:"6c989e27",1519:"10d27add",1640:"d2ce80bf",1688:"be33b996",1903:"9c2000d9",1924:"7f7bb4f2",1936:"3329227e",1972:"6aa170c8",2042:"ccdbba13",2089:"11b02d02",2131:"d7f2b515",2223:"a0e6338f",2264:"03a17636",2489:"a212f802",2634:"b5502b21",2711:"999c03aa",2723:"ad84c6fe",2908:"9a88f7fa",2959:"cecb2797",3021:"eb474160",3042:"040aac0d",3073:"732a63bb",3213:"6f58abda",3249:"d6c50b29",3276:"00ab24d9",3381:"a7f76393",3392:"a7951473",3451:"6bd16af0",3605:"862db0b2",3637:"ffa80471",3694:"4d710693",3841:"6784ed33",3844:"2a34d737",3976:"2d4c4f66",4132:"a5c6ef5a",4134:"7b436152",4212:"5dccb1c7",4317:"678503c7",4469:"bbcdd440",4553:"25f6966a",4584:"a7d307eb",4622:"420bc0ab",4813:"1198d246",4948:"fa51d361",5013:"b10f6f78",5277:"6e628336",5378:"73b1ae3a",5550:"def3ac1b",5557:"dffbf1c4",5597:"dccc1a9f",5742:"ac359952",5772:"fbf28e5d",5970:"91dc704f",6007:"fe62cc08",6061:"bb03b217",6157:"fccfe0be",6173:"40e527dc",6197:"b8553e32",6295:"958608f5",6318:"213b74ab",6328:"a2ec01b1",6353:"aea9ee55",6382:"7a2cdde0",6463:"665cb544",6473:"0243df4f",6648:"152274c2",6653:"fdbc0c47",6685:"1ad16e94",6743:"a3fe848c",6792:"c9b93ca4",6887:"f478ac9c",6969:"408561bf",7054:"cab4fa5c",7068:"b2ebdef8",7098:"c920e4e4",7315:"c0d4e545",7318:"5b9bda16",7458:"e1cdf442",7472:"909d2cac",7477:"4aaebd1d",7570:"086b8299",7605:"ccc1511d",7627:"df6df631",7643:"4bb958af",7696:"6ededead",7757:"ad93b050",7910:"61af651f",8025:"18e81984",8097:"43a7d9e8",8121:"adb9cf78",8130:"29afdc55",8146:"bdf3ab1c",8160:"4a1cc722",8209:"b9e31ef1",8211:"bd793e95",8446:"594ab8ca",8462:"d040ed86",8472:"cd77c361",8503:"45b8fe0a",8609:"6bdc8628",8669:"6245978a",8672:"f50392f4",8734:"1f259505",8737:"f138d21c",8790:"fa36879b",8927:"cee13eea",8947:"19410731",9024:"331564b7",9048:"9a2fc095",9180:"710b1f9e",9190:"dd359a70",9241:"77521554",9325:"cc9232ad",9328:"18a92a49",9340:"91290ba6",9426:"4597631d",9441:"71fcd1cb",9599:"7f649be6",9611:"9a74cba2",9647:"2f22c378",9858:"939e017f",9938:"8278821f",9979:"84827225",9983:"915a6c10"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",t.l=(e,a,c,r)=>{if(f[e])f[e].push(a);else{var d,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{d.onerror=d.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],d.parentNode&&d.parentNode.removeChild(d),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=u.bind(null,d.onerror),d.onload=u.bind(null,d.onload),o&&document.head.appendChild(d)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"9325","8001f939":"157","4f7a2d40":"291",ce589067:"490","500027af":"560",fa40969b:"724",cf03142d:"746",d1393a72:"841","0058b4c6":"849",c6b74119:"850","046910c8":"962","5ce9853b":"1019","489b8a4d":"1179",a7456010:"1235",a2bc1463:"1381","277a78f5":"1440","78b2b753":"1519",c9fa5aa5:"1640","9640838e":"1688",acecf23e:"1903",d8b805fb:"1924","73664a40":"1972",reactPlayerTwitch:"2042",c7b98810:"2089","299c7a47":"2131","5a2de241":"2223","17e5210b":"2264",c4f5d8e4:"2634","9e4087bc":"2711",reactPlayerMux:"2723","2c416566":"2908","50ea61d6":"2959","4cff09f6":"3021",e9e778b7:"3073",a9f09360:"3213",ccc49370:"3249",e5aefb32:"3276","42f80fc5":"3381",reactPlayerVidyard:"3392","70853c19":"3451",a88a3db3:"3605",f4f34a3a:"3637","8717b14a":"3694","56b5f4f8":"3841",bbdfc22d:"3844","0e384e19":"3976","393be207":"4134","621db11d":"4212","0028a090":"4317","52d5c0f9":"4469","451a5132":"4553",f82cd581:"4584","6875c492":"4813",bfe4b778:"4948","8320e026":"5277","38e3d9c8":"5378","14716de7":"5550",d9f32620:"5557",b18842e4:"5597",aba21aa0:"5742","28b19cd2":"5772","0f8cf55d":"5970","611db08b":"6007","1f391b9e":"6061","3973fcf3":"6157",reactPlayerVimeo:"6173","1aff3f87":"6197",d91ad230:"6295",bb4fa758:"6318",reactPlayerDailyMotion:"6328","5e1bb91e":"6353","5c04ee3b":"6382",reactPlayerKaltura:"6463","4c5e977b":"6473","0c0943c7":"6648",f214d5ff:"6653",ae010e44:"6685",e226bb09:"6743","4d665321":"6792",reactPlayerFacebook:"6887","14eb3368":"6969",e92d0461:"7068",a7bd4aaa:"7098",f0ff4a36:"7315",e76c28ee:"7318",reactPlayerFilePlayer:"7458","814f3328":"7472","36994c47":"7477",reactPlayerMixcloud:"7570","770b40a9":"7605",reactPlayerStreamable:"7627",a6aa9e1f:"7643","1ee58ee1":"7696",eb56c656:"7757",e4f5c862:"7910","5e90a9b3":"8025",ab2a161b:"8097","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","1f73ca32":"8211",reactPlayerYouTube:"8446","3217192f":"8462","13fdae3b":"8472","012b45bf":"8503","925b3f96":"8609","05632a52":"8669","8a725248":"8672",reactPlayerPreview:"8734","7661071f":"8737","2304e9ae":"8790",b0378e01:"8927",ef8b811a:"8947",e5a49157:"9024",a94703ab:"9048","8a855f99":"9180","6cb65baf":"9190","11b7b3d8":"9241",e273c56f:"9328",reactPlayerWistia:"9340","38ec836e":"9426","377084eb":"9441","2c586be5":"9599","06b6ef6a":"9611","5e95c892":"9647","1f7895dc":"9858","7b076186":"9938",reactPlayerSoundCloud:"9979",ada7accb:"9983"}[e]||e,t.p+t.u(e)},(()=>{var e={5354:0,1869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var r=t.p+t.u(a),d=new Error;t.l(r,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),r=c&&c.target&&c.target.src;d.message="Loading chunk "+a+" failed.\n("+b+": "+r+")",d.name="ChunkLoadError",d.type=b,d.request=r,f[1](d)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,r=c[0],d=c[1],o=c[2],l=0;if(r.some((a=>0!==e[a]))){for(f in d)t.o(d,f)&&(t.m[f]=d[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 cff699915..130a2f9d8 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 0dadcf06a..ba0f18848 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 5459ef81e..1c9420bec 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 912daadc4..e90c178c6 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 d559c904c..7ad115026 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 849724f9a..99de99d50 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 0b37aa86f..1602e2acf 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 f9d13a34f..0acbbcf06 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 ecfaed1c4..209404535 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 aeab6046b..38588b782 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 231e8479a..93d65e004 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index 200c04287..3a81799b1 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 3ee720079..56b63e89f 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index e5ac5de8e..cb88043c0 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 4ab6c9dcb..3d55eff8c 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index 9abc9da8c..be8c1b277 100644 --- a/docs/API-docs/createfolder/index.html +++ b/docs/API-docs/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index ba7a5e57e..c52fbad01 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 0eb9d037a..87ba9ed0a 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index ea8e011c1..efff33e0e 100644 --- a/docs/API-docs/delete-webhook/index.html +++ b/docs/API-docs/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index cc7041087..cbd0dede0 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index e1bd24eab..f8701787c 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/deletefolder/index.html b/docs/API-docs/deletefolder/index.html index d3526cc22..deb470959 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftdocument/index.html b/docs/API-docs/draftdocument/index.html index a2c73abbd..9868618e7 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index c553a6373..e06bd522e 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index 51db9238b..69f4bfb57 100644 --- a/docs/API-docs/folderlist/index.html +++ b/docs/API-docs/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 54111a892..96ea65ea4 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index dc57b49c7..76347c40d 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index 6b363bebe..edbb133fb 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 0e4ebec84..3c92a3e79 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 5903aebe6..153cd20bf 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index fa57817ce..a8363bbc2 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/getfolder/index.html b/docs/API-docs/getfolder/index.html index e134d271b..c71181d01 100644 --- a/docs/API-docs/getfolder/index.html +++ b/docs/API-docs/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index 68d3a2442..6d7202da4 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index 13157a9da..516377705 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index 009ce7793..6ba384dd8 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index 0fc91416d..bde73d5f3 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/revokedocument/index.html b/docs/API-docs/revokedocument/index.html index b8ed3842b..fd813d99c 100644 --- a/docs/API-docs/revokedocument/index.html +++ b/docs/API-docs/revokedocument/index.html @@ -5,7 +5,7 @@ Revoke Document | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 0af8196fd..8acd3e130 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/selfsign/index.html b/docs/API-docs/selfsign/index.html index 6cdd4918d..2d0de63df 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 11767e931..9fbf47706 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index cafcc53fd..f93fb45dc 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index 8c49e047f..86282c6b6 100644 --- a/docs/API-docs/updatefolder/index.html +++ b/docs/API-docs/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index 2bb509766..c1ba1b729 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 767cde74b..4c30bbd0a 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 b940f8eb5..1cf2a491a 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index f488d3356..4ababaaf5 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 416b55c30..f6b991483 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 243f2baeb..f542e8b2a 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index dc652c9cb..fafa9ed2a 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index 598a668d7..5f85161aa 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 8ca7a419d..cce64e629 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 85be923fd..43e3111b2 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 004879a6a..47bd71dcc 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 24126b3b8..88aa901c1 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 a0e7f81fe..de1b7d35f 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 82beddc8b..08a087fbb 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 67c18694f..c4087f775 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 58779b192..7842fae1b 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index b42a2ad04..d5e03f53b 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 662e15bf0..e824a67ad 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 944524732..1287b1480 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 44e947f46..78a953daf 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 0653088bc..5b067d39f 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 b66c46a9d..9b6a146a9 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 ba30c1153..35d223962 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 5d54ff0a0..4d7cff17b 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 d156dc9b9..844dfec5d 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 3753bdf28..1a332bc06 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 15b61fe88..7079d0522 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 332840476..26736af30 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 3b1332b8e..e2251ea16 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 99a83d01d..08e0fa58f 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 6fb003a81..667e2466d 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index fec051d6f..e2e37506f 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 ef5e52a8e..9efd39aa2 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 b31f8c0b3..b2b99cfc9 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 346d8d350..8fe48ba66 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 20b5fca4c..7d1cc09dc 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index 4cfebb56d..f6a3c2ccc 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 294348425..e1487dc68 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 13593a98f..3c94607aa 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 bf92a5de4..a2e17e1fd 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 bfecca785..d9cbf11a7 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 9d016991c..fe59d0003 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 30fe08263..8f6e90147 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 8926cacd5..33075656b 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 b834e77b6..c5dd012a7 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 4a0ee7c30..048ba7f83 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 403009f98..a4a4303a4 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 5ff988f02..a069b60b7 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 507ce61ba..261aa5dcf 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 3fdbeb490..5bc0dd214 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 1b9198716..f7e692d63 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +