diff --git a/404.html b/404.html index 34b356f9f..58faf3c4c 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.42c39ba6.js b/assets/js/0028a090.42c39ba6.js deleted file mode 100644 index 39155897f..000000000 --- a/assets/js/0028a090.42c39ba6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var i=s(85893),t=s(11151),a=s(58219),l=(s(62316),s(51039)),r=s.n(l),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),p=s(9472),m=s(85162);const h={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:"eJztW+9yE7myf5U+84XFNXZiE7LgOnXqssCyYYFwIfxNUqw80/aIzEiDpIljKH87T3If7T7JrW6NxmPHSfizdcit8heIRy2p+6duqbvV+hI5MbHR8DA6wKLMhUMbHcdRijYxsnRSq2gYHWQIoRkeGDF2Uk3g3vM9QCVGOVqoLBoLTkNikIiSyjpdyM/UCi6MHINFc0p9hYVRXmFppHIWxtrABBUawQOnOqkKpIapdBmUBlMcS4UpWGeqxFUGbQ9elVqBrZIErR1XuZ9ZagV6DKKZMwaXIbNq0FVGWRBQKfmpQuh09OgjJm4v7XTglxStnCjhMCXmQvcPMr0ZwzSTSQaJUDBCEjUlSWuGscXuSFCbVjynLTGRY0nE9WA9uJemkngUeT6LQUCnU5m80wFpoTT6VKaYhtn0eEyQCoYWpHJoxiJBxgppFDXhacLgIFQKY5HIXLplGCGV1hk5qmjm3pE6UgeyHMKrMtcihZmuDDx/8PuC3Gmgb4edzgMcVRN4tdfpHP+SOVfa4daWKMueLlERWrkY2V6ii62UCMt0zFihQRqV8UJhZT4DkaYwlekEneUFUZDocgaJ1iaVyqtGKSYIqipGaGzM0hTaIEgFAgyKdNZ1ultZhMcv958RDIVwPXieVzZupkulwcTlMz88wROkuuFXZ3eHdEiqSQyFOCGUpINPlUxOSGyLipe2VhnGqtN5WZWlNqQYb7wIw06HWn7DXE9BGGT6RBeFVlAKIwp0bA2ZcNxs8FMlDaZenUWeByyGNEwXOh03K3HY6cCeSmVCcPilnZVI2uype56UYCLSl7V6edIWeKR/XoUIlanwK1rmpDxEapA008lTXB74LIYZDfwAlQ4cZNrIz1o5kfOCnKJxMhF5e+GIQVZ3JwyrXamlcuFrPQO8qxeI1o+XpdYsYi0luAqpuMUinIq8QltzNY0hI65eYGnQspXV4xKUKoUM5SS7cD6RfqysWxoYKhtsJ3BRzxXWieFFhm0scosgx0tYFuIEW7OBLr1N9+C3GaQ4FlXuYpCkc85U2INn2oEoy1wmvB+SCfvNpjLY5VWuFaJmRImC1/i53xNoF0gl7QdkntTIQ9R9AnekaX4TIfHYdlwmFGi1stCJzrWh4Vd0iL8vAwmJVg6V68G9UyFz5t5La0GqJK9ShFEukpOYt/MYDG1gtCwzzHM9jb3KMwlvqww6AwQWc1JDrUgApevppV1snL2DjDbGYFHUFqDmOaRto1rb7VjTxARBMDLAQsg8ZuBi+KhH4KTLMSaTLYWaxZD6gwLP3EifxZBkmJzwX0akUsOock4rL1dqdJnqqaqxHGvlrPy8xiJDy7cDOohhJ4bdGO7E0N+OoT+Iob8TQ383hv6dGAbbMQwGMQx2YhjserYGd2qoRYNvm4H+wIPsWuDC9UaXdt4n0rJl05Zpm114urQLH6l+Dzqdxp74819//XWkvhwpgKOI7OsoGh5FDclRFINvo23zKBr2Y6g/nB1FQ7g1+DUQzOj3LqHrf0/pd59Ww//O6Pegf6Tm9aQDZsaJoryEEWr++5kIP2t9oo88M30LWxt9pD3J01ILrRt9bdiihvlCoFskkFTSSZHbi2UKFNdPrAVnK5LtkGSsvReLxc3XT6bAVmjhvdM38V7bagrbADMyWIHgdm9x2lyAgJ/0ugFQc/Wj8u+S/M2edTEIDcn1Q6LN2o/C8WuP3QPety8Goya4flAsGPtRIO4QEHRuXYwCtV4/CGquQkPtC/i27Z1u/3Z3sD3YWYKB4ihPUBTdNO3OZrMfhBAYMHKP6vnZ2aydWe8DUsA6NrpYE6lwILGgqt0n/jt490/Jpx9hEzNTkLgccofwsO2QO52K2Q3rhwpdGz+O6Bde3KzFJjcRHxwqJ5mWSc080QTvbUTRYI9A6BLw6dbTp1stKP3HblEEfCF8pd9dhr79tSh6adpbpV1aodbXAtI0hjXf1zekKRRFcdF330DH5ZG6S4ZQu24X20JNcP3MYcHYWotYOUUyqeqGWjtghcDgpMqFwTOKRa3UiqX/G/abFVsJprJw5jl05ajP53xYLPhlv3bYb9ZqTBIsD0Bfru53TrD2IAYneMZj+KweMSNTzrXFlIDLKLITIS7QKp8t0jj8KxGlpBRCjs7xV3RJb5mJI9Xf5sOnDg4uOX1qiuunbC3OQqPPOFDz4VFUiNp/iMa4+Fu7DM1RdNz08XExpq2+sK4zHLf0UqSENBFzxmLBXiZTzMUI80XbNytrW5x64VvgUEMhVRPOM8vbgQNuFWcrrXXjfI0ZeLHb+hd22KDFAWfIpQ05jWXQ2r3rpA8n4xT61O0IIXSAUXNCrDMLj2srIUSLv5oPsuiWGRMWQtc1OSFehWCv9epcMQPRARM2+bYw2UUT1CIsrUwbFxqjkEoWVdEkDsfNqAGxoj5p23BRT0pKhxnaq3tuBnF2xQx1Vv2CCY5Un8P7kBjgfQHWO2Q1yfXbGFqc/cjGsHR0fe+h8+3mFrhvm9uas4pI/SnVmJq92NZ6sE8nA+UmfSfKNiUJlo4yU0uG2OeUSjtXdPHh0Kb6T+vB6hb8LRqywvffpiU13Y+5J4Ta16lKW4yfpS5Hqu9TVoW/KLkoX1WwUly3raJma+VcjOJIl3w7qtVeGg2jlO5gw81fFPPQaN1vOp1Fwy9RnWSmP+sULvXc+mjpNvdLZJMMC0F/BZbo/ncscxqKsqRobBRHnFWgy2ACLRpG/rY0isk7LukmCC2Nwf2GXwKVv16L4jqyjIaRv3eL4gjPRFEScf0JUCWawjceYh5mvGys5stiLMt/NPegNA5dYH3nMNx1vnIB/l0jtUeYL3BdDCaMEbNo9a493FyFEMT3a1Lz+Sz4BtKRn9HcpjBZFEfSYdGe5YJVM/rbkU5QkyScfPzWvrwsovjmOalfmWn1XR3rm4I1mH8lSr71/MTLS3aPYh9Mg6vZXVzuxcBJ9d5VGhPoWVoxac/pPadzcx5cdOnbumuyma7ylG5xUJge371+98U+13aIPKm41qDZvZcka1htJOvP4+jsamHOINHdcKMMv+Q4dlCVJRpItFFobrZzRddGuMHOzjyOZleLN/t/Kd6vtHjTq6V7w1fxizKFn8HrrTvzOMqu5vWPpljgJzK7sztfnHWRL5hq6o1GOp19CPvW/CrCcKgQHRWv7Kl9k6JpATHSOkehziGxN/Zhq4Yb5IvcqFM1fMcrjQ0HCkxlnoPBBKlehHOsYa+C2unwF8BQX7NRxPuQPrA3Z6uRJSoVxrN+wBGCM3IyQaqKqSmkL4riW2wUSUbVOM5zJcZ0Qc11LgZPpa5sYC8Tli+acySH0WUofWmFVJPlwLiFDtcYtGXvtVeHvtAhx4Vt+wfPvwJLjti74LLmCt1L6ceA/YPnVDkjx7Uf1oNXtkEiQCuWSID8IjiVItyuN3v7zIfkqBgRzcIuFTr16pqVLpxnKJV2LUfxIn3XFPKdG3hRXEVLpCtHVV11NRtYh6VdwpG5aIA80NXXaOUVSAqYVJzvd2SyoYyGU4qLyhepfJUgRyZpZUKxT60WREklgwucAipE1Bo/BlTWdxcwFtahial0kJA3FUUezZB4VqKRqBJcA8HlJuxtfOGH1+pHRVpaWe+FDLa36b8VByDU/flB01YpZD77RxR/fRBwuQsUaiTXuUELD+a3bPCHLVWRZOTCVGatf7ggv3x7bQc3Wzh7nI0eJXJfPt579Xmv/0zu2T314nZyf29376R8+/r+47s9nD3uJ4PXs7eD1+7dm9zufdQy+eNx9l69tqP7t6t3b9+bd2/3zLs3L5x4c/veSGVq9Oh3mcxufxwNtuWT+4+337/pT0ePft9+//pu+Z4H/337/cnJdlI8uz9S94imfPf2v+X+x4e3nn5++PnpwcOzp5/zuz3x7NPH+2fJ3acnD3e77/dM9+n+6M+Pn1z54nZ669lbuXsHn+IbdbD9JIna2iBVLhV+CEv9geX+QIs9Z6XYWbfsL3WBLuMCHLLJqdFUy1jmKKiyzsxATIRUQNCZv1EL0BhtLl/Tb+PsMiB2trc/9BsQbp8HYU9xJprLeg/0Car/rKTt6Z2fnlg9K1jrfZQTSU/E7dGSsO3vXkiLSWWkm0XDwy/RWVeUsuvbh4fH8+M4ImA1xf2ltsyxcFk0jLZW0wBUXc0x5uEXb4ONoVmhUkoWnzM2Ucqt0340j1d7rDXNC6mtExOpJt1Lex0vJH1Jq+EBX5J3EaiV8k+kSK2Gs00VR5K0IENBvg4BSIv8YpEDeRiWKmQn1iYcFmuymkIIGYSlpMDqWbUmzG9F+YchxOaouQmao4VEURPY0p9NqHq40LwmKgxBYZ+jqcHODocdv/bZP791h13fnd35sUe45QZymqnty/jU5NKhHA5qqcaaF6AGZb9E9ZKcAFLz0/55vx/zRBdNZWAg/99//w/3CG4DW+E/YL8yUOopGirV51L1HM8kHbtEzO6H5bQG36eIIkdrKdehHE58lb2c8CViOHMTUYoRFbtTwaVUTvvr+Zbp2x68yZDyo9R0w/j71FPMydwh15rrv50GUTldtCv5YarNyZhYoiL9ERUMoyWnEUMXVJlQCeUqvT7HoA1QvTt5B6WRFkHIgoi5Xn88lomkgWmTMiJxUAglJkiTxRx/EAplKPc1ekROntV55d0YKjpGdF5EzpX24AG5jSw4fUzRCZlj6j0YG3sPst6z6nr6EXnrJU0vE7SLWoscT9Gw/Xr/v8pzKLXzPjkFS+21pYGcEcpShOMZCkvTwFe7WDxHKmY9oLQsnQ/kXpIC5FKdUPV7Fw4bNXuDIysdLmKv6XR6bi+5udznkXRZNQKDpV70m/BH3nna3ZsfN8ny0RR2f/ySnqMkwSO5YM4tJt6qjxiR8BET7FmU8r9WO9B2n8sElcXWgXDv0fMncAq3ettR3No9v4LhrSd79x8+e/mQxqX93dtfv7fd2+aEkbauEKo1FT/RaV7srFpuKz+8edmzedmzedmzedmzedmzedmzedmzedmzedmzedmzedmzednzEwHYvOzZvOzZvOxZU0S6edmzedlztHnZs3nZs3nZs3nZs3nZs3nZs3nZ89M3hs3Lns3Lns3Lns3Lnh952VNXe5AHt1XmQqpWBZ0v9Dlcee9zHEcZFQIND6MvX+ju65XJ53P6/KlCQ1VEx3F0Koyk/C7XEMWhWIbKS05wFg2j+z5d3T2g6WOvkHyfvVI6RbU+vsc9XpZLadu1Ss/3Xx5EcTSq3yQVOqU+RkzpvZKYRsOI9jp+2sSI8qsUwQXnuVCTiiteIj8u1fiIymXLBUInXCBU/9EqnBFq1uJyuXLIi0L/kmBrO/yT7pT/xNm/GnLfcmGHGttATSt4PJ/P/w8bHGHF",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW+9yE7myf5U+84XFNXZiE7LgOnXqssCyYYFwIfxNUqw80/aIzEiDpIljKH87T3If7T7JrW6NxmPHSfizdcit8heIRy2p+6duqbvV+hI5MbHR8DA6wKLMhUMbHcdRijYxsnRSq2gYHWQIoRkeGDF2Uk3g3vM9QCVGOVqoLBoLTkNikIiSyjpdyM/UCi6MHINFc0p9hYVRXmFppHIWxtrABBUawQOnOqkKpIapdBmUBlMcS4UpWGeqxFUGbQ9elVqBrZIErR1XuZ9ZagV6DKKZMwaXIbNq0FVGWRBQKfmpQuh09OgjJm4v7XTglxStnCjhMCXmQvcPMr0ZwzSTSQaJUDBCEjUlSWuGscXuSFCbVjynLTGRY0nE9WA9uJemkngUeT6LQUCnU5m80wFpoTT6VKaYhtn0eEyQCoYWpHJoxiJBxgppFDXhacLgIFQKY5HIXLplGCGV1hk5qmjm3pE6UgeyHMKrMtcihZmuDDx/8PuC3Gmgb4edzgMcVRN4tdfpHP+SOVfa4daWKMueLlERWrkY2V6ii62UCMt0zFihQRqV8UJhZT4DkaYwlekEneUFUZDocgaJ1iaVyqtGKSYIqipGaGzM0hTaIEgFAgyKdNZ1ultZhMcv958RDIVwPXieVzZupkulwcTlMz88wROkuuFXZ3eHdEiqSQyFOCGUpINPlUxOSGyLipe2VhnGqtN5WZWlNqQYb7wIw06HWn7DXE9BGGT6RBeFVlAKIwp0bA2ZcNxs8FMlDaZenUWeByyGNEwXOh03K3HY6cCeSmVCcPilnZVI2uype56UYCLSl7V6edIWeKR/XoUIlanwK1rmpDxEapA008lTXB74LIYZDfwAlQ4cZNrIz1o5kfOCnKJxMhF5e+GIQVZ3JwyrXamlcuFrPQO8qxeI1o+XpdYsYi0luAqpuMUinIq8QltzNY0hI65eYGnQspXV4xKUKoUM5SS7cD6RfqysWxoYKhtsJ3BRzxXWieFFhm0scosgx0tYFuIEW7OBLr1N9+C3GaQ4FlXuYpCkc85U2INn2oEoy1wmvB+SCfvNpjLY5VWuFaJmRImC1/i53xNoF0gl7QdkntTIQ9R9AnekaX4TIfHYdlwmFGi1stCJzrWh4Vd0iL8vAwmJVg6V68G9UyFz5t5La0GqJK9ShFEukpOYt/MYDG1gtCwzzHM9jb3KMwlvqww6AwQWc1JDrUgApevppV1snL2DjDbGYFHUFqDmOaRto1rb7VjTxARBMDLAQsg8ZuBi+KhH4KTLMSaTLYWaxZD6gwLP3EifxZBkmJzwX0akUsOock4rL1dqdJnqqaqxHGvlrPy8xiJDy7cDOohhJ4bdGO7E0N+OoT+Iob8TQ383hv6dGAbbMQwGMQx2YhjserYGd2qoRYNvm4H+wIPsWuDC9UaXdt4n0rJl05Zpm114urQLH6l+Dzqdxp74819//XWkvhwpgKOI7OsoGh5FDclRFINvo23zKBr2Y6g/nB1FQ7g1+DUQzOj3LqHrf0/pd59Ww//O6Pegf6Tm9aQDZsaJoryEEWr++5kIP2t9oo88M30LWxt9pD3J01ILrRt9bdiihvlCoFskkFTSSZHbi2UKFNdPrAVnK5LtkGSsvReLxc3XT6bAVmjhvdM38V7bagrbADMyWIHgdm9x2lyAgJ/0ugFQc/Wj8u+S/M2edTEIDcn1Q6LN2o/C8WuP3QPety8Goya4flAsGPtRIO4QEHRuXYwCtV4/CGquQkPtC/i27Z1u/3Z3sD3YWYKB4ihPUBTdNO3OZrMfhBAYMHKP6vnZ2aydWe8DUsA6NrpYE6lwILGgqt0n/jt490/Jpx9hEzNTkLgccofwsO2QO52K2Q3rhwpdGz+O6Bde3KzFJjcRHxwqJ5mWSc080QTvbUTRYI9A6BLw6dbTp1stKP3HblEEfCF8pd9dhr79tSh6adpbpV1aodbXAtI0hjXf1zekKRRFcdF330DH5ZG6S4ZQu24X20JNcP3MYcHYWotYOUUyqeqGWjtghcDgpMqFwTOKRa3UiqX/G/abFVsJprJw5jl05ajP53xYLPhlv3bYb9ZqTBIsD0Bfru53TrD2IAYneMZj+KweMSNTzrXFlIDLKLITIS7QKp8t0jj8KxGlpBRCjs7xV3RJb5mJI9Xf5sOnDg4uOX1qiuunbC3OQqPPOFDz4VFUiNp/iMa4+Fu7DM1RdNz08XExpq2+sK4zHLf0UqSENBFzxmLBXiZTzMUI80XbNytrW5x64VvgUEMhVRPOM8vbgQNuFWcrrXXjfI0ZeLHb+hd22KDFAWfIpQ05jWXQ2r3rpA8n4xT61O0IIXSAUXNCrDMLj2srIUSLv5oPsuiWGRMWQtc1OSFehWCv9epcMQPRARM2+bYw2UUT1CIsrUwbFxqjkEoWVdEkDsfNqAGxoj5p23BRT0pKhxnaq3tuBnF2xQx1Vv2CCY5Un8P7kBjgfQHWO2Q1yfXbGFqc/cjGsHR0fe+h8+3mFrhvm9uas4pI/SnVmJq92NZ6sE8nA+UmfSfKNiUJlo4yU0uG2OeUSjtXdPHh0Kb6T+vB6hb8LRqywvffpiU13Y+5J4Ta16lKW4yfpS5Hqu9TVoW/KLkoX1WwUly3raJma+VcjOJIl3w7qtVeGg2jlO5gw81fFPPQaN1vOp1Fwy9RnWSmP+sULvXc+mjpNvdLZJMMC0F/BZbo/ncscxqKsqRobBRHnFWgy2ACLRpG/rY0isk7LukmCC2Nwf2GXwKVv16L4jqyjIaRv3eL4gjPRFEScf0JUCWawjceYh5mvGys5stiLMt/NPegNA5dYH3nMNx1vnIB/l0jtUeYL3BdDCaMEbNo9a493FyFEMT3a1Lz+Sz4BtKRn9HcpjBZFEfSYdGe5YJVM/rbkU5QkyScfPzWvrwsovjmOalfmWn1XR3rm4I1mH8lSr71/MTLS3aPYh9Mg6vZXVzuxcBJ9d5VGhPoWVoxac/pPadzcx5cdOnbumuyma7ylG5xUJge371+98U+13aIPKm41qDZvZcka1htJOvP4+jsamHOINHdcKMMv+Q4dlCVJRpItFFobrZzRddGuMHOzjyOZleLN/t/Kd6vtHjTq6V7w1fxizKFn8HrrTvzOMqu5vWPpljgJzK7sztfnHWRL5hq6o1GOp19CPvW/CrCcKgQHRWv7Kl9k6JpATHSOkehziGxN/Zhq4Yb5IvcqFM1fMcrjQ0HCkxlnoPBBKlehHOsYa+C2unwF8BQX7NRxPuQPrA3Z6uRJSoVxrN+wBGCM3IyQaqKqSmkL4riW2wUSUbVOM5zJcZ0Qc11LgZPpa5sYC8Tli+acySH0WUofWmFVJPlwLiFDtcYtGXvtVeHvtAhx4Vt+wfPvwJLjti74LLmCt1L6ceA/YPnVDkjx7Uf1oNXtkEiQCuWSID8IjiVItyuN3v7zIfkqBgRzcIuFTr16pqVLpxnKJV2LUfxIn3XFPKdG3hRXEVLpCtHVV11NRtYh6VdwpG5aIA80NXXaOUVSAqYVJzvd2SyoYyGU4qLyhepfJUgRyZpZUKxT60WREklgwucAipE1Bo/BlTWdxcwFtahial0kJA3FUUezZB4VqKRqBJcA8HlJuxtfOGH1+pHRVpaWe+FDLa36b8VByDU/flB01YpZD77RxR/fRBwuQsUaiTXuUELD+a3bPCHLVWRZOTCVGatf7ggv3x7bQc3Wzh7nI0eJXJfPt579Xmv/0zu2T314nZyf29376R8+/r+47s9nD3uJ4PXs7eD1+7dm9zufdQy+eNx9l69tqP7t6t3b9+bd2/3zLs3L5x4c/veSGVq9Oh3mcxufxwNtuWT+4+337/pT0ePft9+//pu+Z4H/337/cnJdlI8uz9S94imfPf2v+X+x4e3nn5++PnpwcOzp5/zuz3x7NPH+2fJ3acnD3e77/dM9+n+6M+Pn1z54nZ669lbuXsHn+IbdbD9JIna2iBVLhV+CEv9geX+QIs9Z6XYWbfsL3WBLuMCHLLJqdFUy1jmKKiyzsxATIRUQNCZv1EL0BhtLl/Tb+PsMiB2trc/9BsQbp8HYU9xJprLeg/0Car/rKTt6Z2fnlg9K1jrfZQTSU/E7dGSsO3vXkiLSWWkm0XDwy/RWVeUsuvbh4fH8+M4ImA1xf2ltsyxcFk0jLZW0wBUXc0x5uEXb4ONoVmhUkoWnzM2Ucqt0340j1d7rDXNC6mtExOpJt1Lex0vJH1Jq+EBX5J3EaiV8k+kSK2Gs00VR5K0IENBvg4BSIv8YpEDeRiWKmQn1iYcFmuymkIIGYSlpMDqWbUmzG9F+YchxOaouQmao4VEURPY0p9NqHq40LwmKgxBYZ+jqcHODocdv/bZP791h13fnd35sUe45QZymqnty/jU5NKhHA5qqcaaF6AGZb9E9ZKcAFLz0/55vx/zRBdNZWAg/99//w/3CG4DW+E/YL8yUOopGirV51L1HM8kHbtEzO6H5bQG36eIIkdrKdehHE58lb2c8CViOHMTUYoRFbtTwaVUTvvr+Zbp2x68yZDyo9R0w/j71FPMydwh15rrv50GUTldtCv5YarNyZhYoiL9ERUMoyWnEUMXVJlQCeUqvT7HoA1QvTt5B6WRFkHIgoi5Xn88lomkgWmTMiJxUAglJkiTxRx/EAplKPc1ekROntV55d0YKjpGdF5EzpX24AG5jSw4fUzRCZlj6j0YG3sPst6z6nr6EXnrJU0vE7SLWoscT9Gw/Xr/v8pzKLXzPjkFS+21pYGcEcpShOMZCkvTwFe7WDxHKmY9oLQsnQ/kXpIC5FKdUPV7Fw4bNXuDIysdLmKv6XR6bi+5udznkXRZNQKDpV70m/BH3nna3ZsfN8ny0RR2f/ySnqMkwSO5YM4tJt6qjxiR8BET7FmU8r9WO9B2n8sElcXWgXDv0fMncAq3ettR3No9v4LhrSd79x8+e/mQxqX93dtfv7fd2+aEkbauEKo1FT/RaV7srFpuKz+8edmzedmzedmzedmzedmzedmzedmzedmzedmzedmzedmzednzEwHYvOzZvOzZvOxZU0S6edmzedlztHnZs3nZs3nZs3nZs3nZs3nZs3nZ89M3hs3Lns3Lns3Lns3Lnh952VNXe5AHt1XmQqpWBZ0v9Dlcee9zHEcZFQIND6MvX+ju65XJ53P6/KlCQ1VEx3F0Koyk/C7XEMWhWIbKS05wFg2j+z5d3T2g6WOvkHyfvVI6RbU+vsc9XpZLadu1Ss/3Xx5EcTSq3yQVOqU+RkzpvZKYRsOI9jp+2sSI8qsUwQXnuVCTiiteIj8u1fiIymXLBUInXCBU/9EqnBFq1uJyuXLIi0L/kmBrO/yT7pT/xNm/GnLfcmGHGttATSt4PJ/P/w8bHGHF",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"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(a.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.50bb866e.js b/assets/js/0028a090.50bb866e.js new file mode 100644 index 000000000..d0dd59f29 --- /dev/null +++ b/assets/js/0028a090.50bb866e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>m,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),p=s(9472),h=s(85162);const m={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:"eJztO9ty27iSv9KHL5moKNlSHE+i2tpaT+LJKBNfNnbiJJYrgciWiJgEGAC0rKT0dr5kP22/ZKsBgqRk+ZJkao5PrV4Si2g0uhvoCxrd3wLDJjronwbHmOUpM6iDszCIUUeK54ZLEfSD4wTBD8NzxcaGiwnsHA4ABRulqKHQqDQYCZFCAooKbWTGv9IoGI85BI3qguYyDaO0wFxxYTSMpYIJClTMIo5lVGRIA1NuEsgVxjjmAmPQRhWRKRTqDrzJpQBdRBFqPS5StzKXAuQYWLVmCCZBS6pCUyihgUEh+JcCodWSo88YmUHcasEvMWo+EcxgTMT56R95/DCEacKjBCImYITEakyclgRjg9wRozEp7Jo6x4iPOQGXyDqwE8ecaGRpOguBQatVqLTVAq4hV/KCxxj71eR4TCJlVrTAhUE1ZhFaWSFhERO7jEcOTMQwZhFPuVkUI8RcG8VHBa3cGYqhOOZ5H97kqWQxzGSh4PD57zW4kUDfTlut5zgqJvBm0Gqd/ZIYk+v+xgbL847MUZC0UjbSnUhmGzEB5vHYygoVElYrL2SapzNgcQxTHk/QaLshAiKZzyCSUsVcuKORswmCKLIRKh1abjKpELgABgpZPGsb2S40wsujg30SQ8ZMBw7TQofVcjFXGJl05tCTeDxXD9zubG/RGeJiEkLGzklK3MCXgkfnxLZGYbe2PDKdoQAAGIpW64RoriTEdXnOYwCTcA1THCVSngNe0PCUpykYxScTVK2WRfLp0yeH7Jv7z+INLPgw6MMwKPENg7AJ4A/oMOgPg+cHz97s7e4ffxw8HwZNqDFP0WGpQN68frWESrBsGWh/Z293GUqaEuowRaYRFF5wnNrtoB137HpBLE1uGA2HY2mcEKDSNHZaf1+QyTKtR4MX+7uvr1Jayi9jPF0A3N3bGbxaAZknUiyiPPzjYH8VzkI1MA72XzhRNqHm9Y+zBf7KPdwpt/R4sLd7dLyzd+inz4fi06dP9jwdFXkuFR2gE6cWfTooQ/EbpnIKTKE9g5HMMikgZ4plaKyFTZixwwq/FFxh7EwkS1OvX31C04ZWy8xy7LdaMBAxj0jFnLmY5UgW0kF3HCipHoEelSbLgTYUkmyaM0ukaVPmrESekkEiUIVk7Qy/wEXElyHMCPFzpIPl0CZS8a9SGJbaU3WByvCIpU1jQARaE2qYsqYsl1wY/7VcAd6XSk82wap6aa2ItJjElXFhRzTCBUsL1CVV0xASouo15gq1tdwlXhKliCFBPkmuXY/FnwttFhBDob099lSUa/l9suJFK7YxSzUCHy/IMmPn2FgNZO78RAd+m0GMY1akJgROdsyoAjuwLw2wPE95ZH0suQXnwAqFbbvL5YEoCSGdIiIOnZ8hzxJz8jFksWjQoijneOropDnHROxZe2wSJkCKpY2OZCoVoV86Q/b7oiAhksKgMB3YuWA8tdQ7bjVwEaVFjDBKWXQe2hAhBEVOkbZlhmkqp6E78hbEumordCsg0JjSMZSCGBCyXJ7r2hl3jsmAVRpFY17Udg2um1ItfcFY0sIkAq9kYE1PaAUXwmc5AsNNiiGpbM7ELITYBR94aUbyMoQowejc/qVYzCWMCmOkcHzFSuaxnIpSlmMpjOZfV2ikH/l+gfZC2AphO4QnIXQ3Q+j2QuhuhdDdDqH7JITeZgi9Xgi9rRB6246s3pNS1KySb5OAbs8J2TSEC/dbumR5X3FtNZtMpq6s8HTBCg9FtwOtVqVP9rN14dZVDQPSL+uTK5BhEIIbI7M5DPrdEMoPl+QOHvV+9QAz+r1N0nW/p/S7S7vhfif0u9cdinm5aM8SY1iW30AIDf/1RPif5Xmij6W3HgbetNFHskkOdtF/l2TRwLxm6BExxAU3nKX6ep48xP1jq6ZsibMt4sye3uvZKqOW+8aTJ8uPWNvphqytbQx5M2AJ6S2J4HGn9jbXSMAtet8EUFL1s/xvE/+VzbpeCBXI/ZNEk7SfFcevHRseWLt9vTBKgPsnipqwnxXEExIE+a3rpUCj908EJVV+oIwF3NjmVrv7uN3b7G0tiIHu5g4gy9px3J7NZj8pQneDpvCoXN8Gm2Uw62JASoKMlcxW3FTsRaKGKsMn+7eP7vcoph9hlYehxMNiGsenHJoBuZExmz3QDpWfWsVxBF9HcbMGmXaI6LDplyiRPCqJJxgfvY3oNmizEG0SfLyxt7fREKX72M4yL1/wX+l324q++TXLOnHcWYZd2KHG1wziOIQV31cPxDFkWXbddzdA7nIonpIilKHb9bpQAvw96rDi1NfrX6sr9QCLpUjt+vZyt1pXlvxLwn3upzw3sASgcFKkTOEl3VK1S6o0cio/bomWtMgrUR3m20utvQ+6DKOVBPxyUIbyD8sDThwsIqAvt8+7wlgTicIJXlocLodMxPDYZnZDSvcmdOdj/sZAYq+ThvZXxHJOyYUUjbFf0USdVUS4TWtczGlTl+/lGs0CM0yDn7niam533140upvW75X3khscXwlx/8x+gzI/6JIdLn8XZKwMXYIx1n9Lk6AaBmfVHHclx7gxF1ZNhrMb9AlqpYkxZSNMr+ranbWhyU55shrCoYGMiyqTYEne9BTYUXa5NFoOzlfomWO7ecC9cfdq4uUMKdc+nbIotObsMt9k84AC3UvECMFPgFF1JH/6yFeE3e3MO4tQbs8tSxAcWMAq1+dXu2WFha1pCoZwZFzwrMiqpOW4wupFlpVevikvmkmPLH6F5vZeWYFd3rJC+Up0zQJD0bWpBZ+UsIYBVgeDJcj9swwNym53gT9iMxbc5o86vO/XRM9XUxNX+EkCdR6y0kJ9vRp24IC8EmVM3STKgUUR5obyZT+roxXJd9PRrk0lNXNk13umJtTffQavO0x3OZ1LdP9l57CE+7ngi6R2t8PYZOPf6EAukH3nYMklBDP3DHVdNjCzR+++GcOSrCXXH4SBzG09gxSDOOgHMVVN+Lf6ILSoUZvfZDwL+t+CMoVPf5YJcpq58VlT/cW3QEcJZoz+8iRRxQa9+wahf1YNwsDmbKh8g4QW9Mvn4yCkG0ZO72yoCYed1//modyDeBCW9/agH7iX8iAM8JJlOQGXnwBFJOlybFHM/Yo34aq+1Li0/aOqXCA89Dz4g2js1PlSycoPYWpimNdyrZExpdgsWK6O8e+C/hrn5lUPH+nM6wo3pBHVW5UFC8KAG8yaq1yza0p+v6QjlMSJTe1+71y7LSz77jVpnn1u/5GJ5TvMCpnfUUpu9OrCi1u2Q/dHjH003a6fTkOwTxad206Mh7fcsklzTRcbXlnz+Lon9cZLnk5kkcb0RoZMdezL9g+X4thqLJZGha0OqnzEAmcVqRVn3XkYXN7OzCVEsu3f6+GXFMcGijxHBZFUAtXDZibu3jDX29qah8HsdvZm/5bs/UqbN72duxNb6FAXgfwraH30ZB4Gye20/lGVYvwLid3ante+rizzqSoERzKeffR2a34boHcqBEflZgNxoGJUDUGMpEyRiSuSGIxdkCXhAcUiD8p0l31B50p7h+KqzxRGSNU4NoPtbRWUQYd7XofyEZNis136YGNGXYw0QQmPTzuEI/QVbVSG6SC4K2O0NQLIooTq54yjio3p+d9WEVEFmSy0Jy9h2j7jp0hhqUmQu8IVLiaLMWJDOraCo8l7p7k79IWcnC1FPTg+vIMsbQTbdsVszk87Lh0OODg+pLokPi7jsA680ZUkvGjZAghQXAQXnPnahcq2z1zSAYWViPRldHVpYqesCGrDVYJirldSFNYp0Kr09griuhyStkgWhuowy/pT0AZzvSBHS0UlyGNZ3OVU3iJJBpPCvqYYUllfpGTTsnVdEReurtfef+JC+VKq8lgQJBX51nLyUiGgBv4QUGg3ncGYaYMqpGJfkrwq6H5TocTLHBVHEeEKEdyswk7H6zi8PH5UAieFdlFIb3OT/lsKAHylrq8drYuX09k/gvDul4CbQyBfNLoqDKojmN+S3h86F1mUUAhTqJXxYQ1+s3ltXm42cPYyGb2I+AF/OXjzddDd5wM9EK8fR88G24Pz/N3bZy+fdnD2shv13s7e9d6a9yepHnyWPPrjZfJBvNWjZ4+L9+8+qPfvBur9yWvDTh7vjEQiRi9+59Hs8edRb5O/evZy88NJdzp68fvmh7dP8w8W+e+bH87PN6Ns/9lI7BBM/v7df/ODz7uP9r7uft073r3c+5o+7bD9L5+fXUZP9853t9sfBqq9dzD68/MXk79+HD/af8e3n+AenojjzVdR0DwNXKRc4Ee/1R8t3x9ps+f2UGyt2vYjmaFJbHmTLQ5WkqqPc1dea9QM2IRxASQ69ReeAlRKqpv39Psou0kQW5ubH7uVEB5fFcJA2GS7LcQ/luco/l5Om8sbtzyRepnZU+9uOQF3QHY8WGC2+d0xqTEqFDezoH/6Lbhss5y33Xj/9Gx+FgYkWEn3/lxqSzEzSdAPNpbTANQPYe+Yp9+cDlaKppmIKR1+RdlYzjcuusE8XJ6xUjWvhdaGTbiYtG+cdVZzekS74QS+wG99Ucv5n0g3tVKcTagw4HQKEmQU65AAaZNf1zmQXb9VPjuxMuFQ78lyCsFnEBaSAsu+asU1v3HLP/VXbHtrri7NQc1RUF1s6c/qqnpan7zqVugvhV17m+ptbdlrx69dG58/emJD363t+ZmTcCMMtGmmZizjEqALTtk7ai7G0m5AKZSDHMURBQF0zC+6V+N+TCOZVXWXHvx///k/doYPG6wW/gMOCgW5nKKi5hrbXJLiJSe3S8A2/NA2rWGzfyxLUWvKdQiDE9cXwyf2Idb73IjlbETtKVTOyoWRrvihofq6AycJUhaWhh4o9yZ9gSmpO6RS2o4NI4EVRmbN3huYSnU+JpKorWZE5dioKWhEPwVFwkREGVF3nkOQCqhDhaKDXHGNwHhGwLbDZjzmESfEZKQUiwxkTLAJ0mKhvX+QFHJfTK3kiII8LdPChTFU0o1oHIs2I9uB5xQ2WsbpY4yG8RRjF8Ho0EWQpc0qO2BGFK3ntDyPUNeVLCleoLL66+L/Ik0hl8bF5HRZau4tITKKCU03HEeQ35pKfGWIZdeI2awDlJYl/0DhJR2AlItz6i1ow2l1zE5wpLnB+u41nU6v2JKHi3NecJMUI1CYy3rexH60lqc5vfrxkDQfVaYPxkfUQBb5iOSaNTcs8EbpYlhkXYzXZ5bz/1qeQOY+5REKjQ2HsPPi8BVcwKPOZhA2rOcdCN54NXi2u3+0S3jJvjv963Y2O5s2YSS1yZhoLGWb6qoeu2XNbeSH17146168dS/euhdv3YsHsO7FW/firXvx1r146168dS/euhdv3Ys3XPfiDde9eOtevHUv3roXrxbDuhdv3Yu37sVb9+Kte/HWvXjrXrx1L966F2/di7fuxVv34q178da9eP9fevHK+iwKHDfylHHRqHl1pXmnSx16Z2GQUOle/zT49o1eq9+odD6nz18KVFT3dxYGF0xxyp7bqr/Ql7dRQdg5zoJ+8Mw9BrSPafnQHXtbgbJU7EjVeW7Gjt38G2Gb1YWHB0fHQRiMyi7CTMY0R7EpdRiyadAPyGbbZkQrUdtHxmyLSMrEpLA1aoHDS1V5rDDJYknfuS3pK/9olLoxMWtQuVjr51ihf4mxlRP+g6pA/sTZf1bgbuTaCaVsPTTt4Nl8Pv8/iWWU7w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztO9ty27iSv9KHL5moKNlSHE+i2tpaT+LJKBNfNnbiJJYrgciWiJgEGAC0rKT0dr5kP22/ZKsBgqRk+ZJkao5PrV4Si2g0uhvoCxrd3wLDJjronwbHmOUpM6iDszCIUUeK54ZLEfSD4wTBD8NzxcaGiwnsHA4ABRulqKHQqDQYCZFCAooKbWTGv9IoGI85BI3qguYyDaO0wFxxYTSMpYIJClTMIo5lVGRIA1NuEsgVxjjmAmPQRhWRKRTqDrzJpQBdRBFqPS5StzKXAuQYWLVmCCZBS6pCUyihgUEh+JcCodWSo88YmUHcasEvMWo+EcxgTMT56R95/DCEacKjBCImYITEakyclgRjg9wRozEp7Jo6x4iPOQGXyDqwE8ecaGRpOguBQatVqLTVAq4hV/KCxxj71eR4TCJlVrTAhUE1ZhFaWSFhERO7jEcOTMQwZhFPuVkUI8RcG8VHBa3cGYqhOOZ5H97kqWQxzGSh4PD57zW4kUDfTlut5zgqJvBm0Gqd/ZIYk+v+xgbL847MUZC0UjbSnUhmGzEB5vHYygoVElYrL2SapzNgcQxTHk/QaLshAiKZzyCSUsVcuKORswmCKLIRKh1abjKpELgABgpZPGsb2S40wsujg30SQ8ZMBw7TQofVcjFXGJl05tCTeDxXD9zubG/RGeJiEkLGzklK3MCXgkfnxLZGYbe2PDKdoQAAGIpW64RoriTEdXnOYwCTcA1THCVSngNe0PCUpykYxScTVK2WRfLp0yeH7Jv7z+INLPgw6MMwKPENg7AJ4A/oMOgPg+cHz97s7e4ffxw8HwZNqDFP0WGpQN68frWESrBsGWh/Z293GUqaEuowRaYRFF5wnNrtoB137HpBLE1uGA2HY2mcEKDSNHZaf1+QyTKtR4MX+7uvr1Jayi9jPF0A3N3bGbxaAZknUiyiPPzjYH8VzkI1MA72XzhRNqHm9Y+zBf7KPdwpt/R4sLd7dLyzd+inz4fi06dP9jwdFXkuFR2gE6cWfTooQ/EbpnIKTKE9g5HMMikgZ4plaKyFTZixwwq/FFxh7EwkS1OvX31C04ZWy8xy7LdaMBAxj0jFnLmY5UgW0kF3HCipHoEelSbLgTYUkmyaM0ukaVPmrESekkEiUIVk7Qy/wEXElyHMCPFzpIPl0CZS8a9SGJbaU3WByvCIpU1jQARaE2qYsqYsl1wY/7VcAd6XSk82wap6aa2ItJjElXFhRzTCBUsL1CVV0xASouo15gq1tdwlXhKliCFBPkmuXY/FnwttFhBDob099lSUa/l9suJFK7YxSzUCHy/IMmPn2FgNZO78RAd+m0GMY1akJgROdsyoAjuwLw2wPE95ZH0suQXnwAqFbbvL5YEoCSGdIiIOnZ8hzxJz8jFksWjQoijneOropDnHROxZe2wSJkCKpY2OZCoVoV86Q/b7oiAhksKgMB3YuWA8tdQ7bjVwEaVFjDBKWXQe2hAhBEVOkbZlhmkqp6E78hbEumordCsg0JjSMZSCGBCyXJ7r2hl3jsmAVRpFY17Udg2um1ItfcFY0sIkAq9kYE1PaAUXwmc5AsNNiiGpbM7ELITYBR94aUbyMoQowejc/qVYzCWMCmOkcHzFSuaxnIpSlmMpjOZfV2ikH/l+gfZC2AphO4QnIXQ3Q+j2QuhuhdDdDqH7JITeZgi9Xgi9rRB6246s3pNS1KySb5OAbs8J2TSEC/dbumR5X3FtNZtMpq6s8HTBCg9FtwOtVqVP9rN14dZVDQPSL+uTK5BhEIIbI7M5DPrdEMoPl+QOHvV+9QAz+r1N0nW/p/S7S7vhfif0u9cdinm5aM8SY1iW30AIDf/1RPif5Xmij6W3HgbetNFHskkOdtF/l2TRwLxm6BExxAU3nKX6ep48xP1jq6ZsibMt4sye3uvZKqOW+8aTJ8uPWNvphqytbQx5M2AJ6S2J4HGn9jbXSMAtet8EUFL1s/xvE/+VzbpeCBXI/ZNEk7SfFcevHRseWLt9vTBKgPsnipqwnxXEExIE+a3rpUCj908EJVV+oIwF3NjmVrv7uN3b7G0tiIHu5g4gy9px3J7NZj8pQneDpvCoXN8Gm2Uw62JASoKMlcxW3FTsRaKGKsMn+7eP7vcoph9hlYehxMNiGsenHJoBuZExmz3QDpWfWsVxBF9HcbMGmXaI6LDplyiRPCqJJxgfvY3oNmizEG0SfLyxt7fREKX72M4yL1/wX+l324q++TXLOnHcWYZd2KHG1wziOIQV31cPxDFkWXbddzdA7nIonpIilKHb9bpQAvw96rDi1NfrX6sr9QCLpUjt+vZyt1pXlvxLwn3upzw3sASgcFKkTOEl3VK1S6o0cio/bomWtMgrUR3m20utvQ+6DKOVBPxyUIbyD8sDThwsIqAvt8+7wlgTicIJXlocLodMxPDYZnZDSvcmdOdj/sZAYq+ThvZXxHJOyYUUjbFf0USdVUS4TWtczGlTl+/lGs0CM0yDn7niam533140upvW75X3khscXwlx/8x+gzI/6JIdLn8XZKwMXYIx1n9Lk6AaBmfVHHclx7gxF1ZNhrMb9AlqpYkxZSNMr+ranbWhyU55shrCoYGMiyqTYEne9BTYUXa5NFoOzlfomWO7ecC9cfdq4uUMKdc+nbIotObsMt9k84AC3UvECMFPgFF1JH/6yFeE3e3MO4tQbs8tSxAcWMAq1+dXu2WFha1pCoZwZFzwrMiqpOW4wupFlpVevikvmkmPLH6F5vZeWYFd3rJC+Up0zQJD0bWpBZ+UsIYBVgeDJcj9swwNym53gT9iMxbc5o86vO/XRM9XUxNX+EkCdR6y0kJ9vRp24IC8EmVM3STKgUUR5obyZT+roxXJd9PRrk0lNXNk13umJtTffQavO0x3OZ1LdP9l57CE+7ngi6R2t8PYZOPf6EAukH3nYMklBDP3DHVdNjCzR+++GcOSrCXXH4SBzG09gxSDOOgHMVVN+Lf6ILSoUZvfZDwL+t+CMoVPf5YJcpq58VlT/cW3QEcJZoz+8iRRxQa9+wahf1YNwsDmbKh8g4QW9Mvn4yCkG0ZO72yoCYed1//modyDeBCW9/agH7iX8iAM8JJlOQGXnwBFJOlybFHM/Yo34aq+1Li0/aOqXCA89Dz4g2js1PlSycoPYWpimNdyrZExpdgsWK6O8e+C/hrn5lUPH+nM6wo3pBHVW5UFC8KAG8yaq1yza0p+v6QjlMSJTe1+71y7LSz77jVpnn1u/5GJ5TvMCpnfUUpu9OrCi1u2Q/dHjH003a6fTkOwTxad206Mh7fcsklzTRcbXlnz+Lon9cZLnk5kkcb0RoZMdezL9g+X4thqLJZGha0OqnzEAmcVqRVn3XkYXN7OzCVEsu3f6+GXFMcGijxHBZFUAtXDZibu3jDX29qah8HsdvZm/5bs/UqbN72duxNb6FAXgfwraH30ZB4Gye20/lGVYvwLid3ante+rizzqSoERzKeffR2a34boHcqBEflZgNxoGJUDUGMpEyRiSuSGIxdkCXhAcUiD8p0l31B50p7h+KqzxRGSNU4NoPtbRWUQYd7XofyEZNis136YGNGXYw0QQmPTzuEI/QVbVSG6SC4K2O0NQLIooTq54yjio3p+d9WEVEFmSy0Jy9h2j7jp0hhqUmQu8IVLiaLMWJDOraCo8l7p7k79IWcnC1FPTg+vIMsbQTbdsVszk87Lh0OODg+pLokPi7jsA680ZUkvGjZAghQXAQXnPnahcq2z1zSAYWViPRldHVpYqesCGrDVYJirldSFNYp0Kr09griuhyStkgWhuowy/pT0AZzvSBHS0UlyGNZ3OVU3iJJBpPCvqYYUllfpGTTsnVdEReurtfef+JC+VKq8lgQJBX51nLyUiGgBv4QUGg3ncGYaYMqpGJfkrwq6H5TocTLHBVHEeEKEdyswk7H6zi8PH5UAieFdlFIb3OT/lsKAHylrq8drYuX09k/gvDul4CbQyBfNLoqDKojmN+S3h86F1mUUAhTqJXxYQ1+s3ltXm42cPYyGb2I+AF/OXjzddDd5wM9EK8fR88G24Pz/N3bZy+fdnD2shv13s7e9d6a9yepHnyWPPrjZfJBvNWjZ4+L9+8+qPfvBur9yWvDTh7vjEQiRi9+59Hs8edRb5O/evZy88NJdzp68fvmh7dP8w8W+e+bH87PN6Ns/9lI7BBM/v7df/ODz7uP9r7uft073r3c+5o+7bD9L5+fXUZP9853t9sfBqq9dzD68/MXk79+HD/af8e3n+AenojjzVdR0DwNXKRc4Ee/1R8t3x9ps+f2UGyt2vYjmaFJbHmTLQ5WkqqPc1dea9QM2IRxASQ69ReeAlRKqpv39Psou0kQW5ubH7uVEB5fFcJA2GS7LcQ/luco/l5Om8sbtzyRepnZU+9uOQF3QHY8WGC2+d0xqTEqFDezoH/6Lbhss5y33Xj/9Gx+FgYkWEn3/lxqSzEzSdAPNpbTANQPYe+Yp9+cDlaKppmIKR1+RdlYzjcuusE8XJ6xUjWvhdaGTbiYtG+cdVZzekS74QS+wG99Ucv5n0g3tVKcTagw4HQKEmQU65AAaZNf1zmQXb9VPjuxMuFQ78lyCsFnEBaSAsu+asU1v3HLP/VXbHtrri7NQc1RUF1s6c/qqnpan7zqVugvhV17m+ptbdlrx69dG58/emJD363t+ZmTcCMMtGmmZizjEqALTtk7ai7G0m5AKZSDHMURBQF0zC+6V+N+TCOZVXWXHvx///k/doYPG6wW/gMOCgW5nKKi5hrbXJLiJSe3S8A2/NA2rWGzfyxLUWvKdQiDE9cXwyf2Idb73IjlbETtKVTOyoWRrvihofq6AycJUhaWhh4o9yZ9gSmpO6RS2o4NI4EVRmbN3huYSnU+JpKorWZE5dioKWhEPwVFwkREGVF3nkOQCqhDhaKDXHGNwHhGwLbDZjzmESfEZKQUiwxkTLAJ0mKhvX+QFHJfTK3kiII8LdPChTFU0o1oHIs2I9uB5xQ2WsbpY4yG8RRjF8Ho0EWQpc0qO2BGFK3ntDyPUNeVLCleoLL66+L/Ik0hl8bF5HRZau4tITKKCU03HEeQ35pKfGWIZdeI2awDlJYl/0DhJR2AlItz6i1ow2l1zE5wpLnB+u41nU6v2JKHi3NecJMUI1CYy3rexH60lqc5vfrxkDQfVaYPxkfUQBb5iOSaNTcs8EbpYlhkXYzXZ5bz/1qeQOY+5REKjQ2HsPPi8BVcwKPOZhA2rOcdCN54NXi2u3+0S3jJvjv963Y2O5s2YSS1yZhoLGWb6qoeu2XNbeSH17146168dS/euhdv3YsHsO7FW/firXvx1r146168dS/euhdv3Ys3XPfiDde9eOtevHUv3roXrxbDuhdv3Yu37sVb9+Kte/HWvXjrXrx1L966F2/di7fuxVv34q178da9eP9fevHK+iwKHDfylHHRqHl1pXmnSx16Z2GQUOle/zT49o1eq9+odD6nz18KVFT3dxYGF0xxyp7bqr/Ql7dRQdg5zoJ+8Mw9BrSPafnQHXtbgbJU7EjVeW7Gjt38G2Gb1YWHB0fHQRiMyi7CTMY0R7EpdRiyadAPyGbbZkQrUdtHxmyLSMrEpLA1aoHDS1V5rDDJYknfuS3pK/9olLoxMWtQuVjr51ihf4mxlRP+g6pA/sTZf1bgbuTaCaVsPTTt4Nl8Pv8/iWWU7w==",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"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:' {\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.1ed86312.js b/assets/js/2c586be5.1ed86312.js new file mode 100644 index 000000000..76c0f3498 --- /dev/null +++ b/assets/js/2c586be5.1ed86312.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"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:"eJztW+FyGzeSfpXe+eNYNaREWna8rKurdezcnm6TSLVSKrUlqRRwpknCmgEmAEYUo+K/e5J7tH2SrW4AM0OKlGQ7lVXq6B8WB2gAjQ+NRnejcZc4MbXJ6Dz5oLO6ROVscpkmOdrMyMpJrZJRcjZDeG9QOIRIBe9OjkAUhZ5bqC0aC07DFBUaolI4hzz2B+MFVEbfyFyqKeTCCZhLN4OxsPjmEFBlOsccJrLA/oW6UGeyGsGPVaFFDgtdGzj58F9NbzQMlZ3v7X3AcT2FH4/29i6/mjlX2dH+vqiqvq5QWTlVhRjbfqbL/ZwIq3zyMoX5DA1Sr5AJBSisLBYg8hzmMp+isym4GSrIdLWATGuTSyUc2hQqMUVQdTlGY1MQKodSGwSpQIBBkS96Tvdqi/A/p8c/wESbUrg+nBS1TZvhcmkwc8XCd+9m2MzqhY1oWGekmqZQimtCSzr4pZbZNU3bosrpLzV8d3LEWO3tndZVpY3DHH7yUxjt7VHNN1joOQiDTJ/pstQKKmFEiY6XayYcVxv8pZYGc78ooigiFqML1YO9PbeocLS3B0cqlxmBwR1SKehJoO17UgKJSE8rzOREBtIOdKAVzGcymzEmc+HXsypE5tk0aCvMnLzB1Y5vU1hQxx9Q6cjBTBv5q1ZOFLwcN2iczETRXTZikEitE8YRnJWWysXSMAL8IywPrR4vSpArYi0nsEqpuMYi3IiiRhu4mqcwI67+jpVBy6Ie+iUgVQ4zlNPZ1vFE/rG2bqVjqC2x2eUijBVXieFFhm0iCosgJytYluIaO6OB5j0sij58s4AcJ6IuXAqSJM6ZGvvwg3YgqqqQmRgXSJILtHmEqw32eJWDOARGlCh5jU94R6MFAbmcTNDQ5qRK7iK0idyRnLUqgHeOmwkFWq0tdKYLbaj7NRni8lUgIdPKoXJ9eHcjZMHc+9lakCor6hxhXIjsOoVxUWMKBnO/cxdIeisNWohIQNgAOgMEFgsSQ61oAkqH4aUFG7jK+3A2k7bdUFQZseZBpO3CGrbtRNPIhEHcY4ClkEXKyKXwUY/BSVdgSju2EmqRksLEFBzeurG+TSGbYXbNv4zIpYZx7ZxWfmK50VWu5yqAOdHKWfnrhi0Zaz4d0WEKhym8SeFtCoODFAbDFAaHKQzepDB4m8LwIIXhMIXhYQrDN56t4duAtWgA7jIwGHqU3R8HXVK830nLW5s0pm2U8HxFCV+oQR/29poNxcU///zzhbq7UAAXCW2wi2R0kTQkF0kKvo705kUyGqQQCm4vkhG8Gn4dCRb0/YbQ9d9z+h7QavjvGX0PBxdqGQYdMjNOlNUDjFD1b89E/AzyRIU8MpVF3UaFpJQ8LdXQulFpwxZVLNsJvaIJSSWdFIXdPqdI8fym1XK2NrNDmhlL7/ZpcfXzm1NkK9aw8vRVrGw7VVENMCPDNQhe99vjZgsCftDnBkDg6kvn/4bm3+is7SA0JM8PiS5rXwrH1322D1hvbwcjEDw/KFrGvhSItwQEnVvbUaDa5wdB4CpWBFvA1x0c9gave8OD4eEKDORGeYKy7OV5b7FYfCGEwICReRTGZ2szWLPeCCQPdmJ0ucFVYU+ipQrmE/+O5v33ZNSPo72LOfmI7IRE46bxDrsWudO5WLywvqvYtLHjiL614hYdNrmK+GBPOZtpmQXmiSZab2NyBvsEQo+Az/e//36/A6Uv7JVlxBdiKX33GPpuaVn287y/TruyQp3SEvI8hQ3lmyvyHMqy3FbuK+i4vFB/po0QTLfteyEQ/D7bYYPUt+Nv3Stthci1Knh89u4275W182UmVagIcgNrBAandSEM3pKbaqVWjMtvoInWdlHcRK2Zz14tO4QcM/BIwFfHwZR/GQScZrDaAZU83u7exLqdGJziLfeR1dbpkpiRuaAeUrB1NiOnT0SPgWBv4zv8lYlKUnShQOe4FF3W38SEX7SOZ06Luu6YW3QrkxEWYssNvjmvPjsagwM+94Jf8sDBFyien9rvcBYrfbSDqs8vklIE0yWZYPtbuxmai+SyaeN9csw7bWFTY7h8YD9Bu2lyLMQYi/t77cm7oTudIFkdcKiilKoJJTDLB5EDrhW3a7Whcrlhn/lpdwU8Kve4TSLOUEgb4ymroHVbh4AThwEVIkcWxwixAQVt4y7+UpFvGHuCzEeFEFbnkRGIDpiwifXFwR7YVDTCysp0caE+SqlkWZdN0HLS9BoRK8Mh34WLWlIoPI7QXd17I4jbR0agCOH2AS7UgCMLMSbBegE224KB5Pkphg5nj5+An6MyVk7Nzz3vPn0jxnl1N+KGY5JI/QHZbEK7fRf24ZgOJYqY+kYUAssyrByFy750izYsP+1YGnAkqRsi234wdal+bxncJkxPkc41vn8zOQx0X2Z7EWpPE8buNP5AArnC9pNtJR8PLP011LZgYMmi99yUYWBr7eRP0kRXdKcqtTrKk1GS8TVsvDdMUu4brftG54tkdJeEED79DAFyarr/0dJF7l1isxmWgn5Fnujql65ek5Rj0GhskiYcs6F7YEItGSV6/BEzGq0yxI6TaKkPbje6i1T+7jJJg9+ejBJ/qZmkCd6KsiLiZO3Wt8onyTIO+FBXTUnbleUfzSUq9bNyb/1ZvX3o9LBME7pv/MyefqCmPLcSz/R7TYUOP4iF7XToDYBk/cad2tB2yEIryMXC0g6rrTfVMlFkdUEhALytpFk08QiOA3Tko2G0GalhdPB62S56y5IwRiySNJEOy275FiEw+tNXLkNNyHCk+FPbftQ4RvxLKKALfl4nUX4yFx81whh5jaqZVp/cfjB8NRgOXg2G1EO4+Pl8HH3tfQ5WBeMdOayYR/O9117WpsB3JP3HhDPS87TFFB8XxrNtl/idq0M703WR06UcCtPnu/TPTtNYle/mVOo/Is3LNLl9fDK3kOlezBCArwqcOKirCg1k2ig0L7uhv2czueHh4TJNFo9Pb/GHnN7XtHjzx2f3E6dWtGkn/w5eX71dpsnscV7/u0n++Dcye/hm2Z6ua8bD1Vjni6uot5aPEcaDgugmusjRkEFyX1+1qoY0DCUtXa3r+bHWBQq1QdGsXPqH9DIyD8kyDLHv+QzJvm6tRu69NVSDHem5pUQCXAtHSkvmoKnxIunD0aRj9nIIYT3vINJyDoDS8ILHu7I1q/EX++GbMHrRTbCinJc25h9ZYGJwWFYFZyjNZVEQ33Su96H5x5ZfgyQxEI/LOPDjR8V7H/bkAUOj1fQeCLZjH94L1WR4rGZSwN1dIwYsHcsl3N3RqqK5okN3uUzbAhprpYDPVV9iMEN5s9KqKcK2YVPWaepNnCsycXxBuEzrMiCnSqrpVW2K5bJ/TwzbNXoybvdgCmtHnfw/QIzYOVLHJkfzhJ17NPGem4YXJKwvQgidkZHGurAfvbgHhv2t2BaUQ2IEOXzfNvvb1mNLVCr21+4fZ+R0ipTGGCi4ccg7QpHNvGZgrsSEtjanJhq8kbq2kb2ZsI3JnROF9NtFqumq49lBh9PCunPvb9q6ihKVjs9OnoAlu8U9r4m8N+ln6fuA47MTSnaUk+Db9eFH2yARoRUrJEC+FtxIEfOhGvNt4SOZqBgRrzZXMlP7Ic2wB/cZyqXdyFHaXqs0qcH3Om6zYWmJdO0oDVeGFC/rsLIrODIXDZBnun6KVD6CpIBpzTe0jk7lqBr5qqdNVpTKOlP7KC7ktYn5mUEsiDJDa1ucIipE1Ok/BVTWNxcwEdahSaFWkpA3NQVNmi7xtkIjUWW4AYKHT2l/jLe+fRA/yqvVynpHY3hwQH9WoWryukOndENG85rURbH4U5I+PbDwsJfjizdbDg+5LbOPcvjrbXYzPCHlVJtPdhujlVWbglK1CeteI+TsRHaQlaqQCq8ibFfDg4OrAWG7TJPDTfCd6hLdjFMPCcS50ZTEXRUoKKnYLEBMhVRAZ775DdFEY7R52Aj7NM4eAuFwBYTX90E4UnwRxk8DzvQ1qt93pt3hnR+eWL0tWVZ8gCCRnojrk5XJdsv9JC1mtZFukYzO75Lbnqhkz9ePzi+Xl2lCwGoKylXaMsfCzZJRsn8vRmfR3HCM5fzOi24jjVaonC6r7tn9opL7N4Nkma632OglbKW2TkylmvYebHXZTvWUlsMjvjLhNqhRyb8hRTUCnl2qNJEkBjMUZDQQgrTKf28DlN/GtYqhw03RwHZN1uN76+p9Q8QuBuxWYnCbQ3CD153g13mMY3FoqolMbQo2NVOP4aMmetQJCHXiQeetzDahlxh5GXDIYnh4yL791wN2gl+9Zf/y8M2Spaz1tZJk1Z/iUPK6V5Akq9ZubNTYcqFVa5D4q5GVkzWetlJNNC9+WJHjCtUpneS0x24G9/1zLDJdNgnZkfyf//t/3CKuJKuAP8FxbaDSczST2md1Twq8lXR2dh4XRe8PRVmgtcUC6Mic8jOjXE45QyMenJmoxFgWkpQGkWkfDe3oHduHn1r/8YXxySo3WJCugUJrfnXjNIja6ZLHiAfjXJvrCbGUgoAxPdRAS5YfxiaoZkJl5IL6vZSCNkCvjOiIr4y0CEKWREymBk4mMpN84mrljMgclEKJKdJgKccJCIUqPrMwekyWmtVF7W0ReuyB6PwU+a6mDx/I9uOJcxQYnZAF5t4Msak3A4Msh1dMYzK5KxpeZmjbFLcCb9Cw7vBGfF0UUGnnDWtylLtrSx05I5SlAzhEoMPSNPAFO4nHyMWiD3RhQ4cT2YgkAIVU1/7N0XkjZj/h2EqHbYxkPp/f02MvV9v8VbpZPQaDlW7bTbmQtV63efPxkpQEmtIeT07R3Mgsmgxbxtxn4v1wvgnvjkelISr5l/UGdNYUMkNlsXMavfvryXdwA6/6B0na0dxPYHj/u6P33/5w+i31S2eL33+D/kH/gAO72rpSqM5Qa+/31rdu5+Zo99xv99xv99xv99xv99zvj/Mgbffcb/fcb/fcb/fcb/fcb/fcb/fc7xlAsXvut3vut3vut3vut3vut3vut3vut3vut3vut3vut3vut3vu9zxeV+2e++2e+z0rgdw994vP/UKuCNmN+1UhpOrku/kEo/P1R4CXaTKjDKTReXJ3RxeLP1JKLxX/UqOh9KXLNLkRRlL0nJOX0pikQ9kp10hpIu/9ZUDvjMZPvdzzXfZazhblGPkW73j1H6TtJkmdHJ+eJWkSc7BLnVMbI+b0iFHMk1FCSpsfPDKk/LZM8KOQQqhpzQkzie+XcotE7WariUnXnJgUfnTyboRadLhczVjyU6H/aWIbG/wH3X3/DRf/2ZD7mq0NAraRmpbwcrlc/guCOcsg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW+FyGzeSfpXe+eNYNaREWna8rKurdezcnm6TSLVSKrUlqRRwpknCmgEmAEYUo+K/e5J7tH2SrW4AM0OKlGQ7lVXq6B8WB2gAjQ+NRnejcZc4MbXJ6Dz5oLO6ROVscpkmOdrMyMpJrZJRcjZDeG9QOIRIBe9OjkAUhZ5bqC0aC07DFBUaolI4hzz2B+MFVEbfyFyqKeTCCZhLN4OxsPjmEFBlOsccJrLA/oW6UGeyGsGPVaFFDgtdGzj58F9NbzQMlZ3v7X3AcT2FH4/29i6/mjlX2dH+vqiqvq5QWTlVhRjbfqbL/ZwIq3zyMoX5DA1Sr5AJBSisLBYg8hzmMp+isym4GSrIdLWATGuTSyUc2hQqMUVQdTlGY1MQKodSGwSpQIBBkS96Tvdqi/A/p8c/wESbUrg+nBS1TZvhcmkwc8XCd+9m2MzqhY1oWGekmqZQimtCSzr4pZbZNU3bosrpLzV8d3LEWO3tndZVpY3DHH7yUxjt7VHNN1joOQiDTJ/pstQKKmFEiY6XayYcVxv8pZYGc78ooigiFqML1YO9PbeocLS3B0cqlxmBwR1SKehJoO17UgKJSE8rzOREBtIOdKAVzGcymzEmc+HXsypE5tk0aCvMnLzB1Y5vU1hQxx9Q6cjBTBv5q1ZOFLwcN2iczETRXTZikEitE8YRnJWWysXSMAL8IywPrR4vSpArYi0nsEqpuMYi3IiiRhu4mqcwI67+jpVBy6Ie+iUgVQ4zlNPZ1vFE/rG2bqVjqC2x2eUijBVXieFFhm0iCosgJytYluIaO6OB5j0sij58s4AcJ6IuXAqSJM6ZGvvwg3YgqqqQmRgXSJILtHmEqw32eJWDOARGlCh5jU94R6MFAbmcTNDQ5qRK7iK0idyRnLUqgHeOmwkFWq0tdKYLbaj7NRni8lUgIdPKoXJ9eHcjZMHc+9lakCor6hxhXIjsOoVxUWMKBnO/cxdIeisNWohIQNgAOgMEFgsSQ61oAkqH4aUFG7jK+3A2k7bdUFQZseZBpO3CGrbtRNPIhEHcY4ClkEXKyKXwUY/BSVdgSju2EmqRksLEFBzeurG+TSGbYXbNv4zIpYZx7ZxWfmK50VWu5yqAOdHKWfnrhi0Zaz4d0WEKhym8SeFtCoODFAbDFAaHKQzepDB4m8LwIIXhMIXhYQrDN56t4duAtWgA7jIwGHqU3R8HXVK830nLW5s0pm2U8HxFCV+oQR/29poNxcU///zzhbq7UAAXCW2wi2R0kTQkF0kKvo705kUyGqQQCm4vkhG8Gn4dCRb0/YbQ9d9z+h7QavjvGX0PBxdqGQYdMjNOlNUDjFD1b89E/AzyRIU8MpVF3UaFpJQ8LdXQulFpwxZVLNsJvaIJSSWdFIXdPqdI8fym1XK2NrNDmhlL7/ZpcfXzm1NkK9aw8vRVrGw7VVENMCPDNQhe99vjZgsCftDnBkDg6kvn/4bm3+is7SA0JM8PiS5rXwrH1322D1hvbwcjEDw/KFrGvhSItwQEnVvbUaDa5wdB4CpWBFvA1x0c9gave8OD4eEKDORGeYKy7OV5b7FYfCGEwICReRTGZ2szWLPeCCQPdmJ0ucFVYU+ipQrmE/+O5v33ZNSPo72LOfmI7IRE46bxDrsWudO5WLywvqvYtLHjiL614hYdNrmK+GBPOZtpmQXmiSZab2NyBvsEQo+Az/e//36/A6Uv7JVlxBdiKX33GPpuaVn287y/TruyQp3SEvI8hQ3lmyvyHMqy3FbuK+i4vFB/po0QTLfteyEQ/D7bYYPUt+Nv3Stthci1Knh89u4275W182UmVagIcgNrBAandSEM3pKbaqVWjMtvoInWdlHcRK2Zz14tO4QcM/BIwFfHwZR/GQScZrDaAZU83u7exLqdGJziLfeR1dbpkpiRuaAeUrB1NiOnT0SPgWBv4zv8lYlKUnShQOe4FF3W38SEX7SOZ06Luu6YW3QrkxEWYssNvjmvPjsagwM+94Jf8sDBFyien9rvcBYrfbSDqs8vklIE0yWZYPtbuxmai+SyaeN9csw7bWFTY7h8YD9Bu2lyLMQYi/t77cm7oTudIFkdcKiilKoJJTDLB5EDrhW3a7Whcrlhn/lpdwU8Kve4TSLOUEgb4ymroHVbh4AThwEVIkcWxwixAQVt4y7+UpFvGHuCzEeFEFbnkRGIDpiwifXFwR7YVDTCysp0caE+SqlkWZdN0HLS9BoRK8Mh34WLWlIoPI7QXd17I4jbR0agCOH2AS7UgCMLMSbBegE224KB5Pkphg5nj5+An6MyVk7Nzz3vPn0jxnl1N+KGY5JI/QHZbEK7fRf24ZgOJYqY+kYUAssyrByFy750izYsP+1YGnAkqRsi234wdal+bxncJkxPkc41vn8zOQx0X2Z7EWpPE8buNP5AArnC9pNtJR8PLP011LZgYMmi99yUYWBr7eRP0kRXdKcqtTrKk1GS8TVsvDdMUu4brftG54tkdJeEED79DAFyarr/0dJF7l1isxmWgn5Fnujql65ek5Rj0GhskiYcs6F7YEItGSV6/BEzGq0yxI6TaKkPbje6i1T+7jJJg9+ejBJ/qZmkCd6KsiLiZO3Wt8onyTIO+FBXTUnbleUfzSUq9bNyb/1ZvX3o9LBME7pv/MyefqCmPLcSz/R7TYUOP4iF7XToDYBk/cad2tB2yEIryMXC0g6rrTfVMlFkdUEhALytpFk08QiOA3Tko2G0GalhdPB62S56y5IwRiySNJEOy275FiEw+tNXLkNNyHCk+FPbftQ4RvxLKKALfl4nUX4yFx81whh5jaqZVp/cfjB8NRgOXg2G1EO4+Pl8HH3tfQ5WBeMdOayYR/O9117WpsB3JP3HhDPS87TFFB8XxrNtl/idq0M703WR06UcCtPnu/TPTtNYle/mVOo/Is3LNLl9fDK3kOlezBCArwqcOKirCg1k2ig0L7uhv2czueHh4TJNFo9Pb/GHnN7XtHjzx2f3E6dWtGkn/w5eX71dpsnscV7/u0n++Dcye/hm2Z6ua8bD1Vjni6uot5aPEcaDgugmusjRkEFyX1+1qoY0DCUtXa3r+bHWBQq1QdGsXPqH9DIyD8kyDLHv+QzJvm6tRu69NVSDHem5pUQCXAtHSkvmoKnxIunD0aRj9nIIYT3vINJyDoDS8ILHu7I1q/EX++GbMHrRTbCinJc25h9ZYGJwWFYFZyjNZVEQ33Su96H5x5ZfgyQxEI/LOPDjR8V7H/bkAUOj1fQeCLZjH94L1WR4rGZSwN1dIwYsHcsl3N3RqqK5okN3uUzbAhprpYDPVV9iMEN5s9KqKcK2YVPWaepNnCsycXxBuEzrMiCnSqrpVW2K5bJ/TwzbNXoybvdgCmtHnfw/QIzYOVLHJkfzhJ17NPGem4YXJKwvQgidkZHGurAfvbgHhv2t2BaUQ2IEOXzfNvvb1mNLVCr21+4fZ+R0ipTGGCi4ccg7QpHNvGZgrsSEtjanJhq8kbq2kb2ZsI3JnROF9NtFqumq49lBh9PCunPvb9q6ihKVjs9OnoAlu8U9r4m8N+ln6fuA47MTSnaUk+Db9eFH2yARoRUrJEC+FtxIEfOhGvNt4SOZqBgRrzZXMlP7Ic2wB/cZyqXdyFHaXqs0qcH3Om6zYWmJdO0oDVeGFC/rsLIrODIXDZBnun6KVD6CpIBpzTe0jk7lqBr5qqdNVpTKOlP7KC7ktYn5mUEsiDJDa1ucIipE1Ok/BVTWNxcwEdahSaFWkpA3NQVNmi7xtkIjUWW4AYKHT2l/jLe+fRA/yqvVynpHY3hwQH9WoWryukOndENG85rURbH4U5I+PbDwsJfjizdbDg+5LbOPcvjrbXYzPCHlVJtPdhujlVWbglK1CeteI+TsRHaQlaqQCq8ibFfDg4OrAWG7TJPDTfCd6hLdjFMPCcS50ZTEXRUoKKnYLEBMhVRAZ775DdFEY7R52Aj7NM4eAuFwBYTX90E4UnwRxk8DzvQ1qt93pt3hnR+eWL0tWVZ8gCCRnojrk5XJdsv9JC1mtZFukYzO75Lbnqhkz9ePzi+Xl2lCwGoKylXaMsfCzZJRsn8vRmfR3HCM5fzOi24jjVaonC6r7tn9opL7N4Nkma632OglbKW2TkylmvYebHXZTvWUlsMjvjLhNqhRyb8hRTUCnl2qNJEkBjMUZDQQgrTKf28DlN/GtYqhw03RwHZN1uN76+p9Q8QuBuxWYnCbQ3CD153g13mMY3FoqolMbQo2NVOP4aMmetQJCHXiQeetzDahlxh5GXDIYnh4yL791wN2gl+9Zf/y8M2Spaz1tZJk1Z/iUPK6V5Akq9ZubNTYcqFVa5D4q5GVkzWetlJNNC9+WJHjCtUpneS0x24G9/1zLDJdNgnZkfyf//t/3CKuJKuAP8FxbaDSczST2md1Twq8lXR2dh4XRe8PRVmgtcUC6Mic8jOjXE45QyMenJmoxFgWkpQGkWkfDe3oHduHn1r/8YXxySo3WJCugUJrfnXjNIja6ZLHiAfjXJvrCbGUgoAxPdRAS5YfxiaoZkJl5IL6vZSCNkCvjOiIr4y0CEKWREymBk4mMpN84mrljMgclEKJKdJgKccJCIUqPrMwekyWmtVF7W0ReuyB6PwU+a6mDx/I9uOJcxQYnZAF5t4Msak3A4Msh1dMYzK5KxpeZmjbFLcCb9Cw7vBGfF0UUGnnDWtylLtrSx05I5SlAzhEoMPSNPAFO4nHyMWiD3RhQ4cT2YgkAIVU1/7N0XkjZj/h2EqHbYxkPp/f02MvV9v8VbpZPQaDlW7bTbmQtV63efPxkpQEmtIeT07R3Mgsmgxbxtxn4v1wvgnvjkelISr5l/UGdNYUMkNlsXMavfvryXdwA6/6B0na0dxPYHj/u6P33/5w+i31S2eL33+D/kH/gAO72rpSqM5Qa+/31rdu5+Zo99xv99xv99xv99xv99zvj/Mgbffcb/fcb/fcb/fcb/fcb/fcb/fc7xlAsXvut3vut3vut3vut3vut3vut3vut3vut3vut3vut3vut3vu9zxeV+2e++2e+z0rgdw994vP/UKuCNmN+1UhpOrku/kEo/P1R4CXaTKjDKTReXJ3RxeLP1JKLxX/UqOh9KXLNLkRRlL0nJOX0pikQ9kp10hpIu/9ZUDvjMZPvdzzXfZazhblGPkW73j1H6TtJkmdHJ+eJWkSc7BLnVMbI+b0iFHMk1FCSpsfPDKk/LZM8KOQQqhpzQkzie+XcotE7WariUnXnJgUfnTyboRadLhczVjyU6H/aWIbG/wH3X3/DRf/2ZD7mq0NAraRmpbwcrlc/guCOcsg",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 from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.a184f1a5.js b/assets/js/2c586be5.a184f1a5.js deleted file mode 100644 index 8b1815919..000000000 --- a/assets/js/2c586be5.a184f1a5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={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:"eJztW+9yGzeSf5Xe+eJYNaREWna8rKurdezcnm6TSLVSKrUlqhRwpsmBNQNMAAypiYrf7knu0fZJthp/5g9FSpad2ih19AeLAzSAxg+NRnejcRcZttDR5DL6IJOqQGF0dBVHKepE8dJwKaJJdJEhvFfIDEKggndnJ8DyXK40VBqVBiNhgQIVUQlcQRr6g1kNpZJLnnKxgJQZBituMpgxjW+OAUUiU0xhznMcTsVUXPByAj+WuWQp1LJScPbhv5reaBgquzw4+ICzagE/nhwcXH2VGVPqyeEhK8uhLFFovhA5m+lhIovDlAjLdP4yhlWGCqlXSJgAZJrnNbA0hRVPF2h0DCZDAYksa0ikVCkXzKCOoWQLBFEVM1Q6BiZSKKRC4AIYKGRpPTByUGmE/zk//QHmUhXMDOEsr3TcDJdyhYnJa9e9ybCZ1Qsd0NBGcbGIoWA3hBY38EvFkxuatkaR0l9q+O7sxGJ1cHBelaVUBlP4yU1hcnBANd9gLlfAFFr6RBaFFFAyxQo0drkyZmy1wl8qrjB1i8LyPGAxmYoBHByYusTJwQGciJQnBIbtkEpBzj3t0JESSER6XmLC59yTdqADKWCV8SSzmKyYW88yZ4ljU6EuMTF8if2Ob2OoqeMPKGTgIJOK/yqFYbldjiUqwxOWd5eNGCRSbZgyBGcpuTCh1I8A//DLQ6tnF8XLFbGWElgFF7ZGIyxZXqH2XK1iyIirv2OpUFtR9/0SkCKFDPki2zkeSz9W2vQ6hkoTm10u/FhhlSy8aGGbs1wj8HkPy4LdYGc0kHYPs3wI39SQ4pxVuYmBk8QZVeEQfpAGWFnmPGGzHElygTYPM5XCgV1lLw6eEcEKu8ZndkejBgYpn89R0eakStuFbxO4IzlrVYDdOSZjAqTYWOhE5lJR9xsyZMv7QEIihUFhhvBuyXhuuXez1cBFklcpwixnyU0Ms7zCGBSmbufWSHor9lqISIBpD7oFCDTmJIZS0ASE9MNzDdpzlQ7hIuO63VBUGbC2g3DdhdVv27mkkQmDsMcAC8bz2CIXw0c5A8NNjjHt2JKJOiaFiTEYvDUzeRtDkmFyY38plnIJs8oYKdzEUiXLVK6EB3MuhdH81y1bMtQ8HdFxDMcxvInhbQyjoxhG4xhGxzGM3sQwehvD+CiG8TiG8XEM4zeOrfFbjzVrAO4yMBo7lM0fB11SvN9xbbc2aUzdKOFVTwlPxWgIBwfNhrLFP//881TcTQXANKINNo0m06ghmUYxuDrSm9NoMorBF9xOowm8Gn8dCGr6fkPouu8VfY9oNdx3Rt/j0VSs/aBjy4xhRfkAI1T92zMRPr08UaEdmcqCbqNCUkqOlmpo3ai0YYsq1u2EXtGEuOCGs1zvnlOgeH7TajnbmNkxzcxK7+5p2ernN6fAVqixytNVWWXbqQpqwDIy3oDg9bA9bnYg4AZ9bgB4rr50/m9o/o3O2g1CQ/L8kOiy9qVwfD209oHV27vB8ATPD4qWsS8F4i0BQefWbhSo9vlB4LkKFd4WcHVHx4PR68H4aHzcg4HcKEdQFIM0HdR1/YUQggWMzCM/vrU2vTXrjEDyYOdKFltcFetJtFTefLK/g3n/PRn1s2DvYko+onVCgnHTeIddi9zIlNUvtOsqNG3sOKJvrbi6w6atIj6sp5xkkieeeaIJ1tuMnMEhgTAg4NPD778/7EDpCgdFEfCFUErfAwt9t7Qohmk63KTtrVCntIA0jWFL+faKNIWiKHaVuwo6Lqfiz7QRvOm2ey94gue3HVrGtu6IjVMk48JXeOmADQKFiypnCm/JGdVcCjv730DfbOyVsFVaY976rtbts5EBNy346tQb7C+9GNMM+h1QyePt7k2s24nCBd7aPpJKG1kQMzxl1EMMukoycu1Y8AukyOs2imO/ElZyiiHkaIwtRZMM+0xMxejIHj7eOXjg9PEUz0/YOpyFShdyoOrLaVQwbz9Ec2x/S5OhmkZXTRvnGGPaaQvbGsNVRy5ZSkgTsQ1ZtOxlPMWczTBv654srN3p+IXvgEMVBReNP29ZPgoc2Fp2u1HrK9dbtoGbdlf+goYNUhxwhpzrENTog9Zt7aM+NhYnEG14b4YQGlDkNGyyLdvC4dqJCNHibwaENJo+Y0xDaLolKGRXIexXvzqPjEB0YAmbgFsYbNcAfgq9leniQn0UXPCiKprI4bzpNSBW+JO2Cxe1pHh0GKG7uvdGYLePjEBhut0DTMXIuvchMGD1Amw3yDzJ81MMHc6+RDH0jq7PPXSevt0C993ttuWsIlJ3SjVbTe/ea0M4pZOBgpOuEUWbkgRLQ5Gp3kYc2ZBKN1a0+3DoUv275WBTBT9FQjb4/s2kxNN9mXlCqH2aqHSn8XuJy1SMXMiqcDclu+JVhRWK56YqPFsb52IUR7Kkaz8uxUkaTaLE3hSGq60otn2jNt/ItI4md5GPMtNPH8OlpocfNd013kU6ybBg9CvwRLeTdDsYxTZMikpHcWTDCnRVSahFk0jOPmJCo5WK2DEcNfVh203uApW7Xoti71pGk8jdu0VxhLesKIk42riYLNN5tA4DPtRVU9J2pe2P5p6P+uldrX5Wbx86PazjiK7EPrOnH6ipnVuBF/K9pEKDH1itOx264zHavBSmNrQpEt8KUlZrkv1KO0MmYXlS5eSl4m3JVd24zNZV7chHw2gzUsPo6PW6XfSWJaYUq6M44gaLbvkOIVDy6SuXoCRkbDDzqW0/Spwh/sUX0B20XSdWPJmLjxJhhnaNykyKJ7cfjV+NxqNXozH14O8mPh9HV3ufg75gvCNvC9Ng3A7a+8QYbBh/+JhwBno7bbbAx4XxYtc9c+d2S2eyylO6N0Kmhva697MzCfry3ZwXw0ekeR1Ht49P5hYSOQiX2PBVjnMDVVmigkQqgeplNzr1bCY3Pj5ex1H9+PTqP+T0vqbFWz0+u5/s7X+bGfF78Prq7TqOssd5/e8mP+F3ZPb4zbo9XTeMh+uZTOvroLfWjxGGg4Lo5jJPUZFBcl9ftaqGNAzl1Vxv6vmZlDkysUXR9O6lfQYUucPka/vw7CpDsnxbL9n23pqQ3jN33NJdN27E0rgmc1BVOI2GcDLvGKTWwd68Gg+09ppaSHhhx7vWlVXjLw79N2H0opsDRGkZbVg6sGCJwWBR5jaJZsXznPimc30IzT9r+TVIEgPhuAwDP35UvHcxOzugb9TPQAFvOw7hPRNNEkL/sh/u7hoxsNKxXsPdHa0qqms6dNfruC2gsXoF9lx1JQoT5Mteq6YI24ZNWaepM3GuycRxBf6+p8sAXwguFteVytfr4T0xbNfok3G7B5NfO+rk/wFixM6JOFUpqk/YuSdzFwuT8IKE9YWP/1pkuNLG70cn7p5hd3GzA2V/d09htG+b/a2rmSYqEfpr949RfLFAyrTzFLaxT41BlmROM1iu2Jy2ts2eU7jkstKBvYzpxuROiYK77cLFoh9t66BjM5e6cx9u27qCcmlOL84+AUsbBhw4TeS8STdL1wecXpxRPh6fe99uCD/qBokALeuRAPlasOQspOw05lvt4nwoLCJObfaSJ4c+E24A9xlKud7KUdzeCTTZq/c6bhM2aYlkZShTlPssJG2w1D0cLRcNkBey+hSpfARJBovKXiIaOpWDarT3FG0+HRfaqMrFOCGtVEgh9GJBlAlq3eIUUCGiTv8xoNCuOYM50wZVDJXghLyqKJzRdIm3JSqOIsEtEDx8SrtjvPXtvfhR6qcU2jka46Mj+tOHqkk99p3S9Q7Na17lef2nKP70wMLDXo4r3m45POS2ZB/5+NfbZDk+I+VUqSe7jcHKqlRO2cSE9aARcutEdpDlIucCrwNs1+Ojo+sRYbuOo+Nt8J3LAk1ms+MIxJWSlGdc5sgo71XVwBaMC6AzX/2GaKJSUj1shD2Ns4dAOO6B8Po+CCfCXhPZ7PULeYPi3zvT7vDGDU+s3hZWVlyAIOKOyNZHvcl2y90kNSaV4qaOJpd30e2AlXzg6ieXV+urOCJgJQXlSqktx8xk0SQ6vBej06iWNsZyeedEt5FGzURKVzn37H5W8sPlKFrHmy22egk7qbVhCy4WgwdbXbVTPaflcIj3JtwGNUr+N6SohsezSxVHnMQgQ0ZGAyFIq/z3NkD5bVirEDrcFg1s12Qzvrep3rdE7ELArheD2x6CG73uBL8uQxzLhqaayNS2YFMz9RA+aqJHnYBQJx502cpsE3oJkZeRDVmMj4+tb//1yDrBr95a//L4zdpKWetrRVHfn7Kh5E2vIIr61m5o1NhyvlVrkLhLi97JGk5bLubSLr5fkdMSxTmd5LTHlqP7/jnmiSyanOFA/s///T/bIqykVQF/gtNKQSlXqOaVSzye53jL6ezsvH8J3h+yIket8xroyFzYlzApX9j0gnBwJqxkM55zUhpEJl00tKN39BB+av3HF8plWiwxJ10DuZT2YYiRwCojCztGOBhXUt3MiaUYGMzoLQFqsvwwNEGRMZGQC+r2UgxSAT2EoSO+VFwjMF4QMZkaOJ/zhNsTVwqjWGKgYIItkAaLbZyAUCjDSwAlZ2SpaZlXzhah9wiIxk3R3qIM4QPZfnbiNgqMhvEcU2eG6NiZgV6W/UObGZncJQ3PE9RtFlaOS1RWdzgjvspzKKVxhjU5yt21pY6MYkLTAewj0H5pGvi8nWTHSFk9BLqwocOJbEQSgJyLG/cs5rIRs59wprnBNkayWq3u6bGX/TZ/5SarZqCwlG27hS20Wq/bvPl4SUoCVaFP5+eoljwJJsOOMQ8t8aE/35hzx4PSYCX/y2YDOmtynqDQ2DmN3v317DtYwqvhURR3NPcnMHz43cn7b384/5b6pbPF7b/R8Gh4ZAO7UpuCic5QG0/MNrdu5+Zo/yJt/yJt/yJt/yJt/yLtj/Nmav8ibf8ibf8ibf8ibf8ibf8ibf8i7RlAsX+Rtn+Rtn+Rtn+Rtn+Rtn+Rtn+Rtn+Rtn+Rtn+R9hwUw/5F2v5F2v5F2v5F2pe8SPPpDGTBHZY546KTkuVyYC4336ldxVFGSTKTy+juju6+fqSsUyr+pUJFGTZXcbRkilOA1+bXxCGPhBIobpAyGd67ePXggsaPnUTa69aNtCJKg3Et3tl1eZC2m8dzdnp+EcVRSBMuZEptFFvROzu2iiYRKTv7Js9Cap8/MftuIWdiUdmcjsj1S+kvrDJZP3fmxubO+B+d1BAm6g6X/aQaNxX6nya2tcF/0PXs37D+z4bc1exs4LEN1LSEV+v1+l9vet2h",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW+9yGzeSf5Xe+eJYNaREWna8rKurdezcnm6TSLVSKrUlqhRwpsmBNQNMAAypiYrf7knu0fZJthp/5g9FSpad2ih19AeLAzSAxg+NRnejcRcZttDR5DL6IJOqQGF0dBVHKepE8dJwKaJJdJEhvFfIDEKggndnJ8DyXK40VBqVBiNhgQIVUQlcQRr6g1kNpZJLnnKxgJQZBituMpgxjW+OAUUiU0xhznMcTsVUXPByAj+WuWQp1LJScPbhv5reaBgquzw4+ICzagE/nhwcXH2VGVPqyeEhK8uhLFFovhA5m+lhIovDlAjLdP4yhlWGCqlXSJgAZJrnNbA0hRVPF2h0DCZDAYksa0ikVCkXzKCOoWQLBFEVM1Q6BiZSKKRC4AIYKGRpPTByUGmE/zk//QHmUhXMDOEsr3TcDJdyhYnJa9e9ybCZ1Qsd0NBGcbGIoWA3hBY38EvFkxuatkaR0l9q+O7sxGJ1cHBelaVUBlP4yU1hcnBANd9gLlfAFFr6RBaFFFAyxQo0drkyZmy1wl8qrjB1i8LyPGAxmYoBHByYusTJwQGciJQnBIbtkEpBzj3t0JESSER6XmLC59yTdqADKWCV8SSzmKyYW88yZ4ljU6EuMTF8if2Ob2OoqeMPKGTgIJOK/yqFYbldjiUqwxOWd5eNGCRSbZgyBGcpuTCh1I8A//DLQ6tnF8XLFbGWElgFF7ZGIyxZXqH2XK1iyIirv2OpUFtR9/0SkCKFDPki2zkeSz9W2vQ6hkoTm10u/FhhlSy8aGGbs1wj8HkPy4LdYGc0kHYPs3wI39SQ4pxVuYmBk8QZVeEQfpAGWFnmPGGzHElygTYPM5XCgV1lLw6eEcEKu8ZndkejBgYpn89R0eakStuFbxO4IzlrVYDdOSZjAqTYWOhE5lJR9xsyZMv7QEIihUFhhvBuyXhuuXez1cBFklcpwixnyU0Ms7zCGBSmbufWSHor9lqISIBpD7oFCDTmJIZS0ASE9MNzDdpzlQ7hIuO63VBUGbC2g3DdhdVv27mkkQmDsMcAC8bz2CIXw0c5A8NNjjHt2JKJOiaFiTEYvDUzeRtDkmFyY38plnIJs8oYKdzEUiXLVK6EB3MuhdH81y1bMtQ8HdFxDMcxvInhbQyjoxhG4xhGxzGM3sQwehvD+CiG8TiG8XEM4zeOrfFbjzVrAO4yMBo7lM0fB11SvN9xbbc2aUzdKOFVTwlPxWgIBwfNhrLFP//881TcTQXANKINNo0m06ghmUYxuDrSm9NoMorBF9xOowm8Gn8dCGr6fkPouu8VfY9oNdx3Rt/j0VSs/aBjy4xhRfkAI1T92zMRPr08UaEdmcqCbqNCUkqOlmpo3ai0YYsq1u2EXtGEuOCGs1zvnlOgeH7TajnbmNkxzcxK7+5p2ernN6fAVqixytNVWWXbqQpqwDIy3oDg9bA9bnYg4AZ9bgB4rr50/m9o/o3O2g1CQ/L8kOiy9qVwfD209oHV27vB8ATPD4qWsS8F4i0BQefWbhSo9vlB4LkKFd4WcHVHx4PR68H4aHzcg4HcKEdQFIM0HdR1/YUQggWMzCM/vrU2vTXrjEDyYOdKFltcFetJtFTefLK/g3n/PRn1s2DvYko+onVCgnHTeIddi9zIlNUvtOsqNG3sOKJvrbi6w6atIj6sp5xkkieeeaIJ1tuMnMEhgTAg4NPD778/7EDpCgdFEfCFUErfAwt9t7Qohmk63KTtrVCntIA0jWFL+faKNIWiKHaVuwo6Lqfiz7QRvOm2ey94gue3HVrGtu6IjVMk48JXeOmADQKFiypnCm/JGdVcCjv730DfbOyVsFVaY976rtbts5EBNy346tQb7C+9GNMM+h1QyePt7k2s24nCBd7aPpJKG1kQMzxl1EMMukoycu1Y8AukyOs2imO/ElZyiiHkaIwtRZMM+0xMxejIHj7eOXjg9PEUz0/YOpyFShdyoOrLaVQwbz9Ec2x/S5OhmkZXTRvnGGPaaQvbGsNVRy5ZSkgTsQ1ZtOxlPMWczTBv654srN3p+IXvgEMVBReNP29ZPgoc2Fp2u1HrK9dbtoGbdlf+goYNUhxwhpzrENTog9Zt7aM+NhYnEG14b4YQGlDkNGyyLdvC4dqJCNHibwaENJo+Y0xDaLolKGRXIexXvzqPjEB0YAmbgFsYbNcAfgq9leniQn0UXPCiKprI4bzpNSBW+JO2Cxe1pHh0GKG7uvdGYLePjEBhut0DTMXIuvchMGD1Amw3yDzJ81MMHc6+RDH0jq7PPXSevt0C993ttuWsIlJ3SjVbTe/ea0M4pZOBgpOuEUWbkgRLQ5Gp3kYc2ZBKN1a0+3DoUv275WBTBT9FQjb4/s2kxNN9mXlCqH2aqHSn8XuJy1SMXMiqcDclu+JVhRWK56YqPFsb52IUR7Kkaz8uxUkaTaLE3hSGq60otn2jNt/ItI4md5GPMtNPH8OlpocfNd013kU6ybBg9CvwRLeTdDsYxTZMikpHcWTDCnRVSahFk0jOPmJCo5WK2DEcNfVh203uApW7Xoti71pGk8jdu0VxhLesKIk42riYLNN5tA4DPtRVU9J2pe2P5p6P+uldrX5Wbx86PazjiK7EPrOnH6ipnVuBF/K9pEKDH1itOx264zHavBSmNrQpEt8KUlZrkv1KO0MmYXlS5eSl4m3JVd24zNZV7chHw2gzUsPo6PW6XfSWJaYUq6M44gaLbvkOIVDy6SuXoCRkbDDzqW0/Spwh/sUX0B20XSdWPJmLjxJhhnaNykyKJ7cfjV+NxqNXozH14O8mPh9HV3ufg75gvCNvC9Ng3A7a+8QYbBh/+JhwBno7bbbAx4XxYtc9c+d2S2eyylO6N0Kmhva697MzCfry3ZwXw0ekeR1Ht49P5hYSOQiX2PBVjnMDVVmigkQqgeplNzr1bCY3Pj5ex1H9+PTqP+T0vqbFWz0+u5/s7X+bGfF78Prq7TqOssd5/e8mP+F3ZPb4zbo9XTeMh+uZTOvroLfWjxGGg4Lo5jJPUZFBcl9ftaqGNAzl1Vxv6vmZlDkysUXR9O6lfQYUucPka/vw7CpDsnxbL9n23pqQ3jN33NJdN27E0rgmc1BVOI2GcDLvGKTWwd68Gg+09ppaSHhhx7vWlVXjLw79N2H0opsDRGkZbVg6sGCJwWBR5jaJZsXznPimc30IzT9r+TVIEgPhuAwDP35UvHcxOzugb9TPQAFvOw7hPRNNEkL/sh/u7hoxsNKxXsPdHa0qqms6dNfruC2gsXoF9lx1JQoT5Mteq6YI24ZNWaepM3GuycRxBf6+p8sAXwguFteVytfr4T0xbNfok3G7B5NfO+rk/wFixM6JOFUpqk/YuSdzFwuT8IKE9YWP/1pkuNLG70cn7p5hd3GzA2V/d09htG+b/a2rmSYqEfpr949RfLFAyrTzFLaxT41BlmROM1iu2Jy2ts2eU7jkstKBvYzpxuROiYK77cLFoh9t66BjM5e6cx9u27qCcmlOL84+AUsbBhw4TeS8STdL1wecXpxRPh6fe99uCD/qBokALeuRAPlasOQspOw05lvt4nwoLCJObfaSJ4c+E24A9xlKud7KUdzeCTTZq/c6bhM2aYlkZShTlPssJG2w1D0cLRcNkBey+hSpfARJBovKXiIaOpWDarT3FG0+HRfaqMrFOCGtVEgh9GJBlAlq3eIUUCGiTv8xoNCuOYM50wZVDJXghLyqKJzRdIm3JSqOIsEtEDx8SrtjvPXtvfhR6qcU2jka46Mj+tOHqkk99p3S9Q7Na17lef2nKP70wMLDXo4r3m45POS2ZB/5+NfbZDk+I+VUqSe7jcHKqlRO2cSE9aARcutEdpDlIucCrwNs1+Ojo+sRYbuOo+Nt8J3LAk1ms+MIxJWSlGdc5sgo71XVwBaMC6AzX/2GaKJSUj1shD2Ns4dAOO6B8Po+CCfCXhPZ7PULeYPi3zvT7vDGDU+s3hZWVlyAIOKOyNZHvcl2y90kNSaV4qaOJpd30e2AlXzg6ieXV+urOCJgJQXlSqktx8xk0SQ6vBej06iWNsZyeedEt5FGzURKVzn37H5W8sPlKFrHmy22egk7qbVhCy4WgwdbXbVTPaflcIj3JtwGNUr+N6SohsezSxVHnMQgQ0ZGAyFIq/z3NkD5bVirEDrcFg1s12Qzvrep3rdE7ELArheD2x6CG73uBL8uQxzLhqaayNS2YFMz9RA+aqJHnYBQJx502cpsE3oJkZeRDVmMj4+tb//1yDrBr95a//L4zdpKWetrRVHfn7Kh5E2vIIr61m5o1NhyvlVrkLhLi97JGk5bLubSLr5fkdMSxTmd5LTHlqP7/jnmiSyanOFA/s///T/bIqykVQF/gtNKQSlXqOaVSzye53jL6ezsvH8J3h+yIket8xroyFzYlzApX9j0gnBwJqxkM55zUhpEJl00tKN39BB+av3HF8plWiwxJ10DuZT2YYiRwCojCztGOBhXUt3MiaUYGMzoLQFqsvwwNEGRMZGQC+r2UgxSAT2EoSO+VFwjMF4QMZkaOJ/zhNsTVwqjWGKgYIItkAaLbZyAUCjDSwAlZ2SpaZlXzhah9wiIxk3R3qIM4QPZfnbiNgqMhvEcU2eG6NiZgV6W/UObGZncJQ3PE9RtFlaOS1RWdzgjvspzKKVxhjU5yt21pY6MYkLTAewj0H5pGvi8nWTHSFk9BLqwocOJbEQSgJyLG/cs5rIRs59wprnBNkayWq3u6bGX/TZ/5SarZqCwlG27hS20Wq/bvPl4SUoCVaFP5+eoljwJJsOOMQ8t8aE/35hzx4PSYCX/y2YDOmtynqDQ2DmN3v317DtYwqvhURR3NPcnMHz43cn7b384/5b6pbPF7b/R8Gh4ZAO7UpuCic5QG0/MNrdu5+Zo/yJt/yJt/yJt/yJt/yLtj/Nmav8ibf8ibf8ibf8ibf8ibf8ibf8i7RlAsX+Rtn+Rtn+Rtn+Rtn+Rtn+Rtn+Rtn+Rtn+Rtn+R9hwUw/5F2v5F2v5F2v5F2pe8SPPpDGTBHZY546KTkuVyYC4336ldxVFGSTKTy+juju6+fqSsUyr+pUJFGTZXcbRkilOA1+bXxCGPhBIobpAyGd67ePXggsaPnUTa69aNtCJKg3Et3tl1eZC2m8dzdnp+EcVRSBMuZEptFFvROzu2iiYRKTv7Js9Cap8/MftuIWdiUdmcjsj1S+kvrDJZP3fmxubO+B+d1BAm6g6X/aQaNxX6nya2tcF/0PXs37D+z4bc1exs4LEN1LSEV+v1+l9vet2h",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 from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},g={},j=[{value:"Request",id:"request",level:2}];function y(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.44854024.js b/assets/js/70853c19.44854024.js deleted file mode 100644 index 7ad73c963..000000000 --- a/assets/js/70853c19.44854024.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>u,contentTitle:()=>j,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),t=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWW1v2zgS/itTFri7LRTb6WaBhbA4bLY1esY2L6gT5ENspLQ0lrihSC1J2TEMf7tfcj/tfslhSMmWnazbokVb4JwPsSw+Q84MHw7Jx0vmeGZZfMtucJJrfc/GEUvRJkaUTmjFYnaVI1g+Q9AGqjLlDqHGwunlALiUeg4LXYHTATevWysjYZ6LJAdhobKYEsIZkWVoAGeonB2p58+f18/xSI3UcQdevJgJnGMav3gxUgAAR3CTowIrMoUGQiOkOqkKVA5cLmzoAeZCymaATrB9//59eFiGD/obMQ8fsRhGLHQ3YlG7XU/+wMQN0hGLR+z1xavrs/751d3g9Yi1UVMhMXSyhly/e7vTleLFLuj89Ky/i9KuRl1K5BbBIDkGXKU+7hBlE/OOcWu6Qh877SFxltpuN++3UrLr63Dw5rz/7rGndfoKLuQWsH92Onj7BLLMtdru8vJfF+f9dh4BVpsv4y3Hw9z8tvjAUA3wtJ7Sq8FZf3h1ena5g0oMcvckrEGtRuolEbBG7jJwzTlhoYZ8Lv3qbg78+x7591GE8VD1I9HGB7qXNQEBk0VTzT6TPqG/A3u+JXtaZuNHjn92UVoRu058UdJFKfEDZWlDMC5lTTL7AZZ9RJVqhj4w7busU830fJEd0EPVT0S5FBMpPlDSGsyXK2pNjweyfY9ka2bnI45lDfSL0JJFTJdoOGV0kLKY0V3jb+FC0txdImbwzwqt+02nCxYvd24yl0bPRIr+YuJ0fYSDjXGilUPlyJCXpRSJH6z7hyXrJbNJjgWnJxpFGEzp3nRtJN2Z3KJEFtckZRErDXnrBFoyqIykjxpknREqYxGbalNw136DD5zWMotZ7lxp4253oStzVF+pjiojf60hnUQXbLWKmBPOG9SYuwnFvlpRk0FbamWDDy97vccpGVZJgtZOKwnr7H5KJvaHbdBW0j0V+SbO5i4ZZjIFu/ZILp5tBSgUsemuCeruZa9393Md6cmTwekCXS5UBnNfi4xWWQRlWMzOLIBnXCiQ3KF59uWiRmO02R/0p3m2Lwknvd7d8ToJx4+TcNO6jXNpkKcLwAdhnf26Ie/zY3+Ax3fzdYAnjwO8tmhAaQdTXan06wa1O/b+QE7WYfz0OIyBmnEpUq+pXOl7VF83kvbwLgxPrj4UvnDRJuRD8iDfzrZCbb8PQVpMKiPcgsW3S/ZwxEtxFNrj2/FqHDFaAJrqeKmt95i7nMWsO1+XY4tmhsb6DnwBXddEy1U60Q8dXaKijVTyiaV62OWl6M6O2SrateBl+Qlo63gmVHa012q8iXFI8xBSvRXpOuG8FL/jgkVNItuoiAma/xx5isYnnab33WYj6zeTtOvm/q2B+p1q70Q9TRclqiEdXGiSZ8dsV+m7QZnoAr1MlyM08P/++z/eojnpeA4+g4vKQKnnaGjzoDPRVOKDmEjcyIJ2rQsiLyRaKxcglMPM0Mabikw4Hm4pVAoTXvKJkIJYSzBN1gZaxLcdOn+6HA01/d0gcEhxhpLIDlLre+rHaeCV04UfozmpzrW5n5JLEXCYVFYotBYsYmOCKucqQWjmNCK9kytA5dCURlgELgoCT7UBnE5FIqhjWqKGJw4KrniGNFgE5DdloQwnDgtGTyrrwGpZ+UBoxALRhRAVYmo78FrMMAROL1N0XEhMIauoiwgSnSLUU0xhqBQmaB2UNLxI0HdqHTcOJM7QeA77maTNFEpNpURwCXq6NbfUkTNcWTqOBIeaqVmnrzSadmU/RsoXHSCxlnYxEnaJAFKoe5Jwj+B2TbMbnFjhcPyPhrDz+fzRevph2+aNcHk1AYOl3thl/qVffW3z9ZcfWMQcmsJeTIdoZiJpDlB/MWbXg7t1geWJL7D+AB3W6q+7BrSapEhQWWyVw9M3l29hBj92eixqLc2PcLj7dvCqfz7sU79U48L6O+70Oj16RSWx4Ko11LAW4K+3BPjdFbzcbBgH2f5wQzzI9gfZ/v+QfwfZ/sCeg2x/kO2/F6YdZPsD2b452b6hbF9rIA4fXLeUXHjpqFbEg+pz24jXpKTnpAfFt2y5nHCL10auVvT6zwoNiUnjiM24EXxCksbteBU1ygnJRPe4YDF7FS5BR1c0MMFlFUSYHQWNhJ9gcZokWLq92LZkdXkxvGIRm9S/MhQ6JRvD5/QLBJ+zmBFx/C8W/rbvtXB6v2SSq6ziGeFDvyT48Iqy0FaL7r1aVD9QZE2TWrS83JaRQij0nwJ70uAXuvr9jot/ruGh5S8N6tw2aJq78Wq1+h+PQIzq",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save 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:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWW1v2zgS/itTFri7LRTb6WaBhbA4bLY1esY2L6gT5ENspLQ0lrihSC1J2TEMf7tfcj/tfslhSMmWnazbokVb4JwPsSw+Q84MHw7Jx0vmeGZZfMtucJJrfc/GEUvRJkaUTmjFYnaVI1g+Q9AGqjLlDqHGwunlALiUeg4LXYHTATevWysjYZ6LJAdhobKYEsIZkWVoAGeonB2p58+f18/xSI3UcQdevJgJnGMav3gxUgAAR3CTowIrMoUGQiOkOqkKVA5cLmzoAeZCymaATrB9//59eFiGD/obMQ8fsRhGLHQ3YlG7XU/+wMQN0hGLR+z1xavrs/751d3g9Yi1UVMhMXSyhly/e7vTleLFLuj89Ky/i9KuRl1K5BbBIDkGXKU+7hBlE/OOcWu6Qh877SFxltpuN++3UrLr63Dw5rz/7rGndfoKLuQWsH92Onj7BLLMtdru8vJfF+f9dh4BVpsv4y3Hw9z8tvjAUA3wtJ7Sq8FZf3h1ena5g0oMcvckrEGtRuolEbBG7jJwzTlhoYZ8Lv3qbg78+x7591GE8VD1I9HGB7qXNQEBk0VTzT6TPqG/A3u+JXtaZuNHjn92UVoRu058UdJFKfEDZWlDMC5lTTL7AZZ9RJVqhj4w7busU830fJEd0EPVT0S5FBMpPlDSGsyXK2pNjweyfY9ka2bnI45lDfSL0JJFTJdoOGV0kLKY0V3jb+FC0txdImbwzwqt+02nCxYvd24yl0bPRIr+YuJ0fYSDjXGilUPlyJCXpRSJH6z7hyXrJbNJjgWnJxpFGEzp3nRtJN2Z3KJEFtckZRErDXnrBFoyqIykjxpknREqYxGbalNw136DD5zWMotZ7lxp4253oStzVF+pjiojf60hnUQXbLWKmBPOG9SYuwnFvlpRk0FbamWDDy97vccpGVZJgtZOKwnr7H5KJvaHbdBW0j0V+SbO5i4ZZjIFu/ZILp5tBSgUsemuCeruZa9393Md6cmTwekCXS5UBnNfi4xWWQRlWMzOLIBnXCiQ3KF59uWiRmO02R/0p3m2Lwknvd7d8ToJx4+TcNO6jXNpkKcLwAdhnf26Ie/zY3+Ax3fzdYAnjwO8tmhAaQdTXan06wa1O/b+QE7WYfz0OIyBmnEpUq+pXOl7VF83kvbwLgxPrj4UvnDRJuRD8iDfzrZCbb8PQVpMKiPcgsW3S/ZwxEtxFNrj2/FqHDFaAJrqeKmt95i7nMWsO1+XY4tmhsb6DnwBXddEy1U60Q8dXaKijVTyiaV62OWl6M6O2SrateBl+Qlo63gmVHa012q8iXFI8xBSvRXpOuG8FL/jgkVNItuoiAma/xx5isYnnab33WYj6zeTtOvm/q2B+p1q70Q9TRclqiEdXGiSZ8dsV+m7QZnoAr1MlyM08P/++z/eojnpeA4+g4vKQKnnaGjzoDPRVOKDmEjcyIJ2rQsiLyRaKxcglMPM0Mabikw4Hm4pVAoTXvKJkIJYSzBN1gZaxLcdOn+6HA01/d0gcEhxhpLIDlLre+rHaeCV04UfozmpzrW5n5JLEXCYVFYotBYsYmOCKucqQWjmNCK9kytA5dCURlgELgoCT7UBnE5FIqhjWqKGJw4KrniGNFgE5DdloQwnDgtGTyrrwGpZ+UBoxALRhRAVYmo78FrMMAROL1N0XEhMIauoiwgSnSLUU0xhqBQmaB2UNLxI0HdqHTcOJM7QeA77maTNFEpNpURwCXq6NbfUkTNcWTqOBIeaqVmnrzSadmU/RsoXHSCxlnYxEnaJAFKoe5Jwj+B2TbMbnFjhcPyPhrDz+fzRevph2+aNcHk1AYOl3thl/qVffW3z9ZcfWMQcmsJeTIdoZiJpDlB/MWbXg7t1geWJL7D+AB3W6q+7BrSapEhQWWyVw9M3l29hBj92eixqLc2PcLj7dvCqfz7sU79U48L6O+70Oj16RSWx4Ko11LAW4K+3BPjdFbzcbBgH2f5wQzzI9gfZ/v+QfwfZ/sCeg2x/kO2/F6YdZPsD2b452b6hbF9rIA4fXLeUXHjpqFbEg+pz24jXpKTnpAfFt2y5nHCL10auVvT6zwoNiUnjiM24EXxCksbteBU1ygnJRPe4YDF7FS5BR1c0MMFlFUSYHQWNhJ9gcZokWLq92LZkdXkxvGIRm9S/MhQ6JRvD5/QLBJ+zmBFx/C8W/rbvtXB6v2SSq6ziGeFDvyT48Iqy0FaL7r1aVD9QZE2TWrS83JaRQij0nwJ70uAXuvr9jot/ruGh5S8N6tw2aJq78Wq1+h+PQIzq",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"}},u={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function v(e){const n={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Save or Update Webhook"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,a.jsx)(n.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,a.jsx)(n.h3,{id:"events",children:"events:"}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"viewed:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "event": "viewed",\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"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"created:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "event": "created",\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'})}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"signed:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "event": "signed",\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 "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"completed:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "event": "completed",\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 "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"declined:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "event": "declined",\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'})}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,a.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,a.jsx)(n.p,{children:"Provide url to create Webhook"})})}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(m.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"401",value:"401",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Webhook url already exists!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.ce18ae1a.js b/assets/js/70853c19.ce18ae1a.js new file mode 100644 index 000000000..f62d8d319 --- /dev/null +++ b/assets/js/70853c19.ce18ae1a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>I,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var l=s(85893),a=s(11151),i=s(58219),r=(s(62316),s(51039)),t=s.n(r),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWW1v2zYQ/itXFthLodhOlwGDMQzLWqMz1rygTpAPsZHS0lniQpEqSdkxDH/bL9lP2y8ZjpRs2cncFg26DnM/NIn43PHu+PBI3i2Y46ll3Wt2heNM61s2iliCNjaicEIr1mUXGYLlUwRtoCwS7hAqLByf94FLqWcw1yU4HXCzarQ0EmaZiDMQFkqLCSGcEWmKBnCKytmhevr0afV7d6iG6rAFz55NBc4w6T57NlQAAAdwlaECK1KFBsIgJDouc1QOXCZs0AAzIWU9QSvIvn37NvyyCD/o35B5+JB1YciCuiGLmuN6/DvGrp8MWXfIXp69uDzpnV7c9F8OWRM1ERKDkhXk8s3rLVWK59ug0+OT3jZKuwp1LpFbBINkGHCVeL+Dl7XPW8KN5Qo6tsZD4CyNXa+/b4Rk29ZB/9Vp7819S6vw5VzIDWDv5Lj/+gFkkWm1qfL817PTXjOOAMv1H6MNw8Pa/DJ/z1Q18Lha0ov+SW9wcXxyvoWKDXL3IKxGLYfqORGwQm4zcMU5YaGCfCr9KjV7/n2J/PsgwhBS7SSI0WWaQWL4xIHDvJCUQil17rnzn+TOPWRpGhr7p69CKB+VYjBU31Fm8vHYmZgCAsbz+sD8RJYFfXuS/ZsJqiE2umf4J597S2LXkT/3dF5IfM/JtyYYl7IimX0Pyz4gmdVT75n2RR6F9fI8yiXLQ9X3RLkEYynek9JqzOMltVrjnmxfItnq1fmAm38NfRRasojpAg2niPYT1mX0nP0qvHnr53HEDL4r0bpfdDJn3cXWY/nc6KlI0L99na4ugbAWjrVyqBwJ8qKQIvaTtX+3JL1gNs4w5/QbzSIMJvQ0vzSSnuVuXiDrViRlESsMWesEWhIojaQfFcg6I1TKIjbRJueu+QXvOO1l1mWZc4XttttzXZqD6tV+UBr5cwVpxTpny2XEnHBeoMLcjMn35ZKGDNpCKxtseN7p3A/JoIxjtHZSSlhF92Misdttg7aU7iHP137W5YqwkgnYlUVy/mTDQaGITTe1UzfPO52bHypPjx50TufoMqFSmPlcZLRKIyjCZnZmDjzlQgFd+c2Tx/MajdFmt9MfZ9muIBx1OjeHqyAc3g/CVaPgw6VBnswB74R19vO6vMuO3Q4e3sxWDh7dd/DSogGlHUx0qZLP69T23LsdOVq58f19N/pqyqVI/NvzQt+i+ryeNKd3YXoy9S73iYsOIe+SB/lxtuFq83tw0mJcGuHmrHu9YHcHvBAHYbx7PVqOIkYbQFMeL7T1FnOXsS5rz1bp2KKZorFegU+gq5xouUrG+q6lC1R0kEo+tpQP27wQ7ekhW0bbErwoPgJtHU+FSg92So3WPg5oHUKoNzxdBZwX4jecs6gOZBMVMUHrnyFP0Pig0/K+WR9kvXqRts3cfTSQ3on2RlTLdFagGtDFhRZ5esi2i8lXKGOdo68EZwg1/K8//vQS9U3Hc/AJnJUGCj1DQ4cH3YkmEu/EWOK68mxXpWfkuURr5RyEcpgaOngTkQrHwyuFUmHMCz4WUhBrCaZJ2kCD+LZF90+XoaGhrw0ChwSnKInsILW+JT1OAy+dzv0c9U11ps3thEyKgMO4tEKhtWARaxFUGVcxQr2mEZXUuQJUDk1hhEXgIifwRBvAyUTEghTTFjU8dpBzxVOkySIguykKRbhxWDB6XFoHVsvSO0Iz5oguuKgQE9uCl2KKwXH6mKDjQmICaUkqIoh1glAtMbmhEhijdVDQ9CJGr9Q6bhxInKLxHPYrSYcpFJpSieAS9GRjbUmRM1xZuo4Eg+qlWYWvMJpOZT9HwuctoH4AnWLUOyACSKFuqUtwANcrml3h2AqHo29qws5ms3v76dtNmVfCZeUYDBZ6LZf6j373NcVXf3zLIubQ5PZsMkAzFXF9gfqHOdse3K4SLI99gvUX6LBXf94WoN0kRYzKYiMdHr86fw1T+K7VYVFja36Awe3X/Re900GP9FKOC/vvsNVpdegTpcScq8ZUg6rHc7nR49newYv1gbHvDO1fiPvO0L4z9D/k374ztOfOvjO07wz9GyTbd4b2TPuSjsJ9Z2hPtv9BZ6gqszm8c+1CcuGrk1XTJRQWr+v+CDVrMio5dq/ZYjHmFi+NXC7p87sSDdUrRxGbciP4mKpm16NlVBfnqBJ5i3PWZS/CO/vggiYmuCxDnW+rSEu1xSBxHMdYuJ3YZlX0/GxwwSI2rhpZuU5IxvAZNbn4jHUZEcc3xXxBybdb6PuCSa7SkqeED3qppshLikKzIHnrC5LVL+RZPaTmDSs3K5XBFfqfHHtQ4Ee6Iv+G859W8DDyjwJVbGs0rd1ouVz+DRVZ3RE=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save 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:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWW1v2zYQ/itXFthLodhOlwGDMQzLWqMz1rygTpAPsZHS0lniQpEqSdkxDH/bL9lP2y8ZjpRs2cncFg26DnM/NIn43PHu+PBI3i2Y46ll3Wt2heNM61s2iliCNjaicEIr1mUXGYLlUwRtoCwS7hAqLByf94FLqWcw1yU4HXCzarQ0EmaZiDMQFkqLCSGcEWmKBnCKytmhevr0afV7d6iG6rAFz55NBc4w6T57NlQAAAdwlaECK1KFBsIgJDouc1QOXCZs0AAzIWU9QSvIvn37NvyyCD/o35B5+JB1YciCuiGLmuN6/DvGrp8MWXfIXp69uDzpnV7c9F8OWRM1ERKDkhXk8s3rLVWK59ug0+OT3jZKuwp1LpFbBINkGHCVeL+Dl7XPW8KN5Qo6tsZD4CyNXa+/b4Rk29ZB/9Vp7819S6vw5VzIDWDv5Lj/+gFkkWm1qfL817PTXjOOAMv1H6MNw8Pa/DJ/z1Q18Lha0ov+SW9wcXxyvoWKDXL3IKxGLYfqORGwQm4zcMU5YaGCfCr9KjV7/n2J/PsgwhBS7SSI0WWaQWL4xIHDvJCUQil17rnzn+TOPWRpGhr7p69CKB+VYjBU31Fm8vHYmZgCAsbz+sD8RJYFfXuS/ZsJqiE2umf4J597S2LXkT/3dF5IfM/JtyYYl7IimX0Pyz4gmdVT75n2RR6F9fI8yiXLQ9X3RLkEYynek9JqzOMltVrjnmxfItnq1fmAm38NfRRasojpAg2niPYT1mX0nP0qvHnr53HEDL4r0bpfdDJn3cXWY/nc6KlI0L99na4ugbAWjrVyqBwJ8qKQIvaTtX+3JL1gNs4w5/QbzSIMJvQ0vzSSnuVuXiDrViRlESsMWesEWhIojaQfFcg6I1TKIjbRJueu+QXvOO1l1mWZc4XttttzXZqD6tV+UBr5cwVpxTpny2XEnHBeoMLcjMn35ZKGDNpCKxtseN7p3A/JoIxjtHZSSlhF92Misdttg7aU7iHP137W5YqwkgnYlUVy/mTDQaGITTe1UzfPO52bHypPjx50TufoMqFSmPlcZLRKIyjCZnZmDjzlQgFd+c2Tx/MajdFmt9MfZ9muIBx1OjeHqyAc3g/CVaPgw6VBnswB74R19vO6vMuO3Q4e3sxWDh7dd/DSogGlHUx0qZLP69T23LsdOVq58f19N/pqyqVI/NvzQt+i+ryeNKd3YXoy9S73iYsOIe+SB/lxtuFq83tw0mJcGuHmrHu9YHcHvBAHYbx7PVqOIkYbQFMeL7T1FnOXsS5rz1bp2KKZorFegU+gq5xouUrG+q6lC1R0kEo+tpQP27wQ7ekhW0bbErwoPgJtHU+FSg92So3WPg5oHUKoNzxdBZwX4jecs6gOZBMVMUHrnyFP0Pig0/K+WR9kvXqRts3cfTSQ3on2RlTLdFagGtDFhRZ5esi2i8lXKGOdo68EZwg1/K8//vQS9U3Hc/AJnJUGCj1DQ4cH3YkmEu/EWOK68mxXpWfkuURr5RyEcpgaOngTkQrHwyuFUmHMCz4WUhBrCaZJ2kCD+LZF90+XoaGhrw0ChwSnKInsILW+JT1OAy+dzv0c9U11ps3thEyKgMO4tEKhtWARaxFUGVcxQr2mEZXUuQJUDk1hhEXgIifwRBvAyUTEghTTFjU8dpBzxVOkySIguykKRbhxWDB6XFoHVsvSO0Iz5oguuKgQE9uCl2KKwXH6mKDjQmICaUkqIoh1glAtMbmhEhijdVDQ9CJGr9Q6bhxInKLxHPYrSYcpFJpSieAS9GRjbUmRM1xZuo4Eg+qlWYWvMJpOZT9HwuctoH4AnWLUOyACSKFuqUtwANcrml3h2AqHo29qws5ms3v76dtNmVfCZeUYDBZ6LZf6j373NcVXf3zLIubQ5PZsMkAzFXF9gfqHOdse3K4SLI99gvUX6LBXf94WoN0kRYzKYiMdHr86fw1T+K7VYVFja36Awe3X/Re900GP9FKOC/vvsNVpdegTpcScq8ZUg6rHc7nR49newYv1gbHvDO1fiPvO0L4z9D/k374ztOfOvjO07wz9GyTbd4b2TPuSjsJ9Z2hPtv9BZ6gqszm8c+1CcuGrk1XTJRQWr+v+CDVrMio5dq/ZYjHmFi+NXC7p87sSDdUrRxGbciP4mKpm16NlVBfnqBJ5i3PWZS/CO/vggiYmuCxDnW+rSEu1xSBxHMdYuJ3YZlX0/GxwwSI2rhpZuU5IxvAZNbn4jHUZEcc3xXxBybdb6PuCSa7SkqeED3qppshLikKzIHnrC5LVL+RZPaTmDSs3K5XBFfqfHHtQ4Ee6Iv+G859W8DDyjwJVbGs0rd1ouVz+DRVZ3RE=",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"}},j={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function v(e){const n={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(n.p,{children:"Save or Update Webhook"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(n.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,l.jsx)(n.h3,{id:"events",children:"events:"}),"\n",(0,l.jsxs)(n.ol,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"viewed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "viewed",\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"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"created:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "created",\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'})}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["When document is created through draft template API this event will trigger.","\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "created",\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'})}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.ol,{start:"3",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"signed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "signed",\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 "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"completed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "completed",\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 "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"declined:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "declined",\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'})}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(n.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(n.p,{children:"Provide url to create Webhook"})})}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Webhook url already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function I(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.00fb612b.js b/assets/js/ae010e44.00fb612b.js deleted file mode 100644 index 0e94adda3..000000000 --- a/assets/js/ae010e44.00fb612b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4930],{80204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),r=(s(62316),s(51039)),t=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztOtuSG7exv9LBi6ytIXdJrWQdVioVWXIcJbal8q7LlVpurcGZJgdaDDAGMEvSW6zKw/mMk5d8mr/kVOMyM+TeLNuVbCrUw4oDNBrdjUajb9fM8YVlkzP2RudNhcpZdp6xAm1uRO2EVmzCTksEi3JuxULBq/dvYYEKDXdogcO333wJruQOUPGZRAtzg2jdWiIQvFAL0HPgUET8Q/ibbiDnCri0GoTKZVMgaL8Zl1AbHBQ4FwoLWIpigc5msCxFXoIrA040fj0WwoE2gKuaqwKaWivgFhRigcUQTkthoTb6ShSe0EQNrmo0AlVOyCohuQGnPe6f/v5/J8Ti33RjiN+f/v4PmEu9BKH8/LsalQfgdT2cqqk6FfUEvq2l5gWsdWPg/Zs/tYwSVho7Ozh4g7NmAd++PTg4/6R0rraTw0PCoWtURJbkMzvMdXVYEGBdzJ8Sy2iQsAZeuRVyDbzoCcWVqCDX9RpyrU0hFJ1IBjVfIKimmqGxGZBkKm2QeOBgkBfrgdODxiL85eTd1zDXpuJuCO9lY7N2u0IYzJ1cB/TEe+LqiYUZt/jiGKwzQi0yqPgliVU4+KER+SWxbVEVSaiv3r/1sjo4OGnqWhuHBXwXWJgcHNDMZ0gy5gY9fK6rSiuoueEVOjQ2aBdNG/yhEcbrhSuBS5lkMZmqARwcuHWNk4MDeKsKkXv1JIQ0SioYYIcBlIREoCc15mIuImhPdKBV1DqSyZKH86wlzwOZBm2NuRNXuI14lcGaEL9BpRMFpTbiR60cl/44rtA4kXPZPzYi0Ku348aROGstlEujcYf25tDp+UOJekWkFSSsSig/YxGuuGzQRqqWGZRE1TdYG7R0yxNeEqQqoESxKO/cjxcfGuu2EENjicw+FXGvdEpevOjFNufSIoj5liwrfom93VoLMITP1lDgnDfSZSBI45xpcAhfa0c3T4qcDA1prr/T3DUGB/6UozpEQhSv/Bm/72xAIeZzNHQ5adKjiGsSdaRnwWgQe/7muJIr0GrnoHMttSH0Ozrkx7cFCblWzpu+V1dcSE994Na29m8meX6ZwUw2mIHBItzcNUqpl1lQeA9CFi4I3QuI7DKpoVbEgNJxe2HBRqpaS5guFE221pY2EbYv1nht55p2JhmkOwZYcSEzL7kMPugZOOEkZnRja67WGRTcYQYOV26mVxnkJeaXM72KAptr5az48ZZrl2Y+XmrjDI4zeJHBywxGRxmMxhmMjjMYvchg9DKD8VEG43EG4+MMxi+CTMcvozx5K8Q+AaNxkKR7XBIkA/qlsP6KkuWzrTFdbhnTqRoN4eCgvRh++Pvvv5+q66kCmDK6KFM2mbIWZMoyCHNk/6ZsMsogDqymbALPxp8mgDV9vyAJhu8lfY9I4uG7pO/xaKo2cdOxJ8bxqr6HEJr+7YlIn1FnaNDvTGPJRtEgGZcASzN0NjTakkUTm46hZ8SQUMIJLu3dPCWIx8dWR9kOZ8fEmdfQu9ny04+Pp0RWmvFGMEx5o9mbSlfdEzLeEcHzYfds3CGBsOljE0Ck6tfy/4L4b+3S3UJoQR6fJPqk/VpxfDr077y3zXcLIwI8PlF0hP1aQbwkQdDbdLcUaPbxiSBSlSbiex/mjo4Ho+eD8dH4eEsMFA4FgKoaFMVgvV7/ShGCFxi5QHF/7zVGrzQ4c9whzI2ubgk5fETQQUUXyf9ObvpX5JzPkt+KRYpXWwemjfL6nrXTBV8/sQFVWtr6agTfeWrrHpl+iujwEW9eapFH4gkmeWgzCuqGJIQBCb44/Oqrw54ow+CgqpJ8IY3S98CLvj9aVcOiGO7Cbp1Qb7SCosjglvHbJ4oCqqq6azxM0HM5Vf9DFyG6Z3ffhQjw+K5DR9itN2LnFSmFihNRO2AHwOCikdzgioJKK7Ty3P8G9mbnrqSr0jnsPgb14ZuP8ANb8Mm76JQ/jWpMHGwjoJGH191grI/E4AJXHkfeWKcrIkYUnDBkYJu8pBCNJ99fK7nusjH+K+e1oFyAROf8KLp8uE3EVI2O/OMTA4B7Xp8I8fiUrUdZmgypA5o+m7KKR/+BzbH7rV2JZsrO2zUhwMWitxZuWwznPb3kBUmagH3qoSOvFAVKPkPZzf0WyhqI62tJsoNJ15I0QAqbUgjbrPVXxxyLz3xRPpMeghlCWgCz1o7fpryB+17+hY5oN/1i0W0Txi2kpbekYLys0q2KMnxgB4IDD9imt9qA9o4Ngur7CFZUIUV3V4BVeTV/bEofydpREZYxXVPGXGj1tmATlrLpLPNY0brPdLFmk2sWkx70M6YUaNHhB0uZ+Gtm8xIrTr8SNZS7nwuJLGMhN25ZxrwHTIl8khebMD37gLljGVnymtKPaAmHXze5TlAho8uy6AWxCQupXpYxXPGqJuA4BKhyTa5GXczZJm14H6p2pENl/Y82tUx4tgoPvwjbmx6GTcYoC/sLMX1NSz1vFZ7q15oGHb7ha9tDGEw72y2Z0Bq6A3lcBQVfW8oTNTbc5pzLvJHkUOGqFmbdenfeq2pF0iO03akldPR8kw69R9EdZ230xx9QjpoE4MPrj137QeMM8Y9xgKob/jh49dFUfNAIM/RHUZdaffT60fjZaDx6NhoThpgt6+HgxvA1y5hwWNmH5Rhmb1Kwff6v6P3HIhnyQZepzsAnloYP6WCC92zzBT6sc6d3VTB6OVVb6kYWlK1Eboa+kPCLa1TbakybeG6HDyjtJmOrh5lZQa4HqTwCn0icO2jqmkp/2ig0T/vx0qNhbnx8vMnY+mH21v+R7H1Kh7d8mLvvfF2pq7n9O2h99nKTsfJhWv/cVr7+jcQev9h0jyjLDXKH6Q24mOlifZHs1qYPmNyIbdD4ImxoR1mgIY/jpr3qTA1BUsX2YtfOz7SWyNUthmarGuJjHetdP/IrY8JgWSK58p1H6LHb1pONXmhwWajCgjvRnbDk75kGp2wIb+edLIMzuVuQSbC+IKM0PPH7XdjGm/Enh/GbJPSkX12mgl+XKEkkeGBwWNXSl2eXQkqim57vIbT/vGvXSpIISM9l2vjhp+J1iCL9hnHRdm0Toos4hNdctaWv7RITXF+3SuC1Y7OB62s6VTQX9OhuNlk3QHttDfh3NYwYzFFcba1qh7Bb2I71lgZP5oI8mTAQM5B9AkITxkVj5GYzvKGG3Rn9bLndEFM8O0Ly3yAx33VzqhvzMy6uj9IG4fKECCcodkACHBaNzx86Mn9JB32KoiuJC2WdafIQ3RaNSV0Aqb2mNjpHa4ex6D+AQthQFi2xjz8DVDYs5zDn1qHJoFFCOTSmqSnKvdmxs8W/3+BBcxgsZhctxUtK/Rta2eDTjY+O6L9tYaWGKIjmmHI7xNm8kXL9O5b9/FDtfocyDN9upO/zEMsPYvzjKr8avyc9aMxHe+jpQWuMpJYgktyg7dLy/npPtkJJofAiie1ifHR0MSLZbjJ2fJv4TnSFrvTlbxLi0mhqFqolcmpeMWvgCy4UkHk1v6E00Rht7n/vPo6y+4RwvCWE5zeF8Fb55KBvmjvVl6j+tZz2t3dheyJ1VXldCbEYEwHIz7MtZvvjgUmLeWOEW7PJ2TVbDXgtBmF+cna+Oc8YCVZTgqPW1lPMXckm7LCX77BorihJQRi80rZ6aLkqKDd0w7nitTi8GrFNtrviVlfsTmjr+EKoxeDeVecdkyd0EEHWW6x2kWMt/ooUOkZJ9qEyJkgBSuQF+WKbjNH5ftMlez5Pp5TSMLdlVnq2bSdXsmvab8l+pOTHVj7j9nTG6Hk/kRBSBT76b4P/2+L5lvEUobcBei/m7oXcZ52uttFtCm5HPiocHx/78OnTkY8znr30Lvzxi835ljfL2LbH6rNxu34XY9v+hP/uvZbh+aBzmmt/qFHSbZcn3Zqr0c3gBmWuq7bNJ4H/9L//9CvSCflL/Tt41xio9RLNvAm9QnOJK0HvIQHvuM7IK4nWyjXQM7igFlsoxMJXC9JjmPOaz4QUZAYITIeMUc+S2CF81znfT0wonFyhJOsBUmvfr+k08Mbpyu+RnrqlNpfU8UqNozCjFj+0FixiWoKq5L5zNt6RjBpwqT+Vnu3aCIvARUXA5D7gfC5y4d9QrZzhuYOKK75A2izzQRZJoW3SNXpGpUyrZRP8C2oTRHSBRUqE2yG8oZ5Lz7jPlKHjQmIRXAtLvVQF5dS8lsb+1xl5hTVtL3K0XVFV4hUabxOCb9hICbUm2yy4pCijf7aEyBmuLD2pMUsXj6YVX/R9/B4FXw+B0tn03FDcQAoghboM3apnrZp9hzMrHHYB5nK5vGGfnm6v+UK4spmBwVp36xZ+0Fuz/vL24yldfjSVfTc/QXMl8uQE3LHnoQc+jC8WD7FMMge8Fn/cXUCvhxQ5Kou99+XVF++/hCt4NjxiWc8i/wyCD798+/rzr08+J7z0ZoT7NxoeDY98VkxbV3HV2+oE5RxOwjuzk0luH919N/u+m33fzb7vZt93s++72ffd7Ptu9n03+76b/XHxtO9m33ez77vZ993s+272fTf7vpt9382+72Z/BMq272bfd7Pvu9lTN3ss45HJOawlF6rXghBqvmddj/t5xkoqB0/O2PU1pVu/pVYWGv6hQUO15POMXXEjKN/gK8lZqptSyfASqXj3OqRPBqe0cxbuni9D7BTQqewbVrzKc6zdvbD9ivX7dyenLGOp96jSBa0xfEk9+nzJJoweA9/J74XpC6XcN0NKrhaNr2KygJfKvbxx5Xat+NLXiuOPXjGUq3WPyu0icmCF/hJjty74PdUw/orrP7TgYebOBVG2CZoO73yz2fw//gzHCA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",source:"@site/docs/API-docs/selfsign.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/selfsign",permalink:"/docs/API-docs/selfsign",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztOtuSG7exv9LBi6ytIXdJrWQdVioVWXIcJbal8q7LlVpurcGZJgdaDDAGMEvSW6zKw/mMk5d8mr/kVOMyM+TeLNuVbCrUw4oDNBrdjUajb9fM8YVlkzP2RudNhcpZdp6xAm1uRO2EVmzCTksEi3JuxULBq/dvYYEKDXdogcO333wJruQOUPGZRAtzg2jdWiIQvFAL0HPgUET8Q/ibbiDnCri0GoTKZVMgaL8Zl1AbHBQ4FwoLWIpigc5msCxFXoIrA040fj0WwoE2gKuaqwKaWivgFhRigcUQTkthoTb6ShSe0EQNrmo0AlVOyCohuQGnPe6f/v5/J8Ti33RjiN+f/v4PmEu9BKH8/LsalQfgdT2cqqk6FfUEvq2l5gWsdWPg/Zs/tYwSVho7Ozh4g7NmAd++PTg4/6R0rraTw0PCoWtURJbkMzvMdXVYEGBdzJ8Sy2iQsAZeuRVyDbzoCcWVqCDX9RpyrU0hFJ1IBjVfIKimmqGxGZBkKm2QeOBgkBfrgdODxiL85eTd1zDXpuJuCO9lY7N2u0IYzJ1cB/TEe+LqiYUZt/jiGKwzQi0yqPgliVU4+KER+SWxbVEVSaiv3r/1sjo4OGnqWhuHBXwXWJgcHNDMZ0gy5gY9fK6rSiuoueEVOjQ2aBdNG/yhEcbrhSuBS5lkMZmqARwcuHWNk4MDeKsKkXv1JIQ0SioYYIcBlIREoCc15mIuImhPdKBV1DqSyZKH86wlzwOZBm2NuRNXuI14lcGaEL9BpRMFpTbiR60cl/44rtA4kXPZPzYi0Ku348aROGstlEujcYf25tDp+UOJekWkFSSsSig/YxGuuGzQRqqWGZRE1TdYG7R0yxNeEqQqoESxKO/cjxcfGuu2EENjicw+FXGvdEpevOjFNufSIoj5liwrfom93VoLMITP1lDgnDfSZSBI45xpcAhfa0c3T4qcDA1prr/T3DUGB/6UozpEQhSv/Bm/72xAIeZzNHQ5adKjiGsSdaRnwWgQe/7muJIr0GrnoHMttSH0Ozrkx7cFCblWzpu+V1dcSE994Na29m8meX6ZwUw2mIHBItzcNUqpl1lQeA9CFi4I3QuI7DKpoVbEgNJxe2HBRqpaS5guFE221pY2EbYv1nht55p2JhmkOwZYcSEzL7kMPugZOOEkZnRja67WGRTcYQYOV26mVxnkJeaXM72KAptr5az48ZZrl2Y+XmrjDI4zeJHBywxGRxmMxhmMjjMYvchg9DKD8VEG43EG4+MMxi+CTMcvozx5K8Q+AaNxkKR7XBIkA/qlsP6KkuWzrTFdbhnTqRoN4eCgvRh++Pvvv5+q66kCmDK6KFM2mbIWZMoyCHNk/6ZsMsogDqymbALPxp8mgDV9vyAJhu8lfY9I4uG7pO/xaKo2cdOxJ8bxqr6HEJr+7YlIn1FnaNDvTGPJRtEgGZcASzN0NjTakkUTm46hZ8SQUMIJLu3dPCWIx8dWR9kOZ8fEmdfQu9ny04+Pp0RWmvFGMEx5o9mbSlfdEzLeEcHzYfds3CGBsOljE0Ck6tfy/4L4b+3S3UJoQR6fJPqk/VpxfDr077y3zXcLIwI8PlF0hP1aQbwkQdDbdLcUaPbxiSBSlSbiex/mjo4Ho+eD8dH4eEsMFA4FgKoaFMVgvV7/ShGCFxi5QHF/7zVGrzQ4c9whzI2ubgk5fETQQUUXyf9ObvpX5JzPkt+KRYpXWwemjfL6nrXTBV8/sQFVWtr6agTfeWrrHpl+iujwEW9eapFH4gkmeWgzCuqGJIQBCb44/Oqrw54ow+CgqpJ8IY3S98CLvj9aVcOiGO7Cbp1Qb7SCosjglvHbJ4oCqqq6azxM0HM5Vf9DFyG6Z3ffhQjw+K5DR9itN2LnFSmFihNRO2AHwOCikdzgioJKK7Ty3P8G9mbnrqSr0jnsPgb14ZuP8ANb8Mm76JQ/jWpMHGwjoJGH191grI/E4AJXHkfeWKcrIkYUnDBkYJu8pBCNJ99fK7nusjH+K+e1oFyAROf8KLp8uE3EVI2O/OMTA4B7Xp8I8fiUrUdZmgypA5o+m7KKR/+BzbH7rV2JZsrO2zUhwMWitxZuWwznPb3kBUmagH3qoSOvFAVKPkPZzf0WyhqI62tJsoNJ15I0QAqbUgjbrPVXxxyLz3xRPpMeghlCWgCz1o7fpryB+17+hY5oN/1i0W0Txi2kpbekYLys0q2KMnxgB4IDD9imt9qA9o4Ngur7CFZUIUV3V4BVeTV/bEofydpREZYxXVPGXGj1tmATlrLpLPNY0brPdLFmk2sWkx70M6YUaNHhB0uZ+Gtm8xIrTr8SNZS7nwuJLGMhN25ZxrwHTIl8khebMD37gLljGVnymtKPaAmHXze5TlAho8uy6AWxCQupXpYxXPGqJuA4BKhyTa5GXczZJm14H6p2pENl/Y82tUx4tgoPvwjbmx6GTcYoC/sLMX1NSz1vFZ7q15oGHb7ha9tDGEw72y2Z0Bq6A3lcBQVfW8oTNTbc5pzLvJHkUOGqFmbdenfeq2pF0iO03akldPR8kw69R9EdZ230xx9QjpoE4MPrj137QeMM8Y9xgKob/jh49dFUfNAIM/RHUZdaffT60fjZaDx6NhoThpgt6+HgxvA1y5hwWNmH5Rhmb1Kwff6v6P3HIhnyQZepzsAnloYP6WCC92zzBT6sc6d3VTB6OVVb6kYWlK1Eboa+kPCLa1TbakybeG6HDyjtJmOrh5lZQa4HqTwCn0icO2jqmkp/2ig0T/vx0qNhbnx8vMnY+mH21v+R7H1Kh7d8mLvvfF2pq7n9O2h99nKTsfJhWv/cVr7+jcQev9h0jyjLDXKH6Q24mOlifZHs1qYPmNyIbdD4ImxoR1mgIY/jpr3qTA1BUsX2YtfOz7SWyNUthmarGuJjHetdP/IrY8JgWSK58p1H6LHb1pONXmhwWajCgjvRnbDk75kGp2wIb+edLIMzuVuQSbC+IKM0PPH7XdjGm/Enh/GbJPSkX12mgl+XKEkkeGBwWNXSl2eXQkqim57vIbT/vGvXSpIISM9l2vjhp+J1iCL9hnHRdm0Toos4hNdctaWv7RITXF+3SuC1Y7OB62s6VTQX9OhuNlk3QHttDfh3NYwYzFFcba1qh7Bb2I71lgZP5oI8mTAQM5B9AkITxkVj5GYzvKGG3Rn9bLndEFM8O0Ly3yAx33VzqhvzMy6uj9IG4fKECCcodkACHBaNzx86Mn9JB32KoiuJC2WdafIQ3RaNSV0Aqb2mNjpHa4ex6D+AQthQFi2xjz8DVDYs5zDn1qHJoFFCOTSmqSnKvdmxs8W/3+BBcxgsZhctxUtK/Rta2eDTjY+O6L9tYaWGKIjmmHI7xNm8kXL9O5b9/FDtfocyDN9upO/zEMsPYvzjKr8avyc9aMxHe+jpQWuMpJYgktyg7dLy/npPtkJJofAiie1ifHR0MSLZbjJ2fJv4TnSFrvTlbxLi0mhqFqolcmpeMWvgCy4UkHk1v6E00Rht7n/vPo6y+4RwvCWE5zeF8Fb55KBvmjvVl6j+tZz2t3dheyJ1VXldCbEYEwHIz7MtZvvjgUmLeWOEW7PJ2TVbDXgtBmF+cna+Oc8YCVZTgqPW1lPMXckm7LCX77BorihJQRi80rZ6aLkqKDd0w7nitTi8GrFNtrviVlfsTmjr+EKoxeDeVecdkyd0EEHWW6x2kWMt/ooUOkZJ9qEyJkgBSuQF+WKbjNH5ftMlez5Pp5TSMLdlVnq2bSdXsmvab8l+pOTHVj7j9nTG6Hk/kRBSBT76b4P/2+L5lvEUobcBei/m7oXcZ52uttFtCm5HPiocHx/78OnTkY8znr30Lvzxi835ljfL2LbH6rNxu34XY9v+hP/uvZbh+aBzmmt/qFHSbZcn3Zqr0c3gBmWuq7bNJ4H/9L//9CvSCflL/Tt41xio9RLNvAm9QnOJK0HvIQHvuM7IK4nWyjXQM7igFlsoxMJXC9JjmPOaz4QUZAYITIeMUc+S2CF81znfT0wonFyhJOsBUmvfr+k08Mbpyu+RnrqlNpfU8UqNozCjFj+0FixiWoKq5L5zNt6RjBpwqT+Vnu3aCIvARUXA5D7gfC5y4d9QrZzhuYOKK75A2izzQRZJoW3SNXpGpUyrZRP8C2oTRHSBRUqE2yG8oZ5Lz7jPlKHjQmIRXAtLvVQF5dS8lsb+1xl5hTVtL3K0XVFV4hUabxOCb9hICbUm2yy4pCijf7aEyBmuLD2pMUsXj6YVX/R9/B4FXw+B0tn03FDcQAoghboM3apnrZp9hzMrHHYB5nK5vGGfnm6v+UK4spmBwVp36xZ+0Fuz/vL24yldfjSVfTc/QXMl8uQE3LHnoQc+jC8WD7FMMge8Fn/cXUCvhxQ5Kou99+XVF++/hCt4NjxiWc8i/wyCD798+/rzr08+J7z0ZoT7NxoeDY98VkxbV3HV2+oE5RxOwjuzk0luH919N/u+m33fzb7vZt93s++72ffd7Ptu9n03+76b/XHxtO9m33ez77vZ993s+272fTf7vpt9382+72Z/BMq272bfd7Pvu9lTN3ss45HJOawlF6rXghBqvmddj/t5xkoqB0/O2PU1pVu/pVYWGv6hQUO15POMXXEjKN/gK8lZqptSyfASqXj3OqRPBqe0cxbuni9D7BTQqewbVrzKc6zdvbD9ivX7dyenLGOp96jSBa0xfEk9+nzJJoweA9/J74XpC6XcN0NKrhaNr2KygJfKvbxx5Xat+NLXiuOPXjGUq3WPyu0icmCF/hJjty74PdUw/orrP7TgYebOBVG2CZoO73yz2fw//gzHCA==",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:"Create Document",permalink:"/docs/API-docs/createdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Self Sign"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/selfsign"}),"\n",(0,i.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signer"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/ae010e44.595cd5c0.js b/assets/js/ae010e44.595cd5c0.js new file mode 100644 index 000000000..afe11545d --- /dev/null +++ b/assets/js/ae010e44.595cd5c0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4930],{80204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),l=s(58219),r=(s(62316),s(51039)),t=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztW1uPGzeW/itn+OK4UVK35LbjFRaLcezsjHeS2Eh3EAxajQ5VdaSim0VWSFZLSkPAPOzPmHnZn5Zfsji8VJXUNzsOZnqx8oOt4vWcj4eH5+Zr5vjCsskZe6PzpkLlLDvPWIE2N6J2Qis2YaclgkU5t2Kh4NX7t7BAhYY7tMDhh++/AVdyB6j4TKKFuUG0bi0RaLxQC9Bz4FDE9YfwV91AzhVwaTUIlcumQNB+My6hNjgocC4UFrAUxQKdzWBZirwEV4Y10fj5WAgH2gCuaq4KaGqtgFtQiAUWQzgthYXa6CtReEITNbiq0QhUOS1WCckNOO3X/vVvfz8hFv+qG0P8/vq3f8Bc6iUI5fvf1aj8AF7Xw6maqlNRT+CHWmpewFo3Bt6/+c+WUVqV2s4ODt7grFnAD28PDs6/KJ2r7eTwkNbQNSoiS/KZHea6OixoYF3MnxLLaJBWDbxyK+QaeNEDxZWoINf1GnKtTSEUnUgGNV8gqKaaobEZEDKVNkg8cDDIi/XA6UFjEf7r5N13MNem4m4I72Vjs3a7QhjMnVyH5Yn3xNUTCzNu8cUxWGeEWmRQ8UuCVTj4uRH5JbFtURUJ1Ffv33qsDg5OmrrWxmEBPwYWJgcH1PMVEsbcoB+f66rSCmpueIUOjQ3SRd0Gf26E8XLhSuBSJiwmUzWAgwO3rnFycABvVSFyL560ILWSCIaxwzCUQKKhJzXmYi7i0B50oFWUOsJkycN51pLngUyDtsbciSvcXniVwZoWfoNKJwpKbcQvWjku/XFcoXEi57J/bESgF2/HjSM4ay2US61xh/bm0On5Q4lyRaQVBFYllO+xCFdcNmgjVcsMSqLqe6wNWrrlaV0CUhVQoliUd+7Hiw+NdVsLQ2OJzD4Vca90Sh5e9LDNubQIYr6FZcUvsbdbqwGG8NUaCpzzRroMBEmcMw0O4Tvt6OZJkZOiIcn1d5q7xuDAn3IUh0iI4pU/4/edDijEfI6GLid1+iXinEQdyVlQGsSevzmu5Aq02jnoXEttaPkdGfLt20BCrpXzqu/VFRfSUx+4ta3+m0meX2Ywkw1mYLAIN3eNUuplFgTeDyENF0D3AJFeJjHUihhQOm4vLNhIVasJ04Wizlbb0ibC9mGN13auaWfCIN0xwIoLmXnkMvigZ+CEk5jRja25WmdQcIcZOFy5mV5lkJeYX870KgI218pZ8cst1y71fDpq4wyOM3iRwcsMRkcZjMYZjI4zGL3IYPQyg/FRBuNxBuPjDMYvAqbjlxFP3oLYJ2A0Dki6x4UgKdBvhPVXlDSfbZXpckuZTtVoCAcH7cXwzT/99NNUXU8VwJTRRZmyyZS1Q6Ysg9BH+m/KJqMMYsNqyibwbPxlGrCm7xeEYPhe0veIEA/fJX2PR1O1iZuOPTGOV/U9hFD3709E+owyQ41+Z2pLOooaSbmEsdRDZ0OtLVnUsekYekYMCSWc4NLezVMa8fjY6ijb4eyYOPMSejdbvvvx8ZTISj1eCYYurzR7Xemqe0LGOxA8H3bPxh0IhE0fGwCRqs/l/wXx3+qlu0Fohzw+JPqkfS4cXw79O+91891gxAGPD4qOsM8F4iUBQW/T3ShQ7+ODIFKVOuJ7H/qOjgej54Px0fh4CwZyh8KAqhoUxWC9Xn8mhOABIxMo7u+txmiVBmOOO4S50dUtLof3CLpR0UTyv5OZ/i0Z57Nkt2KR/NXWgGm9vL5l7XTB109sWCpNbW01Gt9Zausemb6L6PAeb15qkUfiaUyy0Gbk1A0JhAEBXxx+++1hD8rQOKiqhC+kVvoeeOj7rVU1LIrh7titE+q1VlAUGdzSfntHUUBVVXe1hw56Lqfq3+giRPPs7rsQB/xzr0Mn9N32D18VCghoJf3+3ku7/a7svC+lULEjyg3sDDC4aCQ3uCJ30wqtPC6/gybauUXpEnWmvPdOvWPnff8ABXzxLprrT6OAEwfbC1DLw/NuMNZfxOACV36NvLFOV0SMKDitkIFt8pKcN568AoK9i9P4r5zXgqIEEp3zrejy4W1EhEPredh0qrsOtkW3xQy3kGbe4mP70/eOxujIv3vR97jn4YsjHp/a71GWOkPUgrrPpqzi0XRhc+x+a1eimbLzdk7wrbHozYXbJsN5dvd9gu7SFCj5DOXNu/Y5tyEQ1xfDpIKTMCc0QAqbohfbrPVnx/COD7pRKJUkaYaQJsCsFZzPFsyWsI+TzHBvI4gPbEHjwA9sQ2utM32v7HvvWVQhPHiXc1d5OX9sUh/J2pERljFdU7ReaPW2YBOWIvks86uidV/pYs0m1ywGXOhnDGfQpMMPlrIA18zmJVacfiVqKG8wFxJZxkJc3rKMeeubkgiEF5swPfuAuWMZvRU1hT7R0hp+3uQ6jQrRZJZFC4xNWAgzs4zhilc1DY5NgCrXZObUxZxt0ob3LdW2dEtZ/6MNa9M6W0mP37Tam94Km4xRBPg3rvQdTfW8VXiqX2tqdPiGr21vwfB4sN10Dc2hO5DHWVDwtaUYVWPDdc65zBtJxhyuamHWrWXpLboWkh6h7U4toaPnm3ToPYruOGujP/2ActQEgHftP3XuB40zxD/GBsqs+OPg1SdT8UEjzNAfRV1q9cnzR+Nno/Ho2WhMK8RIXW8Nbgxfs4wJh5V9GMfQe5OC7fN/RRYGFkmTD7ooeQY+qDV8SAbTeM82X+DDMnd6V/akF8+1pW5kQZFS5Gbokxi/OT+2Lca0ied2+IDQbjK2epiZFeR6kFIz8IXEuYOmrintqI1C87Tvqz0a5sbHx5uMrR9mb/1/kr0v6fCWD3P3o89pdfm+fwWtz15uMlY+TOuf26zbv5DY4xeb7hFluUHuML0BFzNdrC+S3tr0ByYzYntofBE2tKMs0JDFcVNfdaqGRlK2+GJXz8+0lsjVLYpmKxPjvSnrTT8yLGOwYlki2fKdRehXt60pG83QYLJQdgd3/Edhyd4zDU7ZEN7OOyyDMbmbDEpjfTJIaXji97uwjVfjTw7jNyH0pJ/ZpmRjF6RJJPjB4LCqpU8NL4WURDc930No/3jTrkWSCEjPZdr44afidfBT/YZx0nZeFaKJOITXXLVpt+30Flxft0LgpWOzgetrOlU0F/TobjZZ10B7bTX4dzW0GMxRXG3Napuwm9i29aYGS+aCLJnQEKOffQJCAchFY+RmM7whht0ZfTRuN2CKZ0eL/H9AzFf8nOrGfMTF9V7aIFye4OEEwQ6LAIdF42OXjtRfkkEfBOnS8UJZZ5o8uLdFY1IFQirtqY3O0dphLDgYQCFsSMmW2F8/A1Q2TOcw59ahyaBRQjk0pqnJzb1ZLbTFv9/gQXUYNGbnLcVLSrUjWtlg042PjuifbbBSMRZEdUzRI+Js3ki5/gPLPt5Vu9+gDM23K+n7LMTygxj/ssqvxu9JDhrzyRZ6etAaI6kciZAbtBVi3l7vYSuUFAovEmwX46OjixFhu8nY8W3wnegKXelT7wTi0mgqVKolciqcMWvgCy4UkHo1vyOaaIw29793n0bZfSAcb4Hw/CYIb5UPP/qCvVN9ieqfy2l/exe2J1JXlZeV4IsxEQb5frbFbL89MGkxb4xwazY5u2arAa/FIPRPzs435xkjYDUFOGptPcXclWzCDnvxDovmioIUtIIX2lYOLVcFxYZuGFe8FodXI7bJdmfcaordOdo6vhBqMbh31nnH5AkdRMB6i9XOc6zFX5Bcx4hkf1TGBAlAibwgW2yTMTrf77tgz9fplFIY5rbISk+37cRKdlX7LdGPFPzYimfcHs4YPe8HEkKowHv/rfN/mz/fMp489NZB7/ncPZf7rJPV1rtNzu3Ie4Xj42PvPn058n7Gs5fehD9+sTnfsmYZ27ZYfTRu1+5ibNue8N+91zI8H3ROc+0PNSLdVpjSrbka3XRuUOa6akuM0vBf//t//Ix0Qv5S/wHeNQZqvUQzb0Kd0lziStB7SIN3TGfklURr5RroGVxQeS8UYuHzEekxzHnNZ0IKUgM0TIeIUU+T2CH82BnfT0xIzVyhJO0BUmtfK+o08Mbpyu+RnrqlNpdUbUtFqzCj8kK0FiximoKq5L5qN96RjIp/qTaWnu3aCIvARUWDyXzA+Vzkwr+hWjnDcwcVV3yBtFnmnSxCoS0QNnpGaVSrZRPsCypRRHSBRYqE2yG8oXpPz7iPlKHjQmIRTAtLdVwFxdS8lMba2xlZhTVtL3K0XUJX4hUarxOCbdhICbUm3Sy4JC+jf7a0kDNcWXpSY5QuHk0LX7R9/B4FXw+Bwtn03JDfQAIghboMlbJnrZj9iDMrHHYO5nK5vKGfnm7P+ZNwZTMDg7Xu5i18o9dm/entx1O6/Ggq+25+guZK5MkIuGPPQz/4ML5YPPgySR3wWvxxdwK9HlLkqCz23pdXf3r/DVzBs+ERy3oa+SMIPvzm7euvvzv5mtalNyPcv9HwaHjko2Lauoqr3lYnKOdwEt6ZnUhy++juK+n3lfT7Svp9Jf2+kn5fSb+vpN9X0u8r6feV9I+Lp30l/b6Sfl9Jv6+k31fS7yvp95X0+0r6fSX9vpJ+X0m/r6TfV9L7cquYQiQ9cFhLLlSv/CHkm8+6+vrzjJWUip6csetrCvX+QGU01Pxzg4by2OcZu+JGUKzDZ7GzlLOldOUlUuLwdQjdDE5p5yxcPp8C2UneU8o5zHiV51i7e8f2s+Xv352csoyluqdKFzTH8CX9/wC+ZBNGz43/XwQeTJ+k5b4QU3K1aHwGlYV1KdXMG1du56kvfZ46/uglYrla96jcTmAHVuhvYuzWCf9O+ZO/4Po/2uGh584JEds0mg7vfLPZ/C+TbRqp",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",source:"@site/docs/API-docs/selfsign.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/selfsign",permalink:"/docs/API-docs/selfsign",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"selfsign",title:"Self Sign",description:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.",sidebar_label:"Self Sign",hide_title:!0,hide_table_of_contents:!0,api:"eJztW1uPGzeW/itn+OK4UVK35LbjFRaLcezsjHeS2Eh3EAxajQ5VdaSim0VWSFZLSkPAPOzPmHnZn5Zfsji8VJXUNzsOZnqx8oOt4vWcj4eH5+Zr5vjCsskZe6PzpkLlLDvPWIE2N6J2Qis2YaclgkU5t2Kh4NX7t7BAhYY7tMDhh++/AVdyB6j4TKKFuUG0bi0RaLxQC9Bz4FDE9YfwV91AzhVwaTUIlcumQNB+My6hNjgocC4UFrAUxQKdzWBZirwEV4Y10fj5WAgH2gCuaq4KaGqtgFtQiAUWQzgthYXa6CtReEITNbiq0QhUOS1WCckNOO3X/vVvfz8hFv+qG0P8/vq3f8Bc6iUI5fvf1aj8AF7Xw6maqlNRT+CHWmpewFo3Bt6/+c+WUVqV2s4ODt7grFnAD28PDs6/KJ2r7eTwkNbQNSoiS/KZHea6OixoYF3MnxLLaJBWDbxyK+QaeNEDxZWoINf1GnKtTSEUnUgGNV8gqKaaobEZEDKVNkg8cDDIi/XA6UFjEf7r5N13MNem4m4I72Vjs3a7QhjMnVyH5Yn3xNUTCzNu8cUxWGeEWmRQ8UuCVTj4uRH5JbFtURUJ1Ffv33qsDg5OmrrWxmEBPwYWJgcH1PMVEsbcoB+f66rSCmpueIUOjQ3SRd0Gf26E8XLhSuBSJiwmUzWAgwO3rnFycABvVSFyL560ILWSCIaxwzCUQKKhJzXmYi7i0B50oFWUOsJkycN51pLngUyDtsbciSvcXniVwZoWfoNKJwpKbcQvWjku/XFcoXEi57J/bESgF2/HjSM4ay2US61xh/bm0On5Q4lyRaQVBFYllO+xCFdcNmgjVcsMSqLqe6wNWrrlaV0CUhVQoliUd+7Hiw+NdVsLQ2OJzD4Vca90Sh5e9LDNubQIYr6FZcUvsbdbqwGG8NUaCpzzRroMBEmcMw0O4Tvt6OZJkZOiIcn1d5q7xuDAn3IUh0iI4pU/4/edDijEfI6GLid1+iXinEQdyVlQGsSevzmu5Aq02jnoXEttaPkdGfLt20BCrpXzqu/VFRfSUx+4ta3+m0meX2Ywkw1mYLAIN3eNUuplFgTeDyENF0D3AJFeJjHUihhQOm4vLNhIVasJ04Wizlbb0ibC9mGN13auaWfCIN0xwIoLmXnkMvigZ+CEk5jRja25WmdQcIcZOFy5mV5lkJeYX870KgI218pZ8cst1y71fDpq4wyOM3iRwcsMRkcZjMYZjI4zGL3IYPQyg/FRBuNxBuPjDMYvAqbjlxFP3oLYJ2A0Dki6x4UgKdBvhPVXlDSfbZXpckuZTtVoCAcH7cXwzT/99NNUXU8VwJTRRZmyyZS1Q6Ysg9BH+m/KJqMMYsNqyibwbPxlGrCm7xeEYPhe0veIEA/fJX2PR1O1iZuOPTGOV/U9hFD3709E+owyQ41+Z2pLOooaSbmEsdRDZ0OtLVnUsekYekYMCSWc4NLezVMa8fjY6ijb4eyYOPMSejdbvvvx8ZTISj1eCYYurzR7Xemqe0LGOxA8H3bPxh0IhE0fGwCRqs/l/wXx3+qlu0Fohzw+JPqkfS4cXw79O+91891gxAGPD4qOsM8F4iUBQW/T3ShQ7+ODIFKVOuJ7H/qOjgej54Px0fh4CwZyh8KAqhoUxWC9Xn8mhOABIxMo7u+txmiVBmOOO4S50dUtLof3CLpR0UTyv5OZ/i0Z57Nkt2KR/NXWgGm9vL5l7XTB109sWCpNbW01Gt9Zausemb6L6PAeb15qkUfiaUyy0Gbk1A0JhAEBXxx+++1hD8rQOKiqhC+kVvoeeOj7rVU1LIrh7titE+q1VlAUGdzSfntHUUBVVXe1hw56Lqfq3+giRPPs7rsQB/xzr0Mn9N32D18VCghoJf3+3ku7/a7svC+lULEjyg3sDDC4aCQ3uCJ30wqtPC6/gybauUXpEnWmvPdOvWPnff8ABXzxLprrT6OAEwfbC1DLw/NuMNZfxOACV36NvLFOV0SMKDitkIFt8pKcN568AoK9i9P4r5zXgqIEEp3zrejy4W1EhEPredh0qrsOtkW3xQy3kGbe4mP70/eOxujIv3vR97jn4YsjHp/a71GWOkPUgrrPpqzi0XRhc+x+a1eimbLzdk7wrbHozYXbJsN5dvd9gu7SFCj5DOXNu/Y5tyEQ1xfDpIKTMCc0QAqbohfbrPVnx/COD7pRKJUkaYaQJsCsFZzPFsyWsI+TzHBvI4gPbEHjwA9sQ2utM32v7HvvWVQhPHiXc1d5OX9sUh/J2pERljFdU7ReaPW2YBOWIvks86uidV/pYs0m1ywGXOhnDGfQpMMPlrIA18zmJVacfiVqKG8wFxJZxkJc3rKMeeubkgiEF5swPfuAuWMZvRU1hT7R0hp+3uQ6jQrRZJZFC4xNWAgzs4zhilc1DY5NgCrXZObUxZxt0ob3LdW2dEtZ/6MNa9M6W0mP37Tam94Km4xRBPg3rvQdTfW8VXiqX2tqdPiGr21vwfB4sN10Dc2hO5DHWVDwtaUYVWPDdc65zBtJxhyuamHWrWXpLboWkh6h7U4toaPnm3ToPYruOGujP/2ActQEgHftP3XuB40zxD/GBsqs+OPg1SdT8UEjzNAfRV1q9cnzR+Nno/Ho2WhMK8RIXW8Nbgxfs4wJh5V9GMfQe5OC7fN/RRYGFkmTD7ooeQY+qDV8SAbTeM82X+DDMnd6V/akF8+1pW5kQZFS5Gbokxi/OT+2Lca0ied2+IDQbjK2epiZFeR6kFIz8IXEuYOmrintqI1C87Tvqz0a5sbHx5uMrR9mb/1/kr0v6fCWD3P3o89pdfm+fwWtz15uMlY+TOuf26zbv5DY4xeb7hFluUHuML0BFzNdrC+S3tr0ByYzYntofBE2tKMs0JDFcVNfdaqGRlK2+GJXz8+0lsjVLYpmKxPjvSnrTT8yLGOwYlki2fKdRehXt60pG83QYLJQdgd3/Edhyd4zDU7ZEN7OOyyDMbmbDEpjfTJIaXji97uwjVfjTw7jNyH0pJ/ZpmRjF6RJJPjB4LCqpU8NL4WURDc930No/3jTrkWSCEjPZdr44afidfBT/YZx0nZeFaKJOITXXLVpt+30Flxft0LgpWOzgetrOlU0F/TobjZZ10B7bTX4dzW0GMxRXG3Napuwm9i29aYGS+aCLJnQEKOffQJCAchFY+RmM7whht0ZfTRuN2CKZ0eL/H9AzFf8nOrGfMTF9V7aIFye4OEEwQ6LAIdF42OXjtRfkkEfBOnS8UJZZ5o8uLdFY1IFQirtqY3O0dphLDgYQCFsSMmW2F8/A1Q2TOcw59ahyaBRQjk0pqnJzb1ZLbTFv9/gQXUYNGbnLcVLSrUjWtlg042PjuifbbBSMRZEdUzRI+Js3ki5/gPLPt5Vu9+gDM23K+n7LMTygxj/ssqvxu9JDhrzyRZ6etAaI6kciZAbtBVi3l7vYSuUFAovEmwX46OjixFhu8nY8W3wnegKXelT7wTi0mgqVKolciqcMWvgCy4UkHo1vyOaaIw29793n0bZfSAcb4Hw/CYIb5UPP/qCvVN9ieqfy2l/exe2J1JXlZeV4IsxEQb5frbFbL89MGkxb4xwazY5u2arAa/FIPRPzs435xkjYDUFOGptPcXclWzCDnvxDovmioIUtIIX2lYOLVcFxYZuGFe8FodXI7bJdmfcaordOdo6vhBqMbh31nnH5AkdRMB6i9XOc6zFX5Bcx4hkf1TGBAlAibwgW2yTMTrf77tgz9fplFIY5rbISk+37cRKdlX7LdGPFPzYimfcHs4YPe8HEkKowHv/rfN/mz/fMp489NZB7/ncPZf7rJPV1rtNzu3Ie4Xj42PvPn058n7Gs5fehD9+sTnfsmYZ27ZYfTRu1+5ibNue8N+91zI8H3ROc+0PNSLdVpjSrbka3XRuUOa6akuM0vBf//t//Ix0Qv5S/wHeNQZqvUQzb0Kd0lziStB7SIN3TGfklURr5RroGVxQeS8UYuHzEekxzHnNZ0IKUgM0TIeIUU+T2CH82BnfT0xIzVyhJO0BUmtfK+o08Mbpyu+RnrqlNpdUbUtFqzCj8kK0FiximoKq5L5qN96RjIp/qTaWnu3aCIvARUWDyXzA+Vzkwr+hWjnDcwcVV3yBtFnmnSxCoS0QNnpGaVSrZRPsCypRRHSBRYqE2yG8oXpPz7iPlKHjQmIRTAtLdVwFxdS8lMba2xlZhTVtL3K0XUJX4hUarxOCbdhICbUm3Sy4JC+jf7a0kDNcWXpSY5QuHk0LX7R9/B4FXw+Bwtn03JDfQAIghboMlbJnrZj9iDMrHHYO5nK5vKGfnm7P+ZNwZTMDg7Xu5i18o9dm/entx1O6/Ggq+25+guZK5MkIuGPPQz/4ML5YPPgySR3wWvxxdwK9HlLkqCz23pdXf3r/DVzBs+ERy3oa+SMIPvzm7euvvzv5mtalNyPcv9HwaHjko2Lauoqr3lYnKOdwEt6ZnUhy++juK+n3lfT7Svp9Jf2+kn5fSb+vpN9X0u8r6feV9I+Lp30l/b6Sfl9Jv6+k31fS7yvp95X0+0r6fSX9vpJ+X0m/r6TfV9L7cquYQiQ9cFhLLlSv/CHkm8+6+vrzjJWUip6csetrCvX+QGU01Pxzg4by2OcZu+JGUKzDZ7GzlLOldOUlUuLwdQjdDE5p5yxcPp8C2UneU8o5zHiV51i7e8f2s+Xv352csoyluqdKFzTH8CX9/wC+ZBNGz43/XwQeTJ+k5b4QU3K1aHwGlYV1KdXMG1du56kvfZ46/uglYrla96jcTmAHVuhvYuzWCf9O+ZO/4Po/2uGh584JEds0mg7vfLPZ/C+TbRqp",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:"Create Document",permalink:"/docs/API-docs/createdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function j(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Self Sign"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/selfsign"}),"\n",(0,i.jsx)(n.p,{children:"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app."}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "name": "textbox",\n "required": true, \n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signer"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.636268e6.js b/assets/js/bbdfc22d.636268e6.js new file mode 100644 index 000000000..10616ac7b --- /dev/null +++ b/assets/js/bbdfc22d.636268e6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>m,metadata:()=>x,toc:()=>f});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),p=s(9472),h=s(85162);const m={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:"eJztW+9yGzeSf5XOfHGsGlIirTg+1tXVOX8u690kckVypa4klQPONDmIZoAJgBHFqPhtn2QfbZ/kqhvAzJAiJdlOZbV1/CJxgAbQ/QMa6G40bhMn5jaZnCdnWNWlcGiTyzTJ0WZG1k5qlUySswIhVsPXBgWVw+u3b0CUpV5YaCwaC05DRpUIWWOdruTvYloiuNhxCotCZgVYNNcIwsK0bLA2UjkLM21gjgqNcFLNIddZUyFVLKQroDaY40wqzME602SuMWiH8K7WCmyTZWjtrCnbkTwbUqsUXIHMqEHXGGVBQKPkbw3CwUGkfi/zgwNwhXCQCQVTJHFykiYwhD12poLqtOKObY2ZnEkiDn0NL9SFOpP1BN7VpRY5LHVj4O03/9N2Qf1S2fnBwTc4bebw7s3BweXnhXO1nRweiroe6hqVlXNViqkdZro6zImwzmfPCUE0SL0yryisLJcg8hwWMp+jsyyxgkzXS8i0NrlUHvpazBFUU03R2BSEyqHSBkEqEGBQ5MuB04PGIvz19ORHmo5KuCG8LRubtsPl0mDmyqXvnhCIUj3zyLw8pvmRap5CJa5oIqWD3xqZXZHYFhXDGuaEsTo4OG3qWhuHOfzsRZgcHFDNV1jqBQiDTJ/pqtIKamFEhY5XG00YVRv8rZEGc79URFlGLCbUzYBmelnj5OAA3qhcZgQHd0mloGeBeuhJCSYiPQ1T60l74NHc+2VMqCyEn9G6FJln1CCtCievcb3jmxSW1PE3qHTkoNBG/q6VEyVPyDUaJzNR9ieOGOSl5oRhzai1VC6WhhHgf8ME0fzxtISVRazlBFclFddYhGtRNmgDV4sUCuLqJ6wNWl7hoV+CUuVQoJwXO8cT+a+NdWsdQ2OJzT4XYaw4TwwvMmwzUVoEOVvDshJX2BsNNG9DohzCV0vIcSaa0qUgac050+AQftQORF2XMuP9hrYSUh9Bu8SAZzksiMCIEhXP8Vujr2WOtCnkcjZDQ+pJldxFaBO5o5VWcwMSj3XHFUKBVhsTnelSG+p+Yw1x+TqQkGnlULkhvL4WsmTuvbQWpMrKJkeYliK7SnmrTMFg7nV3ibTxpn7JMwntpx50BggslrQMtSIBlA7DS9ttWsOzQtpOo6guQs1jSNtHNejtTNPABEFUMsBKyDJl4FL4VU/BSVdiSipbC7VMIRcOU3B446b6JoWswOyKfxmRSw3TxjnaqmnM3Og61wsVsJxp5az8fYtGxpoPB3ScwnEKL1N4lcLoKIXROIXRcQqjlymMXqUwPkphPE5hfJzC+KVna/wqQC1afPsMjMYeZNcDF542urTzfi8tazZtmbbdhRdru/CFGg3h4KDVJy7+5ZdfLtTthQK4SEi/LpLJRdKSXCQp+DraNi+SySiFUHBzkUzgxfjLSLCk75eErv9e0PeIZsN/F/Q9Hl2oVRh0zMw4UdX3MELVfzwT8TOsJyrkkaksbm1USHuSp6UamjcqbdmiilUn0AsSSCrppCjtbpkixdMTq+NsQ7JjkoxX726xuPrpyRTZijW8d/oq3mt7VXEbYEbGGxB8MexOmx0I+EGfGgCBq0+V/yXJ3+5Zu0FoSZ4eEn3WPhWOL4dsHvC+vRuMQPD0oOgY+1QgXhEQdG7tRoFqnx4EgatYEWwBX3d0PBh9MRgfjY/XYCA/yhNU1SDPB8vl8hMhBAaMzKMwPhubwZj1NiD5rDOjqy2eCjsSHVUwn/h3tO5/IJt+Gs1dzMlJXHd3o3vYN8idzsXymfVdxaatHUf0nRW37LHJVcQHu8pZoWUWmCeaaL1NyRscEggDAj4//OGHwx6UvnBQVRFfiKX0PWDo+6VVNczz4Sbt2gz1SivI8xS2lG+vyHOoqmpXua+g4/JC/ceQ4xBsuu3WhUDw56jDllXfjb9TV7oKkWtV8vjs3G3XlY3zpZAqVIR1AxsEBudNKQzekJdqpVaMyx+wE21oUVSizsxnp5b9QQ4ZeCTg85Ngyj8PC5wkWO+ASh5ud0ewficG53jDffh4GjEj8xDYsk1WkM8nosdAsHcBHv7KRC0puFCic1yKLhtuY8JPWs8xp0nd9MstujVhhIXYcotrzrPPjsboiM+94Jfcc/AFiqe37fc4i5U+2EHV5xdJJYLpksyw+61dgeYiuWzbeJcc815b2NYYLu/RJ+iUJsdSTLG8q2uP1oa+OGFl9cChikqqNpLALB9FDrhW3GzUhsrVFj3zYvcXeNzco5pEnKGUNoZT1kHrtw7xJo4DKvQR2ylCbADTdkl+8pJvGXvcmvc7QpieB4YgOmDCNtYXR3tghLWp6QNDfVRSyaqp2qDlrO01QlaFU76PF7WkWH4coT+9d0YQNw+MEKLpOwa4UCMOLcSgBG8MsN0YDCRPb2focfbwEfgxe8basfmxB96Ha2KUq6+JW85JIvUnZKuFdrcaDuGETiWKmPpGFAPLMqwdxcs+VUdblh+noyMOJfVjZLtPpj7Vn70Gdy2mx6zODb7/sHUY6D7N+CLUHrcY+2L8Gy3INbYfbSz5gGDlr6F2RQMrXnpPbTMMbG0c/Uma6JrvdbV6kyeTxN8RxxvTJOW+0bqvdL5MJrdJiOHTzxAhp6aHv1q6i75NbFZgJehX5Ilur2eypK4oCI3GJmnCQRu6yibUkkmip79i5pKUXIyaLtrQUh/cbnIbqfztZZIGxz2ZJP5aM0kTvBFVTcShCFBlmrxj7mIVR7yvr7ak68vyj/b+mPqh+8GP7Iabrjau7z+qp34Pqw7XrjNhjFgmm5kC8WIw+nG+XXvzUS6jskhHKtFeVjFZkibSYdUfZcesGf3hSGeoSRKO7X5oW54WUX3wmNSuLrT6qIbhImYL5o9EydfeHXh9yl6TA4l5NKcH3d1pCnxnMXxoxUR6llbM+2N64/DOmGe77tR7V3m20E2Z0yUZCjPkq+2Pzpvg1BRRZg1nh7SHxJpkLautZKNVmtw8LMwNZHoQL+zh8xJnDpq6RgOZNgrN834o7skINz4+XqXJ8mHxlv+W4n1Jk7d4WLqfOdOhywL5V/D64tUqTYqHef1Lm4vxL2T2+OWqO+s2zvL3U50v38d9a/UQYTxUiI5yg96oE5Oj6QEx1bpEoe4g8WbmrSwNz8gYeRbiXXyFLo2NBwosZFmCwQwpHYdD2HGvgmB0+Pt1CLeYZJx9SwVsNNpmaolKxf6s73CK4Iycz5GSjgIFNw5JAig4yY3SdIgrMaP7f04jMngtdWMje4WwfI9fItmlrkDpM1ekmq8biT10OIWjL/uwPztUQoecoqyCk7O3j8CSTdgBuKLNUPBS+j7g5OwtJSbJWbDDhvDOtkhEaMUaCZBdBNdSxOSFdm9f+qgDKkZEs7BreWTDkBI0gLsM5dJu5SjtYqBtHuKdjrvcNZoi3ThKmpMhH8M6rO0ajsxFC+SZbh6zKh9AUsC84esURyobs5Q4LtslFknlExzZAcobE3OpwrIgSsp27HCKqBBRr/8UUFnfXMBMWIcmpdRHQt405OC0XeJNjUaiynALBPersNfxzg4Py49y4LSy3goZHx3Rvw0DYC1Tk5hpszjL5WdJ+ngn4H4TyBeT23HXDOosmK+K8V9sraqsIBOmQmvXrZgtTR4QoI+bVKVU+D6C8n58dPT+C0JulSbH28A51RW6grOAaOUujKaEyrpEQel9ZgliLqQCGt78gVihMdrcL/WHcXYfCMdHR+9HLQhf3AXhjeKYNCfvnukrVH+upP3hnR+eWL2p2HfwvkAiPRHXJ2vC9su9kBazxki3TCbnt8nNQNRy4Osn55erS1p1rtDkHtfaMsfCFckkObzjLXP2NLli57dJY8pkksTj3gqVU9j4zpEvanl4PUpW6WaLrQbCTmrrxFyq+eDeVpedqKc0HR7xNYE7f6aWf0NyaAKefao0kbQMChRkEhCCNMs/daGCb+NcRSd+q1/eTcqmpx0d7TXfeXNL3+IN95zh8+iJsnPZ+pZJJ1HS+n/0s/Xozrul1zpP0XcasdMxPj5m6/zLEZuxL16xhXj8cnXpEe5ZSxyO6R/5PlC4dnbF80yqmeYJCKCc1KhO6aykdX49umseY5npqs1PjOT//Ps/uEU8XVkNP4OTxkCtF2goGZ8SDmcl3kg6nXpvBcj75yiZqEq0lkICyuHc59nLOV9YxqMpE7WYylKS4hKZ9kkCPd23Q/i5QIpWUtUz4+9ur7EkfYdSa85CdxpE43TVz+WHhTZXM2IpBQFTSltGS7YVxiaoCqEyihz69ZyCNkBZ93SI1kZaBCErIqbDHGczmUnqmHYpIzIHlVBijjRYymY6oVDHpGOjp2QLWV02/rSn1GdE50XkyOUQviHrigWnwhydkCXm/qC3qTe0wqYVsvqnZNTWNLzM0HYZHyVeo2H99WZyU5ZQa+dNV/Ip+nNLHTkjlCVHwDMUp6aFL1giPEYulkOg8CUdEGSF0QIopbqiHPwBnLfL7GecWumwc1EWi8WdveT5epvvpCuaKRisddduzoW88/Sbtx/PSfPRVPZkdormWmYYNrIdYx4y8WE4Y0TGZ0zUZ1HL/95sQPt9KTNUFnsnwuvv3n4P1/BieJSkvd3zEQwffv/m629/PP2W+qX93evfaHg0POK4irauEqo31Nf+qc1Zt59tRP3aw3L/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fudB+ffvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/5/vN8JuSpkOB7WpZCc7MS327chT+l881XPZZoUlMg0OU9ub+lq8Z0pVysq/q1BQ1lQl2lyLYyk8DnnQKUx14eyY65wSVfc/jZgcEbjp37d83X8RuoXpSr5Fq959u+l7edavT05PUvSZBpeHlU6pzZGLOhVklgkk4Q2bX7BxJDy2xPBaeWlUPOGE3YS3y+lKInGFev5TVec3xR+9PJ+hFr2uFxPfPKi0F8SbGuD/6Q78b/h8r9acl+zs0HANlLTFF6uVqv/A6s7k8M=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW+9yGzeSf5XOfHGsGlIirTg+1tXVOX8u690kckVypa4klQPONDmIZoAJgBHFqPhtn2QfbZ/kqhvAzJAiJdlOZbV1/CJxgAbQ/QMa6G40bhMn5jaZnCdnWNWlcGiTyzTJ0WZG1k5qlUySswIhVsPXBgWVw+u3b0CUpV5YaCwaC05DRpUIWWOdruTvYloiuNhxCotCZgVYNNcIwsK0bLA2UjkLM21gjgqNcFLNIddZUyFVLKQroDaY40wqzME602SuMWiH8K7WCmyTZWjtrCnbkTwbUqsUXIHMqEHXGGVBQKPkbw3CwUGkfi/zgwNwhXCQCQVTJHFykiYwhD12poLqtOKObY2ZnEkiDn0NL9SFOpP1BN7VpRY5LHVj4O03/9N2Qf1S2fnBwTc4bebw7s3BweXnhXO1nRweiroe6hqVlXNViqkdZro6zImwzmfPCUE0SL0yryisLJcg8hwWMp+jsyyxgkzXS8i0NrlUHvpazBFUU03R2BSEyqHSBkEqEGBQ5MuB04PGIvz19ORHmo5KuCG8LRubtsPl0mDmyqXvnhCIUj3zyLw8pvmRap5CJa5oIqWD3xqZXZHYFhXDGuaEsTo4OG3qWhuHOfzsRZgcHFDNV1jqBQiDTJ/pqtIKamFEhY5XG00YVRv8rZEGc79URFlGLCbUzYBmelnj5OAA3qhcZgQHd0mloGeBeuhJCSYiPQ1T60l74NHc+2VMqCyEn9G6FJln1CCtCievcb3jmxSW1PE3qHTkoNBG/q6VEyVPyDUaJzNR9ieOGOSl5oRhzai1VC6WhhHgf8ME0fzxtISVRazlBFclFddYhGtRNmgDV4sUCuLqJ6wNWl7hoV+CUuVQoJwXO8cT+a+NdWsdQ2OJzT4XYaw4TwwvMmwzUVoEOVvDshJX2BsNNG9DohzCV0vIcSaa0qUgac050+AQftQORF2XMuP9hrYSUh9Bu8SAZzksiMCIEhXP8Vujr2WOtCnkcjZDQ+pJldxFaBO5o5VWcwMSj3XHFUKBVhsTnelSG+p+Yw1x+TqQkGnlULkhvL4WsmTuvbQWpMrKJkeYliK7SnmrTMFg7nV3ibTxpn7JMwntpx50BggslrQMtSIBlA7DS9ttWsOzQtpOo6guQs1jSNtHNejtTNPABEFUMsBKyDJl4FL4VU/BSVdiSipbC7VMIRcOU3B446b6JoWswOyKfxmRSw3TxjnaqmnM3Og61wsVsJxp5az8fYtGxpoPB3ScwnEKL1N4lcLoKIXROIXRcQqjlymMXqUwPkphPE5hfJzC+KVna/wqQC1afPsMjMYeZNcDF542urTzfi8tazZtmbbdhRdru/CFGg3h4KDVJy7+5ZdfLtTthQK4SEi/LpLJRdKSXCQp+DraNi+SySiFUHBzkUzgxfjLSLCk75eErv9e0PeIZsN/F/Q9Hl2oVRh0zMw4UdX3MELVfzwT8TOsJyrkkaksbm1USHuSp6UamjcqbdmiilUn0AsSSCrppCjtbpkixdMTq+NsQ7JjkoxX726xuPrpyRTZijW8d/oq3mt7VXEbYEbGGxB8MexOmx0I+EGfGgCBq0+V/yXJ3+5Zu0FoSZ4eEn3WPhWOL4dsHvC+vRuMQPD0oOgY+1QgXhEQdG7tRoFqnx4EgatYEWwBX3d0PBh9MRgfjY/XYCA/yhNU1SDPB8vl8hMhBAaMzKMwPhubwZj1NiD5rDOjqy2eCjsSHVUwn/h3tO5/IJt+Gs1dzMlJXHd3o3vYN8idzsXymfVdxaatHUf0nRW37LHJVcQHu8pZoWUWmCeaaL1NyRscEggDAj4//OGHwx6UvnBQVRFfiKX0PWDo+6VVNczz4Sbt2gz1SivI8xS2lG+vyHOoqmpXua+g4/JC/ceQ4xBsuu3WhUDw56jDllXfjb9TV7oKkWtV8vjs3G3XlY3zpZAqVIR1AxsEBudNKQzekJdqpVaMyx+wE21oUVSizsxnp5b9QQ4ZeCTg85Ngyj8PC5wkWO+ASh5ud0ewficG53jDffh4GjEj8xDYsk1WkM8nosdAsHcBHv7KRC0puFCic1yKLhtuY8JPWs8xp0nd9MstujVhhIXYcotrzrPPjsboiM+94Jfcc/AFiqe37fc4i5U+2EHV5xdJJYLpksyw+61dgeYiuWzbeJcc815b2NYYLu/RJ+iUJsdSTLG8q2uP1oa+OGFl9cChikqqNpLALB9FDrhW3GzUhsrVFj3zYvcXeNzco5pEnKGUNoZT1kHrtw7xJo4DKvQR2ylCbADTdkl+8pJvGXvcmvc7QpieB4YgOmDCNtYXR3tghLWp6QNDfVRSyaqp2qDlrO01QlaFU76PF7WkWH4coT+9d0YQNw+MEKLpOwa4UCMOLcSgBG8MsN0YDCRPb2focfbwEfgxe8basfmxB96Ha2KUq6+JW85JIvUnZKuFdrcaDuGETiWKmPpGFAPLMqwdxcs+VUdblh+noyMOJfVjZLtPpj7Vn70Gdy2mx6zODb7/sHUY6D7N+CLUHrcY+2L8Gy3INbYfbSz5gGDlr6F2RQMrXnpPbTMMbG0c/Uma6JrvdbV6kyeTxN8RxxvTJOW+0bqvdL5MJrdJiOHTzxAhp6aHv1q6i75NbFZgJehX5Ilur2eypK4oCI3GJmnCQRu6yibUkkmip79i5pKUXIyaLtrQUh/cbnIbqfztZZIGxz2ZJP5aM0kTvBFVTcShCFBlmrxj7mIVR7yvr7ak68vyj/b+mPqh+8GP7Iabrjau7z+qp34Pqw7XrjNhjFgmm5kC8WIw+nG+XXvzUS6jskhHKtFeVjFZkibSYdUfZcesGf3hSGeoSRKO7X5oW54WUX3wmNSuLrT6qIbhImYL5o9EydfeHXh9yl6TA4l5NKcH3d1pCnxnMXxoxUR6llbM+2N64/DOmGe77tR7V3m20E2Z0yUZCjPkq+2Pzpvg1BRRZg1nh7SHxJpkLautZKNVmtw8LMwNZHoQL+zh8xJnDpq6RgOZNgrN834o7skINz4+XqXJ8mHxlv+W4n1Jk7d4WLqfOdOhywL5V/D64tUqTYqHef1Lm4vxL2T2+OWqO+s2zvL3U50v38d9a/UQYTxUiI5yg96oE5Oj6QEx1bpEoe4g8WbmrSwNz8gYeRbiXXyFLo2NBwosZFmCwQwpHYdD2HGvgmB0+Pt1CLeYZJx9SwVsNNpmaolKxf6s73CK4Iycz5GSjgIFNw5JAig4yY3SdIgrMaP7f04jMngtdWMje4WwfI9fItmlrkDpM1ekmq8biT10OIWjL/uwPztUQoecoqyCk7O3j8CSTdgBuKLNUPBS+j7g5OwtJSbJWbDDhvDOtkhEaMUaCZBdBNdSxOSFdm9f+qgDKkZEs7BreWTDkBI0gLsM5dJu5SjtYqBtHuKdjrvcNZoi3ThKmpMhH8M6rO0ajsxFC+SZbh6zKh9AUsC84esURyobs5Q4LtslFknlExzZAcobE3OpwrIgSsp27HCKqBBRr/8UUFnfXMBMWIcmpdRHQt405OC0XeJNjUaiynALBPersNfxzg4Py49y4LSy3goZHx3Rvw0DYC1Tk5hpszjL5WdJ+ngn4H4TyBeT23HXDOosmK+K8V9sraqsIBOmQmvXrZgtTR4QoI+bVKVU+D6C8n58dPT+C0JulSbH28A51RW6grOAaOUujKaEyrpEQel9ZgliLqQCGt78gVihMdrcL/WHcXYfCMdHR+9HLQhf3AXhjeKYNCfvnukrVH+upP3hnR+eWL2p2HfwvkAiPRHXJ2vC9su9kBazxki3TCbnt8nNQNRy4Osn55erS1p1rtDkHtfaMsfCFckkObzjLXP2NLli57dJY8pkksTj3gqVU9j4zpEvanl4PUpW6WaLrQbCTmrrxFyq+eDeVpedqKc0HR7xNYE7f6aWf0NyaAKefao0kbQMChRkEhCCNMs/daGCb+NcRSd+q1/eTcqmpx0d7TXfeXNL3+IN95zh8+iJsnPZ+pZJJ1HS+n/0s/Xozrul1zpP0XcasdMxPj5m6/zLEZuxL16xhXj8cnXpEe5ZSxyO6R/5PlC4dnbF80yqmeYJCKCc1KhO6aykdX49umseY5npqs1PjOT//Ps/uEU8XVkNP4OTxkCtF2goGZ8SDmcl3kg6nXpvBcj75yiZqEq0lkICyuHc59nLOV9YxqMpE7WYylKS4hKZ9kkCPd23Q/i5QIpWUtUz4+9ur7EkfYdSa85CdxpE43TVz+WHhTZXM2IpBQFTSltGS7YVxiaoCqEyihz69ZyCNkBZ93SI1kZaBCErIqbDHGczmUnqmHYpIzIHlVBijjRYymY6oVDHpGOjp2QLWV02/rSn1GdE50XkyOUQviHrigWnwhydkCXm/qC3qTe0wqYVsvqnZNTWNLzM0HYZHyVeo2H99WZyU5ZQa+dNV/Ip+nNLHTkjlCVHwDMUp6aFL1giPEYulkOg8CUdEGSF0QIopbqiHPwBnLfL7GecWumwc1EWi8WdveT5epvvpCuaKRisddduzoW88/Sbtx/PSfPRVPZkdormWmYYNrIdYx4y8WE4Y0TGZ0zUZ1HL/95sQPt9KTNUFnsnwuvv3n4P1/BieJSkvd3zEQwffv/m629/PP2W+qX93evfaHg0POK4irauEqo31Nf+qc1Zt59tRP3aw3L/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fmf/fudB+ffvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/bvd/5/vN8JuSpkOB7WpZCc7MS327chT+l881XPZZoUlMg0OU9ub+lq8Z0pVysq/q1BQ1lQl2lyLYyk8DnnQKUx14eyY65wSVfc/jZgcEbjp37d83X8RuoXpSr5Fq959u+l7edavT05PUvSZBpeHlU6pzZGLOhVklgkk4Q2bX7BxJDy2xPBaeWlUPOGE3YS3y+lKInGFev5TVec3xR+9PJ+hFr2uFxPfPKi0F8SbGuD/6Q78b/h8r9acl+zs0HANlLTFF6uVqv/A6s7k8M=",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"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.d9da916d.js b/assets/js/bbdfc22d.d9da916d.js deleted file mode 100644 index 1aa6a7755..000000000 --- a/assets/js/bbdfc22d.d9da916d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),h=s(9472),m=s(85162);const p={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:"eJztW+9uIzeSf5Xa/jIZoyVbGmcyKxwWO/lzu3ObxIO1B8HBMiZUd0nNuJvskGzLiqFv9yT3aPckiyqS3S1ZsudPsPEB+mKrySJZ9SNZrCoW7xInFjaZXCYXWNWlcGiTqzTJ0WZG1k5qlUySiwIhVsM3BgWVw+u3b0CUpV5aaCwaC05DRpUIWWOdruRvYlYiuNhxCstCZgVYNDcIwsKsbLA2UjkLc21ggQqNcFItINdZUyFVLKUroDaY41wqzME602SuMWiH8K7WCmyTZWjtvCnbkTwbUqsUXIHMqEHXGGVBQKPkrw3C0VGkfi/zoyNwhXCQCQUzJHFykiYwhD12ZoLqtOKObY2ZnEsiDn0Np2qqLmQ9gXd1qUUOK90YePvtf7ZdUL9Udnl09C3OmgW8e3N0dPVF4VxtJ8fHoq6HukZl5UKVYmaHma6OcyKs8/lzQhANUq/MKworyxWIPIelzBfoLEusINP1CjKtTS6Vh74WCwTVVDM0NgWhcqi0QZAKBBgU+Wrg9KCxCP91fvYjTUcl3BDelo1N2+FyaTBz5cp3TwhEqZ55ZF6e0vxItUihEtc0kdLBr43Mrklsi4phDXPCWB0dnTd1rY3DHH7yIkyOjqjmayz1EoRBps90VWkFtTCiQserjSaMqg3+2kiDuV8qoiwjFhPqZkAzvapxcnQEb1QuM4KDu6RS0PNAPfSkBBORnoep9aQ98Gju/TImVJbCz2hdiswzapBWhZM3uNnxbQor6vhbVDpyUGgjf9PKiZIn5AaNk5ko+xNHDPJSc8Lwzqi1VC6WhhHgv8ME0fzxtISVRazlBFclFddYhBtRNmgDV8sUCuLqn1gbtLzCQ78EpcqhQLko9o4n8l8a6zY6hsYSm30uwlhxnhheZNjmorQIcr6BZSWusTcaaFZDohzC1yvIcS6a0qUgac050+AQftQORF2XMmN9Q6qEto8gLTHgWQ4LIjCiRMVz/NboG5kjKYVczudoaHtSJXcR2kTuaKXV3IDE473jCqFAq62JznSpDXW/tYa4fBNIyLRyqNwQXt8IWTL3XloLUmVlkyPMSpFdp6wqUzCY+727QlK8qV/yTEL61IPOAIHFkpahViSA0mF4aTulNbwopO12FNVFqHkMafuohn071zQwQRA3GWAlZJkycCn8omfgpCsxpS1bC7VKIRcOU3B462b6NoWswOyafxmRSw2zxjlS1TRmbnSd66UKWM61clb+tmNHxpqPB3ScwmkKL1N4lcLoJIXROIXRaQqjlymMXqUwPklhPE5hfJrC+KVna/wqQC1afPsMjMYeZNcDF542uqR5v5eWdzapTNtq4eWGFp6q0RCOjtr9xMU///zzVN1NFcA0of01TSbTpCWZJin4OlKb02QySiEU3E6TCbwYfxUJVvT9ktD130v6HtFs+O+CvsejqVqHQcfMjBNV/QAjVP37MxE/w3qiQh6ZyqJqo0LSSZ6WamjeqLRliyrWnUAvSCCppJOitPtlihRPT6yOsy3JTkkyXr37xeLqpydTZCvWsO70Vaxre1VRDTAj4y0Ivhx2p80eBPygTw2AwNXnyv+S5G911n4QWpKnh0Sftc+F46shmwest/eDEQieHhQdY58LxCsCgs6t/ShQ7dODIHAVK4It4OtOTgejLwfjk/HpBgzkR3mCqhrk+WC1Wn0mhMCAkXkUxmdjMxiz3gYkn3VudLXDU2FHoqMK5hP/jtb9D2TTz6K5izk5iZvubnQP+wa507lYPbO+q9i0teOIvrPiVj02uYr4YFc5K7TMAvNEE623GXmDQwJhQMDnxz/8cNyD0hcOqiriC7GUvgcMfb+0qoZ5Ptym3ZihXmkFeZ7CjvLdFXkOVVXtK/cVdFxO1Z+HHIdg023/XggET287dIzt3BFbp0ghVagIqwO2CAwumlIYvCVf1EqtWPrfQd9s7ZW4VTpjnl1X9vo4MODFgi/OgsH+PCxjkmCzAyp5vN09wfqdGFzgLffho2bEjMxD+Mo2WUGenYh+gVblqgvj8FcmakkhhBKd41J02XCTiakanfDhE5yDB06fQPH0FluPs1jpIw5UfTlNKhHsh2SO3W/tCjTT5Kpt4/1izHttYVdjuOqtS5ET0kTMEYuOvULmWIoZll3dRy/Wvjhh4nvgUEUlVevOM8snkQOuFbdbtaFyvWMbeLH76y9q2LiKI85QShtjGpug9VuHoA8H4xT6sOkMITaAWXtC7NoWHtdeQIgmfzseZNFtMiYsxKY7YkI8C3G/htl5ZASiAyZs421xsH0DBBE2ZqaPC/VRSSWrpmoDh/O214hYFU7aPlzUkuLpcYT+7N4bQdw+MkKIaO8ZYKpG7N7HwADrBdhtkAWSp6cYepx9jmLYOLo+9dD5+O0Wue9vtx1nFZH6U6rdanb/XhvCGZ0MFJv0jSjalGVYO4pMbWzEEYdU+rGi/YdDn+rfvQ62VfDHrJAtvn+3VRLoPs88IdQ+bKn0xfijlstUjXzIqvIXJfviVRUviqemKgJbW+dikia65ptHrd7kySTxt5jxTi9JuW+07mudr5LJXRKizPQzxHCp6fEvlm5L7xKbFVgJ+hV5ovvVuSypKwqTorFJmnBYgS5bCbVkkujZL5i5JCXzuKarILTUB7eb3EUqf7+WpMG1TCaJv3hL0gRvRVUTcSgCVJkm/427WMcRH+qrLen6svyjveGkfugG6xO74abrrQvmT+qp38O6w7XrTBgjVsn2XXa8uoo+iG/XxubLVTQOpCNDo71OYbIkTaTDqj/Knlkz+uORzlCTJBx9/Ni2PC2i+ugxqV1daPVJDcNVwQ7MPxAlX3t/4M0pe03OD+bR1hx0t3spcFR9+NiKifQsrVj0x/Sm070xL/bd+vYum2yhmzKnaxwUZsiXr598s8/JE6LMGs5faNX3hmQtq61ko3Wa3D4uzC1kehCvlOGLEucOmrpGA5k2Cs3zfrDoyQg3Pj1dp8nqcfFW/y/F+4omb/m4dD/xXXyXp/BH8Pri1TpNisd5/XubLfAHMnv6ct2ddVtn+fuZzlfvo95aP0YYDxWio+yVN+rM5Gh6QMy0LlGoe0i8mXu/VcMzMkaehVgNX/JKY+OBAktZlmAwQ0oY4SBr1FUQjA5/Awzhno1c3u+ogM0528wsUanYn/UdzhCckYsFUlpMoODG4RobBadhUSIJcSXmdEPNiS4Gb6RubGSvEJZvmkski9EVKH1uhVSLTc+4hw4nGfRlH/Znh0rokFN073128fYDsGSXfQCuaO/QvZS+Dzi7eEupM3Ie7LAhvLMtEhFasUECZBfBjRTxer3V7Svvk6NiRDQLu5HpNAxJKwO4z1Au7U6O0i5+12bK3eu4y66iKdKNo7QuGTIGrMPabuDIXLRAXujmQ1blI0gKWDQc8He0ZWMeDccUu9QXqXwKHrsmeWNitk9YFkRJ+XgdThEVIur1nwIq65sLmAvr0KSUnEfIm4Zcj7ZLvK3RSFQZ7oDg4S3s93hnh4flR1laWllvhYxPTujflgGwkUtIzLR5huXqT0n64U7AwyaQLya3474Z1FkwXxfjv9taVVlBJkyF1m5aMTuaPCJAHzepSqnwfQTl/fjk5P2XhNw6TU53gXOuK3QF56nQyl0aTSl/dYmCEtDMCsRCSAU0vPkdsUJjtHlY6o/j7CEQTk9O3o9aEL68D8IbxQFbTi+90Neo/r2S9od3fnhi9bZi38H7Aon0RFyfbAjbL/dCWswaI90qmVzeJbcDUcuBr59cXq2vaNW5QpN7XGvLHAtXJJPk+J63zPm95Ipd3iWNKZNJEo97K1ROQdV7R76o5fHNKFmn2y12Ggh7qa0TC6kWgwdbXXWintN0eMQ3BO78mVr+A8mhCXj2qdJE0jIoUJBJQAjSLP+zCxV8F+cqOvE7/fJuUrY97ehob/jO2yp9hzfcc4YvoyfKzmXrWyadREnr/9HP1qO77JZe6zxF32nETsf49JSt869GbMa+eMUW4unL9ZVHuGctcTimf+T7EN7G2RXPM6nmmicggHJWozqns5LW+c3ovnmMZaarNoMukv/f//wvt4inK2/DP8FZY6DWSzSULk4pcfMSbyWdTr1sdvL++d5BVCVaSyEB5XDhM8Hlgi/b4tGUiVrMZClp4xKZ9tfYvb1vh/BTgRRHpKpnxt873mBJ+x1KrTlP2mkQjdNVP9scltpcz4mlFATMKLEWLdlWGJugKoTKKKbn13MK2gDlhdMhWhtpEYSsiJgOc5zPZSapY9JSRmQOKqHEAmmwlM10QqGOabFGz8gWsrps/GlPybmIzovIMcUhfEvWFQtOhTk6IUvM/UFvU29oBaUV8s5nZNTWNLzM0HY5CSXeoOH9683kpiyh1s6bruRT9OeWOnJGKEuOgGcoTk0LX7BEeIxcrIZA4Us6IMgKowVQSnVNWeIDuGyX2U84s9Jh56Isl8t7uuT5Zpu/SVc0MzBY667dggtZ8/Sbtx/PaeejqezZ/BzNjcwwKLI9Yx4z8XE4Y0TGZ0zcz6KWf91uQPq+lBkqi70T4fXf3n4PN/BieJKkPe35AQwff//mm+9+PP+O+iX97vffaHgyPOG4irauEqo31Df+MchFp8+2on7tYXl4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YfKo/IcXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJk/nhUnIpiAL7rguheR0HL5/vQuZNJfb706u0qSgVJvJZXJ3R5df70y5XlPxrw0aytO5SpMbYSQFeDlLJ43ZKJS/cY0ruoT18erBBY2f+hXJF8ZbyUmUTONbvOZ5eZC2nw309uz8IkmTWXgbU+mc2hixpHczYplMElJ2/MaGIeXXEYITn0uhFg2nlCS+X0qiEY0rNjNwrjkDJ/zoZaYItepxuZma40WhvyTYzgb/Qbe2/8DVX1pyX7O3QcA2UtMUXq3X638B09ul6A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJztW+9uIzeSf5Xa/jIZoyVbGmcyKxwWO/lzu3ObxIO1B8HBMiZUd0nNuJvskGzLiqFv9yT3aPckiyqS3S1ZsudPsPEB+mKrySJZ9SNZrCoW7xInFjaZXCYXWNWlcGiTqzTJ0WZG1k5qlUySiwIhVsM3BgWVw+u3b0CUpV5aaCwaC05DRpUIWWOdruRvYlYiuNhxCstCZgVYNDcIwsKsbLA2UjkLc21ggQqNcFItINdZUyFVLKUroDaY41wqzME602SuMWiH8K7WCmyTZWjtvCnbkTwbUqsUXIHMqEHXGGVBQKPkrw3C0VGkfi/zoyNwhXCQCQUzJHFykiYwhD12ZoLqtOKObY2ZnEsiDn0Np2qqLmQ9gXd1qUUOK90YePvtf7ZdUL9Udnl09C3OmgW8e3N0dPVF4VxtJ8fHoq6HukZl5UKVYmaHma6OcyKs8/lzQhANUq/MKworyxWIPIelzBfoLEusINP1CjKtTS6Vh74WCwTVVDM0NgWhcqi0QZAKBBgU+Wrg9KCxCP91fvYjTUcl3BDelo1N2+FyaTBz5cp3TwhEqZ55ZF6e0vxItUihEtc0kdLBr43Mrklsi4phDXPCWB0dnTd1rY3DHH7yIkyOjqjmayz1EoRBps90VWkFtTCiQserjSaMqg3+2kiDuV8qoiwjFhPqZkAzvapxcnQEb1QuM4KDu6RS0PNAPfSkBBORnoep9aQ98Gju/TImVJbCz2hdiswzapBWhZM3uNnxbQor6vhbVDpyUGgjf9PKiZIn5AaNk5ko+xNHDPJSc8Lwzqi1VC6WhhHgv8ME0fzxtISVRazlBFclFddYhBtRNmgDV8sUCuLqn1gbtLzCQ78EpcqhQLko9o4n8l8a6zY6hsYSm30uwlhxnhheZNjmorQIcr6BZSWusTcaaFZDohzC1yvIcS6a0qUgac050+AQftQORF2XMmN9Q6qEto8gLTHgWQ4LIjCiRMVz/NboG5kjKYVczudoaHtSJXcR2kTuaKXV3IDE473jCqFAq62JznSpDXW/tYa4fBNIyLRyqNwQXt8IWTL3XloLUmVlkyPMSpFdp6wqUzCY+727QlK8qV/yTEL61IPOAIHFkpahViSA0mF4aTulNbwopO12FNVFqHkMafuohn071zQwQRA3GWAlZJkycCn8omfgpCsxpS1bC7VKIRcOU3B462b6NoWswOyafxmRSw2zxjlS1TRmbnSd66UKWM61clb+tmNHxpqPB3ScwmkKL1N4lcLoJIXROIXRaQqjlymMXqUwPklhPE5hfJrC+KVna/wqQC1afPsMjMYeZNcDF542uqR5v5eWdzapTNtq4eWGFp6q0RCOjtr9xMU///zzVN1NFcA0of01TSbTpCWZJin4OlKb02QySiEU3E6TCbwYfxUJVvT9ktD130v6HtFs+O+CvsejqVqHQcfMjBNV/QAjVP37MxE/w3qiQh6ZyqJqo0LSSZ6WamjeqLRliyrWnUAvSCCppJOitPtlihRPT6yOsy3JTkkyXr37xeLqpydTZCvWsO70Vaxre1VRDTAj4y0Ivhx2p80eBPygTw2AwNXnyv+S5G911n4QWpKnh0Sftc+F46shmwest/eDEQieHhQdY58LxCsCgs6t/ShQ7dODIHAVK4It4OtOTgejLwfjk/HpBgzkR3mCqhrk+WC1Wn0mhMCAkXkUxmdjMxiz3gYkn3VudLXDU2FHoqMK5hP/jtb9D2TTz6K5izk5iZvubnQP+wa507lYPbO+q9i0teOIvrPiVj02uYr4YFc5K7TMAvNEE623GXmDQwJhQMDnxz/8cNyD0hcOqiriC7GUvgcMfb+0qoZ5Ptym3ZihXmkFeZ7CjvLdFXkOVVXtK/cVdFxO1Z+HHIdg023/XggET287dIzt3BFbp0ghVagIqwO2CAwumlIYvCVf1EqtWPrfQd9s7ZW4VTpjnl1X9vo4MODFgi/OgsH+PCxjkmCzAyp5vN09wfqdGFzgLffho2bEjMxD+Mo2WUGenYh+gVblqgvj8FcmakkhhBKd41J02XCTiakanfDhE5yDB06fQPH0FluPs1jpIw5UfTlNKhHsh2SO3W/tCjTT5Kpt4/1izHttYVdjuOqtS5ET0kTMEYuOvULmWIoZll3dRy/Wvjhh4nvgUEUlVevOM8snkQOuFbdbtaFyvWMbeLH76y9q2LiKI85QShtjGpug9VuHoA8H4xT6sOkMITaAWXtC7NoWHtdeQIgmfzseZNFtMiYsxKY7YkI8C3G/htl5ZASiAyZs421xsH0DBBE2ZqaPC/VRSSWrpmoDh/O214hYFU7aPlzUkuLpcYT+7N4bQdw+MkKIaO8ZYKpG7N7HwADrBdhtkAWSp6cYepx9jmLYOLo+9dD5+O0Wue9vtx1nFZH6U6rdanb/XhvCGZ0MFJv0jSjalGVYO4pMbWzEEYdU+rGi/YdDn+rfvQ62VfDHrJAtvn+3VRLoPs88IdQ+bKn0xfijlstUjXzIqvIXJfviVRUviqemKgJbW+dikia65ptHrd7kySTxt5jxTi9JuW+07mudr5LJXRKizPQzxHCp6fEvlm5L7xKbFVgJ+hV5ovvVuSypKwqTorFJmnBYgS5bCbVkkujZL5i5JCXzuKarILTUB7eb3EUqf7+WpMG1TCaJv3hL0gRvRVUTcSgCVJkm/427WMcRH+qrLen6svyjveGkfugG6xO74abrrQvmT+qp38O6w7XrTBgjVsn2XXa8uoo+iG/XxubLVTQOpCNDo71OYbIkTaTDqj/Knlkz+uORzlCTJBx9/Ni2PC2i+ugxqV1daPVJDcNVwQ7MPxAlX3t/4M0pe03OD+bR1hx0t3spcFR9+NiKifQsrVj0x/Sm070xL/bd+vYum2yhmzKnaxwUZsiXr598s8/JE6LMGs5faNX3hmQtq61ko3Wa3D4uzC1kehCvlOGLEucOmrpGA5k2Cs3zfrDoyQg3Pj1dp8nqcfFW/y/F+4omb/m4dD/xXXyXp/BH8Pri1TpNisd5/XubLfAHMnv6ct2ddVtn+fuZzlfvo95aP0YYDxWio+yVN+rM5Gh6QMy0LlGoe0i8mXu/VcMzMkaehVgNX/JKY+OBAktZlmAwQ0oY4SBr1FUQjA5/Awzhno1c3u+ogM0528wsUanYn/UdzhCckYsFUlpMoODG4RobBadhUSIJcSXmdEPNiS4Gb6RubGSvEJZvmkski9EVKH1uhVSLTc+4hw4nGfRlH/Znh0rokFN073128fYDsGSXfQCuaO/QvZS+Dzi7eEupM3Ie7LAhvLMtEhFasUECZBfBjRTxer3V7Svvk6NiRDQLu5HpNAxJKwO4z1Au7U6O0i5+12bK3eu4y66iKdKNo7QuGTIGrMPabuDIXLRAXujmQ1blI0gKWDQc8He0ZWMeDccUu9QXqXwKHrsmeWNitk9YFkRJ+XgdThEVIur1nwIq65sLmAvr0KSUnEfIm4Zcj7ZLvK3RSFQZ7oDg4S3s93hnh4flR1laWllvhYxPTujflgGwkUtIzLR5huXqT0n64U7AwyaQLya3474Z1FkwXxfjv9taVVlBJkyF1m5aMTuaPCJAHzepSqnwfQTl/fjk5P2XhNw6TU53gXOuK3QF56nQyl0aTSl/dYmCEtDMCsRCSAU0vPkdsUJjtHlY6o/j7CEQTk9O3o9aEL68D8IbxQFbTi+90Neo/r2S9od3fnhi9bZi38H7Aon0RFyfbAjbL/dCWswaI90qmVzeJbcDUcuBr59cXq2vaNW5QpN7XGvLHAtXJJPk+J63zPm95Ipd3iWNKZNJEo97K1ROQdV7R76o5fHNKFmn2y12Ggh7qa0TC6kWgwdbXXWintN0eMQ3BO78mVr+A8mhCXj2qdJE0jIoUJBJQAjSLP+zCxV8F+cqOvE7/fJuUrY97ehob/jO2yp9hzfcc4YvoyfKzmXrWyadREnr/9HP1qO77JZe6zxF32nETsf49JSt869GbMa+eMUW4unL9ZVHuGctcTimf+T7EN7G2RXPM6nmmicggHJWozqns5LW+c3ovnmMZaarNoMukv/f//wvt4inK2/DP8FZY6DWSzSULk4pcfMSbyWdTr1sdvL++d5BVCVaSyEB5XDhM8Hlgi/b4tGUiVrMZClp4xKZ9tfYvb1vh/BTgRRHpKpnxt873mBJ+x1KrTlP2mkQjdNVP9scltpcz4mlFATMKLEWLdlWGJugKoTKKKbn13MK2gDlhdMhWhtpEYSsiJgOc5zPZSapY9JSRmQOKqHEAmmwlM10QqGOabFGz8gWsrps/GlPybmIzovIMcUhfEvWFQtOhTk6IUvM/UFvU29oBaUV8s5nZNTWNLzM0HY5CSXeoOH9683kpiyh1s6bruRT9OeWOnJGKEuOgGcoTk0LX7BEeIxcrIZA4Us6IMgKowVQSnVNWeIDuGyX2U84s9Jh56Isl8t7uuT5Zpu/SVc0MzBY667dggtZ8/Sbtx/PaeejqezZ/BzNjcwwKLI9Yx4z8XE4Y0TGZ0zcz6KWf91uQPq+lBkqi70T4fXf3n4PN/BieJKkPe35AQwff//mm+9+PP+O+iX97vffaHgyPOG4irauEqo31Df+MchFp8+2on7tYXl4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YXJ4YfKo/IcXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJocXJk/nhUnIpiAL7rguheR0HL5/vQuZNJfb706u0qSgVJvJZXJ3R5df70y5XlPxrw0aytO5SpMbYSQFeDlLJ43ZKJS/cY0ruoT18erBBY2f+hXJF8ZbyUmUTONbvOZ5eZC2nw309uz8IkmTWXgbU+mc2hixpHczYplMElJ2/MaGIeXXEYITn0uhFg2nlCS+X0qiEY0rNjNwrjkDJ/zoZaYItepxuZma40WhvyTYzgb/Qbe2/8DVX1pyX7O3QcA2UtMUXq3X638B09ul6A==",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"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.235362e9.js b/assets/js/runtime~main.f0e932ef.js similarity index 96% rename from assets/js/runtime~main.235362e9.js rename to assets/js/runtime~main.f0e932ef.js index 39c0ed6f4..252c9c831 100644 --- a/assets/js/runtime~main.235362e9.js +++ b/assets/js/runtime~main.f0e932ef.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"99437f98",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"d9da916d",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"1e67588d",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"00fb612b",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"05196014",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a5a4e5f7",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"42c39ba6",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"cdd769c8",8140:"901b2f91",8141:"81bec72f",8163:"a62323e7",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"a184f1a5",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"99437f98",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"636268e6",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"1e67588d",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"595cd5c0",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"05196014",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a5a4e5f7",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"50bb866e",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"cdd769c8",8140:"901b2f91",8141:"81bec72f",8163:"a62323e7",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"ce18ae1a",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"1ed86312",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 51639eea0..5738d2542 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 028397b02..01325904f 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 3aedf7e31..407721522 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 618f94081..e5bd51030 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 ea8d4cf81..334cc4c64 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 c9a35892d..4ffe89852 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 e8a1e7f18..15ea4b900 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 0a969025c..2a635b19b 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 a46d2292b..6bd9cf6ae 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 39260c605..42435b946 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 7e026732c..072b5e415 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 156326d15..88682401e 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 08dadceca..681fa400b 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -77,11 +77,12 @@
  1. textbox:
-
{
  "type":"textbox", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "textbox",
    "default": "name",
    "hint": "provide name",
    "regularexpression":"",
    "color": "black",
    "fontsize": 12
  }
}
+
{
  "type":"textbox", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": { 
    "name": "textbox",
    "required": true,
    "readonly": false,
    "default": "name",
    "hint": "provide name",
    "regularexpression":"",
    "color": "black",
    "fontsize": 12
  }
}
  • default: Provide a default value for the textbox (Optional).
  • hint: Provide a hint for the textbox (Optional).
  • regularexpression: Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
    • +
  • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
  1. checkbox:
    2. @@ -98,10 +99,11 @@
    1. dropdown:
    -
    {
     "type":"dropdown", 
     "page":1,  
     "x": 327, 
     "y": 628, 
     "w": 114, 
     "h": 21, 
     "options": {
       "required": true, 
       "name": "dropdown",
       "values": ["male", "female", "other"],
       "default": "",
       "color": "black",
       "fontsize": 12
      }
    }
    +
    {
     "type":"dropdown", 
     "page":1,  
     "x": 327, 
     "y": 628, 
     "w": 114, 
     "h": 21, 
     "options": {
       "required": true, 
       "name": "dropdown",
       "readonly": false,
       "values": ["male", "female", "other"],
       "default": "",
       "color": "black",
       "fontsize": 12
      }
    }
    • values: Provide options for the dropdown list.
    • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
      • +
    • readonly: Set to true if you want to set the dropdown as readonly. By default, it's false.
    1. radio button:
      2. @@ -110,6 +112,7 @@
      • values: Provide options for the radio button list.
      • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
        • +
      • readonly: Set to true if you want to set the radio button as readonly. By default, it's false.
      1. image:
        2. diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 086fe69b1..d143d38da 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 0fd6f3d0f..c8ce4cc86 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 81d6c27ca..507e0b237 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -77,11 +77,12 @@
        1. textbox:
        -
        {
          "type":"textbox", 
          "page":1,  
          "x": 327, 
          "y": 628, 
          "w": 114, 
          "h": 21, 
          "options": {
            "required": true, 
            "name": "textbox",
            "default": "name",
            "hint": "provide name",
            "regularexpression":"",
            "color": "black",
            "fontsize": 12
          }
        }
        +
        {
          "type":"textbox", 
          "page":1,  
          "x": 327, 
          "y": 628, 
          "w": 114, 
          "h": 21, 
          "options": { 
            "name": "textbox",
            "required": true,
            "readonly": false,
            "default": "name",
            "hint": "provide name",
            "regularexpression":"",
            "color": "black",
            "fontsize": 12
          }
        }
        • default: Provide a default value for the textbox (Optional).
        • hint: Provide a hint for the textbox (Optional).
        • regularexpression: Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
          • +
        • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
        1. checkbox:
          2. @@ -90,7 +91,7 @@
          • values: Provide options for the checkbox list.
          • selectedvalues: Provide values that need to be selected by default (Optional).
            • -
          • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false
            • +
          • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false.
          • hidelabel: Set to true if you want to hide labels of the checkbox. By default, it's false.
          • minselections: Provide the minimum number of checkboxes that must be selected by the user.
          • maxselections: Provide the maximum number of checkboxes that can be selected by the user.
            • @@ -98,10 +99,11 @@
            1. dropdown:
            -
            {
             "type":"dropdown", 
             "page":1,  
             "x": 327, 
             "y": 628, 
             "w": 114, 
             "h": 21, 
             "options": {
               "required": true, 
               "name": "dropdown",
               "values": ["male", "female", "other"],
               "default": "",
               "color": "black",
               "fontsize": 12
              }
            }
            +
            {
             "type":"dropdown", 
             "page":1,  
             "x": 327, 
             "y": 628, 
             "w": 114, 
             "h": 21, 
             "options": {
               "required": true, 
               "name": "dropdown",
               "readonly": false,
               "values": ["male", "female", "other"],
               "default": "",
               "color": "black",
               "fontsize": 12
              }
            }
            • values: Provide options for the dropdown list.
            • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
              • +
            • readonly: Set to true if you want to set the dropdown as readonly. By default, it's false.
            1. radio button:
              2. @@ -110,6 +112,7 @@
              • values: Provide options for the radio button list.
              • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
                • +
              • readonly: Set to true if you want to set the radio button as readonly. By default, it's false.
              1. image:
                2. diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index b56fd2316..6372ad451 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 cb2f94ebc..e0ad6629c 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 c152de483..d470f9b87 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 fa82f9062..e583ff531 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 22bd182c2..5eb6e0ca1 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/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 457321a8a..7ba45b372 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -13,6 +13,8 @@ 
                POST 
                /drafttemplate

                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.

                Tip: Upload your PDF document to our 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.

                +

                When document is created this webhook event will trigger

                +
                 {
                     "event": "created",
                     "objectId":"DOCUMENT_ID"
                     "file": "DOCUMENT_URL",
                     "name": "DOCUMENT_NAME",
                     "note": "Please review and sign this document",
                     "description": "",
                     "signers": [
                       {
                         "name": "SIGNER_NAME",
                         "email": "SIGNER_EMAIL",
                         "phone": "SIGNER_PHONE",
                         "url": "SIGNING_URL"
                       }
                     ],
                     "createdAt": "TIMESTAMP"
                 }

                Supported Widgets:

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

                  @@ -77,11 +79,12 @@
                  1. textbox:
                  -
                  {
                    "type":"textbox", 
                    "page":1,  
                    "x": 327, 
                    "y": 628, 
                    "w": 114, 
                    "h": 21, 
                    "options": {
                      "required": true, 
                      "name": "textbox",
                      "default": "name",
                      "hint": "provide name",
                      "regularexpression":"",
                      "color": "black",
                      "fontsize": 12
                    }
                  }
                  +
                  {
                    "type":"textbox", 
                    "page":1,  
                    "x": 327, 
                    "y": 628, 
                    "w": 114, 
                    "h": 21, 
                    "options": { 
                      "name": "textbox",
                      "required": true,
                      "readonly": false,
                      "default": "name",
                      "hint": "provide name",
                      "regularexpression":"",
                      "color": "black",
                      "fontsize": 12
                    }
                  }
                  • default: Provide a default value for the textbox (Optional).
                  • hint: Provide a hint for the textbox (Optional).
                  • regularexpression: Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
                    • +
                  • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
                  1. checkbox:
                    2. @@ -90,7 +93,7 @@
                    • values: Provide options for the checkbox list.
                    • selectedvalues: Provide values that need to be selected by default (Optional).
                      • -
                    • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false
                      • +
                    • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false.
                    • hidelabel: Set to true if you want to hide labels of the checkbox. By default, it's false.
                    • minselections: Provide the minimum number of checkboxes that must be selected by the user.
                    • maxselections: Provide the maximum number of checkboxes that can be selected by the user.
                      • @@ -98,10 +101,11 @@
                      1. dropdown:
                      -
                      {
                       "type":"dropdown", 
                       "page":1,  
                       "x": 327, 
                       "y": 628, 
                       "w": 114, 
                       "h": 21, 
                       "options": {
                         "required": true, 
                         "name": "dropdown",
                         "values": ["male", "female", "other"],
                         "default": "",
                         "color": "black",
                         "fontsize": 12
                        }
                      }
                      +
                      {
                       "type":"dropdown", 
                       "page":1,  
                       "x": 327, 
                       "y": 628, 
                       "w": 114, 
                       "h": 21, 
                       "options": {
                         "required": true, 
                         "name": "dropdown",
                         "readonly": false,
                         "values": ["male", "female", "other"],
                         "default": "",
                         "color": "black",
                         "fontsize": 12
                        }
                      }
                      • values: Provide options for the dropdown list.
                      • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
                        • +
                      • readonly: Set to true if you want to set the dropdown as readonly. By default, it's false.
                      1. radio button:
                        2. @@ -110,6 +114,7 @@
                        • values: Provide options for the radio button list.
                        • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
                          • +
                        • readonly: Set to true if you want to set the radio button as readonly. By default, it's false.
                        1. image:
                          2. diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index f65bceca6..5b1cb5612 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 691d0cc1b..745a99eb6 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 95b416b41..82e187ed8 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 b2280c9d4..f263472b8 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 9af46e05a..d8c436243 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 0c9ca185a..c9ff4e3d8 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 7a464e540..31c8c3b51 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 8f96a14f3..d555cc5e7 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 95b981ea9..46c7352e9 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 7d2e5d705..231a7d0f7 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 dcf0498cd..dafd5ce40 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 580b09d61..0694fc13b 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 1a6df8fb8..2efb8a0d8 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™ - + @@ -26,6 +26,13 @@ 
                    {
                        "event": "created",
                        "objectId":"DOCUMENT_ID"
                        "file": "DOCUMENT_URL",
                        "name": "DOCUMENT_NAME",
                        "note": "Please review and sign this document",
                        "description": "",
                        "signers": [
                          {
                            "name": "SIGNER_NAME",
                            "email": "SIGNER_EMAIL",
                            "phone": "SIGNER_PHONE"
                          }
                        ],
                        "createdAt": "TIMESTAMP"
                      }

                    +
                  +
                    +
                  • When document is created through draft template API this event will trigger. +
                    {
                        "event": "created",
                        "objectId":"DOCUMENT_ID"
                        "file": "DOCUMENT_URL",
                        "name": "DOCUMENT_NAME",
                        "note": "Please review and sign this document",
                        "description": "",
                        "signers": [
                          {
                            "name": "SIGNER_NAME",
                            "email": "SIGNER_EMAIL",
                            "phone": "SIGNER_PHONE",
                            "url": "SIGNING_URL"
                          }
                        ],
                        "createdAt": "TIMESTAMP"
                      }

                    +
                    • +
                  +
                  1. signed:
                    • When document is signed by signer this event will trigger.
                      • diff --git a/docs/API-docs/selfsign/index.html b/docs/API-docs/selfsign/index.html index c95e17dcb..a0a0beab1 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + @@ -77,11 +77,12 @@
                      1. textbox:
                      -
                      {
                        "type":"textbox", 
                        "page":1,  
                        "x": 327, 
                        "y": 628, 
                        "w": 114, 
                        "h": 21, 
                        "options": {
                          "required": true, 
                          "name": "textbox",
                          "default": "name",
                          "hint": "provide name",
                          "regularexpression":"",
                          "color": "black",
                          "fontsize": 12
                        }
                      }
                      +
                      {
                        "type":"textbox", 
                        "page":1,  
                        "x": 327, 
                        "y": 628, 
                        "w": 114, 
                        "h": 21, 
                        "options": {
                          "name": "textbox",
                          "required": true, 
                          "readonly": false,
                          "default": "name",
                          "hint": "provide name",
                          "regularexpression":"",
                          "color": "black",
                          "fontsize": 12
                        }
                      }
                      • default: Provide a default value for the textbox (Optional).
                      • hint: Provide a hint for the textbox (Optional).
                      • regularexpression: Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
                        • +
                      • readonly: Set to true if you want to set the textbox as readonly. By default, it's false.
                      1. checkbox:
                        2. @@ -90,7 +91,7 @@
                        • values: Provide options for the checkbox list.
                        • selectedvalues: Provide values that need to be selected by default (Optional).
                          • -
                        • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false
                          • +
                        • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false.
                        • hidelabel: Set to true if you want to hide labels of the checkbox. By default, it's false.
                          diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index fca78207f..42777689e 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 3d531dac8..0f1b45aea 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 78cad2806..1d62cceff 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 45e5aa69c..6c076f027 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 39f8a4e9e..cde39554f 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 80c148797..11c6fdd56 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 02db49c2a..92ecb7fd8 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 425c22b77..9d3bb292f 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 a4969da70..7f8cb72c0 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 7257265f8..fbce3d233 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 89ada56ab..c7a36838b 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 a7c6bd236..236c91ad3 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 62d82aad3..62619cc14 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 f4a23f688..e1c7d53ab 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 6cd041a34..0d054b2df 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 be35fe877..a1301f015 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 54c0cf4bd..a69f24b04 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 b76212ca6..4cf9a1c09 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 715a0bf5a..89834e16a 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 f867b5b75..daaf38f3f 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 4c5e873fa..b88b95e9d 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 c5fd1e2e0..6959cfab9 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 701eebcac..07d06395e 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 bf2ecd620..e1387c6aa 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 ea97b0b9d..b5ea6fa95 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 470de8d78..5bd5901f2 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 4e2e1a694..c46a3ea7d 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 a4f33ba51..9b30b07f1 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 acbaea958..7a5df7d4a 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 e8484ceb1..e66e4b204 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 2d5a10a1f..061295d1e 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 b7d19900f..90d0d73dd 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 b92bfc537..ef40fc1a0 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 5c98ee462..fa4c69534 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 64967d4fb..dfe4109e5 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 597e4552b..cbb38dd73 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 2cb6d45aa..d2936fc8c 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 b6db36bd4..463891f37 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 77cc5a4ad..f06035dc5 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 3eff618e4..969549661 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 35aabda4c..34c4ce2fc 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 34aa87b42..5a1958a86 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 c4116d7a3..687670f89 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 4aa275ac2..c571947c1 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 7544140bf..660486d30 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 f0ce48085..535d36dae 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 2c013d9cc..de634200e 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 2368c8b3e..4b9dea73e 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 03b216019..7f04b7909 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 d34ee3df1..9fa8d0fa7 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 ee7660de4..a9beeb2ce 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 939c0d5f8..86f1e2819 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 e83bcfc62..bf01ad3fd 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 792d14b7e..7c82241a9 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +