diff --git a/404.html b/404.html index 02e474a8e..eccf95095 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/28b19cd2.1d02367e.js b/assets/js/28b19cd2.1d02367e.js new file mode 100644 index 000000000..c211e7672 --- /dev/null +++ b/assets/js/28b19cd2.1d02367e.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:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>f,toc:()=>j});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:"eJztWc1u3MgRfpVyX2Qb1IyktXMYBMF6ZWMj7CISVjJ8kIRBkyySLTW7uf0zI2YwtzxJHi1PElQ3yeH8SLaDYC8JYNhSs6q6/vur8oo5Xlo2u2UfdeZrVM6y+4TlaDMjGie0YjN2UyGcG+QOoaeCD1cXwKXUSwut9uA0lKjQEI3CJeS9NEhbePDWQWP0QuRCleCwbiR3OBc5CGUd8hx0Ab6RmgcCHkQUQuJrocBVCIU2NdGk3OKf3oE2kArFTfsGcIGmBSdqDHooxJyUyaK6fFBkAjfdtZakgcGGKHLZgreYh9ssZFxBih13DoXRNX02IJRDU/AMgTu4ffv2I6a+hM8Xb9/ev66ca+xsOuVNM9ENKitKJXlqJ5mupzkRNnnxhpT2Nti/cWevE7lzcqdYwnRDThRaXeRsxjpFOhuWwlW980TOEtZww2t0aCiCK6Z4jWzGRv5lCRMUwYa7iu2GVacPmLmL4PxeEZYwg797YTBnM2c8Jsy6VpJYK+pGEgE+NVLnyGYFl5YIsgprzmYr5tomUDojVMkSRmHjbnyCTzxImbHmr6dplZ1VTcrW6/t4LVr3k85bEpVp5VA5+pE3jRRZcMr0wZLqq9GdG3VvGXmenHGf9KpEG8lVhjzrBNrA3hFudObG8Jbc5bAenz8jwGgyYt/ijX0fskx7p7hybJ0wrLmQL7ooEIwFPGj8sfuNMomkxAC/dOuDRkgRibiptPoK9enZD/Tnh1O2XifMCRdOt5NulE3z685tRF1omaOhLH3pBlLEosrnuw5ItZbI1V5S3lTCwpDXOy3GNpiJooVlha5CE46XXDkI0i2RpAiW+hNRR20nQP0rx4J76WDBpUcQFu4Ypfcdm8BFEUoyftH0y5YKI1rgKgel4SjcN7c+JMfRtPs91Xl7tOG0wA12OgvMBxUC8dAFLSyFlKQ39aHYBAb/0bV99vTXHXL4tg/PvXW6hnBNxxR6HjmEO28QumKbwDlXIFQmfY5doyWHU5eC1apPgXnIjPUaViuKJZo5JeJ6nWwO6K6tg5B98cRghmKxxTUc4YZxOBux4lMjTDvPuesOMl03XLVjBUSphCrn3sj1erKXfJvIfLPf9tzURYyE/A94jNS5UJcmR3OwXreSc9eFFwVYDNV3RJ+PEtBKttFRwljXFWXM+U7/8PU5pwslnOBSthP4NBS59aklKtXL2xSRM6Is0WAOHUVgToDeTkCeVbE9BK14QfVNtzcGF0J726tXcQvkOIkEA1yFIlaPUOUEfmr7Uk5g5CxqFFu2T1hoqjXe6PNO1kfejh8X5esUzV4eBjRDIKbjgpy3lsQHpEIfuMx8wA0x3EDhptbVam8GyDN+XYabhuidvqfqUDyVeHlz9XKku4d+R0vjEY5jt9ThMAYhyoTLmytYoBFF93RP4LMdAtVHnm+RQKZzhIXgMfYJLCuRVeT+FmrCkKhCwGJrD4HbwLugIxzDvkK5sAc1SuLrQqXrg2qHBEMuDGZOtiGDtHfA81wQO5dgHTY2hDkafaP9V2rmP/Ekh9KLPETem6GRo7HJCFQTkDY+I2YLuTc90OyyligztHbjp94rRDSSnwAqG9k5FNw6NAl4FfCv8Q2VQy8Snxo0AlWGkxfww3wMIEIfXhPxNsoMB7bRykZ4dXZyQv/s9BYF1mdkBfTEEQGQr0p04A31i81HEQoivMJc2h4QEMkQXU04Yiksxo5AUnpYnECN1lpeEub9Zjj6MmzsZX8vWK4exNnfn7LF2RUlmzcvQ8lDAroZZQdQkoVk4HdKG6bA0Eu7oBReyvbVViYIJYXCeR+Q+dnJyfyM4r9O2LuDIY4Rq/gC1VEoNViKvERnA/Tqmz1Nhf3kpA0o3Y+XOJBwqVUZu35s34TYA2fIwf9aRNEYbb7Xf1cSuSWg6nyzsSQK/poP352czLNscOL7Q3Wy4FLkYUS/0Y+oXv0B5m6MG1/v4vWk6lMdkrabUUUkCt/ZlrXj82ikxcwb4dow4z4d80Ycx++z23uaHGt0laZpudE2aEzD7oxNt/vQdDVqRGtGYs2in5xDRQ1FYrnKU/20P8zzRkwXp2yd7HIcHP2fpbaOl0KVxy9y3W8Mv6bgRP9vmb8ZXhvxC1JSd94dU3UbgAo5ATryJ8X8t820/amP3Ggsvu0n3PEYO0yxe6PpcHE/fg7T53jEvB8PjYxtD4YRTO4MOoxtA/ieaYCnkesQxjp9v4Vuund3/EyHozW5p9DBl10KXjaoaNANCbw43UNnX1BmOgI0ejt78n/945+Bo8+3UF+v4NIbaPQSTeFl6GGFxCdBD+/+Bs0iryVaK9uwbyrDNi0XpXCENbpXN+MNT4UUVJFEpiPoGxW1ncCXzYB8ZMIaDBcoqZBBav0YwIEG7p2uwx19P19q81iQSglwSGldRa+tRexZUFVcZdS6Ymom1H+5isisMfSQclETMeEULAqRCRJM7cfwzEHNFS+RLkuA9CYvdL3bgtEpwTyrpY9AxmmoEV00kXZ7dgIfCTgGwwPYRceFxDxiGJtEDNklJ5mhckgx7B955kSGEeY5bhxIWh6GUowDipcSGu3i0EBwehxbEuQMVzbsIiPQ7kIzuK8DWeGOnLcTuFN36pqSxVukBJBCPdrZnTqG2yHNvmBqhcPNHnG5XO61hTfbPD8LV/mUlph6w1eGw9BExuzDL29Ywhya2l4W12gWIuuBwTN3TgPxtHs8eNw89C2AN+LHXQZq5FJkqCyOWv2Hn69+hQX8MDlhyagRfoPC018vzj/97foTyaVWHevvdHIyOQkLLm1dzdXoqt0lddjfjlabW4U82jH+f8P9B264uzfL4ZObNpILNYK08em+3RkhWMJm46X2fcIqeupnt2y1Iod9pk0GHf/u0RBOuE/YghtBzT48Zt2wkx8ewMaZ8Pq3bjB5A8/sxw/q3z/Eil7hsEmMr9Ujtjsb+fX9OulfY1ItUpxHBY5vSM5Gwh5UIzAROT5kGTbuRdoxNrq6vL5hCesXYXVY4DPDl7Tx50s2Y3fsjoX/gAitNyy56XzFJFelD1MCi3IJRHBPkRojkMeAQLofyLKDPtmGJtEU+psMO8jwZ6rDX7D9y0AevzzL0Pm2p6b43K/X638DlNqNmA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={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:"eJztWc1u3MgRfpVyX2Qb1IyktXMYBMF6ZWMj7CISVjJ8kIRBkyySLTW7uf0zI2YwtzxJHi1PElQ3yeH8SLaDYC8JYNhSs6q6/vur8oo5Xlo2u2UfdeZrVM6y+4TlaDMjGie0YjN2UyGcG+QOoaeCD1cXwKXUSwut9uA0lKjQEI3CJeS9NEhbePDWQWP0QuRCleCwbiR3OBc5CGUd8hx0Ab6RmgcCHkQUQuJrocBVCIU2NdGk3OKf3oE2kArFTfsGcIGmBSdqDHooxJyUyaK6fFBkAjfdtZakgcGGKHLZgreYh9ssZFxBih13DoXRNX02IJRDU/AMgTu4ffv2I6a+hM8Xb9/ev66ca+xsOuVNM9ENKitKJXlqJ5mupzkRNnnxhpT2Nti/cWevE7lzcqdYwnRDThRaXeRsxjpFOhuWwlW980TOEtZww2t0aCiCK6Z4jWzGRv5lCRMUwYa7iu2GVacPmLmL4PxeEZYwg797YTBnM2c8Jsy6VpJYK+pGEgE+NVLnyGYFl5YIsgprzmYr5tomUDojVMkSRmHjbnyCTzxImbHmr6dplZ1VTcrW6/t4LVr3k85bEpVp5VA5+pE3jRRZcMr0wZLqq9GdG3VvGXmenHGf9KpEG8lVhjzrBNrA3hFudObG8Jbc5bAenz8jwGgyYt/ijX0fskx7p7hybJ0wrLmQL7ooEIwFPGj8sfuNMomkxAC/dOuDRkgRibiptPoK9enZD/Tnh1O2XifMCRdOt5NulE3z685tRF1omaOhLH3pBlLEosrnuw5ItZbI1V5S3lTCwpDXOy3GNpiJooVlha5CE46XXDkI0i2RpAiW+hNRR20nQP0rx4J76WDBpUcQFu4Ypfcdm8BFEUoyftH0y5YKI1rgKgel4SjcN7c+JMfRtPs91Xl7tOG0wA12OgvMBxUC8dAFLSyFlKQ39aHYBAb/0bV99vTXHXL4tg/PvXW6hnBNxxR6HjmEO28QumKbwDlXIFQmfY5doyWHU5eC1apPgXnIjPUaViuKJZo5JeJ6nWwO6K6tg5B98cRghmKxxTUc4YZxOBux4lMjTDvPuesOMl03XLVjBUSphCrn3sj1erKXfJvIfLPf9tzURYyE/A94jNS5UJcmR3OwXreSc9eFFwVYDNV3RJ+PEtBKttFRwljXFWXM+U7/8PU5pwslnOBSthP4NBS59aklKtXL2xSRM6Is0WAOHUVgToDeTkCeVbE9BK14QfVNtzcGF0J726tXcQvkOIkEA1yFIlaPUOUEfmr7Uk5g5CxqFFu2T1hoqjXe6PNO1kfejh8X5esUzV4eBjRDIKbjgpy3lsQHpEIfuMx8wA0x3EDhptbVam8GyDN+XYabhuidvqfqUDyVeHlz9XKku4d+R0vjEY5jt9ThMAYhyoTLmytYoBFF93RP4LMdAtVHnm+RQKZzhIXgMfYJLCuRVeT+FmrCkKhCwGJrD4HbwLugIxzDvkK5sAc1SuLrQqXrg2qHBEMuDGZOtiGDtHfA81wQO5dgHTY2hDkafaP9V2rmP/Ekh9KLPETem6GRo7HJCFQTkDY+I2YLuTc90OyyligztHbjp94rRDSSnwAqG9k5FNw6NAl4FfCv8Q2VQy8Snxo0AlWGkxfww3wMIEIfXhPxNsoMB7bRykZ4dXZyQv/s9BYF1mdkBfTEEQGQr0p04A31i81HEQoivMJc2h4QEMkQXU04Yiksxo5AUnpYnECN1lpeEub9Zjj6MmzsZX8vWK4exNnfn7LF2RUlmzcvQ8lDAroZZQdQkoVk4HdKG6bA0Eu7oBReyvbVViYIJYXCeR+Q+dnJyfyM4r9O2LuDIY4Rq/gC1VEoNViKvERnA/Tqmz1Nhf3kpA0o3Y+XOJBwqVUZu35s34TYA2fIwf9aRNEYbb7Xf1cSuSWg6nyzsSQK/poP352czLNscOL7Q3Wy4FLkYUS/0Y+oXv0B5m6MG1/v4vWk6lMdkrabUUUkCt/ZlrXj82ikxcwb4dow4z4d80Ycx++z23uaHGt0laZpudE2aEzD7oxNt/vQdDVqRGtGYs2in5xDRQ1FYrnKU/20P8zzRkwXp2yd7HIcHP2fpbaOl0KVxy9y3W8Mv6bgRP9vmb8ZXhvxC1JSd94dU3UbgAo5ATryJ8X8t820/amP3Ggsvu0n3PEYO0yxe6PpcHE/fg7T53jEvB8PjYxtD4YRTO4MOoxtA/ieaYCnkesQxjp9v4Vuund3/EyHozW5p9DBl10KXjaoaNANCbw43UNnX1BmOgI0ejt78n/945+Bo8+3UF+v4NIbaPQSTeFl6GGFxCdBD+/+Bs0iryVaK9uwbyrDNi0XpXCENbpXN+MNT4UUVJFEpiPoGxW1ncCXzYB8ZMIaDBcoqZBBav0YwIEG7p2uwx19P19q81iQSglwSGldRa+tRexZUFVcZdS6Ymom1H+5isisMfSQclETMeEULAqRCRJM7cfwzEHNFS+RLkuA9CYvdL3bgtEpwTyrpY9AxmmoEV00kXZ7dgIfCTgGwwPYRceFxDxiGJtEDNklJ5mhckgx7B955kSGEeY5bhxIWh6GUowDipcSGu3i0EBwehxbEuQMVzbsIiPQ7kIzuK8DWeGOnLcTuFN36pqSxVukBJBCPdrZnTqG2yHNvmBqhcPNHnG5XO61hTfbPD8LV/mUlph6w1eGw9BExuzDL29Ywhya2l4W12gWIuuBwTN3TgPxtHs8eNw89C2AN+LHXQZq5FJkqCyOWv2Hn69+hQX8MDlhyagRfoPC018vzj/97foTyaVWHevvdHIyOQkLLm1dzdXoqt0lddjfjlabW4U82jH+f8P9B264uzfL4ZObNpILNYK08em+3RkhWMJm46X2fcIqeupnt2y1Iod9pk0GHf/u0RBOuE/YghtBzT48Zt2wkx8ewMaZ8Pq3bjB5A8/sxw/q3z/Eil7hsEmMr9Ujtjsb+fX9OulfY1ItUpxHBY5vSM5Gwh5UIzAROT5kGTbuRdoxNrq6vL5hCesXYXVY4DPDl7Tx50s2Y3fsjoX/gAitNyy56XzFJFelD1MCi3IJRHBPkRojkMeAQLofyLKDPtmGJtEU+psMO8jwZ6rDX7D9y0AevzzL0Pm2p6b43K/X638DlNqNmA==",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"}},g={},j=[{value:"Request",id:"request",level:2}];function y(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",example:!0,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'."}}),(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",example:!1,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."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\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 b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.bc4974db.js b/assets/js/28b19cd2.bc4974db.js deleted file mode 100644 index a381cde92..000000000 --- a/assets/js/28b19cd2.bc4974db.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>f,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=s(85893),n=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),m=(s(82723),s(9487)),o=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:"eJztWNtuG8kR/ZVyv/iCESlp7TwQQbCObGyEXayElQw/SARRnCmSLfV0z/aF1ITgW74kn5YvCap7Zji8WLaDYF8SwLDNnqrqunXVqVoLj3MnRnfig8lDSdo7Mc5EQS63svLSaDEStwuCC0voCVoqeH99CaiUWTmoTQBvYE6aLNNoWkHRSoNpDQ/BeaisWcpC6jl4KiuFniayAKmdJyzAzCBUymAkwChiJhW9khr8gmBmbMk0U3T0p7dgLEylRlu/BlqSrcHLkqIemqhgZfKkLnaKDOC2udaxNLBUMUWhagiOinibgxw1TKnhLmBmTcmfLUjtyc4wJ0APd2/efKBpmMOnyzdvxq8W3lduNBxiVQ1MRdrJuVY4dYPclMOCCati9pqVDi7av3VnqxO7c3CvRSZMxU6URl8WYiQaRRobVtIvWufJQmSiQoslebIcwbXQWJIYiZ5/RSYkR7BCvxD7YTXTB8r9ZXR+q4jIhKXfg7RUiJG3gTLhfK1YrJNlpZiAniplChKjGSrHBPmCShSjtfB1FSm9lXouMsFhQ98/oSeMUkai+tvZdJGfL6qp2GzG6Vpy/q+mqFlUbrQn7fm/WFVK5tEpwwfHqq97d27VvRPseXbGOGtVSTayqyx71ktykb0h3OqM1mLN7vJU9s+/IMAaNuLQ4q197/PcBK9Re7HJBJUo1bMuigR9AQ+Gfmx+cSaxlBTg5259MARTIiauFkZ/hfrs/Af+88OZ2Gwy4aWPp7tJ18umyU3jNqaeGVWQ5Sx97gZWxJEuJvsOmBqjCPVBUt4upIMur/dKjKsol7MaVgvyC7LxeIXaQ5TumGRK4Lg+MXXSdgBcvwqaYVAelqgCgXRwLzi978UALmfxSaYvhn/sqNCjBdQFaAMv430TF2JyvBw2v6emqF9uOR2gpUZnSUWnQiTuqqCDlVSK9eY6lIpA5z++ts2e9rpjDt/14UVw3pQQr2mYYs1jh6APlqB5bAO4QA1S5yoU1BRadjhXKViv2xSYxMzYbGC95liSnXAibjbZ9oDv2jmI2ZdOLOUklztc3RFtGbuzHis9VdLWkwJ9c5CbskJd9xWQcy31fBKs2mwGB8m3jcw3++3ATU3EWMj/gMdYnUt9ZQuyR9/rfnJy7701F4YPPX3Aul8+dSinZA88Hfs1t+mGCwqsHb+02Iv5A6o8xM6YDAI2iB9nbYLtmnq/fnY3dfqdveP4a5wqurq9ft6WppXtaWkDwUmqByYepreaZMLV7TUsycpZ05wG8Mnxq480TWwAd0ggNwXBUmJKqQxWC5kvOI9qKBklEeOMtnjF/NoCmKgjnMChQoV0RzXKUv3k5AxRtWOCoZCWcq9qYHxhggcsCsnsqMB5qtxAdI68NeErWfGfeBJhHmQRIx9sV6rIuqwHGxkq2pAzs4Mi2BZKNenMlDk5t/VT6xUm6snPgLRL7AgzdJ5sBkFHhGdDxbivFUlPFVlJOqfBMx1y0m+RsdJsmHgXR8UDVxntEoA4Pz3lf3bddKnBhZytgJY49Tj21Zw8BKtA6u1HGR9E7DOoXNvymKSLruFOuZKOwGhVRykt8MugJOcczhnVfTPgeh4YtbK/Fw4uHuT535/y5fk1J1uwz4OlYwIaFL4HmdhCNvA7pXVzTgQTTVBmQan6xU4mSK2kpkkbkMn56enknOO/ycTboyFOEVvgkvTL+NRgJYs5eRfBRZP3HME2q3hw0KYdoKgjQWX0PL5ZznBpgTFp5Iw5+F+LKFlr7Pf671oROoZiPlRbS5Lgr/nw7enpJM87J7479k6WqGQRh9Bb80j6xR9g7ta4/vU+Xc+qPpUxaZspTCai+F3sWNs/T0Y6yoOVvo5T3NMJVvIkfR/djXk2KskvDM+DlXFRYx7nRmK4W4eG614h2ggWa5ftbBhfVPdIHOpiap4Ox1Ws5HB5JjbZPsfR4faL1M7jXOr5ybNc463hNxyc5P8d87fjWSV/Jk7qxrt9qmbGXRAyZGF/csx/286TH9vI9Qa/u3aG6w9q3Zx2MHx1F7cDVjdf9YeocX8sEmJ39EnT9B6UF2IXorZMHQBLXMcw1tm7HXTT9N1+m45HG3bPzERfNil4VZHmUS4m8PLsAJ19JpWbBNC4d7bk//rHPyNHm2/xfb2Aq2ChMiuys6BiDZspepLceA93RI6wVOScquNGZR73RYWcS89Yo+m6OVY4lUryi2Qyk0Bf71G7AXzejoAvbVz00JIUP2RQxjxGcGAAgzdlvKOt5ytjH2esUgYIU17IcLd1RC0L6QXqnEtXSs2M6y/qhMwqy40UZcnEjFNoNpO5ZMFcfizmHkrUOCe+LAPWm73Q1G4H1kwZ5jmjQgIy3kBJ5JOJvL1yA/jAwDEaHsEueZSKioRhXJYwZJOcbIYuYEpxw4a5lzklmOfRelC8HotPMc0qQSmoDJdJiYrhdD+2LMhb1C5u2xLQbkLTua8BWfGOAusB3Ot7fcPJEhxxAiipH93oXp/AXZdmn2nqpKftpmy1Wh2Uhde7PD9JvwhTXtOZLd88HsYi0mfvfrwWmfBkS3c1uyG7lHkLDL5w5zASD5vmgWm2bksAVvLHfQYu5ErmpB31Sv37n65/gSX8MDgVWa8QfoPCw18uLz7+evOR5XKpTu/vbHA6OI0rHON8ibp31f4aNm4oe8u7nYfc26L9f4f7B+5wm57l6ckPK4VS9yBtat13eyOEyMSov7YdZ2LBrX50J9ZrdtgnntX5+PdAlnHCOBNLtJKLfWxmzbBTHB/A+pnw6rdmMHkNX9gAH9W/bcSau3DclaVu9Uj13s55M95kbTdm1RLFRVLg5JblbCUcQDUGE4njfZ5T5Z+l7WOj66ubW5GJdtVTxhW1sLjinTauxEjci3sRV+yx9MY1Lp+vhUI9D3FKEEkugwgMHKk+AnmMCKT5D1t21Ce70CSZwn+zYUcZ/szv8Geq/9KRpy9fZGh821JzfMabzebfbJAljA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=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:"eJztWNtuG8kR/ZVyv/iCESlp7TwQQbCObGyEXayElQw/SARRnCmSLfV0z/aF1ITgW74kn5YvCap7Zji8WLaDYF8SwLDNnqrqunXVqVoLj3MnRnfig8lDSdo7Mc5EQS63svLSaDEStwuCC0voCVoqeH99CaiUWTmoTQBvYE6aLNNoWkHRSoNpDQ/BeaisWcpC6jl4KiuFniayAKmdJyzAzCBUymAkwChiJhW9khr8gmBmbMk0U3T0p7dgLEylRlu/BlqSrcHLkqIemqhgZfKkLnaKDOC2udaxNLBUMUWhagiOinibgxw1TKnhLmBmTcmfLUjtyc4wJ0APd2/efKBpmMOnyzdvxq8W3lduNBxiVQ1MRdrJuVY4dYPclMOCCati9pqVDi7av3VnqxO7c3CvRSZMxU6URl8WYiQaRRobVtIvWufJQmSiQoslebIcwbXQWJIYiZ5/RSYkR7BCvxD7YTXTB8r9ZXR+q4jIhKXfg7RUiJG3gTLhfK1YrJNlpZiAniplChKjGSrHBPmCShSjtfB1FSm9lXouMsFhQ98/oSeMUkai+tvZdJGfL6qp2GzG6Vpy/q+mqFlUbrQn7fm/WFVK5tEpwwfHqq97d27VvRPseXbGOGtVSTayqyx71ktykb0h3OqM1mLN7vJU9s+/IMAaNuLQ4q197/PcBK9Re7HJBJUo1bMuigR9AQ+Gfmx+cSaxlBTg5259MARTIiauFkZ/hfrs/Af+88OZ2Gwy4aWPp7tJ18umyU3jNqaeGVWQ5Sx97gZWxJEuJvsOmBqjCPVBUt4upIMur/dKjKsol7MaVgvyC7LxeIXaQ5TumGRK4Lg+MXXSdgBcvwqaYVAelqgCgXRwLzi978UALmfxSaYvhn/sqNCjBdQFaAMv430TF2JyvBw2v6emqF9uOR2gpUZnSUWnQiTuqqCDlVSK9eY6lIpA5z++ts2e9rpjDt/14UVw3pQQr2mYYs1jh6APlqB5bAO4QA1S5yoU1BRadjhXKViv2xSYxMzYbGC95liSnXAibjbZ9oDv2jmI2ZdOLOUklztc3RFtGbuzHis9VdLWkwJ9c5CbskJd9xWQcy31fBKs2mwGB8m3jcw3++3ATU3EWMj/gMdYnUt9ZQuyR9/rfnJy7701F4YPPX3Aul8+dSinZA88Hfs1t+mGCwqsHb+02Iv5A6o8xM6YDAI2iB9nbYLtmnq/fnY3dfqdveP4a5wqurq9ft6WppXtaWkDwUmqByYepreaZMLV7TUsycpZ05wG8Mnxq480TWwAd0ggNwXBUmJKqQxWC5kvOI9qKBklEeOMtnjF/NoCmKgjnMChQoV0RzXKUv3k5AxRtWOCoZCWcq9qYHxhggcsCsnsqMB5qtxAdI68NeErWfGfeBJhHmQRIx9sV6rIuqwHGxkq2pAzs4Mi2BZKNenMlDk5t/VT6xUm6snPgLRL7AgzdJ5sBkFHhGdDxbivFUlPFVlJOqfBMx1y0m+RsdJsmHgXR8UDVxntEoA4Pz3lf3bddKnBhZytgJY49Tj21Zw8BKtA6u1HGR9E7DOoXNvymKSLruFOuZKOwGhVRykt8MugJOcczhnVfTPgeh4YtbK/Fw4uHuT535/y5fk1J1uwz4OlYwIaFL4HmdhCNvA7pXVzTgQTTVBmQan6xU4mSK2kpkkbkMn56enknOO/ycTboyFOEVvgkvTL+NRgJYs5eRfBRZP3HME2q3hw0KYdoKgjQWX0PL5ZznBpgTFp5Iw5+F+LKFlr7Pf671oROoZiPlRbS5Lgr/nw7enpJM87J7479k6WqGQRh9Bb80j6xR9g7ta4/vU+Xc+qPpUxaZspTCai+F3sWNs/T0Y6yoOVvo5T3NMJVvIkfR/djXk2KskvDM+DlXFRYx7nRmK4W4eG614h2ggWa5ftbBhfVPdIHOpiap4Ox1Ws5HB5JjbZPsfR4faL1M7jXOr5ybNc463hNxyc5P8d87fjWSV/Jk7qxrt9qmbGXRAyZGF/csx/286TH9vI9Qa/u3aG6w9q3Zx2MHx1F7cDVjdf9YeocX8sEmJ39EnT9B6UF2IXorZMHQBLXMcw1tm7HXTT9N1+m45HG3bPzERfNil4VZHmUS4m8PLsAJ19JpWbBNC4d7bk//rHPyNHm2/xfb2Aq2ChMiuys6BiDZspepLceA93RI6wVOScquNGZR73RYWcS89Yo+m6OVY4lUryi2Qyk0Bf71G7AXzejoAvbVz00JIUP2RQxjxGcGAAgzdlvKOt5ytjH2esUgYIU17IcLd1RC0L6QXqnEtXSs2M6y/qhMwqy40UZcnEjFNoNpO5ZMFcfizmHkrUOCe+LAPWm73Q1G4H1kwZ5jmjQgIy3kBJ5JOJvL1yA/jAwDEaHsEueZSKioRhXJYwZJOcbIYuYEpxw4a5lzklmOfRelC8HotPMc0qQSmoDJdJiYrhdD+2LMhb1C5u2xLQbkLTua8BWfGOAusB3Ot7fcPJEhxxAiipH93oXp/AXZdmn2nqpKftpmy1Wh2Uhde7PD9JvwhTXtOZLd88HsYi0mfvfrwWmfBkS3c1uyG7lHkLDL5w5zASD5vmgWm2bksAVvLHfQYu5ErmpB31Sv37n65/gSX8MDgVWa8QfoPCw18uLz7+evOR5XKpTu/vbHA6OI0rHON8ibp31f4aNm4oe8u7nYfc26L9f4f7B+5wm57l6ckPK4VS9yBtat13eyOEyMSov7YdZ2LBrX50J9ZrdtgnntX5+PdAlnHCOBNLtJKLfWxmzbBTHB/A+pnw6rdmMHkNX9gAH9W/bcSau3DclaVu9Uj13s55M95kbTdm1RLFRVLg5JblbCUcQDUGE4njfZ5T5Z+l7WOj66ubW5GJdtVTxhW1sLjinTauxEjci3sRV+yx9MY1Lp+vhUI9D3FKEEkugwgMHKk+AnmMCKT5D1t21Ce70CSZwn+zYUcZ/szv8Geq/9KRpy9fZGh821JzfMabzebfbJAljA==",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"}},g={},j=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,n.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)(o.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)(m.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",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",example:!1,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."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.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)(m.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)(m.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)(m.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 y(e={}){const{wrapper:a}={...(0,n.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.84ff4b21.js b/assets/js/2c586be5.84ff4b21.js deleted file mode 100644 index 7890a482f..000000000 --- a/assets/js/2c586be5.84ff4b21.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:()=>g,frontMatter:()=>p,metadata:()=>x,toc:()=>y});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:"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:"eJztG9tyG7f1V07x4lizXImy7KScTqeOnaaeNJGnVibTETUKuHvIhb0LbACsyK2Gb/2Sflq/pHNw2V1SpBQ7mUad0g8yFzgAzg04N+CWWb4wbHLJXqusqVBaw64SlqPJtKitUJJN2EWB8EojtwgRCl6+fQO8LNXSQGNQG7AKFihRE5TEJeRxPpi1UGt1I3IhF5Bzy2EpbAEzbvDFGaDMVI45zEWJ6VRO5fd1qXgOrWqgzucgJKhGw+XR0WucNQv4/s3R0dVnhbW1mRwf87pOVY3SiIUs+cykmaqOcwKs8/lTKFCjmynjEnLNl7AU+QKtAS5zyFTdQqZGSotccosJ1HyBIJtqhhrUHGyBVQq8NKqbxI0JqKs5vH39Z8L56OhLLNVgdo1gmrpW2mJOJNgCO45Mjo5ozCtVVUpCzTWv0BIL1TxOMJnKERwd2bbGydERvJG5yLhF4+ah1h429aCEOYG+qzETcxFAN+iRsCxEVjhSllxaElld8gwdqEZTY2bFDW5OvEqgpYlfo1QRg0Jp8Q8lLS8dH29QW5HxEjKldC6kw9SzD4zl2pLgayWkja1hBfh74GpjPBJ5EDGhlhNTKiFdj0G44WWDJmC1TKAgrP6GtUbj1CzMawuHU4FiUexdj+fvG2M3JobGEJpDLMJaGn9qhMbcsRcd2+a8NAhivsHLin/AwWqg3P7hZQpftpDjnDelTUDYJwasbjCF75QFXtelyPisRJgrDaTH3DYaR07KQR0CIpJXTsZv3W5CAxxyMZ+jpg1JnW6KqIMBO1LFfvtVShOOXIKSA0GPUzg66tZ2Cvrjjz9O5e1UAkwZ4TJlkynrQKYsAd9HKjZlk3ECoWE1ZRN4dvp5BGjp+8XpF/F7Sd/j8Vn8Luj7dDyV67Aokfqdso7UlxZK5MY6dLvVQRiIUnE0I88K1406hZdlOQCdCyxzvyMzVdVNaZRu6UwKEkmn8tRRb3lV30M5df/6VMdPryuGGt3K1BYppEZSGA9LPSRrau3Qoo51z8FnRJCQwgpemv00RYjHR1aP2RZlZ0QZVlyU+8ly3Y+PpoDWFkHP035j76HHT/HYyPG/tqh5QdS8VzOwwpb3kNSBPD66BqhtEfc5EUdnCJftftICwOMjrENsi6wviKyc23vERb2Pj6CAVewI57nvOzkbjZ+PTk9OzwYQc6UrHgCqapTno7Zt2ymDniPQWaAwHRmhaHC9c0AO7lyraoc35ZydHio4H+539EC+Jb9jFk1y7xya4Lc5e1Zxu+k0WJXz9onxU8WhwSvw8L3v1w7QdF2ER0s+dFYokQXkCSYwHmbku6bEhBHxMT/+9ttjz5mkbxxVVWCXlwW10vfIcXLYWlVpnqfbsEOGD1sryPMEdrTv7shzqKpqX7vvIBWfyt+TXltc2Zla7VftAPD4tLtHbKeCB6MQ+wohQ0fQDtgC0LhoSq5xRf6yEUo66u8cBluaHxWfR1X0zrLzuVwo4pGEz86Dr/s0KCXhszkBtTw87g6aw0k0LnDl5sgaY1VFyIic0wwJmCYrgBsflJKrq2TZhtjHJP4r47WgoKVEa10r2izdRGIqxyfunC8w+3Cv5kSIx6c6A8xip49xqPtyyioeDC+bY/9b2QL1lF11YwyWmFnMB2Nh12C4GmgZz4nTBOxipB69QuRY8hmWfd8AuSDGAanUUQnpkYhsOInzuV6+2uoNnesdSu2JGGpTPP2iTkauQSlMDH43WTAcHYJGW3ALEjGn43+GEAcMAoxdSu65NAgoSZTb8aRBu4kYp6jHD90RUzqext0XeP3ACgQHDrCL1+Ni+xYIJGxIZsgXmqMSUlRNNUikxFkjx6pgBYfsopGUSoorDKV7ZwW+emAFivL3LzCVYxfy5lrVuVpKt8tht+8TQB7fNh9g9ku2+YZZ8XC/ZBtFrIbbaIdFIVBvS7otZPbvoRTO6fymJIAfJAzwLMPaYr51gI9dNK95LhTMGmuV3H+ED6Een3y3sPsvyJgI/nlSHuL2m0napzkqn/ncl+OonDQfm2wDWrs3GkuYqimTLpR8k7MJy1zyPeaPWeKWQGO/VHnLJrcsU9JSx+SWhXwiDT1+byh9f8tMVmDF6VdEjRL+lHBnCfNZM8MS5qJeyv4T89iEqdl7zGi1WhM6VqChOdy4yW2EMlYLuWBJiK7YhPnsOEsYrnhVEzDbyvXX+Zyt44L3TdW19FMZ96NLptM8G9WKT5rt9WCGdcIo0/2JM1Hi0tNW4YV6pajR4mvemsGE3myx7ToLjaGdkYVRkPPW0AZojHcwMl5mTUmRHa5qodsuzHTh3UA/OkS7lTpEx8/XvdB7lLjWvGUJExarYfseJdDq4yWXoSLOuDzYx459r3CG+KfQQFUeJydefTQW7xXCDJ2M6kLJjx4/Pn02Ph0/G5/SDCHX/ul89L13MdhUjJcU02Aenc5Rn95OwGWA04eUM8I7svkCH1bGi33lo0GFwxSqKXOqYSDXqavifHqtbkO/O6ORPqDN64StHiZm5ct8vjYFn5U4t9DUNWrIlJaonw4zOo+GuNOzs3XC2ofJa/8nyfuchLd8mLofXFGvL3j+Frg++2KdsOJhXP/SlR1/Q2TPXqx767rlPFzPVN5ex3Nr/RBgNBQEN1dljpockrvnVX/U0AljUObX2+f8TKkSudxx0AjTV8HjpQIKUykGDinNZYHk0/bRq5u99yNDxOyxTeHCVXGHGSthyCvUDU5ZCm/mA6/UBb4bKAxgXS1ZKnji1rs2jTvGnxyHb+LRk2EJ3xX+u1RuRMEBg8WqLl1tfCnKkvAmu55C9895fh0nCYFoLuPCD5uKVz4z5hYMgzYLyxB8xxRecQlCZmUTnPS5iqkzuL3t1MBpx3oNt7ckVdTXZHTX66RvoLU2Gpxd9S0aMxQ3G6O6JuwHdm2Dod7FuSYXxzeEAsYQAbGQQi6uG12u1+kdNexl9LP5dodNQXY0yf8BxwidN/Jc56h37tw7yinp5sL5xdv7oX26b9vbpYTUyO89H0b5feHnhPOLt3SxRMxDNJPC9+6ekYMJ1APfAAGKLuBGcC+0pHdYWp9xQknbOxwUG3dy0nClYwR3EcqF2YlR0ueauytQdyaGXGjMbNm6S0+qscDzXPggFozF2qSsY+SFah7g+6dwksOicaUmS3YoHgYu/91fDBHSWN34bBvkjY53YYLCEGSGxvR8ilwhoMH8CaA0fjiHOTcWdQKNFMR53VAU302Jqxq1QJlhyh6wQ95Q9dFrUD+6s6Sk8a706ckJ/bfJmu6+WpiUygREx7wpy/Z3LPn5ofP9frxv3m0b73PMi/fi9B+r7Ob0LWlBoz86MIp+RKPLkVUj4u2oU2oXJg04K2QpJF5Htl2fnpxcj4m364Sd7WLfO1WhLUhYS2LiUiu5SKCmKzkIVrfAF1xIIKumf0VuotZK3+9mfBxm9zHhbIMJz+8y4Y10BQp35fFCfUD536V0uLz1yxOqq8rpig+BmfBArp9tEDts90QazBotbMsml7dsNeK1GPn+yeXV+iphxFhFaadaGYcxtwWbsOM7WSiD+sZlES5vvep22mi4zKmIcMez5bU4vhmzdbI9YqcfvBfaWL4QcjG6d9RVT+o7Eofn+AbBfdhei2+Q4vbAzyFUwgSpQYGczCJxkKT8tz4F91WUVUyO7cp39TLZzmBtH+c7clIxJbWRZdqdZBo/H6R3LmOmxiVfutzLrnRKR3pMkHT5kUHKY5DxuOx1tksuxNzC2AXlp2dnLnr9fOzCvGdfuAjq7MXaaVkfTTC2GTG4nOm238vYpj8XB3XeShjVOyTBVA4tq2takzznygk/SOS8RvmOLDftsZvx3QgUy0z53ByZuwj+73/+y42IknRHwO/gvNFQqyXqeePvx85LXAmylYNL0zG+QV6VaEzZApnIhbs+nYuFK1NHQ5nxms9EKejQIDDl832Dc8ek8EMfIT3RvmJ/gyWdNVAq9cHZcwW8sapya0TDuFT6w5xQSoDDjC7BojFgEOMQlAWXGQVZfi8loDRw6Z2pWguDwEVFwO4m5nwuMuEsrpJW88xCxSVfIC2WuEiYuFDHK6xazcgzM6psvO9BF2kRrSfRFQtSeE2+niPc5TnRclFi7t0Ok3i3L+gykSFzmJHrXtPyIkPT380p8Qa1Ozu8A9+UJdSKTnLBSwoFh7Kliazm0pABDjnWIJqOfcEvcmvkvE2BiotknMgnJAUohfzg73Nfdmr2A86MsNhnAZbL5Z1z7OnmmK+FLZoZaKxVP27hGt2pNxzefTylQwJ1Zc7n71DfiCy6DHvWPHbAx8G+cR9wxkOD1+JP2wPI1pQiQ2lwYI1efv32r3ADz9ITlgxO7p+B8PFf37z66rt3X9G8ZFv8/hunJ+mJS10qYysuB0ttvUvY3rqD2sjhGcPhGcPhGcPhGcPhGcPjK4cfnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjHsUOrDM4bDM4bDM4bDMwY4PGM4PGP47WX70DOGUCEkP+m4LrmQg1sOvqx8uf244SphBdWdJ5fs9pYy1N/TVSVq/qlBTUXrq4TdcC0o2ehK1kkszVJN8gNScfCVT/qPLmj9xOuaq2BsVeqpsuxHvHTCuRd2WBp/e/7ugiUs3i2rVE5jNF/S4wy+ZBPySZl7yOE46+7Mc3fZteRy0bgyKfPzUkWZN7bYLEd/cOXo8GNQbeWyHWC5Waf2pNBfImzngD9QxeMbbP/YgfuevQMCbyM0ifBqvV7/B7clbE4=",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:"eJztG9tyG7f1V07x4lizXImy7KScTqeOnaaeNJGnVibTETUKuHvIhb0LbACsyK2Gb/2Sflq/pHNw2V1SpBQ7mUad0g8yFzgAzg04N+CWWb4wbHLJXqusqVBaw64SlqPJtKitUJJN2EWB8EojtwgRCl6+fQO8LNXSQGNQG7AKFihRE5TEJeRxPpi1UGt1I3IhF5Bzy2EpbAEzbvDFGaDMVI45zEWJ6VRO5fd1qXgOrWqgzucgJKhGw+XR0WucNQv4/s3R0dVnhbW1mRwf87pOVY3SiIUs+cykmaqOcwKs8/lTKFCjmynjEnLNl7AU+QKtAS5zyFTdQqZGSotccosJ1HyBIJtqhhrUHGyBVQq8NKqbxI0JqKs5vH39Z8L56OhLLNVgdo1gmrpW2mJOJNgCO45Mjo5ozCtVVUpCzTWv0BIL1TxOMJnKERwd2bbGydERvJG5yLhF4+ah1h429aCEOYG+qzETcxFAN+iRsCxEVjhSllxaElld8gwdqEZTY2bFDW5OvEqgpYlfo1QRg0Jp8Q8lLS8dH29QW5HxEjKldC6kw9SzD4zl2pLgayWkja1hBfh74GpjPBJ5EDGhlhNTKiFdj0G44WWDJmC1TKAgrP6GtUbj1CzMawuHU4FiUexdj+fvG2M3JobGEJpDLMJaGn9qhMbcsRcd2+a8NAhivsHLin/AwWqg3P7hZQpftpDjnDelTUDYJwasbjCF75QFXtelyPisRJgrDaTH3DYaR07KQR0CIpJXTsZv3W5CAxxyMZ+jpg1JnW6KqIMBO1LFfvtVShOOXIKSA0GPUzg66tZ2Cvrjjz9O5e1UAkwZ4TJlkynrQKYsAd9HKjZlk3ECoWE1ZRN4dvp5BGjp+8XpF/F7Sd/j8Vn8Luj7dDyV67Aokfqdso7UlxZK5MY6dLvVQRiIUnE0I88K1406hZdlOQCdCyxzvyMzVdVNaZRu6UwKEkmn8tRRb3lV30M5df/6VMdPryuGGt3K1BYppEZSGA9LPSRrau3Qoo51z8FnRJCQwgpemv00RYjHR1aP2RZlZ0QZVlyU+8ly3Y+PpoDWFkHP035j76HHT/HYyPG/tqh5QdS8VzOwwpb3kNSBPD66BqhtEfc5EUdnCJftftICwOMjrENsi6wviKyc23vERb2Pj6CAVewI57nvOzkbjZ+PTk9OzwYQc6UrHgCqapTno7Zt2ymDniPQWaAwHRmhaHC9c0AO7lyraoc35ZydHio4H+539EC+Jb9jFk1y7xya4Lc5e1Zxu+k0WJXz9onxU8WhwSvw8L3v1w7QdF2ER0s+dFYokQXkCSYwHmbku6bEhBHxMT/+9ttjz5mkbxxVVWCXlwW10vfIcXLYWlVpnqfbsEOGD1sryPMEdrTv7shzqKpqX7vvIBWfyt+TXltc2Zla7VftAPD4tLtHbKeCB6MQ+wohQ0fQDtgC0LhoSq5xRf6yEUo66u8cBluaHxWfR1X0zrLzuVwo4pGEz86Dr/s0KCXhszkBtTw87g6aw0k0LnDl5sgaY1VFyIic0wwJmCYrgBsflJKrq2TZhtjHJP4r47WgoKVEa10r2izdRGIqxyfunC8w+3Cv5kSIx6c6A8xip49xqPtyyioeDC+bY/9b2QL1lF11YwyWmFnMB2Nh12C4GmgZz4nTBOxipB69QuRY8hmWfd8AuSDGAanUUQnpkYhsOInzuV6+2uoNnesdSu2JGGpTPP2iTkauQSlMDH43WTAcHYJGW3ALEjGn43+GEAcMAoxdSu65NAgoSZTb8aRBu4kYp6jHD90RUzqext0XeP3ACgQHDrCL1+Ni+xYIJGxIZsgXmqMSUlRNNUikxFkjx6pgBYfsopGUSoorDKV7ZwW+emAFivL3LzCVYxfy5lrVuVpKt8tht+8TQB7fNh9g9ku2+YZZ8XC/ZBtFrIbbaIdFIVBvS7otZPbvoRTO6fymJIAfJAzwLMPaYr51gI9dNK95LhTMGmuV3H+ED6Een3y3sPsvyJgI/nlSHuL2m0napzkqn/ncl+OonDQfm2wDWrs3GkuYqimTLpR8k7MJy1zyPeaPWeKWQGO/VHnLJrcsU9JSx+SWhXwiDT1+byh9f8tMVmDF6VdEjRL+lHBnCfNZM8MS5qJeyv4T89iEqdl7zGi1WhM6VqChOdy4yW2EMlYLuWBJiK7YhPnsOEsYrnhVEzDbyvXX+Zyt44L3TdW19FMZ96NLptM8G9WKT5rt9WCGdcIo0/2JM1Hi0tNW4YV6pajR4mvemsGE3myx7ToLjaGdkYVRkPPW0AZojHcwMl5mTUmRHa5qodsuzHTh3UA/OkS7lTpEx8/XvdB7lLjWvGUJExarYfseJdDq4yWXoSLOuDzYx459r3CG+KfQQFUeJydefTQW7xXCDJ2M6kLJjx4/Pn02Ph0/G5/SDCHX/ul89L13MdhUjJcU02Aenc5Rn95OwGWA04eUM8I7svkCH1bGi33lo0GFwxSqKXOqYSDXqavifHqtbkO/O6ORPqDN64StHiZm5ct8vjYFn5U4t9DUNWrIlJaonw4zOo+GuNOzs3XC2ofJa/8nyfuchLd8mLofXFGvL3j+Frg++2KdsOJhXP/SlR1/Q2TPXqx767rlPFzPVN5ex3Nr/RBgNBQEN1dljpockrvnVX/U0AljUObX2+f8TKkSudxx0AjTV8HjpQIKUykGDinNZYHk0/bRq5u99yNDxOyxTeHCVXGHGSthyCvUDU5ZCm/mA6/UBb4bKAxgXS1ZKnji1rs2jTvGnxyHb+LRk2EJ3xX+u1RuRMEBg8WqLl1tfCnKkvAmu55C9895fh0nCYFoLuPCD5uKVz4z5hYMgzYLyxB8xxRecQlCZmUTnPS5iqkzuL3t1MBpx3oNt7ckVdTXZHTX66RvoLU2Gpxd9S0aMxQ3G6O6JuwHdm2Dod7FuSYXxzeEAsYQAbGQQi6uG12u1+kdNexl9LP5dodNQXY0yf8BxwidN/Jc56h37tw7yinp5sL5xdv7oX26b9vbpYTUyO89H0b5feHnhPOLt3SxRMxDNJPC9+6ekYMJ1APfAAGKLuBGcC+0pHdYWp9xQknbOxwUG3dy0nClYwR3EcqF2YlR0ueauytQdyaGXGjMbNm6S0+qscDzXPggFozF2qSsY+SFah7g+6dwksOicaUmS3YoHgYu/91fDBHSWN34bBvkjY53YYLCEGSGxvR8ilwhoMH8CaA0fjiHOTcWdQKNFMR53VAU302Jqxq1QJlhyh6wQ95Q9dFrUD+6s6Sk8a706ckJ/bfJmu6+WpiUygREx7wpy/Z3LPn5ofP9frxv3m0b73PMi/fi9B+r7Ob0LWlBoz86MIp+RKPLkVUj4u2oU2oXJg04K2QpJF5Htl2fnpxcj4m364Sd7WLfO1WhLUhYS2LiUiu5SKCmKzkIVrfAF1xIIKumf0VuotZK3+9mfBxm9zHhbIMJz+8y4Y10BQp35fFCfUD536V0uLz1yxOqq8rpig+BmfBArp9tEDts90QazBotbMsml7dsNeK1GPn+yeXV+iphxFhFaadaGYcxtwWbsOM7WSiD+sZlES5vvep22mi4zKmIcMez5bU4vhmzdbI9YqcfvBfaWL4QcjG6d9RVT+o7Eofn+AbBfdhei2+Q4vbAzyFUwgSpQYGczCJxkKT8tz4F91WUVUyO7cp39TLZzmBtH+c7clIxJbWRZdqdZBo/H6R3LmOmxiVfutzLrnRKR3pMkHT5kUHKY5DxuOx1tksuxNzC2AXlp2dnLnr9fOzCvGdfuAjq7MXaaVkfTTC2GTG4nOm238vYpj8XB3XeShjVOyTBVA4tq2takzznygk/SOS8RvmOLDftsZvx3QgUy0z53ByZuwj+73/+y42IknRHwO/gvNFQqyXqeePvx85LXAmylYNL0zG+QV6VaEzZApnIhbs+nYuFK1NHQ5nxms9EKejQIDDl832Dc8ek8EMfIT3RvmJ/gyWdNVAq9cHZcwW8sapya0TDuFT6w5xQSoDDjC7BojFgEOMQlAWXGQVZfi8loDRw6Z2pWguDwEVFwO4m5nwuMuEsrpJW88xCxSVfIC2WuEiYuFDHK6xazcgzM6psvO9BF2kRrSfRFQtSeE2+niPc5TnRclFi7t0Ok3i3L+gykSFzmJHrXtPyIkPT380p8Qa1Ozu8A9+UJdSKTnLBSwoFh7Kliazm0pABDjnWIJqOfcEvcmvkvE2BiotknMgnJAUohfzg73Nfdmr2A86MsNhnAZbL5Z1z7OnmmK+FLZoZaKxVP27hGt2pNxzefTylQwJ1Zc7n71DfiCy6DHvWPHbAx8G+cR9wxkOD1+JP2wPI1pQiQ2lwYI1efv32r3ADz9ITlgxO7p+B8PFf37z66rt3X9G8ZFv8/hunJ+mJS10qYysuB0ttvUvY3rqD2sjhGcPhGcPhGcPhGcPhGcPjK4cfnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjEcnjHsUOrDM4bDM4bDM4bDMwY4PGM4PGP47WX70DOGUCEkP+m4LrmQg1sOvqx8uf244SphBdWdJ5fs9pYy1N/TVSVq/qlBTUXrq4TdcC0o2ehK1kkszVJN8gNScfCVT/qPLmj9xOuaq2BsVeqpsuxHvHTCuRd2WBp/e/7ugiUs3i2rVE5jNF/S4wy+ZBPySZl7yOE46+7Mc3fZteRy0bgyKfPzUkWZN7bYLEd/cOXo8GNQbeWyHWC5Waf2pNBfImzngD9QxeMbbP/YgfuevQMCbyM0ifBqvV7/B7clbE4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},y=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create 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:["Upload you pdf in our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,i.jsx)(n.p,{children:"Common parameters of 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"]}),"\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.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\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 }\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 }\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 }\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 }\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 }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\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 dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\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 radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.d5781f47.js b/assets/js/2c586be5.d5781f47.js new file mode 100644 index 000000000..4a6a94f33 --- /dev/null +++ b/assets/js/2c586be5.d5781f47.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 i=s(85893),a=s(11151),r=s(58219),l=(s(62316),s(51039)),t=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:"eJztG+1y27jxVbb4k4uHoi3HyV01nU5zyfXqae+caXxz07E8PohciUhIgAVAS6xH//okfbQ+SWfxQVKyZF/STs+dKj8cEVgs9gvAfgB3zPKFYZMr9lZlTYXSGnadsBxNpkVthZJswi4LhDcauUWIUPD63TnwslRLA41BbcAqWKBETVASl5BHfDBrodbqVuRCLiDnlsNS2AJm3OCrM0CZqRxzmIsS06mcyh/qUvEcWtVAnc9BSFCNhqujo7c4axbww/nR0fUXhbW1mRwf87pOVY3SiIUs+cykmaqOcwKs8/lzKFCjw5RxCbnmS1iKfIHWAJc5ZKpuIVMjpUUuucUEar5AkE01Qw1qDrbAKgVeGtUhcWMC6WoO797+nmg+OvoaSzXArhFMU9dKW8yJBVtgJ5HJ0RGNeaOqSkmoueYVWhKhmkcEk6kcwdGRbWucHB3BucxFxi0ah4dae9jUgxLlBPq+xkzMRQDd4EfCshBZ4VhZcmlJZXXJM3SgGk2NmRW3uIl4lUBLiN+iVJGCQmnxNyUtL50cb1FbkfESMqV0LqSj1IsPjOXakuJrJaSNrWEG+EuQamM8EXlQMZGWk1AqIV2PQbjlZYMmULVMoCCq/oy1RuPMLOC1haOpQLEo9s7H8w+NsRuIoTFE5pCKMJfGvzZCY+7Ei05sc14aBDHfkGXFP+JgNlBu/fAyha9byHHOm9ImIOwzA1Y3mML3ygKv61JkfFYizJUGsmNuG40jp+VgDoEQySun43duNaEBDrmYz1HTgqROhyLaYKCOTLFffpXSRCOXoORA0eMUjo66uZ2B/vTTT1N5N5UAU0a0TNlkyjqQKUvA95GJTdlknEBoWE3ZBF6cfhkBWvp+dfpV/F7S93h8Fr8L+j4dT+U6TEqsfq+sY/W1hRK5sY7cbnYQBqJWHM/Is8J1o07hdVkOQOcCy9yvyExVdVMapVvak4JG0qk8ddxbXtUPcE7d/3mu46e3FUONbmZqixxSIxmMh6Ue0jW1dmRRx7qX4AtiSEhhBS/Nfp4ixNNjq6dsi7Mz4gwrLsr9bLnup8dTIGuLoZdpv7D38ONRPDV2/K8tbl4RNx/UDKyw5QMsdSBPj68BaVvMfUnM0R7CZbuftQDw9BjrCNti6ytiK+f2AXVR79NjKFAVO8J+7vtOzkbjl6PTk9OzAcRc6YoHgKoa5fmobdt2yqCXCHQnUEBHh1A8cL1zQA7uXKtqhzflnJ0eKjgf7nf0QL4jv2MWj+TeOTTBb3PnWcXtptNgVc7bZ8ajikODV+Dhe9+vHZDpuoiOlnzorFAiC8QTTBA8zMh3TUkII5Jjfvzdd8deMknfOKqqIC6vC2ql75GT5LC1qtI8T7dhhwIftlaQ5wnsaN/dkedQVdW+dt9BJj6Vvya7triyM7Xab9oB4OlZd0/YTgMPh0LsK4QMHcE6YAtA46IpucYV+ctGKOm4v7cZbFl+NHweTdE7y87ncqGIJxK+uAi+7vNglETPJgJqeXzcPTKHSDQucOVwZI2xqiJiRM4JQwKmyQrgxgel5OoqWbYh9jGJ/8p4LShoKdFa14o2SzeJmMrxidvnC8w+Pmg5EeLpmc6AstjpYxzqvpqyioeDl82x/61sgXrKrrsxBkvMLOaDsbBrMFwPrIznJGkCdjFST14hciz5DMu+b0BcUOOAVeqohPRERDGcRHyul6+2ekPneodReyaG1hR3v2iTUWpQChOD300RDEeHoNEW3IJEzGn7nyHEAYMAY5eReykNAkpS5XY8adBuEsYp6vFDd8SUTqZx9QVZPzIDwYED7OL1ONm+CQILG5oZyoVwVEKKqqkGiZSINUqsCqfgUFw0klJJcYahdu/NwFePzEBR/v4JpnLsQt5cqzpXS+lWOez2fQLI01vmA8r+nWW+cax4uH9nGUWqhstox4lCoP4s6ZaQ2b+GUrig/ZuSAH6QMMCzDGuL+dYGPnbRvOa5UDBrrFVy/xY+hHp6+t2i7r+gY2L452l5SNsvpmmf5qh85nNfjqNy2nxqug1k7V5oLGGqpky6UPI8ZxOWueR7zB+zxE2Bxn6t8pZN7limpKWOyR0L+UQaevzBUPr+jpmswIrTr0gaJfwp4c4S5rNmhiXMRb2U/SfhsQlTsw+Y0Wy1JnKsQEM43LjJXYQyVgu5YEmIrtiE+ew4SxiueFUTMNvK9df5nK3jhA+h6lp6VMb96JLphGejWvFZ2N4OMKwTRpnuz8REiUvPW4WX6o2iRotveWsGCP2xxbbrLDSGVkYWRkHOW0MLoDHewch4mTUlRXa4qoVuuzDThXcD++gI7WbqCB2/XPdK70niWvOWJUxYrIbte4xAq0/XXIaKJOPyYJ869oPCGeLvQgNVeZyeePXJVHxQCDN0OqoLJT95/Pj0xfh0/GJ8ShhCrv3z5eh771OwaRivKabBPDqdoz69nYDLAKePGWeEd2zzBT5ujJf7ykeDCocpVFPmVMNArlNXxfn8Wt2GfXeHRvqINa8TtnqcmZUv8/naFHxR4txCU9eoIVNaon4+zOg8GeZOz87WCWsfZ6/9n2TvS1Le8nHufnRFvb7g+UvQ+uKrdcKKx2n9Q1d2/AWJPXu17k/XLefhZqby9ibuW+vHAONBQXBzVeaoySG5v1/1Ww3tMAZlfrO9z8+UKpHLHRuNMH0VPF4qoDCVYuCQ0lwWSD5tH7067L0fGSJmT20Kl66KO8xYCUNeoW5wylI4nw+8Uhf4bpAwgHW1ZKngmZvvxjRuG392HL5JRs+GJXxX+O9SuZEEBwwWq7p0tfGlKEuim871FLp/zvPrJEkExOMyTvz4UfHGZ8bchGHQZmEZgu+YwhsuQcisbIKTPlcxdQZ3d50ZOOtYr+HujrSK+oYO3fU66Rtoro0Gd676Fo0ZituNUV0T9gO7tsFQ7+LckIvjG0IBY0iAWEghFzeNLtfr9J4Z9jr62XK7J6agO0LyfyAxIudcXugc9c6Vu2Gc2yI8n/uUlYJn1P0sJF2doIQ2NixPb/2Bfl/72CP0UAWmbNc33XI3zcwQlIz4+uVktVgskO4EBAg3OPHXjfwVARrmqOJzWunujozGW6EaE8kruOk88JwghF89Qi42k2IDYdGWscF76uxP0r2Oi8t3D8vSJ0O3YwFK1438zuSDTM+mxwkXl+/o2o2Yh1gvhR9MJ4ooW74BAhR7wa3gXrpJ7861Ph+H0onEb6MbN5bScOFlBPcJyoXZSVHSZ+K7C2L3EEMuNGa2bJ2OVGOB57nwIT4Yi7UZCPJSNY9Y5edIksOicYU4S6d03CpddaC/NiOksbrxuUjIGx1vCgW7IMgMjenlFKVCQAP8CaA0fjiHOTcWdQKNFCR53VCOo0OJqxq1QJlhyh45pf0x3sf24eSgG11KGh9onJ6c0H+boulu8wWkVEQhPuZNWba/YsnPTyw8HOX45t2ew0NhS/FBnP5tld2eviMraPQnh43Ry2p0ObJqRLIddUbtgsiBZIUshcSbKLab05OTmzHJdp2ws13ie68qtAUpa0lCXGolFwnUdGGJNqMW+IILCXTm6/+gNFFrpR92wj6NsoeEcLYhhJf3hXAuXfnGXQi9VB9R/nc5HU5v/fRE6qpytuITBEx4INfPNpgdtnsmDWaNFrZlk6s7thrxWox8/+Tqen2dMBKsoqRcrYyjmNuCTdjxvRydQX3rcixXd950O2s0XOZUYrnn9/NaHN+O2TrZHrEzStgLbSxfCLkYPTjqumf1PanDS3yD4T6pUYs/ImU1gjyHUAkTZAYFcnIaSIKk5T/3Ccpvoq5i6nBXNrDXyXZ+b3s735Gxiwm7jRzc7hTc+OUg+XUV81guNdVlpnYlmzrWY/qoyx4NEkKDfNBVb7Nd6iVmXsYuZXF6duZi+y/HLgh+8ZWLL89erZ2V9bEWY5vxlPe8tqICxja93Tio8+XCqN4hCUfl8GR1TWvS51w55QeNXNQo39PJTWvsdnw/PscyUz5zScddBP/n3//hRkRNui3gV3DRaKjVEvW88beH5yWuBJ2VgyvlMfpDXpVoTNkCHZELd7k8FwtXxI8HZcZrPhOloE2DwJTPhg72HZPCj338+Ez7+wy3WNJeA6VSH915roA3VlVujngwLpX+OCeSEuAwoyvCaMjVwzgEZcFlRiGoX0sJKA1cemeq1sIgcFERsLunOp+LTLgTV0mreWah4pIvkCZLXJ6ApFDHC75azcgzM6psvO9B14wRrWfRlVJSeEu+nmPcZYHRclFi7t0Ok3i3L9gysSFzmJGPXdP0IkPT31wq8Ra12zu8196UJdTKek+aAuWhbgmR1VwaOoBDBjqophNf8IvcHDlvU6DSKx1O5BOSAZRCfvS33a86M/sRZ0ZY7HMky+Xy3j72fHPMt8IWzQw01qoft3CNbtcbDu8+ntMmgboyF/P3qG9FFl2GPXMeO+DjcL5xH47HTYPX4nfbA+isKUWG0uDgNHr97bs/wS28SE9YMti5fwbBx386f/PN9++/Ibx0tvj1N05P0hOX2FXGVlwOptp6tbG9dAeVo8Mjj8Mjj8Mjj8Mjj8Mjj6d3WeDwyOPwyOPwyOPwyOPwyOPwyOPwyOPwyOPwyOPwyOPwyGOHUR8eeRweeRweeRweecDhkcfhkccvr9vHHnmECiH5Scd1yYUc3HLwZeWr7acf1wkrqO48uWJ3d5Sh/oEuclHzXxvUVLS+Ttgt14KSja5kncTSLNUkPyIVB9/4pP/okuZPvK25CsZWpZ4qy37Ea6ecB2GHpfF3F+8vWcLizbtK5TRG8yU9XeFLNiGflLlnLk6y7kUBd1eBSy4XjSuTMo+XKsq8scVmOfqjK0eHH4NqK5ftgMrNOrVnhf4SYzsH/IYqHn/E9rcduO/ZOyDINkKTCq/X6/W/ACoI1Fo=",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:"eJztG+1y27jxVbb4k4uHoi3HyV01nU5zyfXqae+caXxz07E8PohciUhIgAVAS6xH//okfbQ+SWfxQVKyZF/STs+dKj8cEVgs9gvAfgB3zPKFYZMr9lZlTYXSGnadsBxNpkVthZJswi4LhDcauUWIUPD63TnwslRLA41BbcAqWKBETVASl5BHfDBrodbqVuRCLiDnlsNS2AJm3OCrM0CZqRxzmIsS06mcyh/qUvEcWtVAnc9BSFCNhqujo7c4axbww/nR0fUXhbW1mRwf87pOVY3SiIUs+cykmaqOcwKs8/lzKFCjw5RxCbnmS1iKfIHWAJc5ZKpuIVMjpUUuucUEar5AkE01Qw1qDrbAKgVeGtUhcWMC6WoO797+nmg+OvoaSzXArhFMU9dKW8yJBVtgJ5HJ0RGNeaOqSkmoueYVWhKhmkcEk6kcwdGRbWucHB3BucxFxi0ah4dae9jUgxLlBPq+xkzMRQDd4EfCshBZ4VhZcmlJZXXJM3SgGk2NmRW3uIl4lUBLiN+iVJGCQmnxNyUtL50cb1FbkfESMqV0LqSj1IsPjOXakuJrJaSNrWEG+EuQamM8EXlQMZGWk1AqIV2PQbjlZYMmULVMoCCq/oy1RuPMLOC1haOpQLEo9s7H8w+NsRuIoTFE5pCKMJfGvzZCY+7Ei05sc14aBDHfkGXFP+JgNlBu/fAyha9byHHOm9ImIOwzA1Y3mML3ygKv61JkfFYizJUGsmNuG40jp+VgDoEQySun43duNaEBDrmYz1HTgqROhyLaYKCOTLFffpXSRCOXoORA0eMUjo66uZ2B/vTTT1N5N5UAU0a0TNlkyjqQKUvA95GJTdlknEBoWE3ZBF6cfhkBWvp+dfpV/F7S93h8Fr8L+j4dT+U6TEqsfq+sY/W1hRK5sY7cbnYQBqJWHM/Is8J1o07hdVkOQOcCy9yvyExVdVMapVvak4JG0qk8ddxbXtUPcE7d/3mu46e3FUONbmZqixxSIxmMh6Ue0jW1dmRRx7qX4AtiSEhhBS/Nfp4ixNNjq6dsi7Mz4gwrLsr9bLnup8dTIGuLoZdpv7D38ONRPDV2/K8tbl4RNx/UDKyw5QMsdSBPj68BaVvMfUnM0R7CZbuftQDw9BjrCNti6ytiK+f2AXVR79NjKFAVO8J+7vtOzkbjl6PTk9OzAcRc6YoHgKoa5fmobdt2yqCXCHQnUEBHh1A8cL1zQA7uXKtqhzflnJ0eKjgf7nf0QL4jv2MWj+TeOTTBb3PnWcXtptNgVc7bZ8ajikODV+Dhe9+vHZDpuoiOlnzorFAiC8QTTBA8zMh3TUkII5Jjfvzdd8deMknfOKqqIC6vC2ql75GT5LC1qtI8T7dhhwIftlaQ5wnsaN/dkedQVdW+dt9BJj6Vvya7triyM7Xab9oB4OlZd0/YTgMPh0LsK4QMHcE6YAtA46IpucYV+ctGKOm4v7cZbFl+NHweTdE7y87ncqGIJxK+uAi+7vNglETPJgJqeXzcPTKHSDQucOVwZI2xqiJiRM4JQwKmyQrgxgel5OoqWbYh9jGJ/8p4LShoKdFa14o2SzeJmMrxidvnC8w+Pmg5EeLpmc6AstjpYxzqvpqyioeDl82x/61sgXrKrrsxBkvMLOaDsbBrMFwPrIznJGkCdjFST14hciz5DMu+b0BcUOOAVeqohPRERDGcRHyul6+2ekPneodReyaG1hR3v2iTUWpQChOD300RDEeHoNEW3IJEzGn7nyHEAYMAY5eReykNAkpS5XY8adBuEsYp6vFDd8SUTqZx9QVZPzIDwYED7OL1ONm+CQILG5oZyoVwVEKKqqkGiZSINUqsCqfgUFw0klJJcYahdu/NwFePzEBR/v4JpnLsQt5cqzpXS+lWOez2fQLI01vmA8r+nWW+cax4uH9nGUWqhstox4lCoP4s6ZaQ2b+GUrig/ZuSAH6QMMCzDGuL+dYGPnbRvOa5UDBrrFVy/xY+hHp6+t2i7r+gY2L452l5SNsvpmmf5qh85nNfjqNy2nxqug1k7V5oLGGqpky6UPI8ZxOWueR7zB+zxE2Bxn6t8pZN7limpKWOyR0L+UQaevzBUPr+jpmswIrTr0gaJfwp4c4S5rNmhiXMRb2U/SfhsQlTsw+Y0Wy1JnKsQEM43LjJXYQyVgu5YEmIrtiE+ew4SxiueFUTMNvK9df5nK3jhA+h6lp6VMb96JLphGejWvFZ2N4OMKwTRpnuz8REiUvPW4WX6o2iRotveWsGCP2xxbbrLDSGVkYWRkHOW0MLoDHewch4mTUlRXa4qoVuuzDThXcD++gI7WbqCB2/XPdK70niWvOWJUxYrIbte4xAq0/XXIaKJOPyYJ869oPCGeLvQgNVeZyeePXJVHxQCDN0OqoLJT95/Pj0xfh0/GJ8ShhCrv3z5eh771OwaRivKabBPDqdoz69nYDLAKePGWeEd2zzBT5ujJf7ykeDCocpVFPmVMNArlNXxfn8Wt2GfXeHRvqINa8TtnqcmZUv8/naFHxR4txCU9eoIVNaon4+zOg8GeZOz87WCWsfZ6/9n2TvS1Le8nHufnRFvb7g+UvQ+uKrdcKKx2n9Q1d2/AWJPXu17k/XLefhZqby9ibuW+vHAONBQXBzVeaoySG5v1/1Ww3tMAZlfrO9z8+UKpHLHRuNMH0VPF4qoDCVYuCQ0lwWSD5tH7067L0fGSJmT20Kl66KO8xYCUNeoW5wylI4nw+8Uhf4bpAwgHW1ZKngmZvvxjRuG392HL5JRs+GJXxX+O9SuZEEBwwWq7p0tfGlKEuim871FLp/zvPrJEkExOMyTvz4UfHGZ8bchGHQZmEZgu+YwhsuQcisbIKTPlcxdQZ3d50ZOOtYr+HujrSK+oYO3fU66Rtoro0Gd676Fo0ZituNUV0T9gO7tsFQ7+LckIvjG0IBY0iAWEghFzeNLtfr9J4Z9jr62XK7J6agO0LyfyAxIudcXugc9c6Vu2Gc2yI8n/uUlYJn1P0sJF2doIQ2NixPb/2Bfl/72CP0UAWmbNc33XI3zcwQlIz4+uVktVgskO4EBAg3OPHXjfwVARrmqOJzWunujozGW6EaE8kruOk88JwghF89Qi42k2IDYdGWscF76uxP0r2Oi8t3D8vSJ0O3YwFK1438zuSDTM+mxwkXl+/o2o2Yh1gvhR9MJ4ooW74BAhR7wa3gXrpJ7861Ph+H0onEb6MbN5bScOFlBPcJyoXZSVHSZ+K7C2L3EEMuNGa2bJ2OVGOB57nwIT4Yi7UZCPJSNY9Y5edIksOicYU4S6d03CpddaC/NiOksbrxuUjIGx1vCgW7IMgMjenlFKVCQAP8CaA0fjiHOTcWdQKNFCR53VCOo0OJqxq1QJlhyh45pf0x3sf24eSgG11KGh9onJ6c0H+boulu8wWkVEQhPuZNWba/YsnPTyw8HOX45t2ew0NhS/FBnP5tld2eviMraPQnh43Ry2p0ObJqRLIddUbtgsiBZIUshcSbKLab05OTmzHJdp2ws13ie68qtAUpa0lCXGolFwnUdGGJNqMW+IILCXTm6/+gNFFrpR92wj6NsoeEcLYhhJf3hXAuXfnGXQi9VB9R/nc5HU5v/fRE6qpytuITBEx4INfPNpgdtnsmDWaNFrZlk6s7thrxWox8/+Tqen2dMBKsoqRcrYyjmNuCTdjxvRydQX3rcixXd950O2s0XOZUYrnn9/NaHN+O2TrZHrEzStgLbSxfCLkYPTjqumf1PanDS3yD4T6pUYs/ImU1gjyHUAkTZAYFcnIaSIKk5T/3Ccpvoq5i6nBXNrDXyXZ+b3s735Gxiwm7jRzc7hTc+OUg+XUV81guNdVlpnYlmzrWY/qoyx4NEkKDfNBVb7Nd6iVmXsYuZXF6duZi+y/HLgh+8ZWLL89erZ2V9bEWY5vxlPe8tqICxja93Tio8+XCqN4hCUfl8GR1TWvS51w55QeNXNQo39PJTWvsdnw/PscyUz5zScddBP/n3//hRkRNui3gV3DRaKjVEvW88beH5yWuBJ2VgyvlMfpDXpVoTNkCHZELd7k8FwtXxI8HZcZrPhOloE2DwJTPhg72HZPCj338+Ez7+wy3WNJeA6VSH915roA3VlVujngwLpX+OCeSEuAwoyvCaMjVwzgEZcFlRiGoX0sJKA1cemeq1sIgcFERsLunOp+LTLgTV0mreWah4pIvkCZLXJ6ApFDHC75azcgzM6psvO9B14wRrWfRlVJSeEu+nmPcZYHRclFi7t0Ok3i3L9gysSFzmJGPXdP0IkPT31wq8Ra12zu8196UJdTKek+aAuWhbgmR1VwaOoBDBjqophNf8IvcHDlvU6DSKx1O5BOSAZRCfvS33a86M/sRZ0ZY7HMky+Xy3j72fHPMt8IWzQw01qoft3CNbtcbDu8+ntMmgboyF/P3qG9FFl2GPXMeO+DjcL5xH47HTYPX4nfbA+isKUWG0uDgNHr97bs/wS28SE9YMti5fwbBx386f/PN9++/Ibx0tvj1N05P0hOX2FXGVlwOptp6tbG9dAeVo8Mjj8Mjj8Mjj8Mjj8Mjj6d3WeDwyOPwyOPwyOPwyOPwyOPwyOPwyOPwyOPwyOPwyOPwyGOHUR8eeRweeRweeRweecDhkcfhkccvr9vHHnmECiH5Scd1yYUc3HLwZeWr7acf1wkrqO48uWJ3d5Sh/oEuclHzXxvUVLS+Ttgt14KSja5kncTSLNUkPyIVB9/4pP/okuZPvK25CsZWpZ4qy37Ea6ecB2GHpfF3F+8vWcLizbtK5TRG8yU9XeFLNiGflLlnLk6y7kUBd1eBSy4XjSuTMo+XKsq8scVmOfqjK0eHH4NqK5ftgMrNOrVnhf4SYzsH/IYqHn/E9rcduO/ZOyDINkKTCq/X6/W/ACoI1Fo=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document 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,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)(t(),{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:["Upload you pdf in our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,i.jsx)(n.p,{children:"Common parameters of 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"]}),"\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.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\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 }\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 }\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 }\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 }\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 }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\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 dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\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 radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0,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'."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\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)(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 f(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.20e3554c.js b/assets/js/bbdfc22d.20e3554c.js new file mode 100644 index 000000000..85de79f3e --- /dev/null +++ b/assets/js/bbdfc22d.20e3554c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),l=s(11151),a=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),p=s(9472),m=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:"eJztGmtvGzfyr0z5JY2wki3HeZxwOFxe1xp9OGgcFAfLSKndkZbxLrkhuZZUQ9/ul9xPu19yGD52V7JkJ2nR+g76YmvJ4XBmOOQ8r5nlM8NG5+wMy6rgFg27SFiGJtWiskJJNmJnOUKchpcaOY3D8zcnwItCzQ3UBrUBqyClSYS0NlaV4lc+KRBsRJzAPBdpDgb1FQI3MClqrLSQ1sBUaZihRM2tkDPIVFqXSBNzYXOoNGY4FRIzMFbXqa01mgG8q5QEU6cpGjOti2YnT4ZQMgGboyNUo621NMChluJjjdDrRej3Iuv1wObcQsolTJDYyYibQBB2yJlwmlPSITYVpmIqCDjgGozlWL6rCsUzWKoaqmwKQoKqNZz3eq9wUs/g3Umvd/F1bm1lRgcHvKoGqkJpxEwWfGIGqSoPMgKssulDyFGjw0SkZZrPYS6yGVoDXGaQqmoJqeorLTLJLSZQ8RmCrMsJalBTorIcAC+MapC4NcTGk2OCePPqH47oXu8FFqqDXiOYuqqUtpgRD8RwlMOo16M1L1VZKgkV17xESyqgphHBiAD6JOZlhaNeD05kJlJSA4eJRlvogQcl4gn0bZCrB11jSQYdIm7mXFo6pqrgKTpQjXQkVlzhOuJFAktC/AqlihTkSotflbS8cKK8Qm1FygtIldKZkI5SL0EwlmunlpUS0sbRsAP8Mwi2Np6ILJwykZaRWEoh3YxBuOJFjSZQNU8gJ6p+wkqjceoV8Nrc0ZSjmOU79+PZh9rYNcRQGyKzS0XYS+PHWmjMnHjRiW3KC4MgpmuyLPkldnYD5d4AXgzgxRIynPK6sAkI+8CA1TUO4EdlgVdVIVJ32ekekypzuqJ9d8pBIQIhkpfujN9odSUypBuZiekUNUoLNOlQRC0M1JEyVm4BsVcqTTRyCUp2Dno4gF6v2dup6C+//DKW12MJMGZEy5iNxqwBGbME/Byp2JiNhgmEgcWYjeDR0dMIsKTvJ0fP4vecvofD4/id0/fRcCxXYdMjR4zlZXULITT9+xMRP/3RGRp0O9NYVAMapPPzsDRDoqfRhiyaWLUMPSKGhBRW8MLs5ilC3D+2Wso2ODsmzrDkotjNlpu+fzwFsjYYejxo79kOfjyK+8aO/7XBzRPi5oOagBW2uIWlBuT+8dUhbYO5p8RcqsqKy+Vu1gLA/WOsIWyDrWfEVsbtLcdFs/ePoUBVnAgGz88dHveHj/tHh0fHHYip0iUPAGXZz7L+crlcjhm0EgHHP9m+gI7MX7R/3laTjznVqtzi3Djfo4UKvoD7HR2CH8gNmEQL2XprrXvqqVy34VZlfPnAeFRxaTDSHr51xZYdMt0U0bEkrzbNlUgD8QQTBA8TciYHJIQ+yTE7+OGHAy+ZpB3sl2UQlz8LGqXvvpNkd7QsB1k22ITtCrw7WkKWJbBlfPtElkFZlrvG/QSp+Fj+ZeDihoWdqMVu1Q4A90+7W8K2KngwCnEuFzJMBO2ADQCNs7rgGhfkvhqhpOP+xmOwoflR8XlURe+7OrfPRQaeSPj6NLieD4NSEj3rCGjk7nU3yOwi0TjDhcPhY1YiRmQheDR1mlOc6qJc8jyVLJYhFDGJ/0p5JSiGKNBaN4o2HawTMZbDQ/fO55he3qo5EeL+qU6HsjjpQw6aPh+zkgfDy6bY/lY2Rz1mF80agwWmFrPOWti2GC46WsYzkjQBu5ClJS8XGRZ8gkU71yEuHGOHVZoohfRERDEcRnxuli82ZsPkaotSeya62hRfv6iTUWpQCBNj0XURdFeHGM5lIiT6FMQEIS6ASfN6b1NyL6VOfEdHuRneGbTrhHEDcemWEM/JNN6+IOs7diA4cIBN+Bw327VBYGHtZLpyIRylkKKsy05qI2KNEiuDFeyKi1ZSbiru0D3dGzvwxR07hOzQjg3Gcugi0EyrKlNz6W45bPd9Asj9u+Ydyn7LNV8zKx7ut1yjSFX3Gm2xKATqbUlzhczuOzSAU3q/KYXgFwkDPE2xsphtPOBDF81rngkFk9paJXc/4V2o+3e+G9T9AWdMDH/aKXdp+7NOeiyHPtFR+lTkrixH6c7zvp1uIGv7MQQTJ1nCVOXy7EqeZGzEfM4+ZrBZ4rZCY1+obMlG1yxV0qK09DMk+mjpwQdDtYFrZtIcS06/IolUTZiKglBRrg21YQlz8S+VFkiIbMTU5AOmliXkXFaUe0VDONy60XWEMlYLOWNJiLPYiPnMNUsYLnhZEXAYApSpoujHoVjFHW/D1Yy0uIz70eTzCQ+ljL8QjVu62iinfBGmLoZVK9cWGdeaL9lm5SbmiqMH79c1Wd1iGc23sOQKRPfCg7GECYtld5cdp6bV50s6RUWcuBTW5651x8LLz96T1lW5kl+0MOSkt8j8E6XkZ29uvH5kzynYwCx6g/02nZ6AS80O7tKYCO+45bPunt65ubHn2a4yS6cSYHJVFxnl+pHrgat2fHlZi0qFvEhrV61rXvM1zhpSG86Gq4Qt7mZm4StivoYDXxc4tVBXFWpIlZaoH3ZTLfeGuaPj41XClnezt/yfZO8pHd78bu5+dsWvtjD4Z9D66NkqYfndtH7blOf+RGKPn6xaW7dhy99PVLZ8H9+t1V2A0agQnEGZnchTnaHuCGKiVIFcdvd3vsiGYE6mPtBU8ICmH4RUCbE0FdpE+wJzURSgMUUq2LqMZXy6IPgg4MwDhNoNxaivacA5e6aeGIKSEZ/xCCcIVovZDDW1C3gItzjxzQTIXQ8CFXKJKj616B3QSuOVULWJ5OXcAGW4CyR/0uYofG1TyNl6KNsRFvmWa7wPnJGTVBw9PXtzuyx9CmNDmC7I7oPNhQl227PpccLp2RuqXYtp8MsG8M40ooiy5WsgQH4SXAnupZu0b/3SR9EonUiU43at8D8IVeM+3CQoE2YrRUmbP2v6RG4ghkxoTG2xdGekags8y4T3UsBYrExHkGeqvkMrv0SSHGa1S59busKxkO1yem3tWUjfgOIil6zWsdwe9IIgqRullVOUCgF18CeA0vjlHKbcWNQJtaaQ5HVNkUmDEhcVaoEyxQG74wr7O9764cSxGzCVksZ7IUeHh/RvwwFY65yhzZuummL5FUs+PQi43QXywxR23HSDWg/mRX70ralkmeZ05iUas+7FbFlyBwNduQlZCInvo1DeHx0evn9Mklsl7HibcN6qEm1ORzEnTZ1rJWcJVAVy6vjQS+AzLiTQ9vp3lBVqrfTtXH8eZbcJ4fjw8P2wEcLjm0I4kS6l6pqpztQlyj+W0+721m9PpC5KFzv4WIAJD+Tm2Rqz3XHPpMG01sIu2ej8mi36vBJ9Pz86v1hdkNbZXFF4XCnjKOY2ZyN2cCNadt1sFIqdX7NaF2zEork3XGaU9rxh8nklDq6GbJVsrtjqIOyENpbPhJz1b1110bL6lo7DS3yN4TaeqcR3SAFNkGcXKmGC1CBHTi4BSZBO+ac2VfA6nlUM4rfG5e2hbEbaMdBei503n/At0XAnGD6PkagLLpvYkrUcsSb+o59NRHfeql4TPMXYaeiCjqPjY+edPx06N/bRM+chHj9ZXXgJd7wl7xF1TH4wRl3b5YZWJNOpcgcQhHJaoXxLtpH0/Gp40z3GIlUluuR7jhDB//Ovf7sV0Zq6a/gVnNYaKjVHTc2R1FA2LXAhyBp1ejcp+neVAV4WaAylBKTFme97FDNX3IqmKOUVn4hC0MUlMOWLwJ27bwbwc46UK6SpB9rX+a6woPsOhVKXzmIq4LVVZbe3EuZKX06JpAQ4TKiTDQ05UxiXoMy5TCnF5/U5AaWBS++uVFoYBC5KAibjjdOpSAUhpldK89RCySWfIW2WODedpFDFPjStJuT7GFXU3rpTNxyi9Sy6FOMAXpE35RinwQwtFwVm3rCbxDtW4dEiNmQGE/JiK9pepGjain6BV6jd/fV+cV0UUCnrfVWKKbpnS4is5tJQIOAJikfTiC94Hm6PjC8HQNlMMhDkdZECFEJeUltmH84bNfsZJ0ZYbEOU+Xx+4y15uL7mG2HzegIaK9Wum7lB9/J0lzcfD+nmoy7N6fQt6iuRYnjIdux54IAPgo3hqbMx8T7zSvx9cwG994VIURrsWITn37z5Hq7g0eCQJZ3X8xMIPvj+5OXrH9++Jrz0vvv7NxwcDg5dXkUZW3LZ2eqlb30+a9+zjaxfYyz3/dT7fup9P/W+n3rfT73vp973U98nnvb91Pt+6n0/9e/ZT7Tvp973U4/3/dSw76fe91Pv+6n3/dT7fup9P/W+n3rfT73vp/4/6qcOtUPymA6qggtXfHbVhutQNz7f7LK+SFhOheXRObu+puzxO12sVjT8sUZNVemLhF1xLSgL6GrSSay9UrXyEpdUcvAVhf4Z7Z94rXPlkY1SPJWO/Yrn7phuhe3Wvt+cvj1jCZuETvBSZbRG8zl1ifM5G5F3ylxHuZOw6wXmrs2v4HJWuwIq83ipZMxrm6/Xmy9dvTn86NRhuVx2qFwvRHtW6C8xtnXBX6lG8R0u/9aA+5mdC4JsIzQd4cVqtfovkFJQjw==",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:"eJztGmtvGzfyr0z5JY2wki3HeZxwOFxe1xp9OGgcFAfLSKndkZbxLrkhuZZUQ9/ul9xPu19yGD52V7JkJ2nR+g76YmvJ4XBmOOQ8r5nlM8NG5+wMy6rgFg27SFiGJtWiskJJNmJnOUKchpcaOY3D8zcnwItCzQ3UBrUBqyClSYS0NlaV4lc+KRBsRJzAPBdpDgb1FQI3MClqrLSQ1sBUaZihRM2tkDPIVFqXSBNzYXOoNGY4FRIzMFbXqa01mgG8q5QEU6cpGjOti2YnT4ZQMgGboyNUo621NMChluJjjdDrRej3Iuv1wObcQsolTJDYyYibQBB2yJlwmlPSITYVpmIqCDjgGozlWL6rCsUzWKoaqmwKQoKqNZz3eq9wUs/g3Umvd/F1bm1lRgcHvKoGqkJpxEwWfGIGqSoPMgKssulDyFGjw0SkZZrPYS6yGVoDXGaQqmoJqeorLTLJLSZQ8RmCrMsJalBTorIcAC+MapC4NcTGk2OCePPqH47oXu8FFqqDXiOYuqqUtpgRD8RwlMOo16M1L1VZKgkV17xESyqgphHBiAD6JOZlhaNeD05kJlJSA4eJRlvogQcl4gn0bZCrB11jSQYdIm7mXFo6pqrgKTpQjXQkVlzhOuJFAktC/AqlihTkSotflbS8cKK8Qm1FygtIldKZkI5SL0EwlmunlpUS0sbRsAP8Mwi2Np6ILJwykZaRWEoh3YxBuOJFjSZQNU8gJ6p+wkqjceoV8Nrc0ZSjmOU79+PZh9rYNcRQGyKzS0XYS+PHWmjMnHjRiW3KC4MgpmuyLPkldnYD5d4AXgzgxRIynPK6sAkI+8CA1TUO4EdlgVdVIVJ32ekekypzuqJ9d8pBIQIhkpfujN9odSUypBuZiekUNUoLNOlQRC0M1JEyVm4BsVcqTTRyCUp2Dno4gF6v2dup6C+//DKW12MJMGZEy5iNxqwBGbME/Byp2JiNhgmEgcWYjeDR0dMIsKTvJ0fP4vecvofD4/id0/fRcCxXYdMjR4zlZXULITT9+xMRP/3RGRp0O9NYVAMapPPzsDRDoqfRhiyaWLUMPSKGhBRW8MLs5ilC3D+2Wso2ODsmzrDkotjNlpu+fzwFsjYYejxo79kOfjyK+8aO/7XBzRPi5oOagBW2uIWlBuT+8dUhbYO5p8RcqsqKy+Vu1gLA/WOsIWyDrWfEVsbtLcdFs/ePoUBVnAgGz88dHveHj/tHh0fHHYip0iUPAGXZz7L+crlcjhm0EgHHP9m+gI7MX7R/3laTjznVqtzi3Djfo4UKvoD7HR2CH8gNmEQL2XprrXvqqVy34VZlfPnAeFRxaTDSHr51xZYdMt0U0bEkrzbNlUgD8QQTBA8TciYHJIQ+yTE7+OGHAy+ZpB3sl2UQlz8LGqXvvpNkd7QsB1k22ITtCrw7WkKWJbBlfPtElkFZlrvG/QSp+Fj+ZeDihoWdqMVu1Q4A90+7W8K2KngwCnEuFzJMBO2ADQCNs7rgGhfkvhqhpOP+xmOwoflR8XlURe+7OrfPRQaeSPj6NLieD4NSEj3rCGjk7nU3yOwi0TjDhcPhY1YiRmQheDR1mlOc6qJc8jyVLJYhFDGJ/0p5JSiGKNBaN4o2HawTMZbDQ/fO55he3qo5EeL+qU6HsjjpQw6aPh+zkgfDy6bY/lY2Rz1mF80agwWmFrPOWti2GC46WsYzkjQBu5ClJS8XGRZ8gkU71yEuHGOHVZoohfRERDEcRnxuli82ZsPkaotSeya62hRfv6iTUWpQCBNj0XURdFeHGM5lIiT6FMQEIS6ASfN6b1NyL6VOfEdHuRneGbTrhHEDcemWEM/JNN6+IOs7diA4cIBN+Bw327VBYGHtZLpyIRylkKKsy05qI2KNEiuDFeyKi1ZSbiru0D3dGzvwxR07hOzQjg3Gcugi0EyrKlNz6W45bPd9Asj9u+Ydyn7LNV8zKx7ut1yjSFX3Gm2xKATqbUlzhczuOzSAU3q/KYXgFwkDPE2xsphtPOBDF81rngkFk9paJXc/4V2o+3e+G9T9AWdMDH/aKXdp+7NOeiyHPtFR+lTkrixH6c7zvp1uIGv7MQQTJ1nCVOXy7EqeZGzEfM4+ZrBZ4rZCY1+obMlG1yxV0qK09DMk+mjpwQdDtYFrZtIcS06/IolUTZiKglBRrg21YQlz8S+VFkiIbMTU5AOmliXkXFaUe0VDONy60XWEMlYLOWNJiLPYiPnMNUsYLnhZEXAYApSpoujHoVjFHW/D1Yy0uIz70eTzCQ+ljL8QjVu62iinfBGmLoZVK9cWGdeaL9lm5SbmiqMH79c1Wd1iGc23sOQKRPfCg7GECYtld5cdp6bV50s6RUWcuBTW5651x8LLz96T1lW5kl+0MOSkt8j8E6XkZ29uvH5kzynYwCx6g/02nZ6AS80O7tKYCO+45bPunt65ubHn2a4yS6cSYHJVFxnl+pHrgat2fHlZi0qFvEhrV61rXvM1zhpSG86Gq4Qt7mZm4StivoYDXxc4tVBXFWpIlZaoH3ZTLfeGuaPj41XClnezt/yfZO8pHd78bu5+dsWvtjD4Z9D66NkqYfndtH7blOf+RGKPn6xaW7dhy99PVLZ8H9+t1V2A0agQnEGZnchTnaHuCGKiVIFcdvd3vsiGYE6mPtBU8ICmH4RUCbE0FdpE+wJzURSgMUUq2LqMZXy6IPgg4MwDhNoNxaivacA5e6aeGIKSEZ/xCCcIVovZDDW1C3gItzjxzQTIXQ8CFXKJKj616B3QSuOVULWJ5OXcAGW4CyR/0uYofG1TyNl6KNsRFvmWa7wPnJGTVBw9PXtzuyx9CmNDmC7I7oPNhQl227PpccLp2RuqXYtp8MsG8M40ooiy5WsgQH4SXAnupZu0b/3SR9EonUiU43at8D8IVeM+3CQoE2YrRUmbP2v6RG4ghkxoTG2xdGekags8y4T3UsBYrExHkGeqvkMrv0SSHGa1S59busKxkO1yem3tWUjfgOIil6zWsdwe9IIgqRullVOUCgF18CeA0vjlHKbcWNQJtaaQ5HVNkUmDEhcVaoEyxQG74wr7O9764cSxGzCVksZ7IUeHh/RvwwFY65yhzZuummL5FUs+PQi43QXywxR23HSDWg/mRX70ralkmeZ05iUas+7FbFlyBwNduQlZCInvo1DeHx0evn9Mklsl7HibcN6qEm1ORzEnTZ1rJWcJVAVy6vjQS+AzLiTQ9vp3lBVqrfTtXH8eZbcJ4fjw8P2wEcLjm0I4kS6l6pqpztQlyj+W0+721m9PpC5KFzv4WIAJD+Tm2Rqz3XHPpMG01sIu2ej8mi36vBJ9Pz86v1hdkNbZXFF4XCnjKOY2ZyN2cCNadt1sFIqdX7NaF2zEork3XGaU9rxh8nklDq6GbJVsrtjqIOyENpbPhJz1b1110bL6lo7DS3yN4TaeqcR3SAFNkGcXKmGC1CBHTi4BSZBO+ac2VfA6nlUM4rfG5e2hbEbaMdBei503n/At0XAnGD6PkagLLpvYkrUcsSb+o59NRHfeql4TPMXYaeiCjqPjY+edPx06N/bRM+chHj9ZXXgJd7wl7xF1TH4wRl3b5YZWJNOpcgcQhHJaoXxLtpH0/Gp40z3GIlUluuR7jhDB//Ovf7sV0Zq6a/gVnNYaKjVHTc2R1FA2LXAhyBp1ejcp+neVAV4WaAylBKTFme97FDNX3IqmKOUVn4hC0MUlMOWLwJ27bwbwc46UK6SpB9rX+a6woPsOhVKXzmIq4LVVZbe3EuZKX06JpAQ4TKiTDQ05UxiXoMy5TCnF5/U5AaWBS++uVFoYBC5KAibjjdOpSAUhpldK89RCySWfIW2WODedpFDFPjStJuT7GFXU3rpTNxyi9Sy6FOMAXpE35RinwQwtFwVm3rCbxDtW4dEiNmQGE/JiK9pepGjain6BV6jd/fV+cV0UUCnrfVWKKbpnS4is5tJQIOAJikfTiC94Hm6PjC8HQNlMMhDkdZECFEJeUltmH84bNfsZJ0ZYbEOU+Xx+4y15uL7mG2HzegIaK9Wum7lB9/J0lzcfD+nmoy7N6fQt6iuRYnjIdux54IAPgo3hqbMx8T7zSvx9cwG994VIURrsWITn37z5Hq7g0eCQJZ3X8xMIPvj+5OXrH9++Jrz0vvv7NxwcDg5dXkUZW3LZ2eqlb30+a9+zjaxfYyz3/dT7fup9P/W+n3rfT73vp973U98nnvb91Pt+6n0/9e/ZT7Tvp973U4/3/dSw76fe91Pv+6n3/dT7fup9P/W+n3rfT73vp/4/6qcOtUPymA6qggtXfHbVhutQNz7f7LK+SFhOheXRObu+puzxO12sVjT8sUZNVemLhF1xLSgL6GrSSay9UrXyEpdUcvAVhf4Z7Z94rXPlkY1SPJWO/Yrn7phuhe3Wvt+cvj1jCZuETvBSZbRG8zl1ifM5G5F3ylxHuZOw6wXmrs2v4HJWuwIq83ipZMxrm6/Xmy9dvTn86NRhuVx2qFwvRHtW6C8xtnXBX6lG8R0u/9aA+5mdC4JsIzQd4cVqtfovkFJQjw==",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:"Get Template",permalink:"/docs/API-docs/get-template"}},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,l.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(n.p,{children:["Upload you pdf in our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,i.jsx)(n.p,{children:"Common parameters of 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"]}),"\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 }\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 }\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 }\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 }\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 }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\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 dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\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 radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\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 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",example:!0,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'."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(a.Z,{children:[(0,i.jsxs)(m.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(m.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(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)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.a84b1389.js b/assets/js/bbdfc22d.a84b1389.js deleted file mode 100644 index d3e3fc486..000000000 --- a/assets/js/bbdfc22d.a84b1389.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:()=>x,default:()=>y,frontMatter:()=>p,metadata:()=>u,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:"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:"eJztGmtvGzfyr0z5pY2wki3HeZxwOFwevTbow0HjoDhYRkrtjrSMd8kNybW8NfTtfsn9tPslh+FjdyVLdpIWre+gL7aWHA5nhkPO85pZvjBscsZOsawKbtGw84RlaFItKiuUZBN2miPEaXihkdM4PHv9CnhRqKWB2qA2YBWkNImQ1saqUvzKZwWCjYgTWOYizcGgvkTgBmZFjZUW0hqYKw0LlKi5FXIBmUrrEmliKWwOlcYM50JiBsbqOrW1RjOCt5WSYOo0RWPmddHu5MkQSiZgc3SEarS1lgY41FJ8qBEGgwj9TmSDAdicW0i5hBkSOxlxEwjCHjkzTnNKOsSmwlTMBQEHXKOpnMq3VaF4Bo2qocrmICSoWsPZYPASZ/UC3r4aDM6/yq2tzOTggFfVSFUojVjIgs/MKFXlQUaAVTZ/ADlqdJiItEzzJSxFtkBrgMsMUlU1kKqh0iKT3GICFV8gyLqcoQY1JyrLEfDCqBaJW0NsPD4miNcv/+GIHgyeY6F66DWCqatKaYsZ8UAMRzlMBgNa80KVpZJQcc1LtKQCah4RTAhgSGJuKpwMBvBKZiIlNXCYaLSDHnlQIp5A3wS5etA1lmTQIeJmyaWlY6oKnqID1UhHYsUlriO+SqAhxC9RqkhBrrT4VUnLCyfKS9RWpLyAVCmdCeko9RIEY7l2alkpIW0cDTvAP4Nga+OJyMIpE2kZiaUU0s0YhEte1GgCVcsEcqLqJ6w0GqdeAa/NHU05ikW+cz+eva+NXUMMtSEy+1SEvTR+qIXGzIkXndjmvDAIYr4my5JfYG83UO4N4MUInjeQ4ZzXhU1A2C8NWF3jCH5UFnhVFSJ1l53uMakypys6dKccFCIQInnpzvi1VpciQ7qRmZjPUaO0QJMORdTCQB0pY+UWEHul0kQjl6Bk76DHIxgM2r2div7yyy9TeT2VAFNGtEzZZMpakClLwM+Rik3ZZJxAGLiasgk8PHoSARr6fnz0NH4v6Xs8Po7fOX0fjadyFTY9csRYXla3EELTvz8R8dMfnaFBtzONRTWgQTo/D0szJHoabcmiiVXH0ENiSEhhBS/Mbp4ixP1jq6Nsg7Nj4gxLLordbLnp+8dTIGuDoUej7p7t4MejuG/s+F8b3Dwmbt6rGVhhi1tYakHuH1890jaYe0LMpaqsuGx2sxYA7h9jLWEbbD0ltjJubzkumr1/DAWq4kQweH7u8Hg4fjQ8Ojw67kHMlS55ACjLYZYNm6Zppgw6iYDjn2xfQEfmL9o/b6vJx5xrVW5xbpzv0UEFX8D9jg7BD+QGzKKF7Ly1zj31VK7bcKsy3nxpPKq4NBhpD9+5Yk2PTDdFdDTk1aa5EmkgnmCC4GFGzuSIhDAkOWYHP/xw4CWTdIPDsgzi8mdBo/Q9dJLsj5blKMtGm7B9gfdHS8iyBLaMb5/IMijLcte4nyAVn8q/jFzccGVn6mq3ageA+6fdHWFbFTwYhTiXCxkmgnbABoDGRV1wjVfkvhqhpOP+xmOwoflR8XlURe+7OrfPRQaeSPjqJLieD4JSEj3rCGjk7nU3yOwj0bjAK4fDx6xEjMhC8GjqNKc41UW55HkqWTQhFDGJ/0p5JSiGKNBaN4o2Ha0TMZXjQ/fO55he3Ko5EeL+qU6PsjjpQw6aPpuykgfDy+bY/VY2Rz1l5+0agwWmFrPeWti2GM57WsYzkjQBu5ClIy8XGRZ8hkU31yMuHGOPVZoohfRERDEcRnxull9tzIbJ1Ral9kz0tSm+flEno9SgECbGousi6K8OMZzLREj0KYgZQlwAs/b13qbkXkq9+I6OcjO8M2jXCeMG4tItIZ6Tabx9QdZ37EBw4ADb8DlutmuDwMLayfTlQjhKIUVZl73URsQaJVYGK9gXF62k3FTcoX+6N3bgV3fsELJDOzaYyrGLQDOtqkwtpbvlsN33CSD375r3KPst13zNrHi433KNIlX9a7TFohCotyXtFTK779AITuj9phSCXyQM8DTFymK28YCPXTSveSYUzGprldz9hPeh7t/5blD3B5wxMfxxp9yn7c866akc+0RH6VORu7IcpTvP+3a6gaztxxBMnGQJU5XLsyv5KmMT5nP2MYPNErcVGvtcZQ2bXLNUSYvS0s+Q6KOlB+8N1QaumUlzLDn9iiRSNWEuCkJFuTbUhiXMxb9UWiAhsglTs/eYWpaQc1lR7hUN4XDrJtcRylgt5IIlIc5iE+Yz1yxheMXLioDDEKBMFUU/DsUq7ngbrnakw2XcjzafT3goZfyZaNzS1UY55bMw9TGsOrl2yLjWvGGblZuYK44evF/XZnWLJppvYckViO6FB2MJExbL/i47Tk2rT5d0ioo4cSmsT13rjoWXn7wnratyJT9rYchJb5H5R0rJz97ceP3InlGwgVn0BoddOj0Bl5od3aUxEd5xyxf9Pb1zc2PP011lll4lwOSqLjLK9SPXI1ft+PyyFpUKeZHWrlrXvuZrnLWktpyNVwm7upuZK18R8zUc+KrAuYW6qlBDqrRE/aCfark3zB0dH68S1tzNXvM/yd4TOrzl3dz97IpfXWHwz6D14dNVwvK7af22Lc/9icQeP151tm7Dlr+bqax5F9+t1V2A0agQnEGZvZInOkPdE8RMqQK57O9Pvgg945LKfyenr2+H9kH6hhxdGDkEmwsTLBMsRVGAxwknp6+pOivmwfMYwVvXbuBgNKZI5V6+BgLkCcCl4ODMS9K9Zo2PE1Fa1C4gFov10vYo1EWHcJOgTJitFCVdhqjthLiBGDKhMbVF41oaVG2BZ5nwdhiMxcqMWCvIU1XfIffPkSSHRe0SxJaUNJZqXdaqq64K6VssnG+e1ToWlAnU1cC1on6LTk5RKgTUw58ASuOXc5hzY1En1HxBktc1+d4tSryqUAuUKY7YHUrqtbjzNIP6UeFfSePt7NHhIf3bMHFrvSG0eds3UjRfsOTj3dzbjbwfJsf6pqHvbPTz/OhbU8kyzenMSzRm3U5vWXIHA325CVkIie+iUN4dHR6+e0SSWyXseJtw3qgSbU5HsSRNXWolFwlUBXLqadAN8AUXEmh7/TvKCrVW+nauP42y24RwfHj4btwK4dFNIbySLmno2oVO1QXKP5bT/vbWb0+kXpXOO/beLhMeyM2zNWb7455Jg2mthW3Y5OyaXQ15JYZ+fnJ2vjonrbO5ogCwUsZRzG3OJuzgRjzo+rUo2Di7ZrUu2IRFg2a4zCixd8Oo8UocXI7ZKtlcsdUE7oQ2li+EXAxvXXXesfqGjsNLfI3hzmOvxHdILnuQZx8qYYLUIEdORo8kSKf8UxcMfx3PKoapWyPP7lA2Y8kYSq5Fh5tP+JZ4rxfuncVYy4VPbfTEOo5YG+HQzzZmOetUrw0PYnQwdm710fGx8z+fjJ2j9vCp84GOH6/OvYR7/oDLP/RNfjBGfdvlhlYk07lyBxCEclKhfEO2kfT8cnzTAcQiVSW69HKOEMH/869/uxXRmrpr+AWc1BoqtURN7X/UMjUv8EqQNep1J1J863LfvCzQGAp6pcWF7+wTC1e+iaYo5RWfiULQxSUw5cucvbtvRvBzjpQNo6kvta9kXWJB9x0KpS6cxVTAa6vKfvcgLJW+mBNJCXCYUa8WGgMGMS5BmXOZUhLL63MCSgOX3l2ptDAIXJQETMYb53ORCkJMr5TmqYWSS75A2ixxjihJoYqdVlrNyPcxqqi9dad+L0TrWXRJtBG8JG/KMU6DGVouCsy8YTeJd6zCo0VsyAxmaCxUtL1I0XQ16wIvUbv7606S7BRUil5TwQvymvtnS4is5tKQq+sJikfTii94Hm6PjDcjoHwdGQjyukgBCiEvqPFwCGetmv2MMyMsdk74crm88ZY8WF/zjbB5PQONlerWLdyge3n6y9uPB3TzUZfmZP4G9aVIMTxkO/Y8cMAHwcbw1NmYeJ95Jf6+uYDe+0KkKA32LMKzb15/D5fwcHTIkt7r+REEH3z/6sXXP775mvDS++7v33h0ODp0mQNlbMllb6sXvrn3tHvPNvJarbHcdwzvO4b3HcP7juF9x/C+Y3jfMXyfeNp3DO87hvcdw79nx8y+Y3jfMTzddwzDvmN43zG87xjedwzvO4b3HcP7juF9x/C+Y/j/qGM41A7JYzqoCi5c8dlVG65D3fhss4/4PGE5FZYnZ+z6mrLHb3WxWtHwhxo1VaXPE3bJtaAsoKtJJ7H2StXKC2yo5OArCsNT2j/xWufKIxuleCod+xXP3DHdCtuvfb8+eXPKEjYLvc6lymiN5kvqg+ZLNiHvlLmeaSdh1+3KXSNbweWidgVU5vFSyZjXNl+vN1+4enP40avDctn0qFwvRHtW6C8xtnXBX6lG8R02f2vB/czOBUG2EZqO8Hy1Wv0XugLodA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={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:"eJztGmtvGzfyr0z5pY2wki3HeZxwOFwevTbow0HjoDhYRkrtjrSMd8kNybW8NfTtfsn9tPslh+FjdyVLdpIWre+gL7aWHA5nhkPO85pZvjBscsZOsawKbtGw84RlaFItKiuUZBN2miPEaXihkdM4PHv9CnhRqKWB2qA2YBWkNImQ1saqUvzKZwWCjYgTWOYizcGgvkTgBmZFjZUW0hqYKw0LlKi5FXIBmUrrEmliKWwOlcYM50JiBsbqOrW1RjOCt5WSYOo0RWPmddHu5MkQSiZgc3SEarS1lgY41FJ8qBEGgwj9TmSDAdicW0i5hBkSOxlxEwjCHjkzTnNKOsSmwlTMBQEHXKOpnMq3VaF4Bo2qocrmICSoWsPZYPASZ/UC3r4aDM6/yq2tzOTggFfVSFUojVjIgs/MKFXlQUaAVTZ/ADlqdJiItEzzJSxFtkBrgMsMUlU1kKqh0iKT3GICFV8gyLqcoQY1JyrLEfDCqBaJW0NsPD4miNcv/+GIHgyeY6F66DWCqatKaYsZ8UAMRzlMBgNa80KVpZJQcc1LtKQCah4RTAhgSGJuKpwMBvBKZiIlNXCYaLSDHnlQIp5A3wS5etA1lmTQIeJmyaWlY6oKnqID1UhHYsUlriO+SqAhxC9RqkhBrrT4VUnLCyfKS9RWpLyAVCmdCeko9RIEY7l2alkpIW0cDTvAP4Nga+OJyMIpE2kZiaUU0s0YhEte1GgCVcsEcqLqJ6w0GqdeAa/NHU05ikW+cz+eva+NXUMMtSEy+1SEvTR+qIXGzIkXndjmvDAIYr4my5JfYG83UO4N4MUInjeQ4ZzXhU1A2C8NWF3jCH5UFnhVFSJ1l53uMakypys6dKccFCIQInnpzvi1VpciQ7qRmZjPUaO0QJMORdTCQB0pY+UWEHul0kQjl6Bk76DHIxgM2r2div7yyy9TeT2VAFNGtEzZZMpakClLwM+Rik3ZZJxAGLiasgk8PHoSARr6fnz0NH4v6Xs8Po7fOX0fjadyFTY9csRYXla3EELTvz8R8dMfnaFBtzONRTWgQTo/D0szJHoabcmiiVXH0ENiSEhhBS/Mbp4ixP1jq6Nsg7Nj4gxLLordbLnp+8dTIGuDoUej7p7t4MejuG/s+F8b3Dwmbt6rGVhhi1tYakHuH1890jaYe0LMpaqsuGx2sxYA7h9jLWEbbD0ltjJubzkumr1/DAWq4kQweH7u8Hg4fjQ8Ojw67kHMlS55ACjLYZYNm6Zppgw6iYDjn2xfQEfmL9o/b6vJx5xrVW5xbpzv0UEFX8D9jg7BD+QGzKKF7Ly1zj31VK7bcKsy3nxpPKq4NBhpD9+5Yk2PTDdFdDTk1aa5EmkgnmCC4GFGzuSIhDAkOWYHP/xw4CWTdIPDsgzi8mdBo/Q9dJLsj5blKMtGm7B9gfdHS8iyBLaMb5/IMijLcte4nyAVn8q/jFzccGVn6mq3ageA+6fdHWFbFTwYhTiXCxkmgnbABoDGRV1wjVfkvhqhpOP+xmOwoflR8XlURe+7OrfPRQaeSPjqJLieD4JSEj3rCGjk7nU3yOwj0bjAK4fDx6xEjMhC8GjqNKc41UW55HkqWTQhFDGJ/0p5JSiGKNBaN4o2Ha0TMZXjQ/fO55he3Ko5EeL+qU6PsjjpQw6aPpuykgfDy+bY/VY2Rz1l5+0agwWmFrPeWti2GM57WsYzkjQBu5ClIy8XGRZ8hkU31yMuHGOPVZoohfRERDEcRnxull9tzIbJ1Ral9kz0tSm+flEno9SgECbGousi6K8OMZzLREj0KYgZQlwAs/b13qbkXkq9+I6OcjO8M2jXCeMG4tItIZ6Tabx9QdZ37EBw4ADb8DlutmuDwMLayfTlQjhKIUVZl73URsQaJVYGK9gXF62k3FTcoX+6N3bgV3fsELJDOzaYyrGLQDOtqkwtpbvlsN33CSD375r3KPst13zNrHi433KNIlX9a7TFohCotyXtFTK779AITuj9phSCXyQM8DTFymK28YCPXTSveSYUzGprldz9hPeh7t/5blD3B5wxMfxxp9yn7c866akc+0RH6VORu7IcpTvP+3a6gaztxxBMnGQJU5XLsyv5KmMT5nP2MYPNErcVGvtcZQ2bXLNUSYvS0s+Q6KOlB+8N1QaumUlzLDn9iiRSNWEuCkJFuTbUhiXMxb9UWiAhsglTs/eYWpaQc1lR7hUN4XDrJtcRylgt5IIlIc5iE+Yz1yxheMXLioDDEKBMFUU/DsUq7ngbrnakw2XcjzafT3goZfyZaNzS1UY55bMw9TGsOrl2yLjWvGGblZuYK44evF/XZnWLJppvYckViO6FB2MJExbL/i47Tk2rT5d0ioo4cSmsT13rjoWXn7wnratyJT9rYchJb5H5R0rJz97ceP3InlGwgVn0BoddOj0Bl5od3aUxEd5xyxf9Pb1zc2PP011lll4lwOSqLjLK9SPXI1ft+PyyFpUKeZHWrlrXvuZrnLWktpyNVwm7upuZK18R8zUc+KrAuYW6qlBDqrRE/aCfark3zB0dH68S1tzNXvM/yd4TOrzl3dz97IpfXWHwz6D14dNVwvK7af22Lc/9icQeP151tm7Dlr+bqax5F9+t1V2A0agQnEGZvZInOkPdE8RMqQK57O9Pvgg945LKfyenr2+H9kH6hhxdGDkEmwsTLBMsRVGAxwknp6+pOivmwfMYwVvXbuBgNKZI5V6+BgLkCcCl4ODMS9K9Zo2PE1Fa1C4gFov10vYo1EWHcJOgTJitFCVdhqjthLiBGDKhMbVF41oaVG2BZ5nwdhiMxcqMWCvIU1XfIffPkSSHRe0SxJaUNJZqXdaqq64K6VssnG+e1ToWlAnU1cC1on6LTk5RKgTUw58ASuOXc5hzY1En1HxBktc1+d4tSryqUAuUKY7YHUrqtbjzNIP6UeFfSePt7NHhIf3bMHFrvSG0eds3UjRfsOTj3dzbjbwfJsf6pqHvbPTz/OhbU8kyzenMSzRm3U5vWXIHA325CVkIie+iUN4dHR6+e0SSWyXseJtw3qgSbU5HsSRNXWolFwlUBXLqadAN8AUXEmh7/TvKCrVW+nauP42y24RwfHj4btwK4dFNIbySLmno2oVO1QXKP5bT/vbWb0+kXpXOO/beLhMeyM2zNWb7455Jg2mthW3Y5OyaXQ15JYZ+fnJ2vjonrbO5ogCwUsZRzG3OJuzgRjzo+rUo2Di7ZrUu2IRFg2a4zCixd8Oo8UocXI7ZKtlcsdUE7oQ2li+EXAxvXXXesfqGjsNLfI3hzmOvxHdILnuQZx8qYYLUIEdORo8kSKf8UxcMfx3PKoapWyPP7lA2Y8kYSq5Fh5tP+JZ4rxfuncVYy4VPbfTEOo5YG+HQzzZmOetUrw0PYnQwdm710fGx8z+fjJ2j9vCp84GOH6/OvYR7/oDLP/RNfjBGfdvlhlYk07lyBxCEclKhfEO2kfT8cnzTAcQiVSW69HKOEMH/869/uxXRmrpr+AWc1BoqtURN7X/UMjUv8EqQNep1J1J863LfvCzQGAp6pcWF7+wTC1e+iaYo5RWfiULQxSUw5cucvbtvRvBzjpQNo6kvta9kXWJB9x0KpS6cxVTAa6vKfvcgLJW+mBNJCXCYUa8WGgMGMS5BmXOZUhLL63MCSgOX3l2ptDAIXJQETMYb53ORCkJMr5TmqYWSS75A2ixxjihJoYqdVlrNyPcxqqi9dad+L0TrWXRJtBG8JG/KMU6DGVouCsy8YTeJd6zCo0VsyAxmaCxUtL1I0XQ16wIvUbv7606S7BRUil5TwQvymvtnS4is5tKQq+sJikfTii94Hm6PjDcjoHwdGQjyukgBCiEvqPFwCGetmv2MMyMsdk74crm88ZY8WF/zjbB5PQONlerWLdyge3n6y9uPB3TzUZfmZP4G9aVIMTxkO/Y8cMAHwcbw1NmYeJ95Jf6+uYDe+0KkKA32LMKzb15/D5fwcHTIkt7r+REEH3z/6sXXP775mvDS++7v33h0ODp0mQNlbMllb6sXvrn3tHvPNvJarbHcdwzvO4b3HcP7juF9x/C+Y3jfMXyfeNp3DO87hvcdw79nx8y+Y3jfMTzddwzDvmN43zG87xjedwzvO4b3HcP7juF9x/C+Y/j/qGM41A7JYzqoCi5c8dlVG65D3fhss4/4PGE5FZYnZ+z6mrLHb3WxWtHwhxo1VaXPE3bJtaAsoKtJJ7H2StXKC2yo5OArCsNT2j/xWufKIxuleCod+xXP3DHdCtuvfb8+eXPKEjYLvc6lymiN5kvqg+ZLNiHvlLmeaSdh1+3KXSNbweWidgVU5vFSyZjXNl+vN1+4enP40avDctn0qFwvRHtW6C8xtnXBX6lG8R02f2vB/czOBUG2EZqO8Hy1Wv0XugLodA==",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:"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,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.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,a.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of 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"]}),"\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 }\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 }\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 }\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 }\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 }\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 "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\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"]}),"\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 "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 "values": ["male", "female", "other"],\n "default": "male"\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 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"]}),"\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 "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\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 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"]}),"\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'})}),"\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 file"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(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:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(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)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(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:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(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:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,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."}})]})]})})}),"\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:"Template 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",example:"Bh2Hspnmch"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\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 y(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.d7434884.js b/assets/js/runtime~main.6595be5b.js similarity index 97% rename from assets/js/runtime~main.d7434884.js rename to assets/js/runtime~main.6595be5b.js index 7acf6db14..104ef2841 100644 --- a/assets/js/runtime~main.d7434884.js +++ b/assets/js/runtime~main.6595be5b.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",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",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",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",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",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"16772eb0",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",533:"2d5f5b1d",762:"74ae2291",792:"01714e3e",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"a84b1389",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"941ae0bf",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f3cca27d",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"5bd0eb92",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"fcf78bcd",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"910d4a50",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"bc4974db",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6238:"a5a4e5f7",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"cdd769c8",8140:"901b2f91",8141:"60a9b3b8",8163:"34493030",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"c9a9ba10",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"84ff4b21",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",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",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","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",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","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",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",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",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",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",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"16772eb0",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"b8b3b66b",339:"d942a670",420:"3b683e17",453:"61f3e45f",533:"2d5f5b1d",762:"74ae2291",792:"01714e3e",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"6147969f",1477:"b31b2642",1512:"9637e502",1520:"ceac1441",1531:"20e3554c",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"941ae0bf",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f3cca27d",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"5bd0eb92",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"fcf78bcd",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"910d4a50",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"1d02367e",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6238:"a5a4e5f7",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"b9e4a7cc",8106:"cdd769c8",8140:"901b2f91",8141:"60a9b3b8",8163:"34493030",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"c9a9ba10",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"d5781f47",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",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",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","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",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","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 6d57101ee..5e3c61a54 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 74a46fc15..f4318214d 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 65fe709a0..8287d4995 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 2a6db1c60..1390f30fc 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 ca5e1886f..8317fb7c6 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 31198d653..edc9d97ab 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 b26a3b0ad..9d1a22726 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 be2780b20..d38aa8990 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 ebc1a2af2..ddd40c0d8 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 b51962617..e4ba21513 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 5bf8e9c62..c91e620ef 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 372714d6f..caac16d0e 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 c37830d13..b5b06deda 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -116,7 +116,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
    description string
    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
    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.

+

Body

required

    file base64required
    title stringrequired
    description string
    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.

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 15e15a081..c33f64566 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
    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.

+

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.

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 3363d48a7..4a84255c1 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 195d3201e..b3052b3e2 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + @@ -113,7 +113,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
    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.

+

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.

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 95b2f4132..97928c428 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 77da6b1b8..788bc16da 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 c93da6717..d8b58f62f 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 09d8283a6..bcbd868b2 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 628b0669f..33a0d5d1e 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/folderlist/index.html b/docs/API-docs/folderlist/index.html index 4cf9a4f07..6b1cf4789 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 4f0a32b45..e3eb618d2 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 1d12b487d..49225a17c 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 44e75049e..40cac5943 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 e3bdfdc34..d249270eb 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 88c120441..ba998e4c7 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index cfd5c7705..d135fe580 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 65706758a..9d296136e 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 85d4dd3e4..4926a9320 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 4e8521af9..1baa937f8 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 20c2a3a06..ae5126261 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 a6e604d0d..18ec3f7a3 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 a6133d139..85451231f 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/update-document/index.html b/docs/API-docs/update-document/index.html index e52b65ecc..eca3c5b30 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 0390adb53..5f0b234dc 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 cb01a4b92..4313b971d 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 21200838d..0f04366cd 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 55b640ef5..06d71b030 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 9f6da8118..c2bc1f7b0 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 7f3b95685..4a6fc7e5c 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 ec4ae6a59..883131f2c 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 69b11ee4b..27d93b292 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 c86b2ff73..77c9db878 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 577c8f5ab..82d5f293a 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 5d4646ce2..9cb12cc86 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 cc571c96a..f82099536 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 ea0037def..0056f1c98 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 6985fdc88..c6a440e1c 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 1b20008bf..9f25986b0 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 eadf8cb83..bbca7b26c 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 a48b2364b..7c214ea88 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 ac2816fce..c585f763d 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/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index 1f3d5f3b8..81afd77e4 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 debd1049e..18c0ea1b8 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 93ff70625..3848f9aca 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 a31c3d7df..38f6cd183 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 bd6f4df1e..52ba41931 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 558852bcf..3f8663cd4 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 13cb23299..e0022ad93 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 245dc73e0..b879413a5 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 d9553fabc..71616c0de 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 a30d1a92c..c52a93cb0 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 13fb5bb19..20b95a6ff 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 c3754d27d..111d778ac 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 655be32be..fc97993ae 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 a3f06e0f8..70fa94829 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 ebf845653..dbd5907d6 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 435ef413a..1e4050e36 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 a37526b25..e71320348 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 5fb1f412e..96326c7cd 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/quick-send/index.html b/docs/help/Templates/quick-send/index.html index 15d292b19..67b7fdab4 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 532780f2b..f835f3b13 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 801f69591..85f895c75 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 118d077c9..009e3bd52 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 5dfad3f1a..1beb54ce6 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 04986abe8..59377a983 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 81e9c0878..6b3eeda6c 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 756432d1a..4ac7e1719 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 f9d57b52d..b065011b5 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 e8c680675..0534c5634 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 41ef5793b..05691d9a3 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 fb9421512..b70c6da04 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 19bb3e02f..bc46efeaa 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 f578e11c8..7a7e65c0b 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +