diff --git a/404.html b/404.html index eb60c687b..915570e11 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.a94482e8.js b/assets/js/0028a090.a94482e8.js deleted file mode 100644 index 00f0e9502..000000000 --- a/assets/js/0028a090.a94482e8.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:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),a=s(11151),t=s(58219),r=(s(62316),s(51039)),l=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:"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:"eJztO+1yGzmOr8LtPzOjasmW4ngyqqur8ySejDLxx8XO5MNyOVQ3JDHuJjsk27KS0r99kn20fZIrgGSrJUu2k0zteuv0J7GaIAiAAAiCwJfI8pGJumfRKeRFxi2Y6DyOUjCJFoUVSkbd6HQMLAyzZ5oPrZAjtnfcYyD5IAPDSgPaMKtYogGBktJYlYvPOMpswBwzA/oK53LDBlkJhRbSGjZUmo1AguaEOFVJmQMOTIQds0JDCkMhIWXG6jKxpQbTYq8LJZkpkwSMGZaZW1koydSQ8WrNmNkxEKkabKmlYZyVUnwqgTUaavAREttLGw32YwpGjCS3kCJxYfqFSH+K2WQskjFLuGQDQFZT5NQTDDVyBxzHlKQ1TQGJGAoE9shabC9NBdLIs2waM84ajVJnjQYThhVaXYkU0rCaGg5RpJxEy4S0oIc8AZIVIBY5omUCcsZlyoY8EZmwi2JkqTBWi0GJK7f6si9PRdFlr4tM8ZRNVanZ8bPf5uBWMfx21mg8g0E5Yq97jcb5j2NrC9Pd2uJF0VIFSJRWxgemlah8K0XAIh2SrEADYiV5ATcimzKepmwi0hFYQxsiWaKKKUuU0qmQTjUKPgImy3wA2sTETa40MCEZZxp4Om1a1SwNsBcnR4cohpzbFjvOShNXy6VCQ2KzqUOP4glc/eB2Z3cHdUjIUcxyfolSEpZ9KkVyiWwbkLS1XmVafckYY33ZaLxBmisJCeP1PGXMjoVhExiMlbpkcIXDE5FlzGoxGoFuNAjJhw8fHLIv7j/CGxF4P+qyfuTx9aO4DhAUtB91+9Gzo6evD/YPTy96z/pRHWooMnBYKpDXr14uoZI8XwY63DvYX4ZS1kMdZ8ANMA1XAia0Hbjjjt0giKXJNafhcCyNIwLQBsfO5t8XZLJM60nv+eH+q5uUevnlXGQLgPsHe72XKyCLsZKLKI9/PzpchbPUNYy9w+dOlHWo2fzH+QJ/fg/3/Jae9g72T073Do7D9FlffvjwgfTppCwKpVGB3jiz6KKi9OWvkKkJ4xpIBxOV50qygmuegyUPO+aWhjV8KoWG1LlInmXBvrqIpskaDTstoNtosJ5MRYIm5tzFtAD0kA665UDR9BD0xLssB1ozSPRpzi2hpU248xJFhg4JQTWgt7PiChYRX8dsioifASqWQztWWnxW0vKMtOoKtBUJz+rOAAkkF2q5JldWKCFt+OpXYO+80aNPIFP33gpJS1FcuZA0YoBd8awE46maxGyMVL2CQoMhz+3xoihlysYgRuO16/H0Y2nsAmJWmuCPAxV+rbBPJF4gsQ15ZoCJ4YIsc34JtdWYKtw50WK/TlkKQ15mNmYC/ZjVJbTYobKMF0UmEjpj8VhwB1ipoUm77BXCE4I2hUQcu3MGT5ZU4BmDHgsHCYWfE6hDTXMHE7JH/tiOuWRKLm10ojKlEf2SDtH3RUGyREkL0rbY3hUXGVHvuDVMyCQrU2CDjCeXMYUIMdN4KOK2TCHL1CR2Kk8gdFST0ElAzECGaqgkMiCVX16Y+WHcOkUHVlkUjgVR0xrC1KXqz4KhwoVRBMHIGLmemAQXs49qwKywGcRosgWX05ilLviAaztQ1zFLxpBc0l+ap0KxQWmtko6vVKsiVRPpZTlU0hrxeYVFhpGvF2gnZjsx243Zk5i1t2PW7sSsvROz9m7M2k9i1tmOWacTs85OzDq7jqzOEy9qXsm3TkC744Rsa8JlD1u66HlfCkOWjS7TVF54suCF+7LdYo1GZU/0mY5wOqr6EdoXnckVSD+KmRtDt9mPuu2Y+Q/XeBw86vwcAKb4exel635P8Hcbd8P9HuPvTrsvZ37RDhFjeV7cQggO//VEhJ9en/CjP637UXBt+BF9koNdPL89WTgwmzP0CBkSUljBM7OepwDx8NiaU7bE2Q5yRtq7ni0ftTw0ngJZYYR8pxsiX1sbCm6ACOksieBxa37arJGAW/ShCcBT9b387yL/lc9aL4QK5OFJok7a94rj5xaFB+S31wvDAzw8UcwJ+15BPEFB4Lm1Xgo4+vBE4KkKAz4WcGPbO83242Znu7OzIAa8mzuAPG+maXM6nX6nCN0NGsMjvz4Fmz6YdTEgJkGGWuUrbip0kZhD+fCJ/g7R/QHG9AOo8jCYeFhM44SUQz0gtyrl0x+MQxWmVnEcws+juGmNTBpCOij9koyVSDzxCBOitwHeBikL0UTBp1sHB1s1UbqPzTwP8mXhK/5ukujrX/O8laatZdiFHap9zVmaxmzF99UDacryPF/33Q3gcdmXv6Ah+NBtvS14gH+NOazQ+vn6a21lPsBTJTNany53q21l6XwZi5D78XrDlgA0jMqMa7jGW6pxSZVaTuXbPdGSFQUjmof5dKml+6DLMJIk2I9HPpT/ySs4crCIAL/cPe8GY3UkGkZwTThcDhmJESlldmNM947xzsfDjQHFPk8a0q+EFwKTCxlYS1/BJq1VRLhNq13McVOX7+UG7AIz3LAwc8XVnHafLhrtbTr3/L3kloPPQzw8t1+jLAy6ZIfL30U596FLNIT538qOQfej82qOu5JDWpvLVk1m57fYE5sbTQoZH0B209bubQ11drxm1YSDA7mQVSaBSN4OFNAov14a9YOzFXbm2K4reHDuwUyCnFkmTEinLAqtPtvnmygPKMG9RAyAhQlsUKnkd6t8Rdj9dN55BL89dyyBcIwAq1xfWO2OFRa2pi4YxJELKfIyr5KWwwprEFnuT/m6vHAmPrKEFerbe2MFfn3HCv6VaM0Cfdmm1EJISpBjYKuDQQ/y8DxDjbK7j8Bv8RkLx+a3Hnhfb4mBr7olrjgnEdSdkJUVmvVm2GJHeCphxtRNwhxYkkBhMV/2vTZakXw/G21TKqmeI1t/MtWh/tU6uE6Z7qOdS3T/ZXro4b4v+EKp3U8Z62z8BynkAtn3DpZcQjB3z1DrsoE5qd5Dc4aerKWjP4ojVVA9g5K9NOpGKVZNhLf6KCbUYOyvKp1G3S+RT+Hjnz5BjjO3Phqsv/gSmWQMOce/AklYsYHvvlEcnlWjOKKcDZZvoNCirn8+jmK8YRT4zgYGcdC87pcA5R7Eo9jf26Nu5F7KoziCa54XCOw/MZCJwssxoZiFFW/DVX2Z4zL0R1W5gHjwefAb0dDU2VLJyjdhqmOYzeU6R8a15tNouTomvAuGa5ybVz18ZNNgK8KiRVRvVQQWxZGwkNdXWbNrWn29pBNQyAmldr92Lm0Lz796TZxHz+3fMtG/w6yQ+T2l5EZvLry4ZXt4f4Q0RNPN+dNpzOjJonWXxgR44paP6mu62PDGmqfrntRrL3lmrMosxTcy4LpFL9vfXIpD1Vg8S0qqDqrOiAXOKlIrztqzOLq+m5lrlqhmeK9nP2YwtKwsCtAsUVqC/qmeiXswzHV2dmZxNL2bvel/JHs/4+ZN7ubuDRU6zItA/h20Pnoyi6Px3bT+XpVi/BuJ3dmdzc86X+ZTVQgOVDq9CH5rdhdgOFQQDsvNevJIp6BrghgolQGXNyTRG7ogS7EfMBb5wae76AVdaBMOFFd9piEBrMahDHbwVcwHHe55nflHTIzN9vEDxYymHBiEkgGfcQgHECrasAzTQQhXxkg1AsCTMdbPWUcVH+LzP1URYQWZKk0gb8wNPeNngGGpHYNwhStCjhZjxJp0qIKjznurvjv4BQ85KkU9Oj2+hywpgm26YjZ3TjsuHQ52dHqMdUli6OOwFnttKkkE0fIFEIZxEbsSPNQuVL596pIOIEkiKpTRzUsTW74iqMluEpQKs5KieJ4CrUpvbyCel0PiFqnSYh2mrz9lxkJhFuRIVFSCPFXlfbTyDklyNirpNcWiyYYiJUrLzuuKhHR1vXT/SUsdSqm8WiAkFvnO5RSkgkA1/DEDadx0zobcWNAxFvui5HWJ95sKJVwXoAXIBFaKQIMT3UWpV8ZNizJYLNJ5/eqlL4INPASjHKAFOsSQsrIgrSFLqIrHws4ts34jUCItu0AbAX2xLkxbJJOKvLB6mKzfp90K0AZrpjVTesSl+OxrqJ0mDWDMsyF53+pNDWvCcN1AM2JbpC+433/+/R9IKmnqRa7SSnvN/RXrGMv4rKmckVVUTAwZuJLr8CJQOTkTB8dmfCyHDwOaEvjEliqQH7gWxtZqjsJz302jfAUoz6RGA539aEqoaHJat6qKLl/bNEdHlVFisVytOnuWFPD2M8QdMvOLoPd/WIOppHFhcGd7G/9bikBDqXgoXp5Xz2fTv0Xx/W+ht8fgoWp5lUrOteTXced3U8g8GaOSrDG0Ofjt53v9dr0F0xfjwfNEHIkXvdefe+1D0TM9+epx8rS327ss3v759MUvLZi+aCedP6dvO3/ad28y0/uoRPL7i/F7+acZPH1cvnv7Xr9729Pv3ryy/M3jvYEcy8Hz30Qyffxx0NkWL5++2H7/pj0ZPP9t+/2fvxTvCflv2+8vL7eT/PDpQO4hTPHu7f+Ko4/7jw4+738+ON2/Pvic/dLih58+Pr1Ofjm43N9tvu/p5sHR4I+Pn2zx6nH66PCt2H0CB/BGnm6/TKK6NgiZCQkXYasviO8L3OwZKcXOqm0/UTnYMek6VadrheXvhavvtnrK+IgLyVB0+i/UAtBa6dv39Osou00QO9vbF+1KCI9vCqEn6bWHOkFO1SXIfy2n9eWtWx5Jvc5J653/joQDovFogdn6d8ekgaTUwk6j7tmX6LrJC9F0492z89l5HKFgFSaeCmWIYm7HUTfaWs5DYUMOJTnOvjgbrAzNcJnie8wNY+OF2LpqR7N4ecZK01wLbSwfCTlq3jrrfM7pCe6GE/gCv/NMQSH+AEwVeHHWoeJIoBaMgWOwjQLETX41T8Lth60K6bGVGa/5niznsEIKayErtXymrcgz1dJMZyHHQ2mbKmsTzTmKqswK/lnlSs7mmlelJUJWok3X+c7ODt17f27TBfHRE7p77ezOzp2Ea/cQynPWg2mXgV+ICv2nxSgpilZGJQvRwJpgIIRdQg4VbagX8lEB8gSjWjSbq/bNiyxkicqrQuIA/s+//4NmhMOXlvkbOyo1K9QENHaLUbdUBtcC40gEJsIMRTiUzuZ5BsZg8k5aGLlGLzGiyoIQnCW84APst8LQT0irXDVPzZWYFnszBnxWwKEftCuyuIIM3QfLlKIWJIxpSqvyejMZmyh9OUSSsE9sgP0FYPAWBGEKyDGXCcZizj4oysGWKwx3Cy0MMC5yBKaWseFQJAIRo9PTPLEs55KPKFyJ6UKNUihCd4BWA7y1GJWVLi7HHgUA61ikJ4YWe4b3IGIcP6ZgucggdSG5id2VyPtA39I1wOtngcuLBMy8NCuDK9DkD9yFtswyVijrLpkYr9X3FhFZzaXBK7sjKGxNJT4fONMaKZ+2GL4z4HmD9yVUgEzIS2yWabKzSs3ewMAIC/NkwmQyueGbflqc81zYcTlgGgo1nzeij+TJ6tOrHz+hJwGdm6PhCXZEJiHCWbPmFgFv+SOLJ3RkBf/AC/E/yxPw+MhEAtJA7YDZe378kl2xR63tKK5543sQvPWy93T/8GQf8eJ54eyv3dpubVMGVBmbc1lbirpEq6bRZcutPXhsmks3zaWb5tJNc+mmuZSxTXPpprl001y6aS7dNJdumks3zaWb5tL+prm0v2ku3TSXbppLN82lczFsmks3zaWb5tJNc+mmuXTTXLppLt00l26aSzfNpZvm0k1z6aa5dNNc+v+ludTXe2HguFVkXMhaDa0r9Ttbajk9j6MxlgJ2z6IvX/C1+rXOZjP8/KkEjXWE53F0xbXA7DlVEcahXA4LzC5hGnWjp+4xoHmKy8dO7akCZal4Eqv93Iw92vxbYevVisdHJ6dRHA18W2yuUpyj+QRbZvkk6kbos6m7tiokp+9foozLUUk1b5HDi1V+vLTjxRLBSyoR9H/USue4nNaoXKwddKzgv8jYygn/hVUgf8D0vytwN7J2gpdtgMYdPJ/NZv8HGPOZ6A==",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:"eJztO+1yGzmOr8LtPzOjasmW4ngyqqur8ySejDLxx8XO5MNyOVQ3JDHuJjsk27KS0r99kn20fZIrgGSrJUu2k0zteuv0J7GaIAiAAAiCwJfI8pGJumfRKeRFxi2Y6DyOUjCJFoUVSkbd6HQMLAyzZ5oPrZAjtnfcYyD5IAPDSgPaMKtYogGBktJYlYvPOMpswBwzA/oK53LDBlkJhRbSGjZUmo1AguaEOFVJmQMOTIQds0JDCkMhIWXG6jKxpQbTYq8LJZkpkwSMGZaZW1koydSQ8WrNmNkxEKkabKmlYZyVUnwqgTUaavAREttLGw32YwpGjCS3kCJxYfqFSH+K2WQskjFLuGQDQFZT5NQTDDVyBxzHlKQ1TQGJGAoE9shabC9NBdLIs2waM84ajVJnjQYThhVaXYkU0rCaGg5RpJxEy4S0oIc8AZIVIBY5omUCcsZlyoY8EZmwi2JkqTBWi0GJK7f6si9PRdFlr4tM8ZRNVanZ8bPf5uBWMfx21mg8g0E5Yq97jcb5j2NrC9Pd2uJF0VIFSJRWxgemlah8K0XAIh2SrEADYiV5ATcimzKepmwi0hFYQxsiWaKKKUuU0qmQTjUKPgImy3wA2sTETa40MCEZZxp4Om1a1SwNsBcnR4cohpzbFjvOShNXy6VCQ2KzqUOP4glc/eB2Z3cHdUjIUcxyfolSEpZ9KkVyiWwbkLS1XmVafckYY33ZaLxBmisJCeP1PGXMjoVhExiMlbpkcIXDE5FlzGoxGoFuNAjJhw8fHLIv7j/CGxF4P+qyfuTx9aO4DhAUtB91+9Gzo6evD/YPTy96z/pRHWooMnBYKpDXr14uoZI8XwY63DvYX4ZS1kMdZ8ANMA1XAia0Hbjjjt0giKXJNafhcCyNIwLQBsfO5t8XZLJM60nv+eH+q5uUevnlXGQLgPsHe72XKyCLsZKLKI9/PzpchbPUNYy9w+dOlHWo2fzH+QJ/fg/3/Jae9g72T073Do7D9FlffvjwgfTppCwKpVGB3jiz6KKi9OWvkKkJ4xpIBxOV50qygmuegyUPO+aWhjV8KoWG1LlInmXBvrqIpskaDTstoNtosJ5MRYIm5tzFtAD0kA665UDR9BD0xLssB1ozSPRpzi2hpU248xJFhg4JQTWgt7PiChYRX8dsioifASqWQztWWnxW0vKMtOoKtBUJz+rOAAkkF2q5JldWKCFt+OpXYO+80aNPIFP33gpJS1FcuZA0YoBd8awE46maxGyMVL2CQoMhz+3xoihlysYgRuO16/H0Y2nsAmJWmuCPAxV+rbBPJF4gsQ15ZoCJ4YIsc34JtdWYKtw50WK/TlkKQ15mNmYC/ZjVJbTYobKMF0UmEjpj8VhwB1ipoUm77BXCE4I2hUQcu3MGT5ZU4BmDHgsHCYWfE6hDTXMHE7JH/tiOuWRKLm10ojKlEf2SDtH3RUGyREkL0rbY3hUXGVHvuDVMyCQrU2CDjCeXMYUIMdN4KOK2TCHL1CR2Kk8gdFST0ElAzECGaqgkMiCVX16Y+WHcOkUHVlkUjgVR0xrC1KXqz4KhwoVRBMHIGLmemAQXs49qwKywGcRosgWX05ilLviAaztQ1zFLxpBc0l+ap0KxQWmtko6vVKsiVRPpZTlU0hrxeYVFhpGvF2gnZjsx243Zk5i1t2PW7sSsvROz9m7M2k9i1tmOWacTs85OzDq7jqzOEy9qXsm3TkC744Rsa8JlD1u66HlfCkOWjS7TVF54suCF+7LdYo1GZU/0mY5wOqr6EdoXnckVSD+KmRtDt9mPuu2Y+Q/XeBw86vwcAKb4exel635P8Hcbd8P9HuPvTrsvZ37RDhFjeV7cQggO//VEhJ9en/CjP637UXBt+BF9koNdPL89WTgwmzP0CBkSUljBM7OepwDx8NiaU7bE2Q5yRtq7ni0ftTw0ngJZYYR8pxsiX1sbCm6ACOksieBxa37arJGAW/ShCcBT9b387yL/lc9aL4QK5OFJok7a94rj5xaFB+S31wvDAzw8UcwJ+15BPEFB4Lm1Xgo4+vBE4KkKAz4WcGPbO83242Znu7OzIAa8mzuAPG+maXM6nX6nCN0NGsMjvz4Fmz6YdTEgJkGGWuUrbip0kZhD+fCJ/g7R/QHG9AOo8jCYeFhM44SUQz0gtyrl0x+MQxWmVnEcws+juGmNTBpCOij9koyVSDzxCBOitwHeBikL0UTBp1sHB1s1UbqPzTwP8mXhK/5ukujrX/O8laatZdiFHap9zVmaxmzF99UDacryPF/33Q3gcdmXv6Ah+NBtvS14gH+NOazQ+vn6a21lPsBTJTNany53q21l6XwZi5D78XrDlgA0jMqMa7jGW6pxSZVaTuXbPdGSFQUjmof5dKml+6DLMJIk2I9HPpT/ySs4crCIAL/cPe8GY3UkGkZwTThcDhmJESlldmNM947xzsfDjQHFPk8a0q+EFwKTCxlYS1/BJq1VRLhNq13McVOX7+UG7AIz3LAwc8XVnHafLhrtbTr3/L3kloPPQzw8t1+jLAy6ZIfL30U596FLNIT538qOQfej82qOu5JDWpvLVk1m57fYE5sbTQoZH0B209bubQ11drxm1YSDA7mQVSaBSN4OFNAov14a9YOzFXbm2K4reHDuwUyCnFkmTEinLAqtPtvnmygPKMG9RAyAhQlsUKnkd6t8Rdj9dN55BL89dyyBcIwAq1xfWO2OFRa2pi4YxJELKfIyr5KWwwprEFnuT/m6vHAmPrKEFerbe2MFfn3HCv6VaM0Cfdmm1EJISpBjYKuDQQ/y8DxDjbK7j8Bv8RkLx+a3Hnhfb4mBr7olrjgnEdSdkJUVmvVm2GJHeCphxtRNwhxYkkBhMV/2vTZakXw/G21TKqmeI1t/MtWh/tU6uE6Z7qOdS3T/ZXro4b4v+EKp3U8Z62z8BynkAtn3DpZcQjB3z1DrsoE5qd5Dc4aerKWjP4ojVVA9g5K9NOpGKVZNhLf6KCbUYOyvKp1G3S+RT+Hjnz5BjjO3Phqsv/gSmWQMOce/AklYsYHvvlEcnlWjOKKcDZZvoNCirn8+jmK8YRT4zgYGcdC87pcA5R7Eo9jf26Nu5F7KoziCa54XCOw/MZCJwssxoZiFFW/DVX2Z4zL0R1W5gHjwefAb0dDU2VLJyjdhqmOYzeU6R8a15tNouTomvAuGa5ybVz18ZNNgK8KiRVRvVQQWxZGwkNdXWbNrWn29pBNQyAmldr92Lm0Lz796TZxHz+3fMtG/w6yQ+T2l5EZvLry4ZXt4f4Q0RNPN+dNpzOjJonWXxgR44paP6mu62PDGmqfrntRrL3lmrMosxTcy4LpFL9vfXIpD1Vg8S0qqDqrOiAXOKlIrztqzOLq+m5lrlqhmeK9nP2YwtKwsCtAsUVqC/qmeiXswzHV2dmZxNL2bvel/JHs/4+ZN7ubuDRU6zItA/h20Pnoyi6Px3bT+XpVi/BuJ3dmdzc86X+ZTVQgOVDq9CH5rdhdgOFQQDsvNevJIp6BrghgolQGXNyTRG7ogS7EfMBb5wae76AVdaBMOFFd9piEBrMahDHbwVcwHHe55nflHTIzN9vEDxYymHBiEkgGfcQgHECrasAzTQQhXxkg1AsCTMdbPWUcVH+LzP1URYQWZKk0gb8wNPeNngGGpHYNwhStCjhZjxJp0qIKjznurvjv4BQ85KkU9Oj2+hywpgm26YjZ3TjsuHQ52dHqMdUli6OOwFnttKkkE0fIFEIZxEbsSPNQuVL596pIOIEkiKpTRzUsTW74iqMluEpQKs5KieJ4CrUpvbyCel0PiFqnSYh2mrz9lxkJhFuRIVFSCPFXlfbTyDklyNirpNcWiyYYiJUrLzuuKhHR1vXT/SUsdSqm8WiAkFvnO5RSkgkA1/DEDadx0zobcWNAxFvui5HWJ95sKJVwXoAXIBFaKQIMT3UWpV8ZNizJYLNJ5/eqlL4INPASjHKAFOsSQsrIgrSFLqIrHws4ts34jUCItu0AbAX2xLkxbJJOKvLB6mKzfp90K0AZrpjVTesSl+OxrqJ0mDWDMsyF53+pNDWvCcN1AM2JbpC+433/+/R9IKmnqRa7SSnvN/RXrGMv4rKmckVVUTAwZuJLr8CJQOTkTB8dmfCyHDwOaEvjEliqQH7gWxtZqjsJz302jfAUoz6RGA539aEqoaHJat6qKLl/bNEdHlVFisVytOnuWFPD2M8QdMvOLoPd/WIOppHFhcGd7G/9bikBDqXgoXp5Xz2fTv0Xx/W+ht8fgoWp5lUrOteTXced3U8g8GaOSrDG0Ofjt53v9dr0F0xfjwfNEHIkXvdefe+1D0TM9+epx8rS327ss3v759MUvLZi+aCedP6dvO3/ad28y0/uoRPL7i/F7+acZPH1cvnv7Xr9729Pv3ryy/M3jvYEcy8Hz30Qyffxx0NkWL5++2H7/pj0ZPP9t+/2fvxTvCflv2+8vL7eT/PDpQO4hTPHu7f+Ko4/7jw4+738+ON2/Pvic/dLih58+Pr1Ofjm43N9tvu/p5sHR4I+Pn2zx6nH66PCt2H0CB/BGnm6/TKK6NgiZCQkXYasviO8L3OwZKcXOqm0/UTnYMek6VadrheXvhavvtnrK+IgLyVB0+i/UAtBa6dv39Osou00QO9vbF+1KCI9vCqEn6bWHOkFO1SXIfy2n9eWtWx5Jvc5J653/joQDovFogdn6d8ekgaTUwk6j7tmX6LrJC9F0492z89l5HKFgFSaeCmWIYm7HUTfaWs5DYUMOJTnOvjgbrAzNcJnie8wNY+OF2LpqR7N4ecZK01wLbSwfCTlq3jrrfM7pCe6GE/gCv/NMQSH+AEwVeHHWoeJIoBaMgWOwjQLETX41T8Lth60K6bGVGa/5niznsEIKayErtXymrcgz1dJMZyHHQ2mbKmsTzTmKqswK/lnlSs7mmlelJUJWok3X+c7ODt17f27TBfHRE7p77ezOzp2Ea/cQynPWg2mXgV+ICv2nxSgpilZGJQvRwJpgIIRdQg4VbagX8lEB8gSjWjSbq/bNiyxkicqrQuIA/s+//4NmhMOXlvkbOyo1K9QENHaLUbdUBtcC40gEJsIMRTiUzuZ5BsZg8k5aGLlGLzGiyoIQnCW84APst8LQT0irXDVPzZWYFnszBnxWwKEftCuyuIIM3QfLlKIWJIxpSqvyejMZmyh9OUSSsE9sgP0FYPAWBGEKyDGXCcZizj4oysGWKwx3Cy0MMC5yBKaWseFQJAIRo9PTPLEs55KPKFyJ6UKNUihCd4BWA7y1GJWVLi7HHgUA61ikJ4YWe4b3IGIcP6ZgucggdSG5id2VyPtA39I1wOtngcuLBMy8NCuDK9DkD9yFtswyVijrLpkYr9X3FhFZzaXBK7sjKGxNJT4fONMaKZ+2GL4z4HmD9yVUgEzIS2yWabKzSs3ewMAIC/NkwmQyueGbflqc81zYcTlgGgo1nzeij+TJ6tOrHz+hJwGdm6PhCXZEJiHCWbPmFgFv+SOLJ3RkBf/AC/E/yxPw+MhEAtJA7YDZe378kl2xR63tKK5543sQvPWy93T/8GQf8eJ54eyv3dpubVMGVBmbc1lbirpEq6bRZcutPXhsmks3zaWb5tJNc+mmuZSxTXPpprl001y6aS7dNJdumks3zaWb5tL+prm0v2ku3TSXbppLN82lczFsmks3zaWb5tJNc+mmuXTTXLppLt00l26aSzfNpZvm0k1z6aa5dNNc+v+ludTXe2HguFVkXMhaDa0r9Ttbajk9j6MxlgJ2z6IvX/C1+rXOZjP8/KkEjXWE53F0xbXA7DlVEcahXA4LzC5hGnWjp+4xoHmKy8dO7akCZal4Eqv93Iw92vxbYevVisdHJ6dRHA18W2yuUpyj+QRbZvkk6kbos6m7tiokp+9foozLUUk1b5HDi1V+vLTjxRLBSyoR9H/USue4nNaoXKwddKzgv8jYygn/hVUgf8D0vytwN7J2gpdtgMYdPJ/NZv8HGPOZ6A==",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={},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:"Draft Template"})}),"\n",(0,i.jsx)(l(),{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)(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 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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.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)(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",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)(p.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)(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 y(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/0028a090.fb02f3a5.js b/assets/js/0028a090.fb02f3a5.js new file mode 100644 index 000000000..7b232bdb6 --- /dev/null +++ b/assets/js/0028a090.fb02f3a5.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:()=>f});var i=s(85893),a=s(11151),t=s(58219),r=(s(62316),s(51039)),l=s.n(r),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:"eJztO9tyGzmuv8Ltl8yoWrKlOJ6MamvreBJPRpn4cmJncrFcCdUNSYy7yQ7Jtqyk9LZfsp+2X3IKINlqyZLtJFOz3jp6SawmCAIgAIIg8CWyfGSi7ll0CnmRcQsmOo+jFEyiRWGFklE3Oh0DC8PsqeZDK+SI7R33GEg+yMCw0oA2zCqWaECgpDRW5eIzjjIbMMfMgL7EudywQVZCoYW0hg2VZiOQoDkhTlVS5oADE2HHrNCQwlBISJmxukxsqcG02KtCSWbKJAFjhmXmVhZKMjVkvFozZnYMRKoGW2ppGGelFJ9KYI2GGnyExPbSRoP9kIIRI8ktpEhcmP5epD/GbDIWyZglXLIBIKspcuoJhhq5A45jStKapoBEDAUCe2QttpemAmnkWTaNGWeNRqmzRoMJwwqtLkUKaVhNDYcoUk6iZUJa0EOeAMkKEIsc0TIBOeMyZUOeiEzYRTGyVBirxaDElVt92ZenouiyV0WmeMqmqtTs+Omvc3CrGH47azSewqAcsVe9RuP8h7G1helubfGiaKkCJEor4wPTSlS+lSJgkQ5JVqABsZK8gBuRTRlPUzYR6QisoQ2RLFHFlCVK6VRIpxoFHwGTZT4AbWLiJlcamJCMMw08nTatapYG2POTo0MUQ85tix1npYmr5VKhIbHZ1KFH8QSuHrjd2d1BHRJyFLOcX6CUhGWfSpFcINsGJG2tV5lWXzLGWF82Gq+R5kpCwng9TxmzY2HYBAZjpS4YXOLwRGQZs1qMRqAbDULy4cMHh+yL+4/wRgTej7qsH3l8/SiuAwQF7UfdfvT06Mmrg/3D0/e9p/2oDjUUGTgsFcirly+WUEmeLwMd7h3sL0Mp66GOM+AGmIZLARPaDtxxx24QxNLkmtNwOJbGEQFog2Nn8+8LMlmm9aT37HD/5XVKvfxyLrIFwP2Dvd6LFZDFWMlFlMe/HR2uwlnqGsbe4TMnyjrUbP7jfIE/v4d7fktPewf7J6d7B8dh+qwvP3z4QPp0UhaF0qhAr51ZdFFR+vIXyNSEcQ2kg4nKcyVZwTXPwZKHHXNLwxo+lUJD6lwkz7JgX11E02SNhp0W0G00WE+mIkETc+5iWgB6SAfdcqBoegh64l2WA60ZJPo055bQ0ibceYkiQ4eEoBrQ21lxCYuIr2I2RcRPARXLoR0rLT4raXlGWnUJ2oqEZ3VngASSC7VckysrlJA2fPUrsLfe6NEnkKl7b4WkpSiuXEgaMcAueVaC8VRNYjZGql5CocGQ5/Z4UZQyZWMQo/Ha9Xj6sTR2ATErTfDHgQq/VtgnEi+Q2IY8M8DEcEGWOb+A2mpMFe6caLFfpiyFIS8zGzOBfszqElrsUFnGiyITCZ2xeCy4A6zU0KRd9grhCUGbQiKO3TmDJ0sq8IxBj4WDhMLPCdShprmDCdkjf2zHXDIllzY6UZnSiH5Jh+j7oiBZoqQFaVts75KLjKh33BomZJKVKbBBxpOLmEKEmGk8FHFbppBlahI7lScQOqpJ6CQgZiBDNVQSGZDKLy/M/DBunaIDqywKx4KoaQ1h6lL1Z8FQ4cIogmBkjFxPTIKL2Uc1YFbYDGI02YLLacxSF3zAlR2oq5glY0gu6C/NU6HYoLRWScdXqlWRqon0shwqaY34vMIiw8jXC7QTs52Y7cbsccza2zFrd2LW3olZezdm7ccx62zHrNOJWWcnZp1dR1bnsRc1r+RbJ6DdcUK2NeGy+y1d9LwvhCHLRpdpKi88WfDCfdlusUajsif6TEc4HVX9CO2LzuQKpB/FzI2h2+xH3XbM/IcrPA4edn4KAFP8vYvSdb8n+LuNu+F+j/F3p92XM79oh4ixPC9uIASH/3wiwk+vT/jRn9b9KLg2/Ig+ycEunt+eLByYzRl6iAwJKazgmVnPU4C4f2zNKVvibAc5I+1dz5aPWu4bT4GsMEK+0w2Rr60NBTdAhHSWRPCoNT9t1kjALXrfBOCp+l7+d5H/ymetF0IFcv8kUSfte8XxU4vCA/Lb64XhAe6fKOaEfa8gHqMg8NxaLwUcvX8i8FSFAR8LuLHtnWb7UbOz3dlZEAPezR1AnjfTtDmdTr9ThO4GjeGRX5+CTR/MuhgQkyBDrfIVNxW6SMyhfPhEf4fo/gBj+gFUeRhMPCymcULKoR6QW5Xy6QPjUIWpVRyH8PMoblojk4aQDkq/JGMlEk88woTobYC3QcpCNFHw6dbBwVZNlO5jM8+DfFn4ir+bJPr61zxvpWlrGXZhh2pfc5amMVvxffVAmrI8z9d9dwN4XPblz2gIPnRbbwse4K8xhxVaP19/ra3MB3iqZEbr0+Vuta0snS9jEXI/Xm/YEoCGUZlxDVd4SzUuqVLLqXy7J1qyomBE8zCfLrV0H3QZRpIE++HIh/I/egVHDhYR4Jfb511jrI5EwwiuCIfLISMxIqXMbozp3jHe+Xi4MaDY50lD+pXwQmByIQNr6SvYpLWKCLdptYs5buryvdyAXWCGGxZmrria0+7TRaO9Teeev5fccPB5iPvn9muUhUGX7HD5uyjnPnSJhjD/W9kx6H50Xs1xV3JIa3PZqsns/AZ7YnOjSSHjA8iu29qdraHOjtesmnBwIBeyyiQQyduBAhrlV0ujfnC2ws4c23UFD849mEmQM8uECemURaHVZ/t8E+UBJbiXiAGwMIENKpX8bpWvCLubzjuP4LfnliUQjhFglesLq92ywsLW1AWDOHIhRV7mVdJyWGENIsv9KV+XF87ER5awQn17r63Ar25Zwb8SrVmgL9uUWghJCXIMbHUw6EHun2eoUXb7EfgtPmPh2PzWA+/rLTHwVbfEFeckgroTsrJCs94MW+wITyXMmLpJmANLEigs5su+10Yrku9mo21KJdVzZOtPpjrUX62D65TpLtq5RPefpoce7vuCL5Ta3ZSxzsZ/kUIukH3nYMklBHP3DLUuG5iT6t03Z+jJWjr6ozhSBdUzKNlLo26UYtVEeKuPYkINxv6i0mnU/RL5FD7+6RPkOHPro8H6iy+RScaQc/wrkIQVG/juG8XhWTWKI8rZYPkGCi3q+ufjKMYbRoHvbGAQB83rfglQ7kE8iv29PepG7qU8iiO44nmBwP4TA5kovBwTillY8SZc1Zc5LkN/VJULiAefB78RDU2dLZWsfBOmOobZXK5zZFxrPo2Wq2PCu2C4xrl51cNHNg22IixaRPVWRWBRHAkLeX2VNbum1ddLOgGFnFBq92vn0rbw/KvXxHn03P4tE/07zAqZ31FKbvT6wotbtof3R0hDNN2cP53GjJ4sWrdpTIAnbvmovqaLDa+tebruSb32kmfGqsxSfCMDrlv0sv3NpThUjcWzpKTqoOqMWOCsIrXirD2Lo6vbmbliiWqG93r2QwZDy8qiAM0SpSXoH+uZuHvDXGdnZxZH09vZm/5XsvcTbt7kdu5eU6HDvAjkP0Hrw8ezOBrfTutvVSnGf5DYnd3Z/KzzZT5VheBApdP3wW/NbgMMhwrCYblZTx7pFHRNEAOlMuDymiR6QxdkKfYAY5EHPt1FL+hCm3CguOozDQlgNQ5lsIOvYj7ocM/rzD9iYmy2jx8oZjTlwCCUDPiMQziAUNGGZZgOQrgyRqoRAJ6MsX7OOqr4EJ//qYoIK8hUaQJ5Y27oGT8DDEvtGIQrXBFytBgj1qRDFRx13lv13cEveMhRKerR6fEdZEkRbNMVs7lz2nHpcLCj02OsSxJDH4e12CtTSSKIli+AMIyL2KXgoXah8u1Tl3QASRJRoYxuXprY8hVBTXadoFSYlRTF8xRoVXp7DfG8HBK3SJUW6zB9/SkzFgqzIEeiohLkqSrvopW3SJKzUUmvKRZNNhQpUVp2XlckpKvrpftPWupQSuXVAiGxyHcupyAVBKrhjxlI46ZzNuTGgo6x2Bclr0u831Qo4aoALUAmsFIEGpzo3pd6Zdy0KIPFIp1XL1/4ItjAQzDKAVqgQwwpKwvSGrKEqngs7Nwy69cCJbQO0O/XBWjXQw8q8fK5tgK0wUJpzZQecSk++8JpjEiUATaAMc8cqHcV+BaF9KCFLxITfO2///mvGl1rI87rhLkVeJriY8AtFNL91ik8RtwaCvSAapEixAf6f5YPAaSOjOZ9rtLKkMzddfwYKwqtqfyiVVTXDBm46u/wOFH5WxMHH2t8WIlvFJreEqhKXBXIL1wJY2vlT+Hl8bp/eAkox6RGA4UhaNWo83JaN/CKLl9mNUdHRVpisXKuOgaXbOHm48ydd/M7qXfFWA6qpHEReWd7G/9b2vhQtR7qqOeF/Nn0b1F89wvxzdeBUEC9ShXnGvPLuPObKWSejFFJ1tj8HPzmUKN+0d+C6fPx4FkijsTz3qvPvfah6JmefPkoedLb7V0Ub/548vznFkyft5POH9M3nT/s29eZ6X1UIvnt+fid/MMMnjwq3755p9++6em3r19a/vrR3kCO5eDZryKZPvo46GyLF0+eb7973Z4Mnv26/e6Pn4t3hPzX7XcXF9tJfvhkIPcQpnj75n/F0cf9hwef9z8fnO5fHXzOfm7xw08fn1wlPx9c7O823/V08+Bo8PvHT7Z4+Sh9ePhG7D6GA3gtT7dfJFFdG4TMhIT3YavfE9/vcbNnpBQ7q7b9ROVgx6TrVCivFVbiF67U3Oop4yMuJEPR6T9RC0BrpW/e06+j7CZB7Gxvv29XQnh0XQg9SQ9P1JRyqi5A/rWc1pe3bnkk9SonrXcHSiQcEI1HC8zWvzsmDSSlFnYadc++RFdNXoimG++enc/O4wgFqzAHVihDFHM7jrrR1nJKDHuDKN9y9sXZYGVohssUn4auGRsvxNZlO5rFyzNWmuZaaGP5SMhR88ZZ53NOT3A3nMAX+J0nLQrxO2DWwouzDhVHArVgDBzjfhQgbvLLeT5wP2xVyNStTL7N92Q5nRayaQsJsuUzbUXKq5bxOgvpJsogVQmkaM5RVCV58M8qbXM217wqQxISJG3KLHR2dugK/lOb7qoPH9M1cGd3du4kXLsSUcq1Hte7x4CFANV/WgzYomgpQFqIUpaDlLUBw5p4IQSJQg4V7bnfh6MC5AnG4GhZl+3r127IEpVXZc8B/N///BfNCOczLfM3dlRqVqgJaOxto96uDK4ERr0ITIQZyipS8p3nGRiDqUZpYeTa0sSI6iBCKJnwgg+wOwwDVSGtcrVHNW9jWuz1GPARBIceaFcScgkZehiWKUUNUxj2lFbl9dY3NlH6YogkYVfbALshMJgzAGEKyDGXCT5IOBOiQAgbxDA4L7QwwLjIEZga3IZDkQhEjH5R88SynEs+oogmpus/SqEIvQxaDfCOZVRWulsEdlQAWMciPYi02FO8tRHj+DEFi9ueuguEid0FzrtJ34A2wMtygcuLBMy8kCyDS9DkMtz1u8wyVijrrsQY0tX3FhFZzaXBBIMjKGxNJT4f5tMaKZ+2GL6K4JGEwS4qQCbkBbb2NNlZpWavYWCEhXnqYzKZXHNfPy7OeSbsuBxg4Kzm80b0kZxdfXr140d0NqBzczQ8wf7NJARBa9bcIuAtf6rxhE61YGy8ECtD80wkIA3UzqC9Z8cv2CV72NqO4prDvgPBWy96T/YPT/YRLx4pzv7are3WNuVrlbE5l7WlqKe1anFdttza88ymFXbTCrtphd20wm5aYRnbtMJuWmE3rbCbVthNK+ymFXbTCrtphe1vWmH7m1bYTSvsphV20wo7F8OmFXbTCrtphd20wm5aYTetsJtW2E0r7KYVdtMKu2mF3bTCblphN62w/19aYX1JGAaOW0XGhayV2bpqwLOlBtnzOBpjtWD3LPryBV+rX+lsNsPPn0rQWGp4HkeXXAvMnlOhYRwq6rAG7QKmUTd64h4Dmqe4fOzUnipQluorsSDQzdijzb8Rtl7QeHx0chrF0cA38eYqxTmaT7DBl0+iboQ+m3qBq1pz+v4lyrgclVQWFzm8WAjISzterCK8oCpC/0etuo7LaY3KxfJCxwr+i4ytnPB3rAL5Hab/qMDdyNoJXrYBGnfwfDab/R9HjNg1",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:"eJztO9tyGzmuv8Ltl8yoWrKlOJ6MamvreBJPRpn4cmJncrFcCdUNSYy7yQ7Jtqyk9LZfsp+2X3IKINlqyZLtJFOz3jp6SawmCAIgAIIg8CWyfGSi7ll0CnmRcQsmOo+jFEyiRWGFklE3Oh0DC8PsqeZDK+SI7R33GEg+yMCw0oA2zCqWaECgpDRW5eIzjjIbMMfMgL7EudywQVZCoYW0hg2VZiOQoDkhTlVS5oADE2HHrNCQwlBISJmxukxsqcG02KtCSWbKJAFjhmXmVhZKMjVkvFozZnYMRKoGW2ppGGelFJ9KYI2GGnyExPbSRoP9kIIRI8ktpEhcmP5epD/GbDIWyZglXLIBIKspcuoJhhq5A45jStKapoBEDAUCe2QttpemAmnkWTaNGWeNRqmzRoMJwwqtLkUKaVhNDYcoUk6iZUJa0EOeAMkKEIsc0TIBOeMyZUOeiEzYRTGyVBirxaDElVt92ZenouiyV0WmeMqmqtTs+Omvc3CrGH47azSewqAcsVe9RuP8h7G1helubfGiaKkCJEor4wPTSlS+lSJgkQ5JVqABsZK8gBuRTRlPUzYR6QisoQ2RLFHFlCVK6VRIpxoFHwGTZT4AbWLiJlcamJCMMw08nTatapYG2POTo0MUQ85tix1npYmr5VKhIbHZ1KFH8QSuHrjd2d1BHRJyFLOcX6CUhGWfSpFcINsGJG2tV5lWXzLGWF82Gq+R5kpCwng9TxmzY2HYBAZjpS4YXOLwRGQZs1qMRqAbDULy4cMHh+yL+4/wRgTej7qsH3l8/SiuAwQF7UfdfvT06Mmrg/3D0/e9p/2oDjUUGTgsFcirly+WUEmeLwMd7h3sL0Mp66GOM+AGmIZLARPaDtxxx24QxNLkmtNwOJbGEQFog2Nn8+8LMlmm9aT37HD/5XVKvfxyLrIFwP2Dvd6LFZDFWMlFlMe/HR2uwlnqGsbe4TMnyjrUbP7jfIE/v4d7fktPewf7J6d7B8dh+qwvP3z4QPp0UhaF0qhAr51ZdFFR+vIXyNSEcQ2kg4nKcyVZwTXPwZKHHXNLwxo+lUJD6lwkz7JgX11E02SNhp0W0G00WE+mIkETc+5iWgB6SAfdcqBoegh64l2WA60ZJPo055bQ0ibceYkiQ4eEoBrQ21lxCYuIr2I2RcRPARXLoR0rLT4raXlGWnUJ2oqEZ3VngASSC7VckysrlJA2fPUrsLfe6NEnkKl7b4WkpSiuXEgaMcAueVaC8VRNYjZGql5CocGQ5/Z4UZQyZWMQo/Ha9Xj6sTR2ATErTfDHgQq/VtgnEi+Q2IY8M8DEcEGWOb+A2mpMFe6caLFfpiyFIS8zGzOBfszqElrsUFnGiyITCZ2xeCy4A6zU0KRd9grhCUGbQiKO3TmDJ0sq8IxBj4WDhMLPCdShprmDCdkjf2zHXDIllzY6UZnSiH5Jh+j7oiBZoqQFaVts75KLjKh33BomZJKVKbBBxpOLmEKEmGk8FHFbppBlahI7lScQOqpJ6CQgZiBDNVQSGZDKLy/M/DBunaIDqywKx4KoaQ1h6lL1Z8FQ4cIogmBkjFxPTIKL2Uc1YFbYDGI02YLLacxSF3zAlR2oq5glY0gu6C/NU6HYoLRWScdXqlWRqon0shwqaY34vMIiw8jXC7QTs52Y7cbsccza2zFrd2LW3olZezdm7ccx62zHrNOJWWcnZp1dR1bnsRc1r+RbJ6DdcUK2NeGy+y1d9LwvhCHLRpdpKi88WfDCfdlusUajsif6TEc4HVX9CO2LzuQKpB/FzI2h2+xH3XbM/IcrPA4edn4KAFP8vYvSdb8n+LuNu+F+j/F3p92XM79oh4ixPC9uIASH/3wiwk+vT/jRn9b9KLg2/Ig+ycEunt+eLByYzRl6iAwJKazgmVnPU4C4f2zNKVvibAc5I+1dz5aPWu4bT4GsMEK+0w2Rr60NBTdAhHSWRPCoNT9t1kjALXrfBOCp+l7+d5H/ymetF0IFcv8kUSfte8XxU4vCA/Lb64XhAe6fKOaEfa8gHqMg8NxaLwUcvX8i8FSFAR8LuLHtnWb7UbOz3dlZEAPezR1AnjfTtDmdTr9ThO4GjeGRX5+CTR/MuhgQkyBDrfIVNxW6SMyhfPhEf4fo/gBj+gFUeRhMPCymcULKoR6QW5Xy6QPjUIWpVRyH8PMoblojk4aQDkq/JGMlEk88woTobYC3QcpCNFHw6dbBwVZNlO5jM8+DfFn4ir+bJPr61zxvpWlrGXZhh2pfc5amMVvxffVAmrI8z9d9dwN4XPblz2gIPnRbbwse4K8xhxVaP19/ra3MB3iqZEbr0+Vuta0snS9jEXI/Xm/YEoCGUZlxDVd4SzUuqVLLqXy7J1qyomBE8zCfLrV0H3QZRpIE++HIh/I/egVHDhYR4Jfb511jrI5EwwiuCIfLISMxIqXMbozp3jHe+Xi4MaDY50lD+pXwQmByIQNr6SvYpLWKCLdptYs5buryvdyAXWCGGxZmrria0+7TRaO9Teeev5fccPB5iPvn9muUhUGX7HD5uyjnPnSJhjD/W9kx6H50Xs1xV3JIa3PZqsns/AZ7YnOjSSHjA8iu29qdraHOjtesmnBwIBeyyiQQyduBAhrlV0ujfnC2ws4c23UFD849mEmQM8uECemURaHVZ/t8E+UBJbiXiAGwMIENKpX8bpWvCLubzjuP4LfnliUQjhFglesLq92ywsLW1AWDOHIhRV7mVdJyWGENIsv9KV+XF87ER5awQn17r63Ar25Zwb8SrVmgL9uUWghJCXIMbHUw6EHun2eoUXb7EfgtPmPh2PzWA+/rLTHwVbfEFeckgroTsrJCs94MW+wITyXMmLpJmANLEigs5su+10Yrku9mo21KJdVzZOtPpjrUX62D65TpLtq5RPefpoce7vuCL5Ta3ZSxzsZ/kUIukH3nYMklBHP3DLUuG5iT6t03Z+jJWjr6ozhSBdUzKNlLo26UYtVEeKuPYkINxv6i0mnU/RL5FD7+6RPkOHPro8H6iy+RScaQc/wrkIQVG/juG8XhWTWKI8rZYPkGCi3q+ufjKMYbRoHvbGAQB83rfglQ7kE8iv29PepG7qU8iiO44nmBwP4TA5kovBwTillY8SZc1Zc5LkN/VJULiAefB78RDU2dLZWsfBOmOobZXK5zZFxrPo2Wq2PCu2C4xrl51cNHNg22IixaRPVWRWBRHAkLeX2VNbum1ddLOgGFnFBq92vn0rbw/KvXxHn03P4tE/07zAqZ31FKbvT6wotbtof3R0hDNN2cP53GjJ4sWrdpTIAnbvmovqaLDa+tebruSb32kmfGqsxSfCMDrlv0sv3NpThUjcWzpKTqoOqMWOCsIrXirD2Lo6vbmbliiWqG93r2QwZDy8qiAM0SpSXoH+uZuHvDXGdnZxZH09vZm/5XsvcTbt7kdu5eU6HDvAjkP0Hrw8ezOBrfTutvVSnGf5DYnd3Z/KzzZT5VheBApdP3wW/NbgMMhwrCYblZTx7pFHRNEAOlMuDymiR6QxdkKfYAY5EHPt1FL+hCm3CguOozDQlgNQ5lsIOvYj7ocM/rzD9iYmy2jx8oZjTlwCCUDPiMQziAUNGGZZgOQrgyRqoRAJ6MsX7OOqr4EJ//qYoIK8hUaQJ5Y27oGT8DDEvtGIQrXBFytBgj1qRDFRx13lv13cEveMhRKerR6fEdZEkRbNMVs7lz2nHpcLCj02OsSxJDH4e12CtTSSKIli+AMIyL2KXgoXah8u1Tl3QASRJRoYxuXprY8hVBTXadoFSYlRTF8xRoVXp7DfG8HBK3SJUW6zB9/SkzFgqzIEeiohLkqSrvopW3SJKzUUmvKRZNNhQpUVp2XlckpKvrpftPWupQSuXVAiGxyHcupyAVBKrhjxlI46ZzNuTGgo6x2Bclr0u831Qo4aoALUAmsFIEGpzo3pd6Zdy0KIPFIp1XL1/4ItjAQzDKAVqgQwwpKwvSGrKEqngs7Nwy69cCJbQO0O/XBWjXQw8q8fK5tgK0wUJpzZQecSk++8JpjEiUATaAMc8cqHcV+BaF9KCFLxITfO2///mvGl1rI87rhLkVeJriY8AtFNL91ik8RtwaCvSAapEixAf6f5YPAaSOjOZ9rtLKkMzddfwYKwqtqfyiVVTXDBm46u/wOFH5WxMHH2t8WIlvFJreEqhKXBXIL1wJY2vlT+Hl8bp/eAkox6RGA4UhaNWo83JaN/CKLl9mNUdHRVpisXKuOgaXbOHm48ydd/M7qXfFWA6qpHEReWd7G/9b2vhQtR7qqOeF/Nn0b1F89wvxzdeBUEC9ShXnGvPLuPObKWSejFFJ1tj8HPzmUKN+0d+C6fPx4FkijsTz3qvPvfah6JmefPkoedLb7V0Ub/548vznFkyft5POH9M3nT/s29eZ6X1UIvnt+fid/MMMnjwq3755p9++6em3r19a/vrR3kCO5eDZryKZPvo46GyLF0+eb7973Z4Mnv26/e6Pn4t3hPzX7XcXF9tJfvhkIPcQpnj75n/F0cf9hwef9z8fnO5fHXzOfm7xw08fn1wlPx9c7O823/V08+Bo8PvHT7Z4+Sh9ePhG7D6GA3gtT7dfJFFdG4TMhIT3YavfE9/vcbNnpBQ7q7b9ROVgx6TrVCivFVbiF67U3Oop4yMuJEPR6T9RC0BrpW/e06+j7CZB7Gxvv29XQnh0XQg9SQ9P1JRyqi5A/rWc1pe3bnkk9SonrXcHSiQcEI1HC8zWvzsmDSSlFnYadc++RFdNXoimG++enc/O4wgFqzAHVihDFHM7jrrR1nJKDHuDKN9y9sXZYGVohssUn4auGRsvxNZlO5rFyzNWmuZaaGP5SMhR88ZZ53NOT3A3nMAX+J0nLQrxO2DWwouzDhVHArVgDBzjfhQgbvLLeT5wP2xVyNStTL7N92Q5nRayaQsJsuUzbUXKq5bxOgvpJsogVQmkaM5RVCV58M8qbXM217wqQxISJG3KLHR2dugK/lOb7qoPH9M1cGd3du4kXLsSUcq1Hte7x4CFANV/WgzYomgpQFqIUpaDlLUBw5p4IQSJQg4V7bnfh6MC5AnG4GhZl+3r127IEpVXZc8B/N///BfNCOczLfM3dlRqVqgJaOxto96uDK4ERr0ITIQZyipS8p3nGRiDqUZpYeTa0sSI6iBCKJnwgg+wOwwDVSGtcrVHNW9jWuz1GPARBIceaFcScgkZehiWKUUNUxj2lFbl9dY3NlH6YogkYVfbALshMJgzAGEKyDGXCT5IOBOiQAgbxDA4L7QwwLjIEZga3IZDkQhEjH5R88SynEs+oogmpus/SqEIvQxaDfCOZVRWulsEdlQAWMciPYi02FO8tRHj+DEFi9ueuguEid0FzrtJ34A2wMtygcuLBMy8kCyDS9DkMtz1u8wyVijrrsQY0tX3FhFZzaXBBIMjKGxNJT4f5tMaKZ+2GL6K4JGEwS4qQCbkBbb2NNlZpWavYWCEhXnqYzKZXHNfPy7OeSbsuBxg4Kzm80b0kZxdfXr140d0NqBzczQ8wf7NJARBa9bcIuAtf6rxhE61YGy8ECtD80wkIA3UzqC9Z8cv2CV72NqO4prDvgPBWy96T/YPT/YRLx4pzv7are3WNuVrlbE5l7WlqKe1anFdttza88ymFXbTCrtphd20wm5aYRnbtMJuWmE3rbCbVthNK+ymFXbTCrtphe1vWmH7m1bYTSvsphV20wo7F8OmFXbTCrtphd20wm5aYTetsJtW2E0r7KYVdtMKu2mF3bTCblphN62w/19aYX1JGAaOW0XGhayV2bpqwLOlBtnzOBpjtWD3LPryBV+rX+lsNsPPn0rQWGp4HkeXXAvMnlOhYRwq6rAG7QKmUTd64h4Dmqe4fOzUnipQluorsSDQzdijzb8Rtl7QeHx0chrF0cA38eYqxTmaT7DBl0+iboQ+m3qBq1pz+v4lyrgclVQWFzm8WAjISzterCK8oCpC/0etuo7LaY3KxfJCxwr+i4ytnPB3rAL5Hab/qMDdyNoJXrYBGnfwfDab/R9HjNg1",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={},f=[{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:"Draft Template"})}),"\n",(0,i.jsx)(l(),{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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\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)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.5f8c6828.js b/assets/js/28b19cd2.5f8c6828.js deleted file mode 100644 index 9b2ad15e1..000000000 --- a/assets/js/28b19cd2.5f8c6828.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>g,toc:()=>j});var i=a(85893),t=a(11151),r=a(58219),l=(a(62316),a(51039)),n=a.n(l),o=(a(82723),a(9487)),m=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u20gSfpVKXxwHtGQ7yR6ExWIyTjBrzGBsxA5ysA2hSRbFtpvdnP6RzBF0myeZR5snWVQ3SVE/dhxgMZddIEiiVnV1/ddXpSVzfGbZ5IZ91JmvUDnL7hKWo82MqJ3Qik3YdYlwZpA7hI4KPlyeA5dSLyw02oPTMEOFhmgULiDvuEHawL23Dmqj5yIXagYOq1pyh1ORg1DWIc9BF+BrqXkg4IFFISS+FgpciVBoUxFNyi3+4x1oA6lQ3DSHgHM0DThRYZBDIeYkTBbF5b0gI7hun7XEDQzWRJHLBrzFPLxmIeMKUmxv51AYXdHXBoRyaAqeIXAHN2/efMTUz+DL+Zs3d69L52o7GY95XY90jcqKmZI8taNMV+OcCOu8OCShvQ36r83ZyUTmHN0qljBdkxGFVuc5m7BWkFaHhXBlZzyRs4TV3PAKHRry4JIpXiGbsIF9WcIEebDmrmTbbtXpPWbuPBi/E4QlzOBvXhjM2cQZjwmzrpHE1oqqlkSAj7XUObJJwaUlgqzEirPJkrmmDpTOCDVjCSO3cTc8wUceuExY/e+TtMxOyzplq9VdfBat+1HnDbHKtHKoHP2X17UUWTDK+N6S6MvBm2txbxhZnoxxl3SiRB3JVIYs6wTacL0lXMvMjeENmcthNTx/goHRpMSuxmv9PmSZ9k5x5dgqYVhxIZ81USAYMrjX+EP7iSKJuEQHP/fqvUZIEYm4LrX6BvXJ6Vv68/aErVYJc8KF082gG0TT9Ko1G1EXWuZoKEqfe4EEsajy6bYBUq0lcrUTlNelsNDH9VaJsTVmomhgUaIr0YTjBVcOAndLJCmCpfpE1FHaEVD9yrHgXjqYc+kRhIVbRuF9y0ZwXoSUjN9o+rAhwoAWuMpBaTgI702tD8FxMG4/pzpvDtY3LXCDrcwC816EQNxXQQsLISXJTXUoFoHefvRsFz3dc/sMvmnDM2+driA8014KNY8Mwp03CG2yjeCMKxAqkz7HttCSwalKwXLZhcA0RMZqBcsl+RLNlAJxtUrWB/TWxkGIvnhiMEMx37jVH+H6Yn82uIqPtTDNNOeuPch0VXPVDAUQMyXUbOqNXK1GO8G39syL7bZjptZjxOR/wGIkzrm6MDmaF+TreQEWQ7odULAeJKCVbKJlhLGuzcIY5K3A4dunrCyUcIJL2YzgU5/V1qeWqFTHb501zojZDA3m0FKEywlQswTkWRnrQZCKF5TQ9HptcC60t514JbdAlpJIfd+VKGK6CDUbwY9Nl7sJDKxDlWFD99Ge1CVkcq3PWtYfeTNsLspXKZodmwY0QyCmvQU5byy9FpAKfcFl5gNuiO4GcjeVrkZ700OeYXfpX+rlO3lP2aF4KvHi+vIFniaF4ChWRx0Oow8iD7i4voQ5GlG0rXoEX2zvp87xfIMEMp0jzAWPrk9gUYqsJOs3UBFmRBX8FUt58NsazgXwAUewK1Au7F6JkthNKFV9EG0fY8iFwczJJgSQ9g54ngu6ziVYh7Xd8HKQojfktfYvyZlvWJLDzIs8eNqbvnCjsckARBNwNj6jyxZybzpg2QYtUWZo7dpOnVWIaMA/AVQ2XudQcOvQJOBVwLvG15QNHUt8rNEIVBnuN0FsUuty9+2CS1SEi2Pm69iHazRWKzrWZsaV+D3Gio5+SrHksiDaGCwEAUKbRZV3NiBum3Wtg+V//fEnlbgQB9NK531s2Je77RJNJZztC5HTFCKAEuPAY31WArfrAmeTrqjZBKzjVW0TUs/howtq6Zr0wUdhHamwEPkMnQXxVMh/RrJnNpAhDCoUqORG1QxjtpfL6S12AWoJG0+H8GiPe5+Eh9MhPgxtdkXEm0NEOLC1Vjai59PjY/pnq5MoMh0FLXTEEeBRaszQgTfUHdZfiqL3Ppe2w3tE0iezJpi4EBZj/Scu3dSTQIXWWj6jkebF08bzU0HH+3tnofJenP7+mM1PLyk6vXl+UtjHoB1Bt+YF0pAU/E5u/ZAfOmfrlMJL2bzaGBSEkkLhtHPI9PT4eHpK/l8l7N1eF0ePlXyO6iBU1j7YCVl30UyB3w3G2oDS3fYAexIudcgUV7bNmgaycDPE4H/No2iMNt9rv0uJ3FJJcr5eaxIZf8uG746Pp1nWG/H9vjyZcynysIG51g+oXv0N6q6VGz7v4vMk6mMVgrZdQYhIFL5nG9oOz6OSFjNvhGvCCuPxiNfiKH4/ubmjxUCFrtS0DKm1DRLTLmPCxpt1aLwcFKIVI7Zm3i1GQkb1SWK5ylP9uLur4bUYz0/YKtm+sXez8yS1dXwm1Ozo2Vt3a8WvyDnR/hvqr3cTtfgZKahb6w6p2gVPiZzwOtmTfP55vUz51HlusPW46RYYwy1Fv6TY2Tz0D3fbhX65MNwg3A13Aoxtzv1xlbQ1xzK2OZ91l/rpI97aB6FP3m+A13YTNURh3dEuKtlAA0+AgQ7UCFXo4Ik2gC9qVLQFCeE/P9nBCF9RZjqid2qrHflff/wZbnTRGp55BRfeQK0XaAovQwUsJD4KQmm761WLvJJorWzCMnIWVq25mAlHwLSFaBmveSqkoHwmMh0ngkFJsCP4ut6eHJiwI8U5SioDILV+CChKA/dOV+GNrhsstHkoSKQEOKS0y6RebRG7K6hKrjIqfDGwA8rhKsL42lAb5qIiYgK1WBQiE8SYipfhmYOKKz4LcCUBkpus0FZ+C0anNBNYLX1EvU5DheiiirT4tSP4SFNGUDxMQui4kJhHwGuTOHC0oU1qqBxSDMtpnjmRYZwJHDcOJG2WQyLHYdZLCbV2ccAkvDb0LTFyhisbFtVxCmtd05uvReThjZw3I7hVt+qKgsVbpACQQj3Yya06gps+zL5iaoXD9ZJ5sVjsFJXDzTs/CVf6lDbcen1vFg5DCRpe7z8csoQ5NJW9KK7QzEXWwYon3hwH4nHbenhcS3UFhNfih+0L1AakyFBZHDSKDz9d/gJzeDs6ZsmgjL5A4PEv52effr36RHyp0Mf8Oxkdj47D9lNbV3E1eGr7F4yAmQd7741EHiyg///zx9/480fb8Wg0GteSCzUAxLHx32wNICxhk+EvHncJKwkoTG7YckkG+0JrLjr+zaMhlHGXsDk3glpFaIXtZJz3PePJSHj9uR1rDuGJH0/2yt+1cUU9PExYsdc9YLP1c83qbpV0vZxEixRnUYCja+Kz5rAD9AiKxBsfsgxr9yztEFldXlxds4R1W9Iq/LrDDF/Qz0F8wSbslt2y8OtUPyyH8yWTXM18mDFY5EsQhHvy1BC/PAT80v6HNNtrk01gE1Whv0mxvRf+SXn4Mzb/6snjN09eaG3bUZN/7lar1X8ARXhStQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u20gSfpVKXxwHtGQ7yR6ExWIyTjBrzGBsxA5ysA2hSRbFtpvdnP6RzBF0myeZR5snWVQ3SVE/dhxgMZddIEiiVnV1/ddXpSVzfGbZ5IZ91JmvUDnL7hKWo82MqJ3Qik3YdYlwZpA7hI4KPlyeA5dSLyw02oPTMEOFhmgULiDvuEHawL23Dmqj5yIXagYOq1pyh1ORg1DWIc9BF+BrqXkg4IFFISS+FgpciVBoUxFNyi3+4x1oA6lQ3DSHgHM0DThRYZBDIeYkTBbF5b0gI7hun7XEDQzWRJHLBrzFPLxmIeMKUmxv51AYXdHXBoRyaAqeIXAHN2/efMTUz+DL+Zs3d69L52o7GY95XY90jcqKmZI8taNMV+OcCOu8OCShvQ36r83ZyUTmHN0qljBdkxGFVuc5m7BWkFaHhXBlZzyRs4TV3PAKHRry4JIpXiGbsIF9WcIEebDmrmTbbtXpPWbuPBi/E4QlzOBvXhjM2cQZjwmzrpHE1oqqlkSAj7XUObJJwaUlgqzEirPJkrmmDpTOCDVjCSO3cTc8wUceuExY/e+TtMxOyzplq9VdfBat+1HnDbHKtHKoHP2X17UUWTDK+N6S6MvBm2txbxhZnoxxl3SiRB3JVIYs6wTacL0lXMvMjeENmcthNTx/goHRpMSuxmv9PmSZ9k5x5dgqYVhxIZ81USAYMrjX+EP7iSKJuEQHP/fqvUZIEYm4LrX6BvXJ6Vv68/aErVYJc8KF082gG0TT9Ko1G1EXWuZoKEqfe4EEsajy6bYBUq0lcrUTlNelsNDH9VaJsTVmomhgUaIr0YTjBVcOAndLJCmCpfpE1FHaEVD9yrHgXjqYc+kRhIVbRuF9y0ZwXoSUjN9o+rAhwoAWuMpBaTgI702tD8FxMG4/pzpvDtY3LXCDrcwC816EQNxXQQsLISXJTXUoFoHefvRsFz3dc/sMvmnDM2+driA8014KNY8Mwp03CG2yjeCMKxAqkz7HttCSwalKwXLZhcA0RMZqBcsl+RLNlAJxtUrWB/TWxkGIvnhiMEMx37jVH+H6Yn82uIqPtTDNNOeuPch0VXPVDAUQMyXUbOqNXK1GO8G39syL7bZjptZjxOR/wGIkzrm6MDmaF+TreQEWQ7odULAeJKCVbKJlhLGuzcIY5K3A4dunrCyUcIJL2YzgU5/V1qeWqFTHb501zojZDA3m0FKEywlQswTkWRnrQZCKF5TQ9HptcC60t514JbdAlpJIfd+VKGK6CDUbwY9Nl7sJDKxDlWFD99Ge1CVkcq3PWtYfeTNsLspXKZodmwY0QyCmvQU5byy9FpAKfcFl5gNuiO4GcjeVrkZ700OeYXfpX+rlO3lP2aF4KvHi+vIFniaF4ChWRx0Oow8iD7i4voQ5GlG0rXoEX2zvp87xfIMEMp0jzAWPrk9gUYqsJOs3UBFmRBX8FUt58NsazgXwAUewK1Au7F6JkthNKFV9EG0fY8iFwczJJgSQ9g54ngu6ziVYh7Xd8HKQojfktfYvyZlvWJLDzIs8eNqbvnCjsckARBNwNj6jyxZybzpg2QYtUWZo7dpOnVWIaMA/AVQ2XudQcOvQJOBVwLvG15QNHUt8rNEIVBnuN0FsUuty9+2CS1SEi2Pm69iHazRWKzrWZsaV+D3Gio5+SrHksiDaGCwEAUKbRZV3NiBum3Wtg+V//fEnlbgQB9NK531s2Je77RJNJZztC5HTFCKAEuPAY31WArfrAmeTrqjZBKzjVW0TUs/howtq6Zr0wUdhHamwEPkMnQXxVMh/RrJnNpAhDCoUqORG1QxjtpfL6S12AWoJG0+H8GiPe5+Eh9MhPgxtdkXEm0NEOLC1Vjai59PjY/pnq5MoMh0FLXTEEeBRaszQgTfUHdZfiqL3Ppe2w3tE0iezJpi4EBZj/Scu3dSTQIXWWj6jkebF08bzU0HH+3tnofJenP7+mM1PLyk6vXl+UtjHoB1Bt+YF0pAU/E5u/ZAfOmfrlMJL2bzaGBSEkkLhtHPI9PT4eHpK/l8l7N1eF0ePlXyO6iBU1j7YCVl30UyB3w3G2oDS3fYAexIudcgUV7bNmgaycDPE4H/No2iMNt9rv0uJ3FJJcr5eaxIZf8uG746Pp1nWG/H9vjyZcynysIG51g+oXv0N6q6VGz7v4vMk6mMVgrZdQYhIFL5nG9oOz6OSFjNvhGvCCuPxiNfiKH4/ubmjxUCFrtS0DKm1DRLTLmPCxpt1aLwcFKIVI7Zm3i1GQkb1SWK5ylP9uLur4bUYz0/YKtm+sXez8yS1dXwm1Ozo2Vt3a8WvyDnR/hvqr3cTtfgZKahb6w6p2gVPiZzwOtmTfP55vUz51HlusPW46RYYwy1Fv6TY2Tz0D3fbhX65MNwg3A13Aoxtzv1xlbQ1xzK2OZ91l/rpI97aB6FP3m+A13YTNURh3dEuKtlAA0+AgQ7UCFXo4Ik2gC9qVLQFCeE/P9nBCF9RZjqid2qrHflff/wZbnTRGp55BRfeQK0XaAovQwUsJD4KQmm761WLvJJorWzCMnIWVq25mAlHwLSFaBmveSqkoHwmMh0ngkFJsCP4ut6eHJiwI8U5SioDILV+CChKA/dOV+GNrhsstHkoSKQEOKS0y6RebRG7K6hKrjIqfDGwA8rhKsL42lAb5qIiYgK1WBQiE8SYipfhmYOKKz4LcCUBkpus0FZ+C0anNBNYLX1EvU5DheiiirT4tSP4SFNGUDxMQui4kJhHwGuTOHC0oU1qqBxSDMtpnjmRYZwJHDcOJG2WQyLHYdZLCbV2ccAkvDb0LTFyhisbFtVxCmtd05uvReThjZw3I7hVt+qKgsVbpACQQj3Yya06gps+zL5iaoXD9ZJ5sVjsFJXDzTs/CVf6lDbcen1vFg5DCRpe7z8csoQ5NJW9KK7QzEXWwYon3hwH4nHbenhcS3UFhNfih+0L1AakyFBZHDSKDz9d/gJzeDs6ZsmgjL5A4PEv52effr36RHyp0Mf8Oxkdj47D9lNbV3E1eGr7F4yAmQd7741EHiyg///zx9/480fb8Wg0GteSCzUAxLHx32wNICxhk+EvHncJKwkoTG7YckkG+0JrLjr+zaMhlHGXsDk3glpFaIXtZJz3PePJSHj9uR1rDuGJH0/2yt+1cUU9PExYsdc9YLP1c83qbpV0vZxEixRnUYCja+Kz5rAD9AiKxBsfsgxr9yztEFldXlxds4R1W9Iq/LrDDF/Qz0F8wSbslt2y8OtUPyyH8yWTXM18mDFY5EsQhHvy1BC/PAT80v6HNNtrk01gE1Whv0mxvRf+SXn4Mzb/6snjN09eaG3bUZN/7lar1X8ARXhStQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},j=[{value:"Request",id:"request",level:2}];function y(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"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)(s.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(s.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(s.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{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)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.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:!0,className:"schemaItem",children:(0,i.jsxs)(a,{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)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.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)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(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)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(d.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)(d.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)(d.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)(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:"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)(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}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(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)(a,{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)(s.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",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(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)(a,{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)(s.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",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.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)(a,{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)(s.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)(h.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:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.87a74c81.js b/assets/js/28b19cd2.87a74c81.js new file mode 100644 index 000000000..86f67df9f --- /dev/null +++ b/assets/js/28b19cd2.87a74c81.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>g,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var i=s(85893),t=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),m=s(41429),d=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u3DgSfpUKL04Cudt2kj00FovJOMGsMYOxETvIwTYalFRq0aFIDX+6rWn0bZ5kHm2eZFGkpFb/OQ6wmMsuYNgWVSwW6/er0pI5PrNscss+6MxXqJxl9wnL0WZG1E5oxSbspkQ4N8gdQkcF768ugEupFxYa7cFpmKFCQzQKF5B33CBt4MFbB7XRc5ELNQOHVS25w6nIQSjrkOegC/C11DwQ8MCiEBJfCgWuRCi0qYgm5Rb/8Ra0gVQobppXgHM0DThRYZBDIeYkTBbF5b0gI7hpj7XEDQzWRJHLBrzFPJxmIeMKUmx351AYXdFrA0I5NAXPELiD29evP2DqZ/D54vXr+5elc7WdjMe8rke6RmXFTEme2lGmq3FOhHVevCKhvQ33X6uzk4nUObpTLGG6JiUKrS5yNmGtIO0dFsKVnfJEzhJWc8MrdGjIgkumeIVswgb6ZQkTZMGau5Jtm1WnD5i5i6D8ThCWMIO/eWEwZxNnPCbMukYSWyuqWhIBPtZS58gmBZeWCLISK84mS+aaOlA6I9SMJYzMxt1wBR954DJh9b9P0zI7K+uUrVb38Vi07kedN8Qq08qhcvQvr2spsqCU8YMl0ZeDM9fi3jLSPCnjPulEiXckVRnSrBNow/aWcC0zN4Y3pC6H1XD9AAOj6RK7N17f732Wae8UV46tEoYVF/JJFQWCIYMHjT+0T+RJxCUa+KlTHzRCikjEdanVN6hPz97Qz5tTtlolzAkXVjedbuBN0+tWbURdaJmjIS996gQSxKLKp9sKSLWWyNWOU96UwkLv11spxtaYiaKBRYmuRBOWF1w5CNwtkaQIlvITUUdpR0D5K8eCe+lgzqVHEBbuGLn3HRvBRRFCMr7R9LAhwoAWuMpBaTgK502tD85xNG6fU503R+udFrjBVmaBeS9CIO6zoIWFkJLkpjwUk0CvPzq2857uuH0K39ThubdOVxCOaTeFnEcK4c4bhDbYRnDOFQiVSZ9jm2hJ4ZSlYLnsXGAaPGO1guWSbIlmSo64WiXrBTprYyF4X1wxmKGYb+zql3C9sV8bbMXHWphmmnPXLmS6qrlqhgKImRJqNvVGrlajHedbW+bZettRU2sxYvI/oDES50JdmhzNM+L1ogCLIdyOyFmPEtBKNlEzwljXRmF08lbg8PaQloUSTnApmxF87KPa+tQSler4raPGGTGbocEcWoqwOQEqloA8K2M+CFLxggKaTq8NzoX2thOv5BZIUxKp7rsSRQwXoWYj+LHpYjeBgXYoM2zcfbQndAmZ3OjzlvUH3gyLi/JVimZHpwHNEIhpd0HOG0unBaRCL7jMfMAN0dxA5qbU1WhvesgzrC79Sb18p+8oOhRPJV7eXD3D0nQhOI7ZUYfFaIPIAy5vrmCORhRtqR7BZ9vbqTM83yCBTOcIc8Gj6RNYlCIrSfsNVIQZUQV7xVQe7LaGcwF8wDHsCpQLu1eiJFYTClUfRNvHGHJhMHOyCQ6kvQOe54K2cwnWYW03rByk6BV5o/1zYuYbmuQw8yIPlvamT9xobDIA0QScjc9os4Xcmw5Ytk5LlBlau9ZTpxUiGvBPAJWN2zkU3Do0CXgV8K7xNUVDxxIfazQCVYZ7VTBIdN9OtVSSiTLWW4QajdWKMLI2M67E79FBSDOltoRpSi4jaZsmLKRIUlF0byaxDoP/9cefbC3XQQS2K1g8gee5QWu/IaEruWvdiZoHgzVlP70pEfFD88N2c0DSBZecVjrv3dQ+34Ou0FTC2T4nOk1SA0qMvZf1WQncrnOtTbr8ahOwjle1TehKDh8pRYLTNd0XH4V1pNyFyGfoLIhD0fcJSY/ZQIbQM1HMkEepZhg+vVxOb7ELqE/YuDpEans87SBSnQ6haqj4KyLe7GfCgq21shHIn52c0J+toqZIdRQ/0BFHrElROkMH3lChWr8UIfUGvMel7aAnkfR5RRNiXQiLsRQRl64BS6BCay2fUXf17Mbn6Qal4/29bVn5IM5+f8zmZ1fknd483bTsY9B2w1utC92QLvid3Pp5QyjirVEKL2XzYqNnEUoKhdPOINOzk5PpGdl/lbC3e00cLVbyOaqjkOR7ZyeQ33kzOX7Xo2sDSneDDOxJuNQhUlzZ4gbqDcPO4IP/NYuiMdp8r/6uJHJLLZHz9fomkfG3dPj25GSaZb0S3+2LkzmXIg/DoBv9FdWLv+G668sNj3fxeBL1sQpO205DRCQK79nGbYfr8ZIWM2+Ea8I05fGY1+I4vp/c3tOMokJXaprL1NoGiWmsMmHjzTw0Xg4S0YoRWzPvZjQhovogsVzlqX7cHRvxWoznp2yVbO/YO2Q6SG0dnwk1O35y1/364tdknKj/jeuvxyS1+BnJqVvtDqnaWVOJnFoH0ifZ/NN6rvOxs9xgAHPbzVKGA5N+XrIzBOkP7gYd/ZxjOMy4H44nGNscQcSp1lZLzdhmq9ht6huhuGsfmj99t4Gj26HYEBB2c7IhQNpAKdsg5SBgOIAXOggmVKGDsVofv6xR0cwmRMj8dAdGfEGZ6dhrUOXtyP/648+wo3PocMwLuPQGar1AU3gZkmQh8VEQptwdBlvklURrZRNGp7MwGM7FTDiC0S2gzHjNUyEFhTyR6di/DLKGHcGX9aznyISJLs5RUqYAqfXXgHs1cO90Fc7oCsZCm68FiZQAh5Qmr1TOLWK3BVXJVUa5Mfp+AEJcxaajNlSpuaiImCA4FoXIBDGm/GZ45qDiis8CokmA5CYttMXBgtEpdTBWSx8xutNQIbp4RRpT2xF8oJ4oXDz0bejI7HmE5zaJ7VHr/XQNlUOKYZTOMycyjB2M48aBpDl4iPXYenspodYutsME6Ya2JUbOcGXDWD32jK1pevW1/UM4I+fNCO7UnbomZ/EWyQGkUF/t5E4dw23vZl8wtcLheiS+WCx28s6rzT0/CVf6lICzXu+bhcWQpYbb+4dXLGEOTWUvi2s0c5F1yOPAmeNAPG6rE49DtC7YeC32QnMpMlQWB7Xk/U9Xv8Ac3oxOWDLItM8QePzLxfnHX68/El+qBTH+Tkcno5Mwq9XWVVwNjtr+3hJg9WBKvxHIg3H5/z/W/I0fa9qiSN3TuJZcqAFmjtjgdqtHYQmbDL/P3CesJCwxuWXLJSnsMw3laPk3j4aAyH3C5twIqiahWrZ9fN6XlYOe8PJT2/m8ggOfevbK31V6RWU+NGGxHH7FZuvj0up+lXTlnkSLFOdRgOMb4rPmsIMFCa3EHe+zDGv3JO0QfF1dXt+whHUz3Sp8i2KGL+jjFV+wCbtjdyx8S+v76bC+ZJKrmQ9tCIt8CaVwT5YaQpyvAeK0/9DN9upkE/vEq9BvutjeDf+kOPwZm3/15PHNwQ2tbjtqss/9arX6D0epkQI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWc1u3DgSfpUKL04Cudt2kj00FovJOMGsMYOxETvIwTYalFRq0aFIDX+6rWn0bZ5kHm2eZFGkpFb/OQ6wmMsuYNgWVSwW6/er0pI5PrNscss+6MxXqJxl9wnL0WZG1E5oxSbspkQ4N8gdQkcF768ugEupFxYa7cFpmKFCQzQKF5B33CBt4MFbB7XRc5ELNQOHVS25w6nIQSjrkOegC/C11DwQ8MCiEBJfCgWuRCi0qYgm5Rb/8Ra0gVQobppXgHM0DThRYZBDIeYkTBbF5b0gI7hpj7XEDQzWRJHLBrzFPJxmIeMKUmx351AYXdFrA0I5NAXPELiD29evP2DqZ/D54vXr+5elc7WdjMe8rke6RmXFTEme2lGmq3FOhHVevCKhvQ33X6uzk4nUObpTLGG6JiUKrS5yNmGtIO0dFsKVnfJEzhJWc8MrdGjIgkumeIVswgb6ZQkTZMGau5Jtm1WnD5i5i6D8ThCWMIO/eWEwZxNnPCbMukYSWyuqWhIBPtZS58gmBZeWCLISK84mS+aaOlA6I9SMJYzMxt1wBR954DJh9b9P0zI7K+uUrVb38Vi07kedN8Qq08qhcvQvr2spsqCU8YMl0ZeDM9fi3jLSPCnjPulEiXckVRnSrBNow/aWcC0zN4Y3pC6H1XD9AAOj6RK7N17f732Wae8UV46tEoYVF/JJFQWCIYMHjT+0T+RJxCUa+KlTHzRCikjEdanVN6hPz97Qz5tTtlolzAkXVjedbuBN0+tWbURdaJmjIS996gQSxKLKp9sKSLWWyNWOU96UwkLv11spxtaYiaKBRYmuRBOWF1w5CNwtkaQIlvITUUdpR0D5K8eCe+lgzqVHEBbuGLn3HRvBRRFCMr7R9LAhwoAWuMpBaTgK502tD85xNG6fU503R+udFrjBVmaBeS9CIO6zoIWFkJLkpjwUk0CvPzq2857uuH0K39ThubdOVxCOaTeFnEcK4c4bhDbYRnDOFQiVSZ9jm2hJ4ZSlYLnsXGAaPGO1guWSbIlmSo64WiXrBTprYyF4X1wxmKGYb+zql3C9sV8bbMXHWphmmnPXLmS6qrlqhgKImRJqNvVGrlajHedbW+bZettRU2sxYvI/oDES50JdmhzNM+L1ogCLIdyOyFmPEtBKNlEzwljXRmF08lbg8PaQloUSTnApmxF87KPa+tQSler4raPGGTGbocEcWoqwOQEqloA8K2M+CFLxggKaTq8NzoX2thOv5BZIUxKp7rsSRQwXoWYj+LHpYjeBgXYoM2zcfbQndAmZ3OjzlvUH3gyLi/JVimZHpwHNEIhpd0HOG0unBaRCL7jMfMAN0dxA5qbU1WhvesgzrC79Sb18p+8oOhRPJV7eXD3D0nQhOI7ZUYfFaIPIAy5vrmCORhRtqR7BZ9vbqTM83yCBTOcIc8Gj6RNYlCIrSfsNVIQZUQV7xVQe7LaGcwF8wDHsCpQLu1eiJFYTClUfRNvHGHJhMHOyCQ6kvQOe54K2cwnWYW03rByk6BV5o/1zYuYbmuQw8yIPlvamT9xobDIA0QScjc9os4Xcmw5Ytk5LlBlau9ZTpxUiGvBPAJWN2zkU3Do0CXgV8K7xNUVDxxIfazQCVYZ7VTBIdN9OtVSSiTLWW4QajdWKMLI2M67E79FBSDOltoRpSi4jaZsmLKRIUlF0byaxDoP/9cefbC3XQQS2K1g8gee5QWu/IaEruWvdiZoHgzVlP70pEfFD88N2c0DSBZecVjrv3dQ+34Ou0FTC2T4nOk1SA0qMvZf1WQncrnOtTbr8ahOwjle1TehKDh8pRYLTNd0XH4V1pNyFyGfoLIhD0fcJSY/ZQIbQM1HMkEepZhg+vVxOb7ELqE/YuDpEans87SBSnQ6haqj4KyLe7GfCgq21shHIn52c0J+toqZIdRQ/0BFHrElROkMH3lChWr8UIfUGvMel7aAnkfR5RRNiXQiLsRQRl64BS6BCay2fUXf17Mbn6Qal4/29bVn5IM5+f8zmZ1fknd483bTsY9B2w1utC92QLvid3Pp5QyjirVEKL2XzYqNnEUoKhdPOINOzk5PpGdl/lbC3e00cLVbyOaqjkOR7ZyeQ33kzOX7Xo2sDSneDDOxJuNQhUlzZ4gbqDcPO4IP/NYuiMdp8r/6uJHJLLZHz9fomkfG3dPj25GSaZb0S3+2LkzmXIg/DoBv9FdWLv+G668sNj3fxeBL1sQpO205DRCQK79nGbYfr8ZIWM2+Ea8I05fGY1+I4vp/c3tOMokJXaprL1NoGiWmsMmHjzTw0Xg4S0YoRWzPvZjQhovogsVzlqX7cHRvxWoznp2yVbO/YO2Q6SG0dnwk1O35y1/364tdknKj/jeuvxyS1+BnJqVvtDqnaWVOJnFoH0ifZ/NN6rvOxs9xgAHPbzVKGA5N+XrIzBOkP7gYd/ZxjOMy4H44nGNscQcSp1lZLzdhmq9ht6huhuGsfmj99t4Gj26HYEBB2c7IhQNpAKdsg5SBgOIAXOggmVKGDsVofv6xR0cwmRMj8dAdGfEGZ6dhrUOXtyP/648+wo3PocMwLuPQGar1AU3gZkmQh8VEQptwdBlvklURrZRNGp7MwGM7FTDiC0S2gzHjNUyEFhTyR6di/DLKGHcGX9aznyISJLs5RUqYAqfXXgHs1cO90Fc7oCsZCm68FiZQAh5Qmr1TOLWK3BVXJVUa5Mfp+AEJcxaajNlSpuaiImCA4FoXIBDGm/GZ45qDiis8CokmA5CYttMXBgtEpdTBWSx8xutNQIbp4RRpT2xF8oJ4oXDz0bejI7HmE5zaJ7VHr/XQNlUOKYZTOMycyjB2M48aBpDl4iPXYenspodYutsME6Ya2JUbOcGXDWD32jK1pevW1/UM4I+fNCO7UnbomZ/EWyQGkUF/t5E4dw23vZl8wtcLheiS+WCx28s6rzT0/CVf6lICzXu+bhcWQpYbb+4dXLGEOTWUvi2s0c5F1yOPAmeNAPG6rE49DtC7YeC32QnMpMlQWB7Xk/U9Xv8Ac3oxOWDLItM8QePzLxfnHX68/El+qBTH+Tkcno5Mwq9XWVVwNjtr+3hJg9WBKvxHIg3H5/z/W/I0fa9qiSN3TuJZcqAFmjtjgdqtHYQmbDL/P3CesJCwxuWXLJSnsMw3laPk3j4aAyH3C5twIqiahWrZ9fN6XlYOe8PJT2/m8ggOfevbK31V6RWU+NGGxHH7FZuvj0up+lXTlnkSLFOdRgOMb4rPmsIMFCa3EHe+zDGv3JO0QfF1dXt+whHUz3Sp8i2KGL+jjFV+wCbtjdyx8S+v76bC+ZJKrmQ9tCIt8CaVwT5YaQpyvAeK0/9DN9upkE/vEq9BvutjeDf+kOPwZm3/15PHNwQ2tbjtqss/9arX6D0epkQI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},j={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"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)(a.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(u.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)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.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:!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)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(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)(a.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:"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:!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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.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)(a.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://example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.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)(a.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",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.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)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.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)(a.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)(u.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 v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.8215307f.js b/assets/js/2c586be5.8215307f.js new file mode 100644 index 000000000..76c6cb0fa --- /dev/null +++ b/assets/js/2c586be5.8215307f.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:()=>f,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=s(85893),i=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),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:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcJbg8IhRCh4c3IEoij03EJt0VhwGqao0BCUwjnkcT4YL6Ay+lrmUk0hF07AXLoZjIXFVweAKtM55jCRBQ7O1bk6ldUhfKgKLXJY6NrAybv/aWajZajtbGfnHY7rKXw42tm5+GrmXGUP9/ZEVQ10hcrKqSrE2A4yXe7lBFjlk+cpzGdokGaFTChAYWWxAJHnMJf5FJ1Nwc1QQaarBWRam1wq4dCmUIkpgqrLMRqbglA5lNogSAUCDIp8sev0bm0R/vf98Q8w0aYUbgAnRW3TZrlcGsxcsfDTuxk2u3pmIzWsM1JNUyjFFVFLOvilltkVbduiyukvDXxzcsS02tl5X1eVNg5z+Mlv4XBnh3q+wULPQRhk+EyXpVZQCSNKdHxcM+G42+AvtTSY+0MRRRFpcXiudmFnxy0qPNzZgSOVy4yIwRNSK+hJgB14UCISgb6vMJMTGUA7pAOtYD6T2YxpMhf+PKtCZB5Ng7bCzMlr7E98k8KCJn6HSkcMZtrIX7VyouDjuEbjZCaK7rERggRqnTCOyFlpqVxsDSvAP8Lx0OnxoQS+ItRyIlYpFfdYhGtR1GgDVvMUZoTVj1gZtMzqYV4ipMphhnI627ieyD/W1vUmhtoSml0swlrxlJi8yGSbiMIiyEmPlqW4ws5qoFmGRTGAbxaQ40TUhUtBEsc5U+MAftAORFUVMhPjAolzgYRHuNrgLp9yYIeAiBIln/EJSzRaEJDLyQQNCSd18hRhTMSO+KxVASw5biYUaLVy0JkutKHpV3iI2/uEhEwrh8oN4M21kAVj73drQaqsqHOEcSGyqxTGRY0pGMy95C6Q9FYatBCBgLCB6EwgsFgQG2pFG1A6LC8t2IBVPoDTmbStQFFnpDUvIm2XrEFsJ5pWJhpEGQMshSxSplwKH/UYnHQFpiSxlVCLlBQmpuDwxo31TQrZDLMr/mVELjWMa+e08hvLja5yPVeBmBOtnJW/rhHJ2PPpFB2lcJDCqxRepzDcT2E4SmF4kMLwVQrD1ymM9lMYjVIYHaQweuXRGr0OtBYNgbsIDEeeyu6PQ11SvN9Jy6JNGtM2SnjeU8LnajiAnZ1GoLj5559/Ple35wrgPCEBO08Oz5MG5DxJwfeR3jxPDocphIab8+QQXoy+jgAL+n5F1PXfc/oe0mn47xl9j4bnahkWHTEyTpTVPYhQ92+PRPwM/ESNvDK1Rd1GjaSUPCz10LlRa4MWdSzbDb2gDUklnRSF3bynCPH0ttVitrKzA9oZc+/mbXH309tTRCv2sPL0XaxsO11RDTAioxUSvBy0180GCvhFnxoBAlZfuv9XtP9GZ20mQgPy9CjRRe1LyfH1gO0D1tubiREAnh4pWsS+lBCviRB0b22mAvU+PRIErGJHsAV83/7B7vDl7mh/dNAjA7lRHqAsd/N8d7FYfCEJgQlG5lFYn63NYM16I5A82InR5RpXhT2JFiqYT/w7mvffk1E/jvYu5uQjshMSjZvGO+xa5E7nYvHM+qni0MaOI/jWilt00OQuwoM95WymZRaQJ5hovY3JGRwQEXaJ8Pne99/vdUjpG3fLMtIXYit97zLpu61lOcjzwSps74Q6rSXkeQpr2td35DmUZbmp3XfQdXmu/kyCEEy3zbIQAH4fcVjD9e36G2Wl7RC5VgWvz97dellZuV9mUoWOwDewAmBwWhfC4A25qVZqxXT5DTTRihRFIWrNfPZq2SHkmIGnBHx1HEz554HBaQf9Cajl4XF3NtadxOAUb3iOrLZOl4SMzAXNkIKtsxk5fSJ6DET2Nr7DX5moJEUXCnSOW9Flg3VI+EPreOZ0qKuOuUXX24ywEEeu8c359NnRGO7zvRf8knsuvgDx9NR+B7PY6aMd1H12npQimC7JBNvf2s3QnCcXzRjvk2PeGQvrBsPFPfIErdDkWIgxFndl7dHS0N1O4KwOcaijlKoJJTDK+xED7hU3K72hc7lGzvy2uwwelXsUk0hnKKSN8ZQ+0bqjQ8CJw4AKkSOLY4Q4gIK2UYq/lOUbxB7B81EhhNN5YAWCAwZsYn1xsXuEilbonUyXLjRHKZUs67IJWk6aWSPFynDJd8lFIykUHlfonu6dFcTNAytQhHDzAudqyJGFGJNgvQDrbcEA8vQUQwezh2/Az1EZvVvzc++7TxfEuK+uIK65JgnUX5CNENrNUjiAY7qUKGLqB1EILMuwchQu+1IRbVB+3LU05EhSN0S2+WLqQv3ePLiJmR7DnSt4/2Z8GOC+zPYiqj2OGbvb+AMxZA/tR9tKPh5Y+jTUpmBgyaz31JRhQGvl5k/SRFeUU5VaHeXJYZJxGjbmDZOU50brvtH5Ijm8TUIIn36GADkN3ftoKZF7m9hshqWgXxEnSv1S6jVJOQaNxiZpwjEbygMT1ZLDRI8/YkarVYbQcRItzcHjDm8jlM9dJmnw25PDxCc1kzTBG1FWBJysZH2rfJIs44L3TdW0tFNZ/tEkUWkeSg9+5jQ/0FBGpcRT/VZTo8N3YmE7E/r7OllNkNMY4t4sjIJcLCwJRG29ZZWJIqsL8tjxppJm0YQP2G3vHGeDaLNSg+jw5bI9oxYlYYxYJGkiHZbd9g1nZvSnEzpDTZThwO6njv2ocYz4l9BA+Xg+J1F+MhYfNcIY+YyqmVafPH44ejEcDV8MRzRDyNN8Ph19710M+ozxhvxLzKO1vdvmVlPglMbgIeaM8LxtMcWHmfF0U869k+mzM10XOeXQUJgBp74/u6qiz9/NJTJ4gJuXaXLz8GZuINO7MaEPXxU4cVBXFRrItFFonncjdU9mc6ODg2WaLB7e3uIPub2v6fDmD+/uJ66EaKtE/hO4vni9TJPZw7j+ranV+A8ie/Bq2V6GK3f95Vjni8uot5YPAcaLguAmusjRkP1wV1+1qoY0DNUYXa7q+bHWBQq1RtH0cvShGoysOTLkQqh6PkMyh1sjj2dv7cpg9nlsKe+PK9FDacl6MzWeJwM4mnSsVPb4V8sEIiyn7JWGZ7zepa1ZjT/bC99Eo2fdeigqUWlD9BEFBgaHZVVwQdFcFgXhTff6AJp/bKg1lCQE4nUZF374qnjro5S8YBjUr8aBYOoN4K1QTUFGv/ABbm8bNmDuWC7h9pZOFc0lXbrLZdo20Fq9Br5XfYvBDOV1b1TThO3Apq0z1Js4l2Ti+IaQ++oiIKdKqullbYrlcnCHDdszejTd7pApnB1N8v+AYoTOkTo2OZpHSO7RxDtaGp4Rsz4LEW+mjDTWBXn07B4Q9kmsDVQOdQzkn33byLetx5agVJyvlR9n5HSKVHUYIHhwKBNCkc28ZmCsxIREmysJDV5LXduI3kzYxuTOCUJ6cZFq2vcTO9ThKq7u3gfrRFdRXdHx6ckjaMle7K7XRN7587v0c8Dx6QnVJspJcMUG8ME2lIikFT0QINcIrqWI5UuN+bbwgUdUTBGvNnuFpINQFbgLdxHKpV2LUdpmQZpK3jsTt8WrdES6dlQ1K0NFlnVY2R4dGYuGkKe6fgxXPkBJAdOaE6qObuWoGjkz09YWSmWdqX3QFfLaxHLKwBYEmaG1LZ0iVQioM38KqKwfLmAirEOTQq0kUd7UFONopsSbCo1EleFaEhj0pCPJfVib9ev0Pvz4XShZjnuIQjkmCfQTYw51xVzDktAUkMaTW936Wt0R1NbDCNIFzWWeId5eobFaAVVnmqlQ8lfPwux0aEse20wUHjSoCkpHEz4k4X1kojn173/+q4PXRrfzLmJ+BZHnlA98AEOOcXmGp1i7wYo0oO5jRPOh+cuqnUfYsdBcljpvBMk+nsdPqKrY2UYvOs1V6FigL5mP+clG39o06lgbPEdKUxpOJxKxna5ov3gjretUQMbig7v64UckOmYdHNjTIKkmnleLroA3eIVKy3Y6tgFlv3q2sXRXZOF+i9WbtG1YKqhiKgnXynqne7S/T3/6JG2eJIRJiXjE6JO6KBZ/StLHx8Tu9/h983or+j4XfvZRjn69ya5HJ8Q2G7TAvRMEj6M2Bb0yoPPabU6AubFDWakKqfAyku1ytL9/OSTaLtPkYB353usS3Yx5hog4N5reH1QFCqqHNwsQUyEVkP1rfkNqojHa3O+QfBpm9xHhoEeEl3eJcKQ4h8uvWk71Farfd6fd5Z1fnlC9KZlXvGJOpAfi/qS32W6736TFrDbSLZLDs9vkZldUctf3H55dLC/ShAirKZ5cacsYCzdLDpO9O+Fli+aa441nt551G260QuWUZ73jA4tK7l0Pk2W6OmKtx7wR2joxlWq6e++oi3ar7+k4PMV7G24DfJX8O1KEL9CzC5UmkthghoIMaKIgnfKPbWz923hWMeq9LpDdnslqaDpGpnvB5vWx5uHLTpT3LAZsOQbbhGDXRVWbfcU4aRMm7UQ+O4HPs5YhmxhjDDEOOTY3OjjgINbXQ472vHjNgZSDV0tmoTaokCT9wAGnOFbd3yTpu3VxUOO0hFGt5e1Tdj0TMjT1Tao4U2PC9OyIVTNi45W+4UaPZpxUE83MFE74uEL1nqxkktnr4d3YFxaZLpu3CRH83//8F4+InMHL/AmOawOVnqOZ1P6Bw6TAG0l2aeedXYysoCgLtLZYAJmjU35xl8spFytFYy8TlRjLQpISIjDtMw0dPWYH8FMbm3lmfN3WNRaku6DQmh+gkWFSO13yGvGinWtzNSGUUhAwpjdLZG5ZxDgE1UyojMI7XjbZVKEHd2Q+V0ZaBCFLAiYzHicTmUm+wbVyRmQOSqHElG2OlGNwRIUqvjgyekxekNVF7e18eveE6PwWOW05gHfkV/HGOcOCjo499ya+Tb2LFcQnPOgbkztb0fIyQ9tWexZ4jYZ1kXeQ66KASjvvtJLR1T1bmsgZoSxd6CG7E46mIV8wxHmNXCwGQLlLuuzIHCUGKKS68s/vzho2+wnHVjps44/z+fyOXnzeH/NX6Wb1mExb3Y6bciNr0e7w5uM56SU0pT2evEdzLbNogmxYc4+B98J9KXyoKwqbqORa47mQGSqLndvtzV9PvoNreDHYT9LOTfAIhPe+O3r77Q/vv6V56a7y8jcc7A/2OWmirSuF6iy18pR1VXQ7SdTty9fty9fty9fty9fty9c/ztvM7cvX7cvX7cvX7cvX7cvX7cvX7cvXJ0CK7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvXp/HQcPvydfvy9Ukx5Pbla3z5GspTyG7cqwohVad+zhcsna2+h71IkxlVNB2eJbe3lFj8QOXy1PxLjYbKoS7S5FoYSdFzLoZKY9EPFcRcIVWmvPXJgN1TWj/1fM+57JUaMKpZ8iPe8OnfC9stujo5fn+apEl831DqnMYYMaf3vGKeHCaktPntb1NXyu23SSHUtOYancTPS7VKonazfqHTFRc6hR+dUh+hFh0s+xVQfiv0P21s7YD/otz333Hx3w2479k4INA2QtMRXiyXy/8Dcc3lPw==",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:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcJbg8IhRCh4c3IEoij03EJt0VhwGqao0BCUwjnkcT4YL6Ay+lrmUk0hF07AXLoZjIXFVweAKtM55jCRBQ7O1bk6ldUhfKgKLXJY6NrAybv/aWajZajtbGfnHY7rKXw42tm5+GrmXGUP9/ZEVQ10hcrKqSrE2A4yXe7lBFjlk+cpzGdokGaFTChAYWWxAJHnMJf5FJ1Nwc1QQaarBWRam1wq4dCmUIkpgqrLMRqbglA5lNogSAUCDIp8sev0bm0R/vf98Q8w0aYUbgAnRW3TZrlcGsxcsfDTuxk2u3pmIzWsM1JNUyjFFVFLOvilltkVbduiyukvDXxzcsS02tl5X1eVNg5z+Mlv4XBnh3q+wULPQRhk+EyXpVZQCSNKdHxcM+G42+AvtTSY+0MRRRFpcXiudmFnxy0qPNzZgSOVy4yIwRNSK+hJgB14UCISgb6vMJMTGUA7pAOtYD6T2YxpMhf+PKtCZB5Ng7bCzMlr7E98k8KCJn6HSkcMZtrIX7VyouDjuEbjZCaK7rERggRqnTCOyFlpqVxsDSvAP8Lx0OnxoQS+ItRyIlYpFfdYhGtR1GgDVvMUZoTVj1gZtMzqYV4ipMphhnI627ieyD/W1vUmhtoSml0swlrxlJi8yGSbiMIiyEmPlqW4ws5qoFmGRTGAbxaQ40TUhUtBEsc5U+MAftAORFUVMhPjAolzgYRHuNrgLp9yYIeAiBIln/EJSzRaEJDLyQQNCSd18hRhTMSO+KxVASw5biYUaLVy0JkutKHpV3iI2/uEhEwrh8oN4M21kAVj73drQaqsqHOEcSGyqxTGRY0pGMy95C6Q9FYatBCBgLCB6EwgsFgQG2pFG1A6LC8t2IBVPoDTmbStQFFnpDUvIm2XrEFsJ5pWJhpEGQMshSxSplwKH/UYnHQFpiSxlVCLlBQmpuDwxo31TQrZDLMr/mVELjWMa+e08hvLja5yPVeBmBOtnJW/rhHJ2PPpFB2lcJDCqxRepzDcT2E4SmF4kMLwVQrD1ymM9lMYjVIYHaQweuXRGr0OtBYNgbsIDEeeyu6PQ11SvN9Jy6JNGtM2SnjeU8LnajiAnZ1GoLj5559/Ple35wrgPCEBO08Oz5MG5DxJwfeR3jxPDocphIab8+QQXoy+jgAL+n5F1PXfc/oe0mn47xl9j4bnahkWHTEyTpTVPYhQ92+PRPwM/ESNvDK1Rd1GjaSUPCz10LlRa4MWdSzbDb2gDUklnRSF3bynCPH0ttVitrKzA9oZc+/mbXH309tTRCv2sPL0XaxsO11RDTAioxUSvBy0180GCvhFnxoBAlZfuv9XtP9GZ20mQgPy9CjRRe1LyfH1gO0D1tubiREAnh4pWsS+lBCviRB0b22mAvU+PRIErGJHsAV83/7B7vDl7mh/dNAjA7lRHqAsd/N8d7FYfCEJgQlG5lFYn63NYM16I5A82InR5RpXhT2JFiqYT/w7mvffk1E/jvYu5uQjshMSjZvGO+xa5E7nYvHM+qni0MaOI/jWilt00OQuwoM95WymZRaQJ5hovY3JGRwQEXaJ8Pne99/vdUjpG3fLMtIXYit97zLpu61lOcjzwSps74Q6rSXkeQpr2td35DmUZbmp3XfQdXmu/kyCEEy3zbIQAH4fcVjD9e36G2Wl7RC5VgWvz97dellZuV9mUoWOwDewAmBwWhfC4A25qVZqxXT5DTTRihRFIWrNfPZq2SHkmIGnBHx1HEz554HBaQf9Cajl4XF3NtadxOAUb3iOrLZOl4SMzAXNkIKtsxk5fSJ6DET2Nr7DX5moJEUXCnSOW9Flg3VI+EPreOZ0qKuOuUXX24ywEEeu8c359NnRGO7zvRf8knsuvgDx9NR+B7PY6aMd1H12npQimC7JBNvf2s3QnCcXzRjvk2PeGQvrBsPFPfIErdDkWIgxFndl7dHS0N1O4KwOcaijlKoJJTDK+xED7hU3K72hc7lGzvy2uwwelXsUk0hnKKSN8ZQ+0bqjQ8CJw4AKkSOLY4Q4gIK2UYq/lOUbxB7B81EhhNN5YAWCAwZsYn1xsXuEilbonUyXLjRHKZUs67IJWk6aWSPFynDJd8lFIykUHlfonu6dFcTNAytQhHDzAudqyJGFGJNgvQDrbcEA8vQUQwezh2/Az1EZvVvzc++7TxfEuK+uIK65JgnUX5CNENrNUjiAY7qUKGLqB1EILMuwchQu+1IRbVB+3LU05EhSN0S2+WLqQv3ePLiJmR7DnSt4/2Z8GOC+zPYiqj2OGbvb+AMxZA/tR9tKPh5Y+jTUpmBgyaz31JRhQGvl5k/SRFeUU5VaHeXJYZJxGjbmDZOU50brvtH5Ijm8TUIIn36GADkN3ftoKZF7m9hshqWgXxEnSv1S6jVJOQaNxiZpwjEbygMT1ZLDRI8/YkarVYbQcRItzcHjDm8jlM9dJmnw25PDxCc1kzTBG1FWBJysZH2rfJIs44L3TdW0tFNZ/tEkUWkeSg9+5jQ/0FBGpcRT/VZTo8N3YmE7E/r7OllNkNMY4t4sjIJcLCwJRG29ZZWJIqsL8tjxppJm0YQP2G3vHGeDaLNSg+jw5bI9oxYlYYxYJGkiHZbd9g1nZvSnEzpDTZThwO6njv2ocYz4l9BA+Xg+J1F+MhYfNcIY+YyqmVafPH44ejEcDV8MRzRDyNN8Ph19710M+ozxhvxLzKO1vdvmVlPglMbgIeaM8LxtMcWHmfF0U869k+mzM10XOeXQUJgBp74/u6qiz9/NJTJ4gJuXaXLz8GZuINO7MaEPXxU4cVBXFRrItFFonncjdU9mc6ODg2WaLB7e3uIPub2v6fDmD+/uJ66EaKtE/hO4vni9TJPZw7j+ranV+A8ie/Bq2V6GK3f95Vjni8uot5YPAcaLguAmusjRkP1wV1+1qoY0DNUYXa7q+bHWBQq1RtH0cvShGoysOTLkQqh6PkMyh1sjj2dv7cpg9nlsKe+PK9FDacl6MzWeJwM4mnSsVPb4V8sEIiyn7JWGZ7zepa1ZjT/bC99Eo2fdeigqUWlD9BEFBgaHZVVwQdFcFgXhTff6AJp/bKg1lCQE4nUZF374qnjro5S8YBjUr8aBYOoN4K1QTUFGv/ABbm8bNmDuWC7h9pZOFc0lXbrLZdo20Fq9Br5XfYvBDOV1b1TThO3Apq0z1Js4l2Ti+IaQ++oiIKdKqullbYrlcnCHDdszejTd7pApnB1N8v+AYoTOkTo2OZpHSO7RxDtaGp4Rsz4LEW+mjDTWBXn07B4Q9kmsDVQOdQzkn33byLetx5agVJyvlR9n5HSKVHUYIHhwKBNCkc28ZmCsxIREmysJDV5LXduI3kzYxuTOCUJ6cZFq2vcTO9ThKq7u3gfrRFdRXdHx6ckjaMle7K7XRN7587v0c8Dx6QnVJspJcMUG8ME2lIikFT0QINcIrqWI5UuN+bbwgUdUTBGvNnuFpINQFbgLdxHKpV2LUdpmQZpK3jsTt8WrdES6dlQ1K0NFlnVY2R4dGYuGkKe6fgxXPkBJAdOaE6qObuWoGjkz09YWSmWdqX3QFfLaxHLKwBYEmaG1LZ0iVQioM38KqKwfLmAirEOTQq0kUd7UFONopsSbCo1EleFaEhj0pCPJfVib9ev0Pvz4XShZjnuIQjkmCfQTYw51xVzDktAUkMaTW936Wt0R1NbDCNIFzWWeId5eobFaAVVnmqlQ8lfPwux0aEse20wUHjSoCkpHEz4k4X1kojn173/+q4PXRrfzLmJ+BZHnlA98AEOOcXmGp1i7wYo0oO5jRPOh+cuqnUfYsdBcljpvBMk+nsdPqKrY2UYvOs1V6FigL5mP+clG39o06lgbPEdKUxpOJxKxna5ov3gjretUQMbig7v64UckOmYdHNjTIKkmnleLroA3eIVKy3Y6tgFlv3q2sXRXZOF+i9WbtG1YKqhiKgnXynqne7S/T3/6JG2eJIRJiXjE6JO6KBZ/StLHx8Tu9/h983or+j4XfvZRjn69ya5HJ8Q2G7TAvRMEj6M2Bb0yoPPabU6AubFDWakKqfAyku1ytL9/OSTaLtPkYB353usS3Yx5hog4N5reH1QFCqqHNwsQUyEVkP1rfkNqojHa3O+QfBpm9xHhoEeEl3eJcKQ4h8uvWk71Farfd6fd5Z1fnlC9KZlXvGJOpAfi/qS32W6736TFrDbSLZLDs9vkZldUctf3H55dLC/ShAirKZ5cacsYCzdLDpO9O+Fli+aa441nt551G260QuWUZ73jA4tK7l0Pk2W6OmKtx7wR2joxlWq6e++oi3ar7+k4PMV7G24DfJX8O1KEL9CzC5UmkthghoIMaKIgnfKPbWz923hWMeq9LpDdnslqaDpGpnvB5vWx5uHLTpT3LAZsOQbbhGDXRVWbfcU4aRMm7UQ+O4HPs5YhmxhjDDEOOTY3OjjgINbXQ472vHjNgZSDV0tmoTaokCT9wAGnOFbd3yTpu3VxUOO0hFGt5e1Tdj0TMjT1Tao4U2PC9OyIVTNi45W+4UaPZpxUE83MFE74uEL1nqxkktnr4d3YFxaZLpu3CRH83//8F4+InMHL/AmOawOVnqOZ1P6Bw6TAG0l2aeedXYysoCgLtLZYAJmjU35xl8spFytFYy8TlRjLQpISIjDtMw0dPWYH8FMbm3lmfN3WNRaku6DQmh+gkWFSO13yGvGinWtzNSGUUhAwpjdLZG5ZxDgE1UyojMI7XjbZVKEHd2Q+V0ZaBCFLAiYzHicTmUm+wbVyRmQOSqHElG2OlGNwRIUqvjgyekxekNVF7e18eveE6PwWOW05gHfkV/HGOcOCjo499ya+Tb2LFcQnPOgbkztb0fIyQ9tWexZ4jYZ1kXeQ66KASjvvtJLR1T1bmsgZoSxd6CG7E46mIV8wxHmNXCwGQLlLuuzIHCUGKKS68s/vzho2+wnHVjps44/z+fyOXnzeH/NX6Wb1mExb3Y6bciNr0e7w5uM56SU0pT2evEdzLbNogmxYc4+B98J9KXyoKwqbqORa47mQGSqLndvtzV9PvoNreDHYT9LOTfAIhPe+O3r77Q/vv6V56a7y8jcc7A/2OWmirSuF6iy18pR1VXQ7SdTty9fty9fty9fty9fty9c/ztvM7cvX7cvX7cvX7cvX7cvX7cvX7cvXJ0CK7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvX7cvXp/HQcPvydfvy9Ukx5Pbla3z5GspTyG7cqwohVad+zhcsna2+h71IkxlVNB2eJbe3lFj8QOXy1PxLjYbKoS7S5FoYSdFzLoZKY9EPFcRcIVWmvPXJgN1TWj/1fM+57JUaMKpZ8iPe8OnfC9stujo5fn+apEl831DqnMYYMaf3vGKeHCaktPntb1NXyu23SSHUtOYancTPS7VKonazfqHTFRc6hR+dUh+hFh0s+xVQfiv0P21s7YD/otz333Hx3w2479k4INA2QtMRXiyXy/8Dcc3lPw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{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,i.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:"Create Document"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,a.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,a.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.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,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,a.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.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,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.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,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.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.jsxs)("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)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,a.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,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.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,a.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,a.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,a.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,a.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,a.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,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,a.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,a.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,a.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,a.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,a.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,a.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}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sender_email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(l.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Document created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.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)(h.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)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.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)(h.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 f(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.b14fac44.js b/assets/js/2c586be5.b14fac44.js deleted file mode 100644 index 73061daca..000000000 --- a/assets/js/2c586be5.b14fac44.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:()=>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:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcJbg8IhRCh4c3IEoij03EJt0VhwGqao0BCUwjnkcT4YL6Ay+lrmUk0hF07AXLoZjIXFVweAKtM55jCRBQ7O1bk6ldUhfKgKLXJY6NrAybv/aWajZajtbGfnHY7rKXw42tm5+GrmXGUP9/ZEVQ10hcrKqSrE2A4yXe7lBFjlk+cpzGdokGaFTChAYWWxAJHnMJf5FJ1Nwc1QQaarBWRam1wq4dCmUIkpgqrLMRqbglA5lNogSAUCDIp8sev0bm0R/vf98Q8w0aYUbgAnRW3TZrlcGsxcsfDTuxk2u3pmIzWsM1JNUyjFFVFLOvilltkVbduiyukvDXxzcsS02tl5X1eVNg5z+Mlv4XBnh3q+wULPQRhk+EyXpVZQCSNKdHxcM+G42+AvtTSY+0MRRRFpcXiudmFnxy0qPNzZgSOVy4yIwRNSK+hJgB14UCISgb6vMJMTGUA7pAOtYD6T2YxpMhf+PKtCZB5Ng7bCzMlr7E98k8KCJn6HSkcMZtrIX7VyouDjuEbjZCaK7rERggRqnTCOyFlpqVxsDSvAP8Lx0OnxoQS+ItRyIlYpFfdYhGtR1GgDVvMUZoTVj1gZtMzqYV4ipMphhnI627ieyD/W1vUmhtoSml0swlrxlJi8yGSbiMIiyEmPlqW4ws5qoFmGRTGAbxaQ40TUhUtBEsc5U+MAftAORFUVMhPjAolzgYRHuNrgLp9yYIeAiBIln/EJSzRaEJDLyQQNCSd18hRhTMSO+KxVASw5biYUaLVy0JkutKHpV3iI2/uEhEwrh8oN4M21kAVj73drQaqsqHOEcSGyqxTGRY0pGMy95C6Q9FYatBCBgLCB6EwgsFgQG2pFG1A6LC8t2IBVPoDTmbStQFFnpDUvIm2XrEFsJ5pWJhpEGQMshSxSplwKH/UYnHQFpiSxlVCLlBQmpuDwxo31TQrZDLMr/mVELjWMa+e08hvLja5yPVeBmBOtnJW/rhHJ2PPpFB2lcJDCqxRepzDcT2E4SmF4kMLwVQrD1ymM9lMYjVIYHaQweuXRGr0OtBYNgbsIDEeeyu6PQ11SvN9Jy6JNGtM2SnjeU8LnajiAnZ1GoLj5559/Ple35wrgPCEBO08Oz5MG5DxJwfeR3jxPDocphIab8+QQXoy+jgAL+n5F1PXfc/oe0mn47xl9j4bnahkWHTEyTpTVPYhQ92+PRPwM/ESNvDK1Rd1GjaSUPCz10LlRa4MWdSzbDb2gDUklnRSF3bynCPH0ttVitrKzA9oZc+/mbXH309tTRCv2sPL0XaxsO11RDTAioxUSvBy0180GCvhFnxoBAlZfuv9XtP9GZ20mQgPy9CjRRe1LyfH1gO0D1tubiREAnh4pWsS+lBCviRB0b22mAvU+PRIErGJHsAV83/7B7vDl7mh/dNAjA7lRHqAsd/N8d7FYfCEJgQlG5lFYn63NYM16I5A82InR5RpXhT2JFiqYT/w7mvffk1E/jvYu5uQjshMSjZvGO+xa5E7nYvHM+qni0MaOI/jWilt00OQuwoM95WymZRaQJ5hovY3JGRwQEXaJ8Pne99/vdUjpG3fLMtIXYit97zLpu61lOcjzwSps74Q6rSXkeQpr2td35DmUZbmp3XfQdXmu/kyCEEy3zbIQAH4fcVjD9e36G2Wl7RC5VgWvz97dellZuV9mUoWOwDewAmBwWhfC4A25qVZqxXT5DTTRihRFIWrNfPZq2SHkmIGnBHx1HEz554HBaQf9Cajl4XF3NtadxOAUb3iOrLZOl4SMzAXNkIKtsxk5fSJ6DET2Nr7DX5moJEUXCnSOW9Flg3VI+EPreOZ0qKuOuUXX24ywEEeu8c359NnRGO7zvRf8knsuvgDx9NR+B7PY6aMd1H12npQimC7JBNvf2s3QnCcXzRjvk2PeGQvrBsPFPfIErdDkWIgxFndl7dHS0N1O4KwOcaijlKoJJTDK+xED7hU3K72hc7lGzvy2uwwelXsUk0hnKKSN8ZQ+0bqjQ8CJw4AKkSOLY4Q4gIK2UYq/lOUbxB7B81EhhNN5YAWCAwZsYn1xsXuEilbonUyXLjRHKZUs67IJWk6aWSPFynDJd8lFIykUHlfonu6dFcTNAytQhHDzAudqyJGFGJNgvQDrbcEA8vQUQwezh2/Az1EZvVvzc++7TxfEuK+uIK65JgnUX5CNENrNUjiAY7qUKGLqB1EILMuwchQu+1IRbVB+3LU05EhSN0S2+WLqQv3ePLiJmR7DnSt4/2Z8GOC+zPYiqj2OGbvb+AMxZA/tR9tKPh5Y+jTUpmBgyaz31JRhQGvl5k/SRFeUU5VaHeXJYZJxGjbmDZOU50brvtH5Ijm8TUIIn36GADkN3ftoKZF7m9hshqWgXxEnSv1S6jVJOQaNxiZpwjEbygMT1ZLDRI8/YkarVYbQcRItzcHjDm8jlM9dJmnw25PDxCc1kzTBG1FWBJysZH2rfJIs44L3TdW0tFNZ/tEkUWkeSg9+5jQ/0FBGpcRT/VZTo8N3YmE7E/r7OllNkNMY4t4sjIJcLCwJRG29ZZWJIqsL8tjxppJm0YQP2G3vHGeDaLNSg+jw5bI9oxYlYYxYJGkiHZbd9g1nZvSnEzpDTZThwO6njv2ocYz4l9BA+Xg+J1F+MhYfNcIY+YyqmVafPH44ejEcDV8MRzRDyNN8Ph19710M+ozxhvxLzKO1vdvmVlPglMbgIeaM8LxtMcWHmfF0U869k+mzM10XOeXQUJgBp74/u6qiz9/NJTJ4gJuXaXLz8GZuINO7MaEPXxU4cVBXFRrItFFonncjdU9mc6ODg2WaLB7e3uIPub2v6fDmD+/uJ66EaKtE/hO4vni9TJPZw7j+ranV+A8ie/Bq2V6GK3f95Vjni8uot5YPAcaLguAmusjRkP1wV1+1qoY0DNUYXa7q+bHWBQq1RtH0cvShGoysOTLkQqh6PkMyh1sjj2dv7cpg9nlsKe+PK9FDacl6MzWeJwM4mnSsVPb4V8sEIiyn7JWGZ7zepa1ZjT/bC99Eo2fdeigqUWlD9BEFBgaHZVVwQdFcFgXhTff6AJp/bKg1lCQE4nUZF374qnjro5S8YBjUr8aBYOoN4K1QTUFGv/ABbm8bNmDuWC7h9pZOFc0lXbrLZdo20Fq9Br5XfYvBDOV1b1TThO3Apq0z1Js4l2Ti+IaQ++oiIKdKqullbYrlcnCHDdszejTd7pApnB1N8v+AYoTOkTo2OZpHSO7RxDtaGp4Rsz4LEW+mjDTWBXn07B4Q9kmsDVQOdQzkn33byLetx5agVJyvlR9n5HSKVHUYIHhwKBNCkc28ZmCsxIREmysJDV5LXduI3kzYxuTOCUJ6cZFq2vcTO9ThKq7u3gfrRFdRXdHx6ckjaMle7K7XRN7587v0c8Dx6QnVJspJcMUG8ME2lIikFT0QINcIrqWI5UuN+bbwgUdUTBGvNnuFpINQFbgLdxHKpV2LUdpmQZpK3jsTt8WrdES6dlQ1K0NFlnVY2R4dGYuGkKe6fgxXPkBJAdOaE6qObuWoGjkz09YWSmWdqX3QFfLaxHLKwBYEmaG1LZ0iVQioM38KqKwfLmAirEOTQq0kUd7UFONopsSbCo1EleFaEhj0pCPJfVib9ev0Pvz4XShZjnuIQjkmCfQTYw51xVzDktAUkMaTW936Bm3bUXkPo8mFntoE6Q+h9wqN1YqatZkKJX/13Kw9J41xJooJG1hNWp0vXVR5xJlm6+MXLax///NfhCpz6mWp84Z77eMZ64RKeZ1tlJHTXPqNBfo69ZgUbJScTaNis8Fdo9yg4Rweb0tXtB+8kdZ1yg5jxv+uUP6IRM+sgwOb9yRKxGhq0ZWqBq9Q3thOx4aX7JesNublCgPebyZ6O7KNBQX9R3XYWlnv6Y729+lPn6TNO4AwKRGPuGtSF8XiT0n6+EDU/W62b15vut7nN88+ytGvN9n16ITYZoPo3TtBMPNrU1BpP53XbnMCHMXoUFaqQiq8jGS7HO3vXw6Jtss0OVhHvve6RDdjniEizo2mov+qQEFF6GYBYiqkAjI6zW9ITTRGm/u9gE/D7D4iHPSI8PIuEY4UJ075KcmpvkL1++60u7zzyxOqNyXziteDifRA3J/0Nttt95u0mNVGukVyeHab3OyKSu76/sOzi+VFmhBhNQVxK20ZY+FmyWGydyema9Fcc5Dv7NazbsONVqickpt3HE9Ryb3rYbJMV0esdVM3QlsnplJNd+8dddFu9T0dh6d4b8NtVK2Sf0cKqwV6dqHSRBIbzFCQ1UoUpFP+sQ1ofxvPKoaa10WP2zNZjQfHcHAvwrs+wDt82QmtnsUoKQc+m7jnulBms68YnGxik51wYyfaeNYyZBPYi3G9IQfERgcHHDn6esghlhevOXpx8GrJLNR68knS99Y5r7DqcyZJ35eKgxpPIYxqzV2fJ+vZbaGpb8e0M/fsht59veG6joaRVBPNnBKO77hC9Z7sThLI6+HdaBIWmS6bav8I/u9//otHxGPnZf4Ex7WBSs/RTGr/ZGBS4I0kS6/zci3GKlCUBVpbLIAMvCm/YcvllMt/ovmUiUqMZSFJwxCY9rH7jpKyA/ipjXY8M74S6hoLUkxQaM1PusjqqJ0ueY14i861uZoQSikIGNMrILTkp2AcgmomVEbWkhc8tkPoCRsZpJWRFkHIkoDJMMbJRGaSr2etnBGZg1IoMWWDIuWoFlGhim94jB6TX2F1UXvLmV4SITq/RU4EDuAdeSq8cc5ZoBOywNwbzTb1TkuQjfBEbkwOYkXLywxtWz9Z4DUaVjTe5ayLAirtvBtIFlX3bGkiZ4SydFuHfEk4moZ8wbTlNXKxGABlA+kmI4+GGKCQ6so/aDtr2OwnHFvpsI3ozefzO0rveX/MX6Wb1WMwWOl23JQbWUV2hzcfz0npoCnt8eQ9mmuZRftiw5p7DLwXLkPhg0dRCYlK/mV1AF1MhcxQWexcXW/+evIdXMOLwX6SdtT8IxDe++7o7bc/vP+W5qWLyMvfcLA/2Oc0hLauFKqz1Mrj0FXR7aQlt29Jt29Jt29Jt29Jt29J/zivHbdvSbdvSbdvSbdvSbdvSbdvSbdvSZ8AKbZvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSZ/G073tW9LtW9InxZDbt6TxLWmoPSG7ca8qhFSd4jhfjXS2+sL0Ik1mVK50eJbc3lJi8QMVoFPzLzUaqnW6SJNrYSRFz7nSKY0VPVTtcoVUdvLWJwN2T2n91PM957JXCryoIMmPeMOnfy9st6Lq5Pj9aZIm8cVAqXMaY8ScXsiKeXKYkNLm17RN0Si33yaFUNOaC3ASPy8VIonazfpVTFdcxRR+dOp4hFp0sOyXN/mt0P+0sbUD/oty33/HxX834L5n44BA2whNR3ixXC7/D1M7pvI=",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:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcJbg8IhRCh4c3IEoij03EJt0VhwGqao0BCUwjnkcT4YL6Ay+lrmUk0hF07AXLoZjIXFVweAKtM55jCRBQ7O1bk6ldUhfKgKLXJY6NrAybv/aWajZajtbGfnHY7rKXw42tm5+GrmXGUP9/ZEVQ10hcrKqSrE2A4yXe7lBFjlk+cpzGdokGaFTChAYWWxAJHnMJf5FJ1Nwc1QQaarBWRam1wq4dCmUIkpgqrLMRqbglA5lNogSAUCDIp8sev0bm0R/vf98Q8w0aYUbgAnRW3TZrlcGsxcsfDTuxk2u3pmIzWsM1JNUyjFFVFLOvilltkVbduiyukvDXxzcsS02tl5X1eVNg5z+Mlv4XBnh3q+wULPQRhk+EyXpVZQCSNKdHxcM+G42+AvtTSY+0MRRRFpcXiudmFnxy0qPNzZgSOVy4yIwRNSK+hJgB14UCISgb6vMJMTGUA7pAOtYD6T2YxpMhf+PKtCZB5Ng7bCzMlr7E98k8KCJn6HSkcMZtrIX7VyouDjuEbjZCaK7rERggRqnTCOyFlpqVxsDSvAP8Lx0OnxoQS+ItRyIlYpFfdYhGtR1GgDVvMUZoTVj1gZtMzqYV4ipMphhnI627ieyD/W1vUmhtoSml0swlrxlJi8yGSbiMIiyEmPlqW4ws5qoFmGRTGAbxaQ40TUhUtBEsc5U+MAftAORFUVMhPjAolzgYRHuNrgLp9yYIeAiBIln/EJSzRaEJDLyQQNCSd18hRhTMSO+KxVASw5biYUaLVy0JkutKHpV3iI2/uEhEwrh8oN4M21kAVj73drQaqsqHOEcSGyqxTGRY0pGMy95C6Q9FYatBCBgLCB6EwgsFgQG2pFG1A6LC8t2IBVPoDTmbStQFFnpDUvIm2XrEFsJ5pWJhpEGQMshSxSplwKH/UYnHQFpiSxlVCLlBQmpuDwxo31TQrZDLMr/mVELjWMa+e08hvLja5yPVeBmBOtnJW/rhHJ2PPpFB2lcJDCqxRepzDcT2E4SmF4kMLwVQrD1ymM9lMYjVIYHaQweuXRGr0OtBYNgbsIDEeeyu6PQ11SvN9Jy6JNGtM2SnjeU8LnajiAnZ1GoLj5559/Ple35wrgPCEBO08Oz5MG5DxJwfeR3jxPDocphIab8+QQXoy+jgAL+n5F1PXfc/oe0mn47xl9j4bnahkWHTEyTpTVPYhQ92+PRPwM/ESNvDK1Rd1GjaSUPCz10LlRa4MWdSzbDb2gDUklnRSF3bynCPH0ttVitrKzA9oZc+/mbXH309tTRCv2sPL0XaxsO11RDTAioxUSvBy0180GCvhFnxoBAlZfuv9XtP9GZ20mQgPy9CjRRe1LyfH1gO0D1tubiREAnh4pWsS+lBCviRB0b22mAvU+PRIErGJHsAV83/7B7vDl7mh/dNAjA7lRHqAsd/N8d7FYfCEJgQlG5lFYn63NYM16I5A82InR5RpXhT2JFiqYT/w7mvffk1E/jvYu5uQjshMSjZvGO+xa5E7nYvHM+qni0MaOI/jWilt00OQuwoM95WymZRaQJ5hovY3JGRwQEXaJ8Pne99/vdUjpG3fLMtIXYit97zLpu61lOcjzwSps74Q6rSXkeQpr2td35DmUZbmp3XfQdXmu/kyCEEy3zbIQAH4fcVjD9e36G2Wl7RC5VgWvz97dellZuV9mUoWOwDewAmBwWhfC4A25qVZqxXT5DTTRihRFIWrNfPZq2SHkmIGnBHx1HEz554HBaQf9Cajl4XF3NtadxOAUb3iOrLZOl4SMzAXNkIKtsxk5fSJ6DET2Nr7DX5moJEUXCnSOW9Flg3VI+EPreOZ0qKuOuUXX24ywEEeu8c359NnRGO7zvRf8knsuvgDx9NR+B7PY6aMd1H12npQimC7JBNvf2s3QnCcXzRjvk2PeGQvrBsPFPfIErdDkWIgxFndl7dHS0N1O4KwOcaijlKoJJTDK+xED7hU3K72hc7lGzvy2uwwelXsUk0hnKKSN8ZQ+0bqjQ8CJw4AKkSOLY4Q4gIK2UYq/lOUbxB7B81EhhNN5YAWCAwZsYn1xsXuEilbonUyXLjRHKZUs67IJWk6aWSPFynDJd8lFIykUHlfonu6dFcTNAytQhHDzAudqyJGFGJNgvQDrbcEA8vQUQwezh2/Az1EZvVvzc++7TxfEuK+uIK65JgnUX5CNENrNUjiAY7qUKGLqB1EILMuwchQu+1IRbVB+3LU05EhSN0S2+WLqQv3ePLiJmR7DnSt4/2Z8GOC+zPYiqj2OGbvb+AMxZA/tR9tKPh5Y+jTUpmBgyaz31JRhQGvl5k/SRFeUU5VaHeXJYZJxGjbmDZOU50brvtH5Ijm8TUIIn36GADkN3ftoKZF7m9hshqWgXxEnSv1S6jVJOQaNxiZpwjEbygMT1ZLDRI8/YkarVYbQcRItzcHjDm8jlM9dJmnw25PDxCc1kzTBG1FWBJysZH2rfJIs44L3TdW0tFNZ/tEkUWkeSg9+5jQ/0FBGpcRT/VZTo8N3YmE7E/r7OllNkNMY4t4sjIJcLCwJRG29ZZWJIqsL8tjxppJm0YQP2G3vHGeDaLNSg+jw5bI9oxYlYYxYJGkiHZbd9g1nZvSnEzpDTZThwO6njv2ocYz4l9BA+Xg+J1F+MhYfNcIY+YyqmVafPH44ejEcDV8MRzRDyNN8Ph19710M+ozxhvxLzKO1vdvmVlPglMbgIeaM8LxtMcWHmfF0U869k+mzM10XOeXQUJgBp74/u6qiz9/NJTJ4gJuXaXLz8GZuINO7MaEPXxU4cVBXFRrItFFonncjdU9mc6ODg2WaLB7e3uIPub2v6fDmD+/uJ66EaKtE/hO4vni9TJPZw7j+ranV+A8ie/Bq2V6GK3f95Vjni8uot5YPAcaLguAmusjRkP1wV1+1qoY0DNUYXa7q+bHWBQq1RtH0cvShGoysOTLkQqh6PkMyh1sjj2dv7cpg9nlsKe+PK9FDacl6MzWeJwM4mnSsVPb4V8sEIiyn7JWGZ7zepa1ZjT/bC99Eo2fdeigqUWlD9BEFBgaHZVVwQdFcFgXhTff6AJp/bKg1lCQE4nUZF374qnjro5S8YBjUr8aBYOoN4K1QTUFGv/ABbm8bNmDuWC7h9pZOFc0lXbrLZdo20Fq9Br5XfYvBDOV1b1TThO3Apq0z1Js4l2Ti+IaQ++oiIKdKqullbYrlcnCHDdszejTd7pApnB1N8v+AYoTOkTo2OZpHSO7RxDtaGp4Rsz4LEW+mjDTWBXn07B4Q9kmsDVQOdQzkn33byLetx5agVJyvlR9n5HSKVHUYIHhwKBNCkc28ZmCsxIREmysJDV5LXduI3kzYxuTOCUJ6cZFq2vcTO9ThKq7u3gfrRFdRXdHx6ckjaMle7K7XRN7587v0c8Dx6QnVJspJcMUG8ME2lIikFT0QINcIrqWI5UuN+bbwgUdUTBGvNnuFpINQFbgLdxHKpV2LUdpmQZpK3jsTt8WrdES6dlQ1K0NFlnVY2R4dGYuGkKe6fgxXPkBJAdOaE6qObuWoGjkz09YWSmWdqX3QFfLaxHLKwBYEmaG1LZ0iVQioM38KqKwfLmAirEOTQq0kUd7UFONopsSbCo1EleFaEhj0pCPJfVib9ev0Pvz4XShZjnuIQjkmCfQTYw51xVzDktAUkMaTW936Bm3bUXkPo8mFntoE6Q+h9wqN1YqatZkKJX/13Kw9J41xJooJG1hNWp0vXVR5xJlm6+MXLax///NfhCpz6mWp84Z77eMZ64RKeZ1tlJHTXPqNBfo69ZgUbJScTaNis8Fdo9yg4Rweb0tXtB+8kdZ1yg5jxv+uUP6IRM+sgwOb9yRKxGhq0ZWqBq9Q3thOx4aX7JesNublCgPebyZ6O7KNBQX9R3XYWlnv6Y729+lPn6TNO4AwKRGPuGtSF8XiT0n6+EDU/W62b15vut7nN88+ytGvN9n16ITYZoPo3TtBMPNrU1BpP53XbnMCHMXoUFaqQiq8jGS7HO3vXw6Jtss0OVhHvve6RDdjniEizo2mov+qQEFF6GYBYiqkAjI6zW9ITTRGm/u9gE/D7D4iHPSI8PIuEY4UJ075KcmpvkL1++60u7zzyxOqNyXziteDifRA3J/0Nttt95u0mNVGukVyeHab3OyKSu76/sOzi+VFmhBhNQVxK20ZY+FmyWGydyema9Fcc5Dv7NazbsONVqickpt3HE9Ryb3rYbJMV0esdVM3QlsnplJNd+8dddFu9T0dh6d4b8NtVK2Sf0cKqwV6dqHSRBIbzFCQ1UoUpFP+sQ1ofxvPKoaa10WP2zNZjQfHcHAvwrs+wDt82QmtnsUoKQc+m7jnulBms68YnGxik51wYyfaeNYyZBPYi3G9IQfERgcHHDn6esghlhevOXpx8GrJLNR68knS99Y5r7DqcyZJ35eKgxpPIYxqzV2fJ+vZbaGpb8e0M/fsht59veG6joaRVBPNnBKO77hC9Z7sThLI6+HdaBIWmS6bav8I/u9//otHxGPnZf4Ex7WBSs/RTGr/ZGBS4I0kS6/zci3GKlCUBVpbLIAMvCm/YcvllMt/ovmUiUqMZSFJwxCY9rH7jpKyA/ipjXY8M74S6hoLUkxQaM1PusjqqJ0ueY14i861uZoQSikIGNMrILTkp2AcgmomVEbWkhc8tkPoCRsZpJWRFkHIkoDJMMbJRGaSr2etnBGZg1IoMWWDIuWoFlGhim94jB6TX2F1UXvLmV4SITq/RU4EDuAdeSq8cc5ZoBOywNwbzTb1TkuQjfBEbkwOYkXLywxtWz9Z4DUaVjTe5ayLAirtvBtIFlX3bGkiZ4SydFuHfEk4moZ8wbTlNXKxGABlA+kmI4+GGKCQ6so/aDtr2OwnHFvpsI3ozefzO0rveX/MX6Wb1WMwWOl23JQbWUV2hzcfz0npoCnt8eQ9mmuZRftiw5p7DLwXLkPhg0dRCYlK/mV1AF1MhcxQWexcXW/+evIdXMOLwX6SdtT8IxDe++7o7bc/vP+W5qWLyMvfcLA/2Oc0hLauFKqz1Mrj0FXR7aQlt29Jt29Jt29Jt29Jt29J/zivHbdvSbdvSbdvSbdvSbdvSbdvSbdvSZ8AKbZvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSbdvSZ/G073tW9LtW9InxZDbt6TxLWmoPSG7ca8qhFSd4jhfjXS2+sL0Ik1mVK50eJbc3lJi8QMVoFPzLzUaqnW6SJNrYSRFz7nSKY0VPVTtcoVUdvLWJwN2T2n91PM957JXCryoIMmPeMOnfy9st6Lq5Pj9aZIm8cVAqXMaY8ScXsiKeXKYkNLm17RN0Si33yaFUNOaC3ASPy8VIonazfpVTFdcxRR+dOp4hFp0sOyXN/mt0P+0sbUD/oty33/HxX834L5n44BA2whNR3ixXC7/D1M7pvI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},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:"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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\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/a9f09360.043a10be.js b/assets/js/a9f09360.043a10be.js new file mode 100644 index 000000000..1e1f56558 --- /dev/null +++ b/assets/js/a9f09360.043a10be.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8888],{63135:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcI7IyYOIhC8OTkCURR6bqG2aCw4DVNUaIRDUDiHPE4H4wVURl/LXKop5MIJmEs3g7Gw+OoAUGU6xxwmssDBuTpXp7I6hA9VoUUOC10bOHn3P81stAy1ne3svMNxPYUPRzs7F1/NnKvs4d6eqKqBrlBZOVWFGNtBpsu9nACrfPI8hfkMDdKskAkFKKwsFiDyHOYyn6KzKbgZKsh0tYBMa5NLJRzaFCoxRVB1OUZjUxAqh1IbBKlAgEGRL3ad3q0twv++P/4BJtqUwg3gpKht2iyXS4OZKxZ+ejfDZlfPbKSGdUaqaQqluCJqSQe/1DK7om1bVDn9pYFvTo6YVjs77+uq0sZhDj/5LRzu7FDPN1joOQiDDJ/pstQKKmFEiY6PayYcdxv8pZYGc38ooigiLQ7P1S7s7LhFhYc7O3CkcpkRMXhCagU9CbADD0pEItD3FWZyIgNoh3SgFcxnMpsxTebCn2dViMyjadBWmDl5jf2Jb1JY0MTvUOmIwUwb+atWThR8HNdonMxE0T02QpBArRPGETkrLZWLrWEF+Ec4Hjo9PpTAV4RaTsQqpeIei3AtihptwGqewoyw+hErg5ZZPcxLhFQ5zFBOZxvXE/nH2rrexFBbQrOLRVgrnhKTF5lsE1FYBDnp0bIUV9hZDTSLsCgG8M0CcpyIunApSOI4Z2ocwA/agaiqQmZiXCBxLpDwCFcb3OVTDuwQEFGi5DM+YYlGCwJyOZmgIeGkTp4ijInYEZ+1KoAlx82EAq1WDjrThTY0/QoPcXufkJBp5VC5Aby5FrJg7P1uLUiVFXWOMC5EdpXCuKgxBYO5l9wFkt5KgxYiEBA2EJ0JBBYLYkOtaANKh+WlBRuwygdwOpO2FSjqjLTmRaTtkjWI7UTTykSDKGOApZBFypRL4aMeg5OuwJQkthJqkZLCxBQc3rixvkkhm2F2xb+MyKWGce2cVn5judFVrucqEHOilbPy1zUiGXs+naKjFA5SeJXC6xSG+ykMRykMD1IYvkph+DqF0X4Ko1EKo4MURq88WqPXgdaiIXAXgeHIU9n9cahLivc7aVm0SWPaRgnPe0r4XA0HsLPTCBQ3//zzz+fq9lwBnCckYOfJ4XnSgJwnKfg+0pvnyeEwhdBwc54cwovR1xFgQd+viLr+e07fQzoN/z2j79HwXC3DoiNGxomyugcR6v7tkYifgZ+okVemtqjbqJGUkoelHjo3am3Qoo5lu6EXtCGppJOisJv3FCGe3rZazFZ2dkA7Y+7dvC3ufnp7imjFHlaevouVbacrqgFGZLRCgpeD9rrZQAG/6FMjQMDqS/f/ivbf6KzNRGhAnh4luqh9KTm+HrB9wHp7MzECwNMjRYvYlxLiNRGC7q3NVKDep0eCgFXsCLaA79s/2B2+3B3tjw56ZCA3ygOU5W6e7y4Wiy8kITDByDwK67O1GaxZbwSSBzsxulzjqrAn0UIF84l/R/P+ezLqx9HexZx8RHZConHTeIddi9zpXCyeWT9VHNrYcQTfWnGLDprcRXiwp5zNtMwC8gQTrbcxOYMDIsIuET7f+/77vQ4pfeNuWUb6Qmyl710mfbe1LAd5PliF7Z1Qp7WEPE9hTfv6jjyHsiw3tfsOui7P1Z9JEILptlkWAsDvIw5ruL5df6OstB0i16rg9dm7Wy8rK/fLTKrQEfgGVgAMTutCGLwhN9VKrZguv4EmWpGiKEStmc9eLTuEHDPwlICvjoMp/zwwOO2gPwG1PDzuzsa6kxic4g3PkdXW6ZKQkbmgGVKwdTYjp09Ej4HI3sZ3+CsTlaToQoHOcSu6bLAOCX9oHc+cDnXVMbfoepsRFuLINb45nz47GsN9vveCX3LPxRcgnp7a72AWO320g7rPzpNSBNMlmWD7W7sZmvPkohnjfXLMO2Nh3WC4uEeeoBWaHAsxxuKurD1aGrrbCZzVIQ51lFI1oQRGeT9iwL3iZqU3dC7XyJnfdpfBo3KPYhLpDIW0MZ7SJ1p3dAg4cRhQIXJkcYwQB1DQNkrxl7J8g9gjeD4qhHA6D6xAcMCATawvLnaPUNEKvZPp0oXmKKWSZV02QctJM2ukWBku+S65aCSFwuMK3dO9s4K4eWAFihBuXuBcDTmyEGMSrBdgvS0YQJ6eYuhg9vAN+Dkqo3drfu599+mCGPfVFcQ11ySB+guyEUK7WQoHcEyXEkVM/SAKgWUZVo7CZV8qog3Kj7uWhhxJ6obINl9MXajfmwc3MdNjuHMF79+MDwPcl9leRLXHMWN3G38ghuyh/WhbyccDS5+G2hQMLJn1npoyDGit3PxJmuiKcqpSq6M8OUxyysLGtGGS8tRo3Tc6XySHt0mI4NPPEB+nkXsfLaVxbxObzbAU9CuiRIlfyrwmacKBGsr9EqmSw0SPP2JGa1SGcHASLY1k6MPbCOUTlkkanPXkMPGZzCRN8EaUFQEnK6neKp8ky7jgfVM1Le1Uln80mVOah3KCnznNDzSUUSnxVL/V1OjwnVjYzoT+kk5Wk+I0hlg2C6MgFwtLUlBbb05losjqgtx0vKmkWTQxA/bVO4fYINqs1CA6fLlMOTmApouSMEYskjSRDstu+4YzM/rTCZ2hJspwNPdTx37UOEb8S2igJDyfkyg/GYuPGmGMfEbVTKtPHj8cvRiOhi+GI5ohJGc+n46+9y4GfcZ4Q04l5tHE3m0TqilwHmPwEHNGeN62mOLDzHi6KdHeSe/Zma6LnBJnKMyA892fXUrR5+/m5hg8wM3LNLl5eDM3kOndmMWHrwqcOKirCg1k2ig0z7vhuSezudHBwTJNFg9vb/GH3N7XdHjzh3f3E5c/tKUh/wlcX7xepsnsYVz/1hRo/AeRPXi1bC/DJDMoHMbL4XKs88Vl1FvLhwDjRUFwE13kaMhouKuvWlVDGoYKiy5X9fxY6wKFWqNoeon5UAJGJhxZbyE+PZ8h2cCtZcezt8ZksPU8tpTsx5WQobRkspkaz5MBHE06pim7+au1ARGW8/RKwzNe79LWrMaf7YVvotGzbhEU1aW0cfmIAgODw7IquIpoLouC8KZ7fQDNP7bOGkoSAvG6jAs/fFW89aFJXjAM6pfgQDDwBvBWqKYKo1/tALe3DRswdyyXcHtLp4rmki7d5TJtG2itXgPfq77FYIbyujeqacJ2YNPWGepNnEsycXxDSHh1EZBTJdX0sjbFcjm4w4btGT2abnfIFM6OJvl/QDFC50gdmxzNIyT3aOK9Kw3PiFmfhTA3U0Ya64I8enYPCPvM1QYqh+IFcsq+beTb1mNLUCrO18qPM3I6RSo1DBA8ONQGochmXjMwVmJCos3lgwavpa5tRG8mbGNy5wQhvbhINe07hx3qcOlWd++DdaKrqJjo+PTkEbRk13XXayLv8fld+jng+PSEChLlJDhgA/hgG0pE0ooeCJBrBNdSxJqlxnxb+GgjKqaIV5u96tFBKAXchbsI5dKuxShtUx9N+e6diduKVToiXTsqlZWhDMs6rGyPjoxFQ8hTXT+GKx+gpIBpzVlUR7dyVI2cjmkLCqWyztQ+0gp5bWINZWALgszQ2pZOkSoE1Jk/BVTWDxcwEdahSaFWkihvagpsNFPiTYVGospwLQkMetKR5D6szfrFeR9+/C7UKcc9RKEckwT6iTGHumKuYUloqkbjya1ufa3uCGrrYQTpgubazhBkr9BYrYBKMs1UKPmrZ2F2OrQlj20mCg8aVAXloAkfkvA+MtGc+vc//9XBa6PbeRcxv4LIc0oCPoAhB7Y8w1OA3WBFGlD3MaL50Pxl1c4j7FhoLkudN4JkH8/jJ1RK7GyjF53m0nMs0NfJx6Rko29tGnWsDZ4j5SYN5xCJ2E5XtF+8kdZ1yh5jxcFd/fAjEh2zDg7saZBUE8+rRVfAG7xCeWU7HduAsl8y21i6K7LQsVh7sSt/0bNF28aigiamMnCtrPe5R/v79KdP0eYZQrCCiXbE55O6KBZ/StLHB8Lud/gbbOVaO/o+J372UY5+vcmuRyfEOBv0wL0TBJ+jNgU9LiDB2G3OgPmxQ1upCqnwkkl8mevs0qC9HO3vXw6Jxss0OVhHxve6RDdj1iFizo2mtwdVgYJq4c0CxFRIBWQGm9+QqmiMNvf7JZ+G2RpKRB66POgR4eVdIhwpzt/yi5ZTfYXq991pd3nnlydUb0pmGK+fE+mBuD/pbbbb7jdpMauNdIvk8Ow2udkVldz1/YdnF8uLNCHCaoolV9oyxsLNksNkbzW0bNFcc9Tx7Nazb8ORVqicUqx3PGFRyb3rYbJMV0es9Zs3QlsnplJNd+8dddHu9D2dhid4b79tmK+Sf0eK8wVydqHSRBIXzFCQGU0EpEP+sY2rfxuPKsa+14Wz2yNZDVDH+HQv5Lw+4jx82Yn1nsWwLUdim0Dsuthqs68YLW2CpZ34Zyf8edbyYxNpjIHGIUfoRgcHHMr6esgxnxevOZxy8GrJHNSGFpKkHz7g7MaqE5wkfecuDmpclzCqtb99tq5nSIamvmEVZ2oMmZ41sWpMbLzYN9zr0ZiTaqKZmcIJH1eo3pOtTCJ7PbwbAcMi02XzLCGC//uf/+IRkTN4mT/BcW2g0nM0k9q/bZgUeCPJOu08sYvxFRRlgdYWCyCjdMqP7XI55TqlaPJlohJjWUjSQQSmfb6ho8bsAH5qIzTPjC/ZusaCVBcUWvPbMzJPaqdLXiPet3NtriaEUgoCxvRciYwuixiHoJoJlVGQx8smGyz01o6M6MpIiyBkScBkzONkIjPJF7lWzojMQSmUmLLlkXIkjqhQxcdGRo/JF7K6qL21T0+eEJ3fImcsB/COvCveOOdZ0NGx597Qt6l3tIL4hLd8Y3JqK1peZmjbQs8Cr9GwLvJucl0UUGnnXVcyvbpnSxM5I5SlSz3keMLRNOQL5jivkYvFAChtSXcdGaXEAIVUV/7l3VnDZj/h2EqHbRRyPp/f0YvP+2P+Kt2sHpOBq9txU25kLdod3nw8J72EprTHk/dormUWzZANa+4x8F64LoUPeEVhE5Vca0IXMkNlsXO5vfnryXdwDS8G+0nauQkegfDed0dvv/3h/bc0L91VXv6Gg/3BPqdOtHWlUJ2l+o9YVyW3kz/dPnndPnndPnndPnndPnn9wzzK3D553T553T553T553T553T553T55fQKk2D553T553T553T553T553T553T553T553T553T553T553T55fRovDLdPXrdPXp8UQ26fvMYnr6E4hezGvaoQUnUq6Hy10tnKQ9iLNJlRNdPhWXJ7S3nFD1QxT82/1GioFOoiTa6FkRQ850KoNFb8UDXMFVJZylufC9g9peVTz/acyF6p/6KCJT/iDR/+vbDdgquT4/enSZrEJw6lzmmMEXN6yCvmyWFCOpvf/Dalpdx+mxRCTWsu0En8vFSoJGo361c5XXGVU/jRqfMRatHBsl/+5LdC/9PG1g74L0p9/x0X/92A+56NAwJtIzSd4MVyufw/pwniXw==",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/draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/draftdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftdocument",permalink:"/docs/API-docs/draftdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcI7IyYOIhC8OTkCURR6bqG2aCw4DVNUaIRDUDiHPE4H4wVURl/LXKop5MIJmEs3g7Gw+OoAUGU6xxwmssDBuTpXp7I6hA9VoUUOC10bOHn3P81stAy1ne3svMNxPYUPRzs7F1/NnKvs4d6eqKqBrlBZOVWFGNtBpsu9nACrfPI8hfkMDdKskAkFKKwsFiDyHOYyn6KzKbgZKsh0tYBMa5NLJRzaFCoxRVB1OUZjUxAqh1IbBKlAgEGRL3ad3q0twv++P/4BJtqUwg3gpKht2iyXS4OZKxZ+ejfDZlfPbKSGdUaqaQqluCJqSQe/1DK7om1bVDn9pYFvTo6YVjs77+uq0sZhDj/5LRzu7FDPN1joOQiDDJ/pstQKKmFEiY6PayYcdxv8pZYGc38ooigiLQ7P1S7s7LhFhYc7O3CkcpkRMXhCagU9CbADD0pEItD3FWZyIgNoh3SgFcxnMpsxTebCn2dViMyjadBWmDl5jf2Jb1JY0MTvUOmIwUwb+atWThR8HNdonMxE0T02QpBArRPGETkrLZWLrWEF+Ec4Hjo9PpTAV4RaTsQqpeIei3AtihptwGqewoyw+hErg5ZZPcxLhFQ5zFBOZxvXE/nH2rrexFBbQrOLRVgrnhKTF5lsE1FYBDnp0bIUV9hZDTSLsCgG8M0CcpyIunApSOI4Z2ocwA/agaiqQmZiXCBxLpDwCFcb3OVTDuwQEFGi5DM+YYlGCwJyOZmgIeGkTp4ijInYEZ+1KoAlx82EAq1WDjrThTY0/QoPcXufkJBp5VC5Aby5FrJg7P1uLUiVFXWOMC5EdpXCuKgxBYO5l9wFkt5KgxYiEBA2EJ0JBBYLYkOtaANKh+WlBRuwygdwOpO2FSjqjLTmRaTtkjWI7UTTykSDKGOApZBFypRL4aMeg5OuwJQkthJqkZLCxBQc3rixvkkhm2F2xb+MyKWGce2cVn5judFVrucqEHOilbPy1zUiGXs+naKjFA5SeJXC6xSG+ykMRykMD1IYvkph+DqF0X4Ko1EKo4MURq88WqPXgdaiIXAXgeHIU9n9cahLivc7aVm0SWPaRgnPe0r4XA0HsLPTCBQ3//zzz+fq9lwBnCckYOfJ4XnSgJwnKfg+0pvnyeEwhdBwc54cwovR1xFgQd+viLr+e07fQzoN/z2j79HwXC3DoiNGxomyugcR6v7tkYifgZ+okVemtqjbqJGUkoelHjo3am3Qoo5lu6EXtCGppJOisJv3FCGe3rZazFZ2dkA7Y+7dvC3ufnp7imjFHlaevouVbacrqgFGZLRCgpeD9rrZQAG/6FMjQMDqS/f/ivbf6KzNRGhAnh4luqh9KTm+HrB9wHp7MzECwNMjRYvYlxLiNRGC7q3NVKDep0eCgFXsCLaA79s/2B2+3B3tjw56ZCA3ygOU5W6e7y4Wiy8kITDByDwK67O1GaxZbwSSBzsxulzjqrAn0UIF84l/R/P+ezLqx9HexZx8RHZConHTeIddi9zpXCyeWT9VHNrYcQTfWnGLDprcRXiwp5zNtMwC8gQTrbcxOYMDIsIuET7f+/77vQ4pfeNuWUb6Qmyl710mfbe1LAd5PliF7Z1Qp7WEPE9hTfv6jjyHsiw3tfsOui7P1Z9JEILptlkWAsDvIw5ruL5df6OstB0i16rg9dm7Wy8rK/fLTKrQEfgGVgAMTutCGLwhN9VKrZguv4EmWpGiKEStmc9eLTuEHDPwlICvjoMp/zwwOO2gPwG1PDzuzsa6kxic4g3PkdXW6ZKQkbmgGVKwdTYjp09Ej4HI3sZ3+CsTlaToQoHOcSu6bLAOCX9oHc+cDnXVMbfoepsRFuLINb45nz47GsN9vveCX3LPxRcgnp7a72AWO320g7rPzpNSBNMlmWD7W7sZmvPkohnjfXLMO2Nh3WC4uEeeoBWaHAsxxuKurD1aGrrbCZzVIQ51lFI1oQRGeT9iwL3iZqU3dC7XyJnfdpfBo3KPYhLpDIW0MZ7SJ1p3dAg4cRhQIXJkcYwQB1DQNkrxl7J8g9gjeD4qhHA6D6xAcMCATawvLnaPUNEKvZPp0oXmKKWSZV02QctJM2ukWBku+S65aCSFwuMK3dO9s4K4eWAFihBuXuBcDTmyEGMSrBdgvS0YQJ6eYuhg9vAN+Dkqo3drfu599+mCGPfVFcQ11ySB+guyEUK7WQoHcEyXEkVM/SAKgWUZVo7CZV8qog3Kj7uWhhxJ6obINl9MXajfmwc3MdNjuHMF79+MDwPcl9leRLXHMWN3G38ghuyh/WhbyccDS5+G2hQMLJn1npoyDGit3PxJmuiKcqpSq6M8OUxyysLGtGGS8tRo3Tc6XySHt0mI4NPPEB+nkXsfLaVxbxObzbAU9CuiRIlfyrwmacKBGsr9EqmSw0SPP2JGa1SGcHASLY1k6MPbCOUTlkkanPXkMPGZzCRN8EaUFQEnK6neKp8ky7jgfVM1Le1Uln80mVOah3KCnznNDzSUUSnxVL/V1OjwnVjYzoT+kk5Wk+I0hlg2C6MgFwtLUlBbb05losjqgtx0vKmkWTQxA/bVO4fYINqs1CA6fLlMOTmApouSMEYskjSRDstu+4YzM/rTCZ2hJspwNPdTx37UOEb8S2igJDyfkyg/GYuPGmGMfEbVTKtPHj8cvRiOhi+GI5ohJGc+n46+9y4GfcZ4Q04l5tHE3m0TqilwHmPwEHNGeN62mOLDzHi6KdHeSe/Zma6LnBJnKMyA892fXUrR5+/m5hg8wM3LNLl5eDM3kOndmMWHrwqcOKirCg1k2ig0z7vhuSezudHBwTJNFg9vb/GH3N7XdHjzh3f3E5c/tKUh/wlcX7xepsnsYVz/1hRo/AeRPXi1bC/DJDMoHMbL4XKs88Vl1FvLhwDjRUFwE13kaMhouKuvWlVDGoYKiy5X9fxY6wKFWqNoeon5UAJGJhxZbyE+PZ8h2cCtZcezt8ZksPU8tpTsx5WQobRkspkaz5MBHE06pim7+au1ARGW8/RKwzNe79LWrMaf7YVvotGzbhEU1aW0cfmIAgODw7IquIpoLouC8KZ7fQDNP7bOGkoSAvG6jAs/fFW89aFJXjAM6pfgQDDwBvBWqKYKo1/tALe3DRswdyyXcHtLp4rmki7d5TJtG2itXgPfq77FYIbyujeqacJ2YNPWGepNnEsycXxDSHh1EZBTJdX0sjbFcjm4w4btGT2abnfIFM6OJvl/QDFC50gdmxzNIyT3aOK9Kw3PiFmfhTA3U0Ya64I8enYPCPvM1QYqh+IFcsq+beTb1mNLUCrO18qPM3I6RSo1DBA8ONQGochmXjMwVmJCos3lgwavpa5tRG8mbGNy5wQhvbhINe07hx3qcOlWd++DdaKrqJjo+PTkEbRk13XXayLv8fld+jng+PSEChLlJDhgA/hgG0pE0ooeCJBrBNdSxJqlxnxb+GgjKqaIV5u96tFBKAXchbsI5dKuxShtUx9N+e6diduKVToiXTsqlZWhDMs6rGyPjoxFQ8hTXT+GKx+gpIBpzVlUR7dyVI2cjmkLCqWyztQ+0gp5bWINZWALgszQ2pZOkSoE1Jk/BVTWDxcwEdahSaFWkihvagpsNFPiTYVGospwLQkMetKR5D6szfrFeR9+/C7UKcc9RKEckwT6iTGHumKuYUloqkbjya1ufa3uCGrrYQTpgubazhBkr9BYrYBKMs1UKPmrZ2F2OrQlj20mCg8aVAXloAkfkvA+MtGc+vc//9XBa6PbeRcxv4LIc0oCPoAhB7Y8w1OA3WBFGlD3MaL50Pxl1c4j7FhoLkudN4JkH8/jJ1RK7GyjF53m0nMs0NfJx6Rko29tGnWsDZ4j5SYN5xCJ2E5XtF+8kdZ1yh5jxcFd/fAjEh2zDg7saZBUE8+rRVfAG7xCeWU7HduAsl8y21i6K7LQsVh7sSt/0bNF28aigiamMnCtrPe5R/v79KdP0eYZQrCCiXbE55O6KBZ/StLHB8Lud/gbbOVaO/o+J372UY5+vcmuRyfEOBv0wL0TBJ+jNgU9LiDB2G3OgPmxQ1upCqnwkkl8mevs0qC9HO3vXw6Jxss0OVhHxve6RDdj1iFizo2mtwdVgYJq4c0CxFRIBWQGm9+QqmiMNvf7JZ+G2RpKRB66POgR4eVdIhwpzt/yi5ZTfYXq991pd3nnlydUb0pmGK+fE+mBuD/pbbbb7jdpMauNdIvk8Ow2udkVldz1/YdnF8uLNCHCaoolV9oyxsLNksNkbzW0bNFcc9Tx7Nazb8ORVqicUqx3PGFRyb3rYbJMV0es9Zs3QlsnplJNd+8dddHu9D2dhid4b79tmK+Sf0eK8wVydqHSRBIXzFCQGU0EpEP+sY2rfxuPKsa+14Wz2yNZDVDH+HQv5Lw+4jx82Yn1nsWwLUdim0Dsuthqs68YLW2CpZ34Zyf8edbyYxNpjIHGIUfoRgcHHMr6esgxnxevOZxy8GrJHNSGFpKkHz7g7MaqE5wkfecuDmpclzCqtb99tq5nSIamvmEVZ2oMmZ41sWpMbLzYN9zr0ZiTaqKZmcIJH1eo3pOtTCJ7PbwbAcMi02XzLCGC//uf/+IRkTN4mT/BcW2g0nM0k9q/bZgUeCPJOu08sYvxFRRlgdYWCyCjdMqP7XI55TqlaPJlohJjWUjSQQSmfb6ho8bsAH5qIzTPjC/ZusaCVBcUWvPbMzJPaqdLXiPet3NtriaEUgoCxvRciYwuixiHoJoJlVGQx8smGyz01o6M6MpIiyBkScBkzONkIjPJF7lWzojMQSmUmLLlkXIkjqhQxcdGRo/JF7K6qL21T0+eEJ3fImcsB/COvCveOOdZ0NGx597Qt6l3tIL4hLd8Y3JqK1peZmjbQs8Cr9GwLvJucl0UUGnnXVcyvbpnSxM5I5SlSz3keMLRNOQL5jivkYvFAChtSXcdGaXEAIVUV/7l3VnDZj/h2EqHbRRyPp/f0YvP+2P+Kt2sHpOBq9txU25kLdod3nw8J72EprTHk/dormUWzZANa+4x8F64LoUPeEVhE5Vca0IXMkNlsXO5vfnryXdwDS8G+0nauQkegfDed0dvv/3h/bc0L91VXv6Gg/3BPqdOtHWlUJ2l+o9YVyW3kz/dPnndPnndPnndPnndPnn9wzzK3D553T553T553T553T553T553T55fQKk2D553T553T553T553T553T553T553T553T553T553T553T55fRovDLdPXrdPXp8UQ26fvMYnr6E4hezGvaoQUnUq6Hy10tnKQ9iLNJlRNdPhWXJ7S3nFD1QxT82/1GioFOoiTa6FkRQ850KoNFb8UDXMFVJZylufC9g9peVTz/acyF6p/6KCJT/iDR/+vbDdgquT4/enSZrEJw6lzmmMEXN6yCvmyWFCOpvf/Dalpdx+mxRCTWsu0En8vFSoJGo361c5XXGVU/jRqfMRatHBsl/+5LdC/9PG1g74L0p9/x0X/92A+56NAwJtIzSd4MVyufw/pwniXw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Self Sign",permalink:"/docs/API-docs/selfsign"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},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 Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Draft 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:"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.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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\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:"document_id",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-send-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "document_id": "hji2zxcv2P",\n "url": "https://url-to-send-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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/a9f09360.524e33af.js b/assets/js/a9f09360.524e33af.js deleted file mode 100644 index f89694154..000000000 --- a/assets/js/a9f09360.524e33af.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8888],{63135:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcI7IyYOIhC8OTkCURR6bqG2aCw4DVNUaIRDUDiHPE4H4wVURl/LXKop5MIJmEs3g7Gw+OoAUGU6xxwmssDBuTpXp7I6hA9VoUUOC10bOHn3P81stAy1ne3svMNxPYUPRzs7F1/NnKvs4d6eqKqBrlBZOVWFGNtBpsu9nACrfPI8hfkMDdKskAkFKKwsFiDyHOYyn6KzKbgZKsh0tYBMa5NLJRzaFCoxRVB1OUZjUxAqh1IbBKlAgEGRL3ad3q0twv++P/4BJtqUwg3gpKht2iyXS4OZKxZ+ejfDZlfPbKSGdUaqaQqluCJqSQe/1DK7om1bVDn9pYFvTo6YVjs77+uq0sZhDj/5LRzu7FDPN1joOQiDDJ/pstQKKmFEiY6PayYcdxv8pZYGc38ooigiLQ7P1S7s7LhFhYc7O3CkcpkRMXhCagU9CbADD0pEItD3FWZyIgNoh3SgFcxnMpsxTebCn2dViMyjadBWmDl5jf2Jb1JY0MTvUOmIwUwb+atWThR8HNdonMxE0T02QpBArRPGETkrLZWLrWEF+Ec4Hjo9PpTAV4RaTsQqpeIei3AtihptwGqewoyw+hErg5ZZPcxLhFQ5zFBOZxvXE/nH2rrexFBbQrOLRVgrnhKTF5lsE1FYBDnp0bIUV9hZDTSLsCgG8M0CcpyIunApSOI4Z2ocwA/agaiqQmZiXCBxLpDwCFcb3OVTDuwQEFGi5DM+YYlGCwJyOZmgIeGkTp4ijInYEZ+1KoAlx82EAq1WDjrThTY0/QoPcXufkJBp5VC5Aby5FrJg7P1uLUiVFXWOMC5EdpXCuKgxBYO5l9wFkt5KgxYiEBA2EJ0JBBYLYkOtaANKh+WlBRuwygdwOpO2FSjqjLTmRaTtkjWI7UTTykSDKGOApZBFypRL4aMeg5OuwJQkthJqkZLCxBQc3rixvkkhm2F2xb+MyKWGce2cVn5judFVrucqEHOilbPy1zUiGXs+naKjFA5SeJXC6xSG+ykMRykMD1IYvkph+DqF0X4Ko1EKo4MURq88WqPXgdaiIXAXgeHIU9n9cahLivc7aVm0SWPaRgnPe0r4XA0HsLPTCBQ3//zzz+fq9lwBnCckYOfJ4XnSgJwnKfg+0pvnyeEwhdBwc54cwovR1xFgQd+viLr+e07fQzoN/z2j79HwXC3DoiNGxomyugcR6v7tkYifgZ+okVemtqjbqJGUkoelHjo3am3Qoo5lu6EXtCGppJOisJv3FCGe3rZazFZ2dkA7Y+7dvC3ufnp7imjFHlaevouVbacrqgFGZLRCgpeD9rrZQAG/6FMjQMDqS/f/ivbf6KzNRGhAnh4luqh9KTm+HrB9wHp7MzECwNMjRYvYlxLiNRGC7q3NVKDep0eCgFXsCLaA79s/2B2+3B3tjw56ZCA3ygOU5W6e7y4Wiy8kITDByDwK67O1GaxZbwSSBzsxulzjqrAn0UIF84l/R/P+ezLqx9HexZx8RHZConHTeIddi9zpXCyeWT9VHNrYcQTfWnGLDprcRXiwp5zNtMwC8gQTrbcxOYMDIsIuET7f+/77vQ4pfeNuWUb6Qmyl710mfbe1LAd5PliF7Z1Qp7WEPE9hTfv6jjyHsiw3tfsOui7P1Z9JEILptlkWAsDvIw5ruL5df6OstB0i16rg9dm7Wy8rK/fLTKrQEfgGVgAMTutCGLwhN9VKrZguv4EmWpGiKEStmc9eLTuEHDPwlICvjoMp/zwwOO2gPwG1PDzuzsa6kxic4g3PkdXW6ZKQkbmgGVKwdTYjp09Ej4HI3sZ3+CsTlaToQoHOcSu6bLAOCX9oHc+cDnXVMbfoepsRFuLINb45nz47GsN9vveCX3LPxRcgnp7a72AWO320g7rPzpNSBNMlmWD7W7sZmvPkohnjfXLMO2Nh3WC4uEeeoBWaHAsxxuKurD1aGrrbCZzVIQ51lFI1oQRGeT9iwL3iZqU3dC7XyJnfdpfBo3KPYhLpDIW0MZ7SJ1p3dAg4cRhQIXJkcYwQB1DQNkrxl7J8g9gjeD4qhHA6D6xAcMCATawvLnaPUNEKvZPp0oXmKKWSZV02QctJM2ukWBku+S65aCSFwuMK3dO9s4K4eWAFihBuXuBcDTmyEGMSrBdgvS0YQJ6eYuhg9vAN+Dkqo3drfu599+mCGPfVFcQ11ySB+guyEUK7WQoHcEyXEkVM/SAKgWUZVo7CZV8qog3Kj7uWhhxJ6obINl9MXajfmwc3MdNjuHMF79+MDwPcl9leRLXHMWN3G38ghuyh/WhbyccDS5+G2hQMLJn1npoyDGit3PxJmuiKcqpSq6M8OUxyysLGtGGS8tRo3Tc6XySHt0mI4NPPEB+nkXsfLaVxbxObzbAU9CuiRIlfyrwmacKBGsr9EqmSw0SPP2JGa1SGcHASLY1k6MPbCOUTlkkanPXkMPGZzCRN8EaUFQEnK6neKp8ky7jgfVM1Le1Uln80mVOah3KCnznNDzSUUSnxVL/V1OjwnVjYzoT+kk5Wk+I0hlg2C6MgFwtLUlBbb05losjqgtx0vKmkWTQxA/bVO4fYINqs1CA6fLlMOTmApouSMEYskjSRDstu+4YzM/rTCZ2hJspwNPdTx37UOEb8S2igJDyfkyg/GYuPGmGMfEbVTKtPHj8cvRiOhi+GI5ohJGc+n46+9y4GfcZ4Q04l5tHE3m0TqilwHmPwEHNGeN62mOLDzHi6KdHeSe/Zma6LnBJnKMyA892fXUrR5+/m5hg8wM3LNLl5eDM3kOndmMWHrwqcOKirCg1k2ig0z7vhuSezudHBwTJNFg9vb/GH3N7XdHjzh3f3E5c/tKUh/wlcX7xepsnsYVz/1hRo/AeRPXi1bC/DJDMoHMbL4XKs88Vl1FvLhwDjRUFwE13kaMhouKuvWlVDGoYKiy5X9fxY6wKFWqNoeon5UAJGJhxZbyE+PZ8h2cCtZcezt8ZksPU8tpTsx5WQobRkspkaz5MBHE06pim7+au1ARGW8/RKwzNe79LWrMaf7YVvotGzbhEU1aW0cfmIAgODw7IquIpoLouC8KZ7fQDNP7bOGkoSAvG6jAs/fFW89aFJXjAM6pfgQDDwBvBWqKYKo1/tALe3DRswdyyXcHtLp4rmki7d5TJtG2itXgPfq77FYIbyujeqacJ2YNPWGepNnEsycXxDSHh1EZBTJdX0sjbFcjm4w4btGT2abnfIFM6OJvl/QDFC50gdmxzNIyT3aOK9Kw3PiFmfhTA3U0Ya64I8enYPCPvM1QYqh+IFcsq+beTb1mNLUCrO18qPM3I6RSo1DBA8ONQGochmXjMwVmJCos3lgwavpa5tRG8mbGNy5wQhvbhINe07hx3qcOlWd++DdaKrqJjo+PTkEbRk13XXayLv8fld+jng+PSEChLlJDhgA/hgG0pE0ooeCJBrBNdSxJqlxnxb+GgjKqaIV5u96tFBKAXchbsI5dKuxShtUx9N+e6diduKVToiXTsqlZWhDMs6rGyPjoxFQ8hTXT+GKx+gpIBpzVlUR7dyVI2cjmkLCqWyztQ+0gp5bWINZWALgszQ2pZOkSoE1Jk/BVTWDxcwEdahSaFWkihvagpsNFPiTYVGospwLQkMetKR5D6szfrFeR9+/C7UKcc9RKEckwT6iTGHumKuYUloqkbjya1ufYO27ai8h9Hk6k5tgvSHeHuFxmpFzdpMhZK/em7WnpPGOBPFhA2sJpfOly6qPOJMs/XxixbWv//5L0KVOfWy1HnDvfbxjHVC9bvONsrIaa73xgJ9cXrMBDZKzqZRsdngrlFC0HDijrelK9oP3kjrOrWGMc1/Vyh/RKJn1sGBzXsSJWI0tehKVYNXqGlsp2PDS/brVBvzcoUBO2ZiL2Dkb1c2I9sAUFB/VHutlfWO7mh/n/70KdrU/gfTk2hHzDWpi2LxpyR9fPTpfi+7wVauNV7v85xnH+Xo15vsenRCjLNB+O6dIBj6tSmoop/4dLc5A45jdGgrVSEVXjKJL3OdXRq0l6P9/csh0XiZJgfryPhel+hmzDpEzLnRVPBfFSioAN0sQEyFVEC2p/kNqYrGaHO/M/BpmK2hROShy4MeEV7eJcKR4qQpPyM51Veoft+ddpd3fnlC9aZkhvHqMJEeiPuT3ma77X6TFrPaSLdIDs9uk5tdUcld3394drG8SBMirKYAbqUtYyzcLDlM9lbjuRbNNYf6zm49+zYcaYXKKa95x/0Uldy7HibLdHXEWmd1I7R1YirVdPfeURftTt/TaXiC9/bbxtYq+Xek4FogZxcqTSRxwQwF2a5EQDrkH9tg9rfxqGLAeV0MuT2S1ahwDAr34rzrw7zDl50A61mMlXL4s4l+rgtoNvuKIcomQtkJOnZijmctPzbhvRjdG3JYbHRwwPGjr4ccaHnxmmMYB6+WzEGtP58kfZ+dUwqrnmeS9D2qOKjxF8Ko1uj1KbKe9Raa+tZMO3PPeujd2hsu7WgeSTXRzCnh+I4rVO/J+iR5vB7ejSlhkemyKfSP4P/+5794RDx2XuZPcFwbqPQczaT2rwUmBd5Isvc6j9ZixAJFWaC1xQLIzJvy87VcTrnyJxpRmajEWBaSFAyBaR/B7+goO4Cf2pjHM+OLoK6xIL0Ehdb8motsj9rpkteIl+lcm6sJoZSCgDE9AEJL3grGIahmQmVkM3nBY2uEXq+RWVoZaRGELAmYzGOcTGQm+ZbWyhmROSiFElM2K1KObREVqvh8x+gxeRdWF7W3n+kREaLzW+Qc4ADekb/CG+fMBTohC8y96WxT77oE2Qiv48bkJla0vMzQtqWTBV6jYUXjHc+6KKDSzjuDZFd1z5YmckYoSzd2yJqEo2nIFwxcXiMXiwFQIpAuMvJriAEKqa78W7azhs1+wrGVDtu43nw+v6P0nvfH/FW6WT0Gg5Vux025kVVkd3jz8ZyUDprSHk/eo7mWWbQxNqy5x8B74S4UPoQUlZCo5F9WB9C9VMgMlcXOzfXmryffwTW8GOwnaUfNPwLhve+O3n77w/tvaV66iLz8DQf7g31ORmjrSqE6S/Wfha5KbicjuX1Eun1Eun1Eun1Eun1E+od55rh9RLp9RLp9RLp9RLp9RLp9RLp9RPoESLF9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RPo03uxtH5FuH5E+KYbcPiKNj0hD5QnZjXtVIaTqlMf5UqSzlaelF2kyo1Klw7Pk9pbyih+oBp2af6nRUJ3TRZpcCyMpeM5VTmks56FSlyukmpO3Phewe0rLp57tOZG9UtxF1Uh+xBs+/Hthu9VUJ8fvT5M0iY8GSp3TGCPm9DRWzJPDhHQ2v6Jt6ka5/TYphJrWXH2T+HmpCknUbtYvYbriEqbwo1PEI9Sig2W/tslvhf6nja0d8F+U+v47Lv67Afc9GwcE2kZoOsGL5XL5f5vwpBI=",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/draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/draftdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftdocument",permalink:"/docs/API-docs/draftdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftdocument",title:"Draft Document",description:"The Draft Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztO+1yGzeSr9I7fxyrRpRIy45XdXW1jp3b1W0SqWK5UluSSgFnmiSsGWACYEQxKv7bJ9lH2ye56gYwHxQpyXYqq9TRPywO0AAaje5Gf+E2cWJqk8Oz5J3O6hKVs8lFmuRoMyMrJ7VKDpPTGcI7IyYOIhC8OTkCURR6bqG2aCw4DVNUaIRDUDiHPE4H4wVURl/LXKop5MIJmEs3g7Gw+OoAUGU6xxwmssDBuTpXp7I6hA9VoUUOC10bOHn3P81stAy1ne3svMNxPYUPRzs7F1/NnKvs4d6eqKqBrlBZOVWFGNtBpsu9nACrfPI8hfkMDdKskAkFKKwsFiDyHOYyn6KzKbgZKsh0tYBMa5NLJRzaFCoxRVB1OUZjUxAqh1IbBKlAgEGRL3ad3q0twv++P/4BJtqUwg3gpKht2iyXS4OZKxZ+ejfDZlfPbKSGdUaqaQqluCJqSQe/1DK7om1bVDn9pYFvTo6YVjs77+uq0sZhDj/5LRzu7FDPN1joOQiDDJ/pstQKKmFEiY6PayYcdxv8pZYGc38ooigiLQ7P1S7s7LhFhYc7O3CkcpkRMXhCagU9CbADD0pEItD3FWZyIgNoh3SgFcxnMpsxTebCn2dViMyjadBWmDl5jf2Jb1JY0MTvUOmIwUwb+atWThR8HNdonMxE0T02QpBArRPGETkrLZWLrWEF+Ec4Hjo9PpTAV4RaTsQqpeIei3AtihptwGqewoyw+hErg5ZZPcxLhFQ5zFBOZxvXE/nH2rrexFBbQrOLRVgrnhKTF5lsE1FYBDnp0bIUV9hZDTSLsCgG8M0CcpyIunApSOI4Z2ocwA/agaiqQmZiXCBxLpDwCFcb3OVTDuwQEFGi5DM+YYlGCwJyOZmgIeGkTp4ijInYEZ+1KoAlx82EAq1WDjrThTY0/QoPcXufkJBp5VC5Aby5FrJg7P1uLUiVFXWOMC5EdpXCuKgxBYO5l9wFkt5KgxYiEBA2EJ0JBBYLYkOtaANKh+WlBRuwygdwOpO2FSjqjLTmRaTtkjWI7UTTykSDKGOApZBFypRL4aMeg5OuwJQkthJqkZLCxBQc3rixvkkhm2F2xb+MyKWGce2cVn5judFVrucqEHOilbPy1zUiGXs+naKjFA5SeJXC6xSG+ykMRykMD1IYvkph+DqF0X4Ko1EKo4MURq88WqPXgdaiIXAXgeHIU9n9cahLivc7aVm0SWPaRgnPe0r4XA0HsLPTCBQ3//zzz+fq9lwBnCckYOfJ4XnSgJwnKfg+0pvnyeEwhdBwc54cwovR1xFgQd+viLr+e07fQzoN/z2j79HwXC3DoiNGxomyugcR6v7tkYifgZ+okVemtqjbqJGUkoelHjo3am3Qoo5lu6EXtCGppJOisJv3FCGe3rZazFZ2dkA7Y+7dvC3ufnp7imjFHlaevouVbacrqgFGZLRCgpeD9rrZQAG/6FMjQMDqS/f/ivbf6KzNRGhAnh4luqh9KTm+HrB9wHp7MzECwNMjRYvYlxLiNRGC7q3NVKDep0eCgFXsCLaA79s/2B2+3B3tjw56ZCA3ygOU5W6e7y4Wiy8kITDByDwK67O1GaxZbwSSBzsxulzjqrAn0UIF84l/R/P+ezLqx9HexZx8RHZConHTeIddi9zpXCyeWT9VHNrYcQTfWnGLDprcRXiwp5zNtMwC8gQTrbcxOYMDIsIuET7f+/77vQ4pfeNuWUb6Qmyl710mfbe1LAd5PliF7Z1Qp7WEPE9hTfv6jjyHsiw3tfsOui7P1Z9JEILptlkWAsDvIw5ruL5df6OstB0i16rg9dm7Wy8rK/fLTKrQEfgGVgAMTutCGLwhN9VKrZguv4EmWpGiKEStmc9eLTuEHDPwlICvjoMp/zwwOO2gPwG1PDzuzsa6kxic4g3PkdXW6ZKQkbmgGVKwdTYjp09Ej4HI3sZ3+CsTlaToQoHOcSu6bLAOCX9oHc+cDnXVMbfoepsRFuLINb45nz47GsN9vveCX3LPxRcgnp7a72AWO320g7rPzpNSBNMlmWD7W7sZmvPkohnjfXLMO2Nh3WC4uEeeoBWaHAsxxuKurD1aGrrbCZzVIQ51lFI1oQRGeT9iwL3iZqU3dC7XyJnfdpfBo3KPYhLpDIW0MZ7SJ1p3dAg4cRhQIXJkcYwQB1DQNkrxl7J8g9gjeD4qhHA6D6xAcMCATawvLnaPUNEKvZPp0oXmKKWSZV02QctJM2ukWBku+S65aCSFwuMK3dO9s4K4eWAFihBuXuBcDTmyEGMSrBdgvS0YQJ6eYuhg9vAN+Dkqo3drfu599+mCGPfVFcQ11ySB+guyEUK7WQoHcEyXEkVM/SAKgWUZVo7CZV8qog3Kj7uWhhxJ6obINl9MXajfmwc3MdNjuHMF79+MDwPcl9leRLXHMWN3G38ghuyh/WhbyccDS5+G2hQMLJn1npoyDGit3PxJmuiKcqpSq6M8OUxyysLGtGGS8tRo3Tc6XySHt0mI4NPPEB+nkXsfLaVxbxObzbAU9CuiRIlfyrwmacKBGsr9EqmSw0SPP2JGa1SGcHASLY1k6MPbCOUTlkkanPXkMPGZzCRN8EaUFQEnK6neKp8ky7jgfVM1Le1Uln80mVOah3KCnznNDzSUUSnxVL/V1OjwnVjYzoT+kk5Wk+I0hlg2C6MgFwtLUlBbb05losjqgtx0vKmkWTQxA/bVO4fYINqs1CA6fLlMOTmApouSMEYskjSRDstu+4YzM/rTCZ2hJspwNPdTx37UOEb8S2igJDyfkyg/GYuPGmGMfEbVTKtPHj8cvRiOhi+GI5ohJGc+n46+9y4GfcZ4Q04l5tHE3m0TqilwHmPwEHNGeN62mOLDzHi6KdHeSe/Zma6LnBJnKMyA892fXUrR5+/m5hg8wM3LNLl5eDM3kOndmMWHrwqcOKirCg1k2ig0z7vhuSezudHBwTJNFg9vb/GH3N7XdHjzh3f3E5c/tKUh/wlcX7xepsnsYVz/1hRo/AeRPXi1bC/DJDMoHMbL4XKs88Vl1FvLhwDjRUFwE13kaMhouKuvWlVDGoYKiy5X9fxY6wKFWqNoeon5UAJGJhxZbyE+PZ8h2cCtZcezt8ZksPU8tpTsx5WQobRkspkaz5MBHE06pim7+au1ARGW8/RKwzNe79LWrMaf7YVvotGzbhEU1aW0cfmIAgODw7IquIpoLouC8KZ7fQDNP7bOGkoSAvG6jAs/fFW89aFJXjAM6pfgQDDwBvBWqKYKo1/tALe3DRswdyyXcHtLp4rmki7d5TJtG2itXgPfq77FYIbyujeqacJ2YNPWGepNnEsycXxDSHh1EZBTJdX0sjbFcjm4w4btGT2abnfIFM6OJvl/QDFC50gdmxzNIyT3aOK9Kw3PiFmfhTA3U0Ya64I8enYPCPvM1QYqh+IFcsq+beTb1mNLUCrO18qPM3I6RSo1DBA8ONQGochmXjMwVmJCos3lgwavpa5tRG8mbGNy5wQhvbhINe07hx3qcOlWd++DdaKrqJjo+PTkEbRk13XXayLv8fld+jng+PSEChLlJDhgA/hgG0pE0ooeCJBrBNdSxJqlxnxb+GgjKqaIV5u96tFBKAXchbsI5dKuxShtUx9N+e6diduKVToiXTsqlZWhDMs6rGyPjoxFQ8hTXT+GKx+gpIBpzVlUR7dyVI2cjmkLCqWyztQ+0gp5bWINZWALgszQ2pZOkSoE1Jk/BVTWDxcwEdahSaFWkihvagpsNFPiTYVGospwLQkMetKR5D6szfrFeR9+/C7UKcc9RKEckwT6iTGHumKuYUloqkbjya1ufYO27ai8h9Hk6k5tgvSHeHuFxmpFzdpMhZK/em7WnpPGOBPFhA2sJpfOly6qPOJMs/XxixbWv//5L0KVOfWy1HnDvfbxjHVC9bvONsrIaa73xgJ9cXrMBDZKzqZRsdngrlFC0HDijrelK9oP3kjrOrWGMc1/Vyh/RKJn1sGBzXsSJWI0tehKVYNXqGlsp2PDS/brVBvzcoUBO2ZiL2Dkb1c2I9sAUFB/VHutlfWO7mh/n/70KdrU/gfTk2hHzDWpi2LxpyR9fPTpfi+7wVauNV7v85xnH+Xo15vsenRCjLNB+O6dIBj6tSmoop/4dLc5A45jdGgrVSEVXjKJL3OdXRq0l6P9/csh0XiZJgfryPhel+hmzDpEzLnRVPBfFSioAN0sQEyFVEC2p/kNqYrGaHO/M/BpmK2hROShy4MeEV7eJcKR4qQpPyM51Veoft+ddpd3fnlC9aZkhvHqMJEeiPuT3ma77X6TFrPaSLdIDs9uk5tdUcld3394drG8SBMirKYAbqUtYyzcLDlM9lbjuRbNNYf6zm49+zYcaYXKKa95x/0Uldy7HibLdHXEWmd1I7R1YirVdPfeURftTt/TaXiC9/bbxtYq+Xek4FogZxcqTSRxwQwF2a5EQDrkH9tg9rfxqGLAeV0MuT2S1ahwDAr34rzrw7zDl50A61mMlXL4s4l+rgtoNvuKIcomQtkJOnZijmctPzbhvRjdG3JYbHRwwPGjr4ccaHnxmmMYB6+WzEGtP58kfZ+dUwqrnmeS9D2qOKjxF8Ko1uj1KbKe9Raa+tZMO3PPeujd2hsu7WgeSTXRzCnh+I4rVO/J+iR5vB7ejSlhkemyKfSP4P/+5794RDx2XuZPcFwbqPQczaT2rwUmBd5Isvc6j9ZixAJFWaC1xQLIzJvy87VcTrnyJxpRmajEWBaSFAyBaR/B7+goO4Cf2pjHM+OLoK6xIL0Ehdb8motsj9rpkteIl+lcm6sJoZSCgDE9AEJL3grGIahmQmVkM3nBY2uEXq+RWVoZaRGELAmYzGOcTGQm+ZbWyhmROSiFElM2K1KObREVqvh8x+gxeRdWF7W3n+kREaLzW+Qc4ADekb/CG+fMBTohC8y96WxT77oE2Qiv48bkJla0vMzQtqWTBV6jYUXjHc+6KKDSzjuDZFd1z5YmckYoSzd2yJqEo2nIFwxcXiMXiwFQIpAuMvJriAEKqa78W7azhs1+wrGVDtu43nw+v6P0nvfH/FW6WT0Gg5Vux025kVVkd3jz8ZyUDprSHk/eo7mWWbQxNqy5x8B74S4UPoQUlZCo5F9WB9C9VMgMlcXOzfXmryffwTW8GOwnaUfNPwLhve+O3n77w/tvaV66iLz8DQf7g31ORmjrSqE6S/Wfha5KbicjuX1Eun1Eun1Eun1Eun1E+od55rh9RLp9RLp9RLp9RLp9RLp9RLp9RPoESLF9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RLp9RPo03uxtH5FuH5E+KYbcPiKNj0hD5QnZjXtVIaTqlMf5UqSzlaelF2kyo1Klw7Pk9pbyih+oBp2af6nRUJ3TRZpcCyMpeM5VTmks56FSlyukmpO3Phewe0rLp57tOZG9UtxF1Uh+xBs+/Hthu9VUJ8fvT5M0iY8GSp3TGCPm9DRWzJPDhHQ2v6Jt6ka5/TYphJrWXH2T+HmpCknUbtYvYbriEqbwo1PEI9Sig2W/tslvhf6nja0d8F+U+v47Lv67Afc9GwcE2kZoOsGL5XL5f5vwpBI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Self Sign",permalink:"/docs/API-docs/selfsign"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},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 Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Draft 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)(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:"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.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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.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:"document_id",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-send-document.com"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "document_id": "hji2zxcv2P",\n "url": "https://url-to-send-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 y(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/bbdfc22d.3855f22e.js b/assets/js/bbdfc22d.3855f22e.js deleted file mode 100644 index 1057f9dff..000000000 --- a/assets/js/bbdfc22d.3855f22e.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:()=>h,metadata:()=>x,toc:()=>g});var t=s(85893),i=s(11151),a=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),p=s(85162);const h={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:"eJztW91yI7exfpXO3KxXNaRErrzew0qdOuufJJvY1pZXW66UpJLBmSYH1gwwBjCiaBXv8iR5tDzJqW4AM0OKlLS7Lkep8Ebi4Lf7Q6PR3WjcJk7MbTI5S06xqkvh0CYXaZKjzYysndQqmSSnBUKshq8MCiqH12/fgChLvbDQWDQWnIaMKhGyxjpdyV/FtERwceAUFoXMCrBorhGEhWnZYG2kchZm2sAcFRrhpJpDrrOmQqpYSFdAbTDHmVSYg3WmyVxj0A7hfa0V2CbL0NpZU7YzeTKkVim4AplQg64xyoKARslfGoSDg9j6UuYHB+AK4SATCqZI7OTETSAIe+RMBdVpxQPbGjM5k9Q4jDU8V+fqVNYTeF+XWuSw1I2Bt1//qR2CxqWys4ODr3HazOH9m4ODi88K52o7OTwUdT3UNSor56oUUzvMdHWYU8M6nz0nBNEgjcq0orCyXILIc1jIfI7OMscKMl0vIdPa5FJ56GsxR1BNNUVjUxAqh0obBKlAgEGRLwdODxqL8Nd3J9/TclTCDeFt2di0nS6XBjNXLv3whEDk6plH5uUxrY9U8xQqcUULKR380sjsiti2qBjWsCaM1cHBu6autXGYw4+ehcnBAdV8iaVegDDI7TNdVVpBLYyo0LG00YJRtcFfGmkw96IiyjJiMaFhBrTSyxonBwfwRuUyIzh4SCoFPQuth74pwURN34Wl9U174NHaezEmVBbCr2hdiswTapCkwslrXB/4JoUlDfw1Kh0pKLSRv2rlRMkLco3GyUyU/YUjAlnUnDC8M2otlYulYQb4e1ggWj9eliBZRFpOcFVScY1FuBZlgzZQtUihIKp+wNqgZQkP4xKUKocC5bzYOZ/If26sWxsYGktk9qkIc8V1YniRYZuJ0iLI2RqWlbjC3mygWQ2JcghfLiHHmWhKl4IkmXOmwSF8rx2Iui5lxvqGVAltH0FaYsCrHAQiEKJExWv81uhrmSMphVzOZmhoe1IlDxH6ROpI0mruQOzx3nGFUKDVxkJnutSGht+QIS5fBxIyrRwqN4TX10KWTL3n1oJUWdnkCNNSZFcpq8oUDOZ+7y6RFG/qRZ6bkD71oDNAYLEkMdSKGFA6TC9tp7SGp4W03Y6iugg1zyFtH9Wwb2eaJiYI4iYDrIQsUwYuhZ/1FJx0Jaa0ZWuhlinkwmEKDm/cVN+kkBWYXfEvI3KpYdo4R6qa5syNrnO9UAHLmVbOyl+37MhY8+GAjlM4TuFlCq9SGB2lMBqnMDpOYfQyhdGrFMZHKYzHKYyPUxi/9GSNXwWoRYtvn4DR2IPseuDC00aXNO+30vLOJpVpWy28WNPC52o0hIODdj9x8U8//XSubs8VwHlC++s8mZwnbZPzJAVfR2rzPJmMUggFN+fJBF6Mv4gNlvT9ktD13wv6HtFq+O+Cvsejc7UKk46ZGCeq+h5CqPq3JyJ+BnmiQp6ZyqJqo0LSSb4t1dC6UWlLFlWsOoZeEENSSSdFaXfzFFs8PbY6yjY4OybOWHp3s8XVT4+nSFasYd3pq1jX9qqiGmBCxhsQfD7sTpsdCPhJnxoAgapP5f8l8d/qrN0gtE2eHhJ90j4Vji+GbB6w3t4NRmjw9KDoCPtUIF4REHRu7UaBap8eBIGqWBFsAV93dDwYfT4YH42P12AgP8o3qKpBng+Wy+UnQggMGJlHYX42NoMx621A8llnRldbPBV2JLpWwXzi39G6/45s+mk0dzEnJ3Hd3Y3uYd8gdzoXy2fWDxW7tnYcte+suGWPTK4iOthVzgots0A8tYnW25S8wSGBMCDg88PvvjvsQekLB1UV8YVYSt8Dhr5fWlXDPB9utl1boV5pBXmewpby7RV5DlVV7Sr3FXRcnqv/GXIcgk233XshNPh9tsMWqe/m37lXugqRa1Xy/Ozcbd8rG+dLIVWoCHIDGw0MzptSGLwhL9VKrRiX30ATbeyiuIk6M5+dWvYHOWTgkYDPToIp/zwIOHGwPgCVPNzvDmP9QQzO8YbH8PE0IkbmIbBlm6wgn09Ej4Fg7wI8/JWJWlJwoUTnuBRdNtxGhF+0nmNOi7rpl1t0a8wIC7HnFtecV58djdERn3vBL7nn4Astnp7a71EWK32wg6rPzpNKBNMlmWH3W7sCzXly0fbxLjnmvb6wrTNc3LOfoNs0OZZiiuXdvfbo3dBnJ0hWDxyqqKRqIwlM8lGkgGvFzUZtqFxt2Wee7b6AR+Uet0nEGUppYzhlHbR+7xBv4jigQh+xnSLEDjBtRfKTRb4l7HEy7zVCWJ4HpqB2wA3bWF+c7YEZ1pamDwyNUUklq6Zqg5azdtQIWRVO+T5e1JNi+XGG/vLemUHcPDBDiKbvmOBcjTi0EIMSrBhguzEYmjw9zdCj7OEj8GN0xtqx+bEH3ofvxMhXfyduOSepqT8h211od2/DIZzQqUQRU9+JYmBZhrWjeNmn7tGW5Mft0RGHkvoxst0nU7/V7y2Du4TpMdK5QfdvJoeh3acZX4Ta44Sxz8Z/kECukf1oY8kHBCt/DbUrGlix6D01ZRjI2jj6kzTRNd/ravUmTyaJvyOON6ZJymOjdV/qfJlMbpMQw6efIUJOXQ9/tnQXfZvYrMBK0K9IE91ez2RJQ1EQGo1N0oSDNnSVTaglk0RPf8bMJSm5GDVdtKGlMbjf5Da28reXSRoc92SS+GvNJE3wRlQ1NQ5FgCrT5B3zEKs4431jtSXdWJZ/tPfHNA7dD37kMNx1tXF9/1Ej9UdYdbh2gwljxDLZzBSIF4PRj/P92puPchk3i3S0JdrLKm6WpIl0WPVn2bFqRn840hlq4oRjux/al5dFVB88J/WrC60+qmO4iNmC+SNR8rV3J15fstfkQGIezelBd3eaAt9ZDB+SmNieuRXz/pzeOLwz5+muO/XeVZ4tdFPmdEmGwgz5avuj8yY4NUWUWcPZIe0hscZZS2rL2WiVJjcPM3MDmR7EC3v4rMSZg6au0UCmjULzvB+KezLMjY+PV2myfJi95X8ke1/Q4i0e5u5HznToskD+HbS+eLVKk+JhWv/S5mL8G4k9frnqzrqNs/xyqvPlZdRbq4caxkOF2lFu0Bt1YnI0PSCmWpco1B0k3sy8laXhGRkjz0K8i6/QpbHxQIGFLEswmCGl43AIO+oqCEaHv1+HcItJxtk3VMBGo22mllqpOJ71A04RnJHzOVLSUWjBnUOSAApOcqM0HaJKzOj+n9OIDF5L3dhIXiEs3+OXSHapK1D6zBWp5utGYg8dTuHo8z7srw6V0CGnKKvg5PTtI7BkE3YArmgzFDyXfgw4OX1LiUlyFuywIby3LRIRWrHWBMgugmspYvJCq9uXPuqAihHRzOxaHtkwpAQN4C5BubRbKUq7GGibh3hn4C53jZZIN46S5mTIx7AOa7uGI1PRAnmqm8dI5QNICpg3fJ3iaMvGLCWOy3aJRVL5BEd2gPLGxFyqIBbUkrIdO5wiKtSoN34KqKzvLmAmrEOTUuojIW8acnDaIfGmRiNRZbgVAoMeusvGbLWb1jFYz9J5/8O3IWMx8hA35ZR2oB8Yc2hqlhreCW32WFy5TdbvGEosZZe0R9Bc7jLT1snkLC9twu4PcbcajdWKirWZCyV/9dIckj2nWIhyxtq3vVSjpDCaN9JMo63TF9Xvv/7xTyKVJfWy0nkrvfbxgvWW8vicbZWR05z5iSX63NR4JdAqOZtGxWaDLUc3A4Yj+MyWrokfvJHW9ZKO4n3f3U35AxKeWY8GPvtpK5GgqWV/V7V0heSmbjhOjZLr+Wrt2bMhgPefIf6Q6RzBoP8oCVMr683g8dER/duwQNdShWk3tGnE5fIPSfp4L/R+G9wXk997VyQ7KfmyGP/F1qrKChKSCq1dN6O3dHmAgT5uUpVS4WUE5XJ8dHT5OSG3SpPjbeC80xW6giWCNuDCaMrorUsUlF9qliDmQiqg6c1viBUao839XH8YZfeBcHx0dDlqQfj8LghvFF+KcPb4qb5C9fty2p/e+emJ1JuKlbDXcon0jbg+WWO2X+6ZtJg1RrplMjm7TW4GopYDXz85u1hdkNS5QlN8ptaWKRauSCbJ4Z1wDafvUyzg7DbhMyGJ9qYVKqd7izs2p6jl4fUoWaWbPbZaqDtbWyfmUs0H9/a66Fh9R8vhEV9juHOoa/k3JI864NlvlSaSxKBAQTYpIUir/EMXq/omrlWMIm0NDHWLshnqiZGeteDNpurfEo7pRWPOYiiEoxttcCPpOEraAAT9bEMKZ53otd57dN5H7PWOj4/ZPfxixH7Ui1fsohy/XF14hHvmOscD+zanj1SvGU+haN2YSJKth/faobnjzIzWiVQzzQsaQD6pUb0j44/2zfXorr+HZaarNuE2Nv/XP/7JPeIZxdP8AU4aA7VeoKHXJZRBOyvxRpK51Xv8QoYAh31FVaK1FONSDuf+4Yic8w18tGEyUYupLCUpAmqmfdZLT5fYIfxYIIXfqeqZ8ckI11iS/oBSa35WQUd/43TVf5wCC22uZkRSCgKmlIePlpwFjF1QFUJlZLL4/cHGAD0jIauwNtIiCFlRY7JOcTaTmaSBSesZkTmohBJzPtVT9jsJhTpm0Rs9JePe6rLx5ivl8iM6zyKH4ofwNbkLzDgV5uiELDH3lqtNvecQlGB4pjIlL62m6WWGtkthKvEaDesD7/c1ZQm1dt4XI7Omv7Y0kDNCWfJsPUFxaVr4gn3Jc+RiOQSKx9OBQ24FCUAp1RU9KhnAWStmP+LUSoedz71YLO7opufrff4sXdFMwWCtu35zLmRN1u/efjwnTYKmsiezd2iuZYZBMe6Y85AbH4YzS2R8ZkX9IGr5f5sd6PwoZYbKYu+Eef3nt9/CNbwYHiVpTxs/guDDb9989c33776hcem88PtvNDwaHnGgUFtXCdWb6iv/duy0048bYez28N0/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SHuQ//2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP+OB2kh94UMx8O6FJKTp0J+q897Ott8pnaRJgUlRk3Okttbulp8b8rViop/adBQVtVFmlwLIyl8zjlVacwdomybK1zSFbe/DRic0vypl3u+jt9IJaPUJ9/jNa/+vW37uVtvT96dJmkyDU/pKp1THyMW9MxOLJJJQkqbn+S1yadcfpuUQs0bTgBK/LiU8iQaV6znS11xvlT40csjEmrZo3I9kcqzQn+Jsa0d/kh34n/D5f+2zX3Nzg4B29ialvBitVr9PwFbmLw=",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:"eJztW91yI7exfpXO3KxXNaRErrzew0qdOuufJJvY1pZXW66UpJLBmSYH1gwwBjCiaBXv8iR5tDzJqW4AM0OKlLS7Lkep8Ebi4Lf7Q6PR3WjcJk7MbTI5S06xqkvh0CYXaZKjzYysndQqmSSnBUKshq8MCiqH12/fgChLvbDQWDQWnIaMKhGyxjpdyV/FtERwceAUFoXMCrBorhGEhWnZYG2kchZm2sAcFRrhpJpDrrOmQqpYSFdAbTDHmVSYg3WmyVxj0A7hfa0V2CbL0NpZU7YzeTKkVim4AplQg64xyoKARslfGoSDg9j6UuYHB+AK4SATCqZI7OTETSAIe+RMBdVpxQPbGjM5k9Q4jDU8V+fqVNYTeF+XWuSw1I2Bt1//qR2CxqWys4ODr3HazOH9m4ODi88K52o7OTwUdT3UNSor56oUUzvMdHWYU8M6nz0nBNEgjcq0orCyXILIc1jIfI7OMscKMl0vIdPa5FJ56GsxR1BNNUVjUxAqh0obBKlAgEGRLwdODxqL8Nd3J9/TclTCDeFt2di0nS6XBjNXLv3whEDk6plH5uUxrY9U8xQqcUULKR380sjsiti2qBjWsCaM1cHBu6autXGYw4+ehcnBAdV8iaVegDDI7TNdVVpBLYyo0LG00YJRtcFfGmkw96IiyjJiMaFhBrTSyxonBwfwRuUyIzh4SCoFPQuth74pwURN34Wl9U174NHaezEmVBbCr2hdiswTapCkwslrXB/4JoUlDfw1Kh0pKLSRv2rlRMkLco3GyUyU/YUjAlnUnDC8M2otlYulYQb4e1ggWj9eliBZRFpOcFVScY1FuBZlgzZQtUihIKp+wNqgZQkP4xKUKocC5bzYOZ/If26sWxsYGktk9qkIc8V1YniRYZuJ0iLI2RqWlbjC3mygWQ2JcghfLiHHmWhKl4IkmXOmwSF8rx2Iui5lxvqGVAltH0FaYsCrHAQiEKJExWv81uhrmSMphVzOZmhoe1IlDxH6ROpI0mruQOzx3nGFUKDVxkJnutSGht+QIS5fBxIyrRwqN4TX10KWTL3n1oJUWdnkCNNSZFcpq8oUDOZ+7y6RFG/qRZ6bkD71oDNAYLEkMdSKGFA6TC9tp7SGp4W03Y6iugg1zyFtH9Wwb2eaJiYI4iYDrIQsUwYuhZ/1FJx0Jaa0ZWuhlinkwmEKDm/cVN+kkBWYXfEvI3KpYdo4R6qa5syNrnO9UAHLmVbOyl+37MhY8+GAjlM4TuFlCq9SGB2lMBqnMDpOYfQyhdGrFMZHKYzHKYyPUxi/9GSNXwWoRYtvn4DR2IPseuDC00aXNO+30vLOJpVpWy28WNPC52o0hIODdj9x8U8//XSubs8VwHlC++s8mZwnbZPzJAVfR2rzPJmMUggFN+fJBF6Mv4gNlvT9ktD13wv6HtFq+O+Cvsejc7UKk46ZGCeq+h5CqPq3JyJ+BnmiQp6ZyqJqo0LSSb4t1dC6UWlLFlWsOoZeEENSSSdFaXfzFFs8PbY6yjY4OybOWHp3s8XVT4+nSFasYd3pq1jX9qqiGmBCxhsQfD7sTpsdCPhJnxoAgapP5f8l8d/qrN0gtE2eHhJ90j4Vji+GbB6w3t4NRmjw9KDoCPtUIF4REHRu7UaBap8eBIGqWBFsAV93dDwYfT4YH42P12AgP8o3qKpBng+Wy+UnQggMGJlHYX42NoMx621A8llnRldbPBV2JLpWwXzi39G6/45s+mk0dzEnJ3Hd3Y3uYd8gdzoXy2fWDxW7tnYcte+suGWPTK4iOthVzgots0A8tYnW25S8wSGBMCDg88PvvjvsQekLB1UV8YVYSt8Dhr5fWlXDPB9utl1boV5pBXmewpby7RV5DlVV7Sr3FXRcnqv/GXIcgk233XshNPh9tsMWqe/m37lXugqRa1Xy/Ozcbd8rG+dLIVWoCHIDGw0MzptSGLwhL9VKrRiX30ATbeyiuIk6M5+dWvYHOWTgkYDPToIp/zwIOHGwPgCVPNzvDmP9QQzO8YbH8PE0IkbmIbBlm6wgn09Ej4Fg7wI8/JWJWlJwoUTnuBRdNtxGhF+0nmNOi7rpl1t0a8wIC7HnFtecV58djdERn3vBL7nn4Astnp7a71EWK32wg6rPzpNKBNMlmWH3W7sCzXly0fbxLjnmvb6wrTNc3LOfoNs0OZZiiuXdvfbo3dBnJ0hWDxyqqKRqIwlM8lGkgGvFzUZtqFxt2Wee7b6AR+Uet0nEGUppYzhlHbR+7xBv4jigQh+xnSLEDjBtRfKTRb4l7HEy7zVCWJ4HpqB2wA3bWF+c7YEZ1pamDwyNUUklq6Zqg5azdtQIWRVO+T5e1JNi+XGG/vLemUHcPDBDiKbvmOBcjTi0EIMSrBhguzEYmjw9zdCj7OEj8GN0xtqx+bEH3ofvxMhXfyduOSepqT8h211od2/DIZzQqUQRU9+JYmBZhrWjeNmn7tGW5Mft0RGHkvoxst0nU7/V7y2Du4TpMdK5QfdvJoeh3acZX4Ta44Sxz8Z/kECukf1oY8kHBCt/DbUrGlix6D01ZRjI2jj6kzTRNd/ravUmTyaJvyOON6ZJymOjdV/qfJlMbpMQw6efIUJOXQ9/tnQXfZvYrMBK0K9IE91ez2RJQ1EQGo1N0oSDNnSVTaglk0RPf8bMJSm5GDVdtKGlMbjf5Da28reXSRoc92SS+GvNJE3wRlQ1NQ5FgCrT5B3zEKs4431jtSXdWJZ/tPfHNA7dD37kMNx1tXF9/1Ej9UdYdbh2gwljxDLZzBSIF4PRj/P92puPchk3i3S0JdrLKm6WpIl0WPVn2bFqRn840hlq4oRjux/al5dFVB88J/WrC60+qmO4iNmC+SNR8rV3J15fstfkQGIezelBd3eaAt9ZDB+SmNieuRXz/pzeOLwz5+muO/XeVZ4tdFPmdEmGwgz5avuj8yY4NUWUWcPZIe0hscZZS2rL2WiVJjcPM3MDmR7EC3v4rMSZg6au0UCmjULzvB+KezLMjY+PV2myfJi95X8ke1/Q4i0e5u5HznToskD+HbS+eLVKk+JhWv/S5mL8G4k9frnqzrqNs/xyqvPlZdRbq4caxkOF2lFu0Bt1YnI0PSCmWpco1B0k3sy8laXhGRkjz0K8i6/QpbHxQIGFLEswmCGl43AIO+oqCEaHv1+HcItJxtk3VMBGo22mllqpOJ71A04RnJHzOVLSUWjBnUOSAApOcqM0HaJKzOj+n9OIDF5L3dhIXiEs3+OXSHapK1D6zBWp5utGYg8dTuHo8z7srw6V0CGnKKvg5PTtI7BkE3YArmgzFDyXfgw4OX1LiUlyFuywIby3LRIRWrHWBMgugmspYvJCq9uXPuqAihHRzOxaHtkwpAQN4C5BubRbKUq7GGibh3hn4C53jZZIN46S5mTIx7AOa7uGI1PRAnmqm8dI5QNICpg3fJ3iaMvGLCWOy3aJRVL5BEd2gPLGxFyqIBbUkrIdO5wiKtSoN34KqKzvLmAmrEOTUuojIW8acnDaIfGmRiNRZbgVAoMeusvGbLWb1jFYz9J5/8O3IWMx8hA35ZR2oB8Yc2hqlhreCW32WFy5TdbvGEosZZe0R9Bc7jLT1snkLC9twu4PcbcajdWKirWZCyV/9dIckj2nWIhyxtq3vVSjpDCaN9JMo63TF9Xvv/7xTyKVJfWy0nkrvfbxgvWW8vicbZWR05z5iSX63NR4JdAqOZtGxWaDLUc3A4Yj+MyWrokfvJHW9ZKO4n3f3U35AxKeWY8GPvtpK5GgqWV/V7V0heSmbjhOjZLr+Wrt2bMhgPefIf6Q6RzBoP8oCVMr683g8dER/duwQNdShWk3tGnE5fIPSfp4L/R+G9wXk997VyQ7KfmyGP/F1qrKChKSCq1dN6O3dHmAgT5uUpVS4WUE5XJ8dHT5OSG3SpPjbeC80xW6giWCNuDCaMrorUsUlF9qliDmQiqg6c1viBUao839XH8YZfeBcHx0dDlqQfj8LghvFF+KcPb4qb5C9fty2p/e+emJ1JuKlbDXcon0jbg+WWO2X+6ZtJg1RrplMjm7TW4GopYDXz85u1hdkNS5QlN8ptaWKRauSCbJ4Z1wDafvUyzg7DbhMyGJ9qYVKqd7izs2p6jl4fUoWaWbPbZaqDtbWyfmUs0H9/a66Fh9R8vhEV9juHOoa/k3JI864NlvlSaSxKBAQTYpIUir/EMXq/omrlWMIm0NDHWLshnqiZGeteDNpurfEo7pRWPOYiiEoxttcCPpOEraAAT9bEMKZ53otd57dN5H7PWOj4/ZPfxixH7Ui1fsohy/XF14hHvmOscD+zanj1SvGU+haN2YSJKth/faobnjzIzWiVQzzQsaQD6pUb0j44/2zfXorr+HZaarNuE2Nv/XP/7JPeIZxdP8AU4aA7VeoKHXJZRBOyvxRpK51Xv8QoYAh31FVaK1FONSDuf+4Yic8w18tGEyUYupLCUpAmqmfdZLT5fYIfxYIIXfqeqZ8ckI11iS/oBSa35WQUd/43TVf5wCC22uZkRSCgKmlIePlpwFjF1QFUJlZLL4/cHGAD0jIauwNtIiCFlRY7JOcTaTmaSBSesZkTmohBJzPtVT9jsJhTpm0Rs9JePe6rLx5ivl8iM6zyKH4ofwNbkLzDgV5uiELDH3lqtNvecQlGB4pjIlL62m6WWGtkthKvEaDesD7/c1ZQm1dt4XI7Omv7Y0kDNCWfJsPUFxaVr4gn3Jc+RiOQSKx9OBQ24FCUAp1RU9KhnAWStmP+LUSoedz71YLO7opufrff4sXdFMwWCtu35zLmRN1u/efjwnTYKmsiezd2iuZYZBMe6Y85AbH4YzS2R8ZkX9IGr5f5sd6PwoZYbKYu+Eef3nt9/CNbwYHiVpTxs/guDDb9989c33776hcem88PtvNDwaHnGgUFtXCdWb6iv/duy0048bYez28N0/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SNs/SHuQ//2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP2DtP+OB2kh94UMx8O6FJKTp0J+q897Ott8pnaRJgUlRk3Okttbulp8b8rViop/adBQVtVFmlwLIyl8zjlVacwdomybK1zSFbe/DRic0vypl3u+jt9IJaPUJ9/jNa/+vW37uVtvT96dJmkyDU/pKp1THyMW9MxOLJJJQkqbn+S1yadcfpuUQs0bTgBK/LiU8iQaV6znS11xvlT40csjEmrZo3I9kcqzQn+Jsa0d/kh34n/D5f+2zX3Nzg4B29ialvBitVr9PwFbmLw=",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,i.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(n.p,{children:"Create Template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.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,t.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,t.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,t.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,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Supported Widgets:"})}),"\n",(0,t.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.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,t.jsxs)(n.li,{children:[(0,t.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,t.jsxs)(n.li,{children:[(0,t.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,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.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,t.jsxs)(n.li,{children:[(0,t.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,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ol,{start:"3",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ol,{start:"4",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ol,{start:"5",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ol,{start:"6",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ol,{start:"7",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ol,{start:"8",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.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,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,t.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,t.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"9",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.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,t.jsxs)(n.ol,{start:"10",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,t.jsxs)(n.ol,{start:"11",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.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,t.jsxs)(n.ol,{start:"12",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.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,t.jsxs)(n.ol,{start:"13",children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(n.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(n.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(n.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(n.p,{children:"object[]"})}),(0,t.jsx)("span",{className:"openapi-schema__divider"}),(0,t.jsx)("span",{className:"openapi-schema__required",children:(0,t.jsx)(n.p,{children:"required"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"Array ["})})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(n.p,{children:"widgets"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(n.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(n.p,{children:"Array ["})})}),(0,t.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,t.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,t.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,t.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,t.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,t.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,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(n.p,{children:"]"})})})]})]})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(n.p,{children:"]"})})})]})]})}),(0,t.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,t.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,t.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}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email_sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"name or email of the person or organization on the behalf of which you are sending the mail.",example:"opensign\u2122"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(a.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.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,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(n.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(n.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.b5a7bd46.js b/assets/js/bbdfc22d.b5a7bd46.js new file mode 100644 index 000000000..6f04779e9 --- /dev/null +++ b/assets/js/bbdfc22d.b5a7bd46.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>m,metadata:()=>x,toc:()=>g});var i=n(85893),a=n(11151),t=n(58219),l=(n(62316),n(51039)),r=n.n(l),o=(n(82723),n(9487)),d=(n(41429),n(5397)),c=n(4667),h=n(9472),p=n(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:"eJztW91yI7exfpXO3KxXNaRErrzew0qdOuufJJvY1pZXW66UpJLBmSYH1gwwBjCiaBXv8iR5tDzJqW4AM0OKlLS7Lkep8EbiAA2g+wO60Wg0bhMn5jaZnCWnWNWlcGiTizTJ0WZG1k5qlUyS0wIhVsNXBgWVw+u3b0CUpV5YaCwaC05DRpUIWWOdruSvYloiuNhxCotCZgVYNNcIwsK0bLA2UjkLM21gjgqNcFLNIddZUyFVLKQroDaY40wqzME602SuMWiH8L7WCmyTZWjtrCnbkTwbUqsUXIHMqEHXGGVBQKPkLw3CwUGkvpT5wQG4QjjIhIIpkjg5SRMYwh47U0F1WnHHtsZMziQRh76G5+pcncp6Au/rUosclrox8PbrP7VdUL9UdnZw8DVOmzm8f3NwcPFZ4VxtJ4eHoq6HukZl5VyVYmqHma4OcyKs89lzQhANUq/MKworyyWIPIeFzOfoLEusINP1EjKtTS6Vh74WcwTVVFM0NgWhcqi0QZAKBBgU+XLg9KCxCH99d/I9TUcl3BDelo1N2+FyaTBz5dJ3TwhEqZ55ZF4e0/xINU+hElc0kdLBL43Mrkhsi4phDXPCWB0cvGvqWhuHOfzoRZgcHFDNl1jqBQiDTJ/pqtIKamFEhY5XG00YVRv8pZEGc79URFlGLCbUzYBmelnj5OAA3qhcZgQHd0mloGeBeuhJCSYifRem1pP2wKO598uYUFkIP6N1KTLPqEFaFU5e43rHNyksqeOvUenIQaGN/FUrJ0qekGs0Tmai7E8cMchLzQnDmlFrqVwsDSPA38ME0fzxtISVRazlBFclFddYhGtRNmgDV4sUCuLqB6wNWl7hoV+CUuVQoJwXO8cT+c+NdWsdQ2OJzT4XYaw4TwwvMmwzUVoEOVvDshJX2BsNNJshUQ7hyyXkOBNN6VKQtOacaXAI32sHoq5LmbG9IVNC6iPISgx4lsOCCIwoUfEcvzX6WuZIRiGXsxkaUk+q5C5Cm8gdrbSaG5B4rDuuEAq02pjoTJfaUPcba4jL14GETCuHyg3h9bWQJXPvpbUgVVY2OcK0FNlVyqYyBYO5190lkuFN/ZJnErKnHnQGCCyWtAy1IgGUDsNL2xmt4WkhbadRVBeh5jGk7aMa9HamaWCCICoZYCVkmTJwKfysp+CkKzElla2FWqaQC4cpOLxxU32TQlZgdsW/jMilhmnjHJlqGjM3us71QgUsZ1o5K3/dopGx5sMBHadwnMLLFF6lMDpKYTROYXScwuhlCqNXKYyPUhiPUxgfpzB+6dkavwpQixbfPgOjsQfZ9cCFp40uWd5vpWXNJpNpWyu8WLPC52o0hIODVp+4+KeffjpXt+cK4Dwh/TpPJudJS3KepODryGyeJ5NRCqHg5jyZwIvxF5FgSd8vCV3/vaDvEc2G/y7oezw6V6sw6JiZcaKq72GEqn97JuJnWE9UyCNTWTRtVEg2ydNSDc0blbZsUcWqE+gFCSSVdFKUdrdMkeLpidVxtiHZMUnGq3e3WFz99GSKbMUatp2+im1tryqaAWZkvAHB58Nut9mBgB/0qQEQuPpU+V+S/K3N2g1CS/L0kOiz9qlwfDFk94Dt9m4wAsHTg6Jj7FOBeEVA0L61GwWqfXoQBK5iRfAFfN3R8WD0+WB8ND5eg4HOUZ6gqgZ5Plgul58IITBg5B6F8dnZDM6s9wHpzDozutpyUuGDREcV3Cf+Hb3778inn0Z3F3M6JK4fd+PxsO+QO52L5TPru4pNWz+O6Dsvbtljk6uIDz4qZ4WWWWCeaKL3NqXT4JBAGBDw+eF33x32oPSFg6qK+EIspe8BQ98vraphng83addmqFdaQZ6nsKV8e0WeQ1VVu8p9BW2X5+p/hhyHYNdtty4Egt9HHbas+m78nbrSVYhcq5LH58Pddl3Z2F8KqUJFWDewQWBw3pTC4A2dUq3UinH5DSzRhhZFJercfD7U8nmQQwYeCfjsJLjyz8MCJwnWO6CSh9vdEazficE53nAfPp5GzMg8BLZskxV05hPxxECwdwEe/spELSm4UKJzXIouG25jwk9a72BOk7p5Lrfo1oQRFmLLLUdznn0+aIyOeN8L55J7Nr5A8fTMfo+zWOmDHVR9dp5UIrguyQy739oVaM6Ti7aNP5Jj3msL2xrDxT36BJ3S5FiKKZZ3de3R2tAXJ6ysHjhUUUnVRhKY5aPIAdeKm43aULnaomde7P4Cj8Y9qknEGUppYzhlHbR+6xBv4jigQh+xnSLEBjBtl+QnL/mWsceteW8RwvQ8MATRARO2sb442gMjrE1NHxjqo5JKVk3VBi1nba8Rsirs8n28qCXF8uMI/em9M4K4eWCEEE3fMcC5GnFoIQYl2DDAdmcwkDw9y9Dj7OEt8GNsxtq2+bEb3odrYpSrr4lb9kki9Ttkq4V2txoO4YR2JYqY+kYUA8syrB3Fyz5VR1uWH6ejIw4l9WNku3emPtXvvQZ3LabHrM4Nvn+zdRjoPs35ItQetxj7YvwHLcg1th/tLPmAYOWvoXZFAyteek/NGAa2Nrb+JE10zfe6Wr3Jk0ni74jjjWmSct9o3Zc6XyaT2yTE8OlniJBT08OfLd1F3yY2K7AS9CvyRLfXM1lSVxSERmOTNOGgDV1lE2rJJNHTnzFzSUpHjJou2tBSH9xuchup/O1lkoaDezJJ/LVmkiZ4I6qaiEMRoMo0nY65i1Uc8b6+2pKuL8s/2vtj6ofuBz+yG2662ri+/6ie+j2sOly7zoQxYplsZgrEi8F4jvPt2puPchmVRTpSifayismSNJEOq/4oO2bN6A9HOkNNknBs90Pb8rSI6oPHpHZ1odVHNQwXMVswfyRKvvbuwOtT9poOkJhHd3rQ3Z2mwHcWw4dWTKRnacW8P6Z3Du+MebrrTr13lWcL3ZQ5XZKhMEO+2v7ovAlOTRFl1nB2SLtJrEnWstpKNlqlyc3DwtxApgfxwh4+K3HmoKlrNJBpo9A874finoxw4+PjVZosHxZv+R8p3hc0eYuHpfuRMx26LJB/B68vXq3SpHiY17+0uRj/RmaPX666vW5jL7+c6nx5Ge3W6iHCuKkQHeUGvVEnJkfTA2KqdYlC3UHizcx7WRqekTPyLMS7+ApdGhs3FFjIsgSDGVI6Doewo62C4HT4+3UIt5jknH1DBew02mZqiUrF/qzvcIrgjJzPkZKOAgU3DkkCKDjJjdJ0iCsxo/t/TiMyeC11YyN7hbB8j18i+aWuQOkzV6SarzuJPXQ4haMv+7A/O1RCm5yirIKT07ePwJJd2AG4os1Q8FL6PuDk9C0lJslZ8MOG8N62SERoxRoJkF8E11LE5IXWti991AEVI6JZ2LU8smFICRrAXYZyabdylHYx0DYP8U7HXe4aTZFuHCXNyZCPYR3Wdg1H5qIF8lQ3j1mVDyApYN7wdYojlY1ZShyX7RKLpPIJjnwAyhsTc6nCsiBKynbscIqoEFGv/xRQWd9cwExYhyal1EdC3jR0wGm7xJsajUSV4VYIDHroLhuz1W9ax2A9S+f9D9+GjMUoQ1TKKWmg7xhzaGpeNawJbfZYnLlN0e84SqQdaC53OWh3XQ/O8QrBthqN1QooNcvMhZK/+iXMHom2CFMsROlJg6mgyyjihzR8nZloa//1j3/2+Nrpcd5lzI8g8pxuAx7gkA+4fsGTx22wJguo1zmi/tD83+YmQNyx0lxWOm8VyT5+jb+llEJnW7voNCehYok+TTbeTrT21qbRxtrgVtIlheHLBE6n1TXJizfSul7+U7x6vGsffkDCMevxwG4IaTWtebXsK3jLV8iz6rrjLC25njrXboMbunD/dub3u+5MGkwx5YNqZb1HPj46on8bE7+WtUyK2WY0l8s/JOnjD8T3Hwd8MR3B7y7FbsV8WYz/YmtVZQUtkgqtXffotzR5QIA+blKVUuFlBOVyfHR0+Tkht0qT423gvNMVuoJXBNmChdGUXFyXKCjV1SxBzIVUQMOb3xArNEab+6X+MM7uA+H46Ohy1ILw+V0Q3ii+n+FE9lN9her3lbQ/vPPDE6s3FVs1b3YT6Ym4PlkTtl/uhbSYNUa6ZTI5u01uBqKWA18/ObtYXdCqc4WmUFGtLXMsXJFMksM7kSN+SUBhibPbhLenJLq+VqicrlDuuL+ilofXo2SVbrbY6izvpLZOzKWaD+5tddGJ+o6mwyO+JnB3tq/l35AO9wHPPlWaSFoGBQpyjwlBmuUfurDZN3GuYkBra4yqm5TNqFMMOq3FkTZN/5bIUC8wdBajMhxoaeMsSSdR0sZC6Gcb3Tjrll4bSIhxhBEfwMfHx3xS/WLER7oXr/i0dPxydeER7p0cODTZd3990HzNjwtF635Nkmz4EWub+eZevnNf3bGtRl9KqpnmOQ/zcFKjekeuKqnW9eju6RTLTFdtenAk/9c//skt4jbGw/wBThoDtV6gobcwlO87K/FGknPYe6pDwTcOUouqRGspIqcczv0zFznnfIHocWWiFlNZSrIVRKZ9jk7P3Ngh/FggXRZQ1TPjUyeusSQTA6XW/AiEvIPG6ar/lAYW2lzNiKUUBEzp1QD5PBYxNkFVCJVR4N6rEPsL9OiFfNjaSIsgZEXE5EvjbCYzSR2TYTQic1AJJea88ad8SiYU6pjzb/SUjiJWl413tunlAaLzIvLFwRC+psMNC06FOTqa9tz72Tb155xgJ8OjmimdKWsaXmZou4SrEq/RsMnwp9SmLKHWzp8cyfPpzy115IxQls7hnqE4NS18wRvmMXKxHALdHtCeRD4hLYBSqit6AjOAs3aZ/YhTKx12EYLFYnHHfD1fb/Nn6YpmSv6l7trNuZCNXb95+/GcjA2ayp7M3qG5lhkG27ljzEMmPgzbmsh4W4vKJmq51YMtZYbKYm8Tev3nt9/CNbwYHiVpz2A/guHDb9989c33776hfmlL8fo3Gh4Njzisqa2rhOoN9ZV/6XbamdCNoHu7P++fz+2fz+2fz+2fz+2fz+2fz+2fz+2fz+2fz+2fz+2fz+2fzz0o//753P753P753P753P753P753P753P753P753P753P753P753P753P753P753P753P753H/H87mQHkOO42FdCsn5VSEb16dGnW0+qrtIk4JypyZnye0tXS2+N+VqRcW/NGgo8eoiTa6FkRQ+57SrNKYXUULOFS7pitvfBgxOafzUr3u+jt/INqPsKN/iNc/+vbT99K63J+9OkzSZhod/lc6pjRELehQoFskkIaPNDwjb/FQuv01KoeYN5wglvl/KihKNK9ZTqq44pSr86KUaCbXscbmea+VFob8k2NYGf6Q78b/h8n9bcl+zs0HANlLTFF6sVqv/B65i1wk=",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:"eJztW91yI7exfpXO3KxXNaRErrzew0qdOuufJJvY1pZXW66UpJLBmSYH1gwwBjCiaBXv8iR5tDzJqW4AM0OKlLS7Lkep8EbiAA2g+wO60Wg0bhMn5jaZnCWnWNWlcGiTizTJ0WZG1k5qlUyS0wIhVsNXBgWVw+u3b0CUpV5YaCwaC05DRpUIWWOdruSvYloiuNhxCotCZgVYNNcIwsK0bLA2UjkLM21gjgqNcFLNIddZUyFVLKQroDaY40wqzME602SuMWiH8L7WCmyTZWjtrCnbkTwbUqsUXIHMqEHXGGVBQKPkLw3CwUGkvpT5wQG4QjjIhIIpkjg5SRMYwh47U0F1WnHHtsZMziQRh76G5+pcncp6Au/rUosclrox8PbrP7VdUL9UdnZw8DVOmzm8f3NwcPFZ4VxtJ4eHoq6HukZl5VyVYmqHma4OcyKs89lzQhANUq/MKworyyWIPIeFzOfoLEusINP1EjKtTS6Vh74WcwTVVFM0NgWhcqi0QZAKBBgU+XLg9KCxCH99d/I9TUcl3BDelo1N2+FyaTBz5dJ3TwhEqZ55ZF4e0/xINU+hElc0kdLBL43Mrkhsi4phDXPCWB0cvGvqWhuHOfzoRZgcHFDNl1jqBQiDTJ/pqtIKamFEhY5XG00YVRv8pZEGc79URFlGLCbUzYBmelnj5OAA3qhcZgQHd0mloGeBeuhJCSYifRem1pP2wKO598uYUFkIP6N1KTLPqEFaFU5e43rHNyksqeOvUenIQaGN/FUrJ0qekGs0Tmai7E8cMchLzQnDmlFrqVwsDSPA38ME0fzxtISVRazlBFclFddYhGtRNmgDV4sUCuLqB6wNWl7hoV+CUuVQoJwXO8cT+c+NdWsdQ2OJzT4XYaw4TwwvMmwzUVoEOVvDshJX2BsNNJshUQ7hyyXkOBNN6VKQtOacaXAI32sHoq5LmbG9IVNC6iPISgx4lsOCCIwoUfEcvzX6WuZIRiGXsxkaUk+q5C5Cm8gdrbSaG5B4rDuuEAq02pjoTJfaUPcba4jL14GETCuHyg3h9bWQJXPvpbUgVVY2OcK0FNlVyqYyBYO5190lkuFN/ZJnErKnHnQGCCyWtAy1IgGUDsNL2xmt4WkhbadRVBeh5jGk7aMa9HamaWCCICoZYCVkmTJwKfysp+CkKzElla2FWqaQC4cpOLxxU32TQlZgdsW/jMilhmnjHJlqGjM3us71QgUsZ1o5K3/dopGx5sMBHadwnMLLFF6lMDpKYTROYXScwuhlCqNXKYyPUhiPUxgfpzB+6dkavwpQixbfPgOjsQfZ9cCFp40uWd5vpWXNJpNpWyu8WLPC52o0hIODVp+4+KeffjpXt+cK4Dwh/TpPJudJS3KepODryGyeJ5NRCqHg5jyZwIvxF5FgSd8vCV3/vaDvEc2G/y7oezw6V6sw6JiZcaKq72GEqn97JuJnWE9UyCNTWTRtVEg2ydNSDc0blbZsUcWqE+gFCSSVdFKUdrdMkeLpidVxtiHZMUnGq3e3WFz99GSKbMUatp2+im1tryqaAWZkvAHB58Nut9mBgB/0qQEQuPpU+V+S/K3N2g1CS/L0kOiz9qlwfDFk94Dt9m4wAsHTg6Jj7FOBeEVA0L61GwWqfXoQBK5iRfAFfN3R8WD0+WB8ND5eg4HOUZ6gqgZ5Plgul58IITBg5B6F8dnZDM6s9wHpzDozutpyUuGDREcV3Cf+Hb3778inn0Z3F3M6JK4fd+PxsO+QO52L5TPru4pNWz+O6Dsvbtljk6uIDz4qZ4WWWWCeaKL3NqXT4JBAGBDw+eF33x32oPSFg6qK+EIspe8BQ98vraphng83addmqFdaQZ6nsKV8e0WeQ1VVu8p9BW2X5+p/hhyHYNdtty4Egt9HHbas+m78nbrSVYhcq5LH58Pddl3Z2F8KqUJFWDewQWBw3pTC4A2dUq3UinH5DSzRhhZFJercfD7U8nmQQwYeCfjsJLjyz8MCJwnWO6CSh9vdEazficE53nAfPp5GzMg8BLZskxV05hPxxECwdwEe/spELSm4UKJzXIouG25jwk9a72BOk7p5Lrfo1oQRFmLLLUdznn0+aIyOeN8L55J7Nr5A8fTMfo+zWOmDHVR9dp5UIrguyQy739oVaM6Ti7aNP5Jj3msL2xrDxT36BJ3S5FiKKZZ3de3R2tAXJ6ysHjhUUUnVRhKY5aPIAdeKm43aULnaomde7P4Cj8Y9qknEGUppYzhlHbR+6xBv4jigQh+xnSLEBjBtl+QnL/mWsceteW8RwvQ8MATRARO2sb442gMjrE1NHxjqo5JKVk3VBi1nba8Rsirs8n28qCXF8uMI/em9M4K4eWCEEE3fMcC5GnFoIQYl2DDAdmcwkDw9y9Dj7OEt8GNsxtq2+bEb3odrYpSrr4lb9kki9Ttkq4V2txoO4YR2JYqY+kYUA8syrB3Fyz5VR1uWH6ejIw4l9WNku3emPtXvvQZ3LabHrM4Nvn+zdRjoPs35ItQetxj7YvwHLcg1th/tLPmAYOWvoXZFAyteek/NGAa2Nrb+JE10zfe6Wr3Jk0ni74jjjWmSct9o3Zc6XyaT2yTE8OlniJBT08OfLd1F3yY2K7AS9CvyRLfXM1lSVxSERmOTNOGgDV1lE2rJJNHTnzFzSUpHjJou2tBSH9xuchup/O1lkoaDezJJ/LVmkiZ4I6qaiEMRoMo0nY65i1Uc8b6+2pKuL8s/2vtj6ofuBz+yG2662ri+/6ie+j2sOly7zoQxYplsZgrEi8F4jvPt2puPchmVRTpSifayismSNJEOq/4oO2bN6A9HOkNNknBs90Pb8rSI6oPHpHZ1odVHNQwXMVswfyRKvvbuwOtT9poOkJhHd3rQ3Z2mwHcWw4dWTKRnacW8P6Z3Du+MebrrTr13lWcL3ZQ5XZKhMEO+2v7ovAlOTRFl1nB2SLtJrEnWstpKNlqlyc3DwtxApgfxwh4+K3HmoKlrNJBpo9A874finoxw4+PjVZosHxZv+R8p3hc0eYuHpfuRMx26LJB/B68vXq3SpHiY17+0uRj/RmaPX666vW5jL7+c6nx5Ge3W6iHCuKkQHeUGvVEnJkfTA2KqdYlC3UHizcx7WRqekTPyLMS7+ApdGhs3FFjIsgSDGVI6Doewo62C4HT4+3UIt5jknH1DBew02mZqiUrF/qzvcIrgjJzPkZKOAgU3DkkCKDjJjdJ0iCsxo/t/TiMyeC11YyN7hbB8j18i+aWuQOkzV6SarzuJPXQ4haMv+7A/O1RCm5yirIKT07ePwJJd2AG4os1Q8FL6PuDk9C0lJslZ8MOG8N62SERoxRoJkF8E11LE5IXWti991AEVI6JZ2LU8smFICRrAXYZyabdylHYx0DYP8U7HXe4aTZFuHCXNyZCPYR3Wdg1H5qIF8lQ3j1mVDyApYN7wdYojlY1ZShyX7RKLpPIJjnwAyhsTc6nCsiBKynbscIqoEFGv/xRQWd9cwExYhyal1EdC3jR0wGm7xJsajUSV4VYIDHroLhuz1W9ax2A9S+f9D9+GjMUoQ1TKKWmg7xhzaGpeNawJbfZYnLlN0e84SqQdaC53OWh3XQ/O8QrBthqN1QooNcvMhZK/+iXMHom2CFMsROlJg6mgyyjihzR8nZloa//1j3/2+Nrpcd5lzI8g8pxuAx7gkA+4fsGTx22wJguo1zmi/tD83+YmQNyx0lxWOm8VyT5+jb+llEJnW7voNCehYok+TTbeTrT21qbRxtrgVtIlheHLBE6n1TXJizfSul7+U7x6vGsffkDCMevxwG4IaTWtebXsK3jLV8iz6rrjLC25njrXboMbunD/dub3u+5MGkwx5YNqZb1HPj46on8bE7+WtUyK2WY0l8s/JOnjD8T3Hwd8MR3B7y7FbsV8WYz/YmtVZQUtkgqtXffotzR5QIA+blKVUuFlBOVyfHR0+Tkht0qT423gvNMVuoJXBNmChdGUXFyXKCjV1SxBzIVUQMOb3xArNEab+6X+MM7uA+H46Ohy1ILw+V0Q3ii+n+FE9lN9her3lbQ/vPPDE6s3FVs1b3YT6Ym4PlkTtl/uhbSYNUa6ZTI5u01uBqKWA18/ObtYXdCqc4WmUFGtLXMsXJFMksM7kSN+SUBhibPbhLenJLq+VqicrlDuuL+ilofXo2SVbrbY6izvpLZOzKWaD+5tddGJ+o6mwyO+JnB3tq/l35AO9wHPPlWaSFoGBQpyjwlBmuUfurDZN3GuYkBra4yqm5TNqFMMOq3FkTZN/5bIUC8wdBajMhxoaeMsSSdR0sZC6Gcb3Tjrll4bSIhxhBEfwMfHx3xS/WLER7oXr/i0dPxydeER7p0cODTZd3990HzNjwtF635Nkmz4EWub+eZevnNf3bGtRl9KqpnmOQ/zcFKjekeuKqnW9eju6RTLTFdtenAk/9c//skt4jbGw/wBThoDtV6gobcwlO87K/FGknPYe6pDwTcOUouqRGspIqcczv0zFznnfIHocWWiFlNZSrIVRKZ9jk7P3Ngh/FggXRZQ1TPjUyeusSQTA6XW/AiEvIPG6ar/lAYW2lzNiKUUBEzp1QD5PBYxNkFVCJVR4N6rEPsL9OiFfNjaSIsgZEXE5EvjbCYzSR2TYTQic1AJJea88ad8SiYU6pjzb/SUjiJWl413tunlAaLzIvLFwRC+psMNC06FOTqa9tz72Tb155xgJ8OjmimdKWsaXmZou4SrEq/RsMnwp9SmLKHWzp8cyfPpzy115IxQls7hnqE4NS18wRvmMXKxHALdHtCeRD4hLYBSqit6AjOAs3aZ/YhTKx12EYLFYnHHfD1fb/Nn6YpmSv6l7trNuZCNXb95+/GcjA2ayp7M3qG5lhkG27ljzEMmPgzbmsh4W4vKJmq51YMtZYbKYm8Tev3nt9/CNbwYHiVpz2A/guHDb9989c33776hfmlL8fo3Gh4Njzisqa2rhOoN9ZV/6XbamdCNoHu7P++fz+2fz+2fz+2fz+2fz+2fz+2fz+2fz+2fz+2fz+2fz+2fzz0o//753P753P753P753P753P753P753P753P753P753P753P753P753P753P753P753P753H/H87mQHkOO42FdCsn5VSEb16dGnW0+qrtIk4JypyZnye0tXS2+N+VqRcW/NGgo8eoiTa6FkRQ+57SrNKYXUULOFS7pitvfBgxOafzUr3u+jt/INqPsKN/iNc/+vbT99K63J+9OkzSZhod/lc6pjRELehQoFskkIaPNDwjb/FQuv01KoeYN5wglvl/KihKNK9ZTqq44pSr86KUaCbXscbmea+VFob8k2NYGf6Q78b/h8n9bcl+zs0HANlLTFF6sVqv/B65i1wk=",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 s={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"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)(s.p,{children:"Create Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(s.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)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(s.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(s.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)(s.p,{children:(0,i.jsx)(s.strong,{children:"Supported Widgets:"})}),"\n",(0,i.jsx)(s.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.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)(s.li,{children:[(0,i.jsx)(s.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)(s.li,{children:[(0,i.jsx)(s.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)(s.li,{children:[(0,i.jsx)(s.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.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)(s.li,{children:[(0,i.jsx)(s.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)(s.p,{children:(0,i.jsx)(s.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ol,{start:"2",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ol,{start:"3",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ol,{start:"4",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ol,{start:"5",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ol,{start:"6",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ol,{start:"7",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ol,{start:"8",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.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)(s.li,{children:[(0,i.jsx)(s.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(s.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(s.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(s.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(s.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(s.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(s.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(s.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(s.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.ol,{start:"9",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.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)(s.ol,{start:"10",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(s.ol,{start:"11",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.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)(s.ol,{start:"12",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.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)(s.ol,{start:"13",children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.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)(s.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)(n,{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)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.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)(n,{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)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(s.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)(s.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)(n,{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)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.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)(s.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)(s.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)(s.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}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.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)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(n,{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)(s.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.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)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(n,{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)(s.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)(s.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)(h.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(n,{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)(s.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 y(e={}){const{wrapper:s}={...(0,a.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.1e734052.js b/assets/js/f0ff4a36.1e734052.js new file mode 100644 index 000000000..ba9e71487 --- /dev/null +++ b/assets/js/f0ff4a36.1e734052.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>g,toc:()=>f});var i=a(85893),n=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WNtuGzcQ/RWGL02A1c1WnFQoihht6roJ6qB2EKCOIHB3R7uMuSRDzkoWBL31S/pp/ZJiuBevbNmO0DQvtpacO2fODLnmKDLPJ5f8Z5OUBWj0fBrxFHzipEVpNJ/wixzYCSBrSNjxu1MGWsQKPFuZkqFhDtBJWABLAYVUnonYlMgE8xYSOZcJS2vuPo+4seAEST9N+YRngM0mj7gVThSA4MisNdeiAD7hDcFMpjziksyyAnN+21YTf4IET1Nm5q29POIOPpfSQcon6EqIuMeVIrFeFlYBjzhcW2VS4JO5UJ4IkhwKwSdrjisbKNFJnfGIz40rBHZX4FoEKRNufx3FeXKQ25hvNlNS663RHjwJOhgO6d+2vb5MEvB+XirWBoVHPDEayfLJmgtrlUzCxuCTJ6b1Xesqtyl6jsSgrFR6FFj6fb2QumedyRx4zzdRG9J9xfxyIq8ODuP8/W8kZS5pcT8JOaL1k8GgXimd6iemIGkocX9xPvygRCQR2uDeEqwC4YF5mek2n4NzRqXgHj+PrxPKqiT2k1BZyALr5iaAN3VVu0DnvdRbvnyR/E8GWAxA/BSdUL2tBOGcWFHZIhT+8Sg5s/tsb7QlYB4KxE6zoBBSPUodA7yqF5pcs7nRj6gZPz86GB2+fDEi+qVMM8D/4H+1e1ffNnIcK2WWkLKFUCV41gtZKbB0EDGPorD9x8qhoSejrzsKdVnE4Lrc7UrLfTAebyK+2pPrxYjisyfT4ctNxPM9mcZHdHIigz35Rt3iQCisEgiz8yqlZ83Rbh6iCvXlQaen+sxtw0JsjAKhuwqpH20injgQCOkxPpxoB8ODw95o2Bu+uBgdTcbfT54f9YfD4Z884tdFyO6mXwoE3q3z+ru06TfRU40HF6b8MvcdpNJBgrPS7azRh/KY1AkqhllhUho1Qq/0D+sNbZ4O6pY7NRwuJeZ189wBlt3dkArjXa393BSAudQZW9LQtHRGZxGrWwi6FROZkJpR6rgnX6/ng3NmJ3zfRGw/y7q5LrWSGmbNXDMbD4ezURuE8d0gtDOjNsjmptTpt3V1l/6HHRrPDluHnt916FQvhJJpmIEvzBXob+tPVz1W6u9msayIwj7fcra7XjnpISmdxFUYtq97wspetT+5nNIIS5li6ik9TOeY8wkfNKUwWHcm8w0neW7RzO6hmNspzgudxua6byxo6j1KxJ567EBYOVhQ67zNIazdg9qjyKTOeg9yTW88PqdTqQK/5fdN27byDVDfrsPaparvIDmIMDVt6HtuAnMd7DMLmjpCOKrF6E7//gAqMQXQ5QlzYA35P3/9HTiasIZMesLOSsesWYKjm4LQKZsruJaxgkAc4K+9i3kQhQLv1YpJjZA5gcBSmUkUKkwJVPmJsCKWSlLuEZkhbsc66ev77EMOmIOjre8cMMFSWICilGXKmCuSg4aJEk0RdDTFtjTuak4mRUywuPRSg/fMAzQsoHOhE2DNWUTMOCY0A43grJMemJAFEc+NYzCfy0SSYCo0JxJkhdAiA1IWMbKbomCdWcgUPHMmLj0yb1QZHCGNBQBWLmqA1PfZz3IBleO0WF1bIWVZSSIilpgUWF135IZOWQwemSX1MoEg1KNwyBQswIXcCyc5L5Vi1hAgSKHoIto9WxKETmhPLa0yqDmaNnzWGboUBh2pWPXZR/1RE2iz0gMlgJL6yk8+6h67bNPsA8ReIkyfNvWwXC7v1MGzbZ4TiXkZMwfW3PBlYTFUTZe9/XjGI47gCn82Pwe3kElzVbtH5yAQD2qYFEmAyXoapxp7dZuBIEvJBLSHDqgdn7x7yxbssD/kUafyv8DgwdvTn17/fv6a5BI2VfU36g/7wzDfG4+F0B1V3ceO23W7vgH7/+FhpEYehGscWCVkgO96Jqqg95J33kom3WeRacRz45FI1utYeHjv1GZDy59LcATw04gvhJNkX8DnVHr6nbavHvd6+vSP+gHlGbvnhWWn5Q2QakLRcFGheS3iV7C69aazmdKQX6EpmVZRHCcJWOzw3umuWy3q5PUFj7goMd9G8auA4vUPkr7Trm14rwygv9RpdjL8QMf9BlY/tuTVzr0MtX8NNcVoutls/gULX7n2",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WNtuGzcQ/RWGL02A1c1WnFQoihht6roJ6qB2EKCOIHB3R7uMuSRDzkoWBL31S/pp/ZJiuBevbNmO0DQvtpacO2fODLnmKDLPJ5f8Z5OUBWj0fBrxFHzipEVpNJ/wixzYCSBrSNjxu1MGWsQKPFuZkqFhDtBJWABLAYVUnonYlMgE8xYSOZcJS2vuPo+4seAEST9N+YRngM0mj7gVThSA4MisNdeiAD7hDcFMpjziksyyAnN+21YTf4IET1Nm5q29POIOPpfSQcon6EqIuMeVIrFeFlYBjzhcW2VS4JO5UJ4IkhwKwSdrjisbKNFJnfGIz40rBHZX4FoEKRNufx3FeXKQ25hvNlNS663RHjwJOhgO6d+2vb5MEvB+XirWBoVHPDEayfLJmgtrlUzCxuCTJ6b1Xesqtyl6jsSgrFR6FFj6fb2QumedyRx4zzdRG9J9xfxyIq8ODuP8/W8kZS5pcT8JOaL1k8GgXimd6iemIGkocX9xPvygRCQR2uDeEqwC4YF5mek2n4NzRqXgHj+PrxPKqiT2k1BZyALr5iaAN3VVu0DnvdRbvnyR/E8GWAxA/BSdUL2tBOGcWFHZIhT+8Sg5s/tsb7QlYB4KxE6zoBBSPUodA7yqF5pcs7nRj6gZPz86GB2+fDEi+qVMM8D/4H+1e1ffNnIcK2WWkLKFUCV41gtZKbB0EDGPorD9x8qhoSejrzsKdVnE4Lrc7UrLfTAebyK+2pPrxYjisyfT4ctNxPM9mcZHdHIigz35Rt3iQCisEgiz8yqlZ83Rbh6iCvXlQaen+sxtw0JsjAKhuwqpH20injgQCOkxPpxoB8ODw95o2Bu+uBgdTcbfT54f9YfD4Z884tdFyO6mXwoE3q3z+ru06TfRU40HF6b8MvcdpNJBgrPS7azRh/KY1AkqhllhUho1Qq/0D+sNbZ4O6pY7NRwuJeZ189wBlt3dkArjXa393BSAudQZW9LQtHRGZxGrWwi6FROZkJpR6rgnX6/ng3NmJ3zfRGw/y7q5LrWSGmbNXDMbD4ezURuE8d0gtDOjNsjmptTpt3V1l/6HHRrPDluHnt916FQvhJJpmIEvzBXob+tPVz1W6u9msayIwj7fcra7XjnpISmdxFUYtq97wspetT+5nNIIS5li6ik9TOeY8wkfNKUwWHcm8w0neW7RzO6hmNspzgudxua6byxo6j1KxJ567EBYOVhQ67zNIazdg9qjyKTOeg9yTW88PqdTqQK/5fdN27byDVDfrsPaparvIDmIMDVt6HtuAnMd7DMLmjpCOKrF6E7//gAqMQXQ5QlzYA35P3/9HTiasIZMesLOSsesWYKjm4LQKZsruJaxgkAc4K+9i3kQhQLv1YpJjZA5gcBSmUkUKkwJVPmJsCKWSlLuEZkhbsc66ev77EMOmIOjre8cMMFSWICilGXKmCuSg4aJEk0RdDTFtjTuak4mRUywuPRSg/fMAzQsoHOhE2DNWUTMOCY0A43grJMemJAFEc+NYzCfy0SSYCo0JxJkhdAiA1IWMbKbomCdWcgUPHMmLj0yb1QZHCGNBQBWLmqA1PfZz3IBleO0WF1bIWVZSSIilpgUWF135IZOWQwemSX1MoEg1KNwyBQswIXcCyc5L5Vi1hAgSKHoIto9WxKETmhPLa0yqDmaNnzWGboUBh2pWPXZR/1RE2iz0gMlgJL6yk8+6h67bNPsA8ReIkyfNvWwXC7v1MGzbZ4TiXkZMwfW3PBlYTFUTZe9/XjGI47gCn82Pwe3kElzVbtH5yAQD2qYFEmAyXoapxp7dZuBIEvJBLSHDqgdn7x7yxbssD/kUafyv8DgwdvTn17/fv6a5BI2VfU36g/7wzDfG4+F0B1V3ceO23W7vgH7/+FhpEYehGscWCVkgO96Jqqg95J33kom3WeRacRz45FI1utYeHjv1GZDy59LcATw04gvhJNkX8DnVHr6nbavHvd6+vSP+gHlGbvnhWWn5Q2QakLRcFGheS3iV7C69aazmdKQX6EpmVZRHCcJWOzw3umuWy3q5PUFj7goMd9G8auA4vUPkr7Trm14rwygv9RpdjL8QMf9BlY/tuTVzr0MtX8NNcVoutls/gULX7n2",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},j={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"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)(s.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(s.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)("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)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.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)(a,{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)(s.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:"status",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"in-progress"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{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)(s.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{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)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.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)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{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)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.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)(s.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:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)(s.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)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "status": "in-progress",\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.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)(a,{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)(s.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)(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:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.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)(a,{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)(s.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:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.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)(a,{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)(s.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)(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 y(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.28386b54.js b/assets/js/f0ff4a36.28386b54.js deleted file mode 100644 index 98d526eeb..000000000 --- a/assets/js/f0ff4a36.28386b54.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),o=s(41429),c=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9uIzUQf5XBX+Ckbf60uTuIEKKCoxQQh2jRSdxFkXd3kvXVaxt7NmkU7TeehEfjSdB4d9NNm+tdBNyXNmvPf8/8ZuytILkMYvpafGuzqkRDQcwSkWPIvHKkrBFTcV0gXCBBRwLnv1wCGplqDLCxFZAFj+QVrhByJKl0AJnaikBCcJiphcogb7kHIhHWoZcs/TIXU7FE6jZFIpz0skRCz2ZthZEliqnoCOYqF4lQbJaTVIj7ttr0LWZ0mYNd7OwVifD4R6U85mJKvsJEBNpoFhtU6TSKROCt0zZHMV1IHZggK7CUYroVtHGRkrwyS5GIhfWlpP4K3sooZSrc9+O0yE4Ll4q6nrHa4KwJGFjQ6WjE//btDVWWYQiLSsMuKCIRmTXElk+3QjqnVRY3hm8DM20fWte4zdHzLIZUo7KLxrF+fHehbk7P0uK3H0SdiIXixeMkFEQuTIfDdqXyepDZkqWRouPFhfiDc4hFGEtHS3AaZUAIaml2qRidszpH/7FC2WTzcRIaCyGy1ncBvCuJ1oU6EXZt9nz5IPlvLUKKyPwcnVh4OwnSe7nhiiMsw/uj5O3hs73TlqF9LBAHzcJSKv1e6hTx63ahyzVXWPMeNZOnz07HZ58/HzP9WuVLpH/hf7P7UN9+0Z9rbdeYw0rqCgOcxKyUVHlMIJAs3eB95dDRs9G3PYWmKlP0fe7dyo77dDKpE7E5kuv5mONzJNPZ53UiiiOZJs/45OQSj+Qb94uDsHRaEs6vmpSed0dbP0YV6yugyS/NS78PC6m1GqXpK+RWUici8ygJ83N6PNFOR6dnJ+PRyej59fjZdPLF9OmzwWg0+l0k4raM2d21Okko+nXeflcu/yh6ms5+basPc99jrjxmNK/8wRp9LI9ZneRimJc25ykhtrnwuN7Yofmg7rnTA/X7EMmnXidicqgDX9kSqVBmCWuebdbemmUCbbsgvwG5lMoAp4n/5L9rzei9PQjVd9E5zrJ+XiujlcF5N37MJ6PRfLwLwuRhEHajnbEEC1uZ/OO6ekj/4w5N5mc7h54+dOjSrKRWeRxVr+0Nmo/rT189NeofZqxqiOK+2HO2v944GTCrvKJNnIlvT6RTJ83+9PWMJ03OFNsO03GIpkJMxbArgOG2N0DXguX5VTdix8LdTWxBmjy1twPr0HCf0TIN3E+H0qnhitvkfQ7p3BHUgeRSmeXJo1yzO4+v+FSawO/5fdeinfoRuUe3Ye1TtVeFAmWckGr+XtjI3Ab7pUPD6B+PajV+0Ktfoc5siXzHoQKhI//7z78iRxfWmEmfwMvKg7Nr9DzQS5PDQuOtSjVG4gh1uytTQFlqDEFvQBnCpZeEkKulIqnjRMCVn0knU6UV5x6TWeb20EvfMIBXBVKBnrc+9QgSclyh5pQFbe0NyyELsiJbRh1dsa2tv1mwSQlISKugDIYAAbFjQVNIkyF0Z5GA9SANoCH0zquAIFXJxAvrARcLlSkWzIXmZUZQSiOXyMoSYLs5Cs7blcoxgLdpFQiC1VV0hDWWiNS4aBDzMIBv1Qobx3mxuV1iDsuKRSSQ2RyhrTt2w+SQYiBwrF5lGIUGkp5A4wp9zL14kotKa3CWAUFJzffF/tmyIPLSBG5fjUHd0ezC57zlu1vUkcvNAN6YN4ZBG6qAnABamZswfWNO4PUuzV5hGhTh7LOuHtbr9YM6eLLPc6GoqFLw6Owd3zIuxqrps+8+nohEEPoyvFxcoV+prLuWvUPnMBIPW5iUWYTJdvLmGvv6PgNDllYZmoA9UDu/+OUnWMHZYCSSXuV/gMHDny6/efHz1QuWy9jU1N94MBqM4ixvA5XS9FT13yTu1+32Duz/h/eLFnkIb2notFQRvtv5p4He16L3pDHtv17MElHYQEyy3aYy4G9e1zUv/1GhZ4CfJWIlvWL7Ij7nKvDvfPc48U5PP/u1fed4Au94CDloeQekhlE0Xkp4NkvEDW7uPb3UMx7oGzRl0xqK8yxDRz3eB911r0VdvLgWiZAVFfsofhNRvP3B0g/atQ/vjQH8lzvNQYYv+bh/xM1XO/Jm550MrX8dNcdoVtf1P3KYmXQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9uIzUQf5XBX+Ckbf60uTuIEKKCoxQQh2jRSdxFkXd3kvXVaxt7NmkU7TeehEfjSdB4d9NNm+tdBNyXNmvPf8/8ZuytILkMYvpafGuzqkRDQcwSkWPIvHKkrBFTcV0gXCBBRwLnv1wCGplqDLCxFZAFj+QVrhByJKl0AJnaikBCcJiphcogb7kHIhHWoZcs/TIXU7FE6jZFIpz0skRCz2ZthZEliqnoCOYqF4lQbJaTVIj7ttr0LWZ0mYNd7OwVifD4R6U85mJKvsJEBNpoFhtU6TSKROCt0zZHMV1IHZggK7CUYroVtHGRkrwyS5GIhfWlpP4K3sooZSrc9+O0yE4Ll4q6nrHa4KwJGFjQ6WjE//btDVWWYQiLSsMuKCIRmTXElk+3QjqnVRY3hm8DM20fWte4zdHzLIZUo7KLxrF+fHehbk7P0uK3H0SdiIXixeMkFEQuTIfDdqXyepDZkqWRouPFhfiDc4hFGEtHS3AaZUAIaml2qRidszpH/7FC2WTzcRIaCyGy1ncBvCuJ1oU6EXZt9nz5IPlvLUKKyPwcnVh4OwnSe7nhiiMsw/uj5O3hs73TlqF9LBAHzcJSKv1e6hTx63ahyzVXWPMeNZOnz07HZ58/HzP9WuVLpH/hf7P7UN9+0Z9rbdeYw0rqCgOcxKyUVHlMIJAs3eB95dDRs9G3PYWmKlP0fe7dyo77dDKpE7E5kuv5mONzJNPZ53UiiiOZJs/45OQSj+Qb94uDsHRaEs6vmpSed0dbP0YV6yugyS/NS78PC6m1GqXpK+RWUici8ygJ83N6PNFOR6dnJ+PRyej59fjZdPLF9OmzwWg0+l0k4raM2d21Okko+nXeflcu/yh6ms5+basPc99jrjxmNK/8wRp9LI9ZneRimJc25ykhtrnwuN7Yofmg7rnTA/X7EMmnXidicqgDX9kSqVBmCWuebdbemmUCbbsgvwG5lMoAp4n/5L9rzei9PQjVd9E5zrJ+XiujlcF5N37MJ6PRfLwLwuRhEHajnbEEC1uZ/OO6ekj/4w5N5mc7h54+dOjSrKRWeRxVr+0Nmo/rT189NeofZqxqiOK+2HO2v944GTCrvKJNnIlvT6RTJ83+9PWMJ03OFNsO03GIpkJMxbArgOG2N0DXguX5VTdix8LdTWxBmjy1twPr0HCf0TIN3E+H0qnhitvkfQ7p3BHUgeRSmeXJo1yzO4+v+FSawO/5fdeinfoRuUe3Ye1TtVeFAmWckGr+XtjI3Ab7pUPD6B+PajV+0Ktfoc5siXzHoQKhI//7z78iRxfWmEmfwMvKg7Nr9DzQS5PDQuOtSjVG4gh1uytTQFlqDEFvQBnCpZeEkKulIqnjRMCVn0knU6UV5x6TWeb20EvfMIBXBVKBnrc+9QgSclyh5pQFbe0NyyELsiJbRh1dsa2tv1mwSQlISKugDIYAAbFjQVNIkyF0Z5GA9SANoCH0zquAIFXJxAvrARcLlSkWzIXmZUZQSiOXyMoSYLs5Cs7blcoxgLdpFQiC1VV0hDWWiNS4aBDzMIBv1Qobx3mxuV1iDsuKRSSQ2RyhrTt2w+SQYiBwrF5lGIUGkp5A4wp9zL14kotKa3CWAUFJzffF/tmyIPLSBG5fjUHd0ezC57zlu1vUkcvNAN6YN4ZBG6qAnABamZswfWNO4PUuzV5hGhTh7LOuHtbr9YM6eLLPc6GoqFLw6Owd3zIuxqrps+8+nohEEPoyvFxcoV+prLuWvUPnMBIPW5iUWYTJdvLmGvv6PgNDllYZmoA9UDu/+OUnWMHZYCSSXuV/gMHDny6/efHz1QuWy9jU1N94MBqM4ixvA5XS9FT13yTu1+32Duz/h/eLFnkIb2notFQRvtv5p4He16L3pDHtv17MElHYQEyy3aYy4G9e1zUv/1GhZ4CfJWIlvWL7Ij7nKvDvfPc48U5PP/u1fed4Au94CDloeQekhlE0Xkp4NkvEDW7uPb3UMx7oGzRl0xqK8yxDRz3eB911r0VdvLgWiZAVFfsofhNRvP3B0g/atQ/vjQH8lzvNQYYv+bh/xM1XO/Jm550MrX8dNcdoVtf1P3KYmXQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"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)(a.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.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)(a.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",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(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)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(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)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(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)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.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)(a.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:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)(a.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)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.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)(a.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)(h.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)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.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)(a.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:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.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)(a.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)(h.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 y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.75afcb3d.js b/assets/js/runtime~main.0e6ee825.js similarity index 81% rename from assets/js/runtime~main.75afcb3d.js rename to assets/js/runtime~main.0e6ee825.js index ab98993df..5e9c5c943 100644 --- a/assets/js/runtime~main.75afcb3d.js +++ b/assets/js/runtime~main.0e6ee825.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,d,f={},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 f[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=f,t.c=r,e=[],t.O=(a,c,b,d)=>{if(!c){var f=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,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 d=Object.create(null);t.r(d);var f={};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=>f[a]=()=>e[a]));return f.default=()=>e,t.d(d,f),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({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",3965:"reactPlayerVidyard",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:"a9f09360",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:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e283f01a",339:"d2fe2a74",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"28386b54",1477:"b31b2642",1512:"9637e502",1520:"523b2d80",1531:"3855f22e",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"6b36ff91",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",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",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:"84114f8b",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"5f8c6828",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",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:"a94482e8",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"8bd89dab",8140:"901b2f91",8141:"81bec72f",8163:"4d9dbd85",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"9bc6455d",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"524e33af",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"b14fac44",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={},d="OpenSign-Docs:",t.l=(e,a,c,f)=>{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 d=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"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",reactPlayerVidyard:"3965","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",a9f09360:"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 d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var f=t.p+t.u(a),r=new Error;t.l(f,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",r.name="ChunkLoadError",r.type=d,r.request=f,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,f=c[0],r=c[1],o=c[2],l=0;if(f.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",3965:"reactPlayerVidyard",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:"a9f09360",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:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e283f01a",339:"d2fe2a74",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"1e734052",1477:"b31b2642",1512:"9637e502",1520:"523b2d80",1531:"b5a7bd46",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"6b36ff91",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",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",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:"84114f8b",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"87a74c81",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",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:"fb02f3a5",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"8bd89dab",8140:"901b2f91",8141:"81bec72f",8163:"4d9dbd85",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"9bc6455d",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"043a10be",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"8215307f",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",reactPlayerVidyard:"3965","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",a9f09360:"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 89d638aa0..05950af59 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 3f423fcb9..cf106823b 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 30221cc75..3843f1ecc 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 73605fe46..4250a7c1d 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 839bb0605..e664e8b51 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 ac3802a40..a256d49ac 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 43db5c3cf..d6e6e17be 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 0203c0630..0e722c51c 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 1d485cd43..6fa96071f 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 fb04a7c9b..e41191996 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 767c06da0..105d290c4 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 86f11dc76..20dc9910c 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 6f5f1869b..88f5629c2 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -119,7 +119,7 @@
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}

Request

-

Body

required

    file base64required
    title stringrequired
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

    required

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

  • folderId string
    send_email boolean

    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.

    email_subject string

    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}}.

    email_body string

    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}}.

    sendInOrder boolean

    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'.

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

+

Body

required

    file base64required
    title stringrequired
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

    required

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

  • folderId string
    send_email boolean

    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.

    email_subject string

    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}}.

    email_body string

    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}}.

    sendInOrder boolean

    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'.

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    sender_name string

    The name of the person or organization on whose behalf the email is being sent.

    sender_email string

    The email address of the person or organization that users can reply to.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

Responses

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 8ade71b6d..e60255b3f 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + @@ -14,7 +14,7 @@

The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at Debug UI or using the Create Template API.

Request

Path Parameters

    template_id stringrequired

    objectId of Template

-

Body

required

    signers

    object[]

    required

  • Array [

  • role string
    email mail
    name string
    phone string
  • ]

  • folderId string
    send_email boolean

    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.

    email_subject string

    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}}.

    email_body string

    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}}.

    sendInOrder boolean

    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'.

    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    enableOTP boolean

    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.

    enableTour boolean

    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.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

+

Body

required

    signers

    object[]

    required

  • Array [

  • role string
    email mail
    name string
    phone string
  • ]

  • folderId string
    send_email boolean

    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.

    email_subject string

    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}}.

    email_body string

    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}}.

    sendInOrder boolean

    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'.

    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    enableOTP boolean

    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.

    enableTour boolean

    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.

    sender_name string

    The name of the person or organization on whose behalf the email is being sent.

    sender_email string

    The email address of the person or organization that users can reply to.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

Responses

In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage

Schema

    objectId string
    url string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index e45a98303..f3924e75b 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 05d93638d..d7e59b718 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -119,7 +119,7 @@
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}

Request

-

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

  • sendInOrder boolean

    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'.

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

+

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

  • sendInOrder boolean

    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'.

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    sender_name string

    The name of the person or organization on whose behalf the email is being sent.

    sender_email string

    The email address of the person or organization that users can reply to.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

Responses

Template created successfully!

Schema

    objectId string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index adfd810aa..a767cc252 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 059831923..f3d6a750e 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 7417a9efd..2305765c6 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 8ae65d978..bcfe7e837 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 041ea55b6..97c3fef90 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftdocument/index.html b/docs/API-docs/draftdocument/index.html index 109842a51..46d36112b 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + @@ -119,7 +119,7 @@
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}

Request

-

Body

required

    file base64required
    title stringrequired
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

  • folderId string
    send_email boolean

    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.

    email_subject string

    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}}.

    email_body string

    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}}.

    sendInOrder boolean

    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'.

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

+

Body

required

    file base64required
    title stringrequired
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

  • folderId string
    send_email boolean

    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.

    email_subject string

    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}}.

    email_body string

    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}}.

    sendInOrder boolean

    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'.

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    sender_name string

    The name of the person or organization on whose behalf the email is being sent.

    sender_email string

    The email address of the person or organization that users can reply to.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

Responses

Document created successfully!

Schema

    document_id string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index c50b30081..d8edc337d 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -121,7 +121,7 @@
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}

Request

-

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

  • sendInOrder boolean

    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'.

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    email_sender_name string

    name or email of the person or organization on the behalf of which you are sending the mail.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

+

Body

required

    file base64required
    title stringrequired
    note string
    description string

    signers

    object[]

    required

    You can provide signer optionally if you it as default signer

  • Array [

  • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

  • sendInOrder boolean

    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'.

    enableOTP boolean

    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.

    enableTour boolean

    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.

    redirect_url string

    Specifies the URL where the signer will be redirected upon completing the document signing process.

    sender_name string

    The name of the person or organization on whose behalf the email is being sent.

    sender_email string

    The email address of the person or organization that users can reply to.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

Responses

Template created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index f2d716802..0147b5e21 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 01178d8ef..5448d626d 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 dd02f898b..d743a4088 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 6f35e408d..825e263a8 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 1ef70281b..e2b1d6417 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 890351f18..b5e134654 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Document API enables you to retrieve details about a specific document.

Request

Path Parameters

    document_id stringrequired

    objectId of Document

-

Responses

successful operation

Schema

    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

  • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number
  • ]

  • ]

  • sendInOrder boolean
    createdAt date
    updatedAt date
    enableTour boolean
    redirect_url string
    allow_modifications boolean
Loading...
+

Responses

successful operation

Schema

    status string
    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

  • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

  • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number
  • ]

  • ]

  • sendInOrder boolean
    createdAt date
    updatedAt date
    enableTour boolean
    redirect_url string
    allow_modifications boolean
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 06b7408f2..d9630d3c3 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 f4429d1e0..0bd646f8b 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 9d42b50e1..1ff75687b 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 e27f12693..4f79d8abb 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 6621b768b..7e5737de2 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 dd2fbfbc6..1f5cdbad6 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 3b9f5e28d..b5903bee0 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/selfsign/index.html b/docs/API-docs/selfsign/index.html index 8bfe8cf73..74c9164f2 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 68d39f3a9..5b6caeac8 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 8c8dd620c..8e18906e6 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 1459c3327..3de636213 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 ea9782705..0acd78552 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 9f62740d1..14b8e38fb 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 4e8eae60a..fd4bfbf1e 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 10866d65f..6c0fe88db 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 a841ff2d9..b027ec64f 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 c1b4c66fd..11f8aec74 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 043ffb578..f1fd3b281 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 88f38e7be..ac518e9a9 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 5a726125b..d5fa850db 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 6d6d26766..30998e287 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 b1e3c98cd..fe144c24b 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 6cd3f85d0..7bf752123 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 10d33a301..43d999539 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 da0618390..b7c6a4487 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 cdda0fb4d..ea9fc980f 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 ffab87de6..56c27316b 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 ce9b76b1f..1b582dccc 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 b3fd6b6e8..6ae66b26b 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 06af2bbed..206e414da 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 cbb54bff2..62d930760 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 6f559733f..f26756680 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 2abad3942..b4b043b13 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 56bf1873f..836580367 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 e5d6af01d..100b47ad8 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 548fe71b1..861dbf768 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 8909fb677..e66a87bc9 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 ce558442e..2816fe7d0 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 c8963f207..142aa25ae 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 071e39d10..b8854be52 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 4077e68cd..d19c7803e 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 19208177d..1bf76ffc0 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 b56ebaa5c..6032d6cab 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 6e2a77d2b..f139db07b 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 7e88b81ec..6b2441d8c 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 eeb1d1857..8439be330 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 be0d7ba27..bb56649be 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 337e47fd2..c013a8fd2 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 20ace65b5..d2dc41a1a 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 4165e224d..a725c81a0 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 786715839..382d2cb26 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 20cba244f..3aa8e1aa1 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 47fad1aab..b0046ebd1 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 d4ccab6aa..a56d920f5 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 dc8760152..9bdc25f9b 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 18569bc7c..ce429a9d1 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 bc1ee6be0..649b1f038 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 76f582afe..2764a22e8 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 6c83d030c..6b3b4a175 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 27f2635e4..c303d8089 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 15f393690..6af16f8f5 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 a9511fb50..13262d241 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +