diff --git a/404.html b/404.html index fe0542706..c976942d7 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/28b19cd2.7cf37f7d.js b/assets/js/28b19cd2.7cf37f7d.js deleted file mode 100644 index 28ec13a90..000000000 --- a/assets/js/28b19cd2.7cf37f7d.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:()=>x,contentTitle:()=>f,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=s(85893),l=s(11151),t=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),h=s(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWM1uG8kRfpVyX2QZI1KS7RyIIFhHNjbCLiJhpYUPEkHUzBSHLfV0z3b3kJwQc8uT5NHyJEH1/HD4I60NBHtJgIVX7Kn/qq76qjfCY+bE5EF8NkmZk/ZOTCORkkusLLw0WkzE/YLgyhJ6go4KPt1eAyplVg4qU4I3kJEmyzSaVpB20iCu4Kl0HgprljKVOgNPeaHQ00ymILXzhCmYOZSFMhgIMIiYS0VvpQa/IJgbmzNNjI7+9AGMhVhqtNUp0JJsBV7mFOzQRCkbkzTmYm/ICO5btY6lgaWCKVJVQekoDdocJKghppY7hbk1OX+2ILUnO8eEAD08vHv3meIyg1+v372bvl14X7jJeIxFMTIFaSczrTB2o8Tk45QJi3R+ykaXLvi/DWdnE4dz9KhFJEzBQZRGX6diIlpDWh9W0i+64MlURKJAizl5spzBjdCYk5iIQXxFJCRnsEC/EPtpNfETJf46BL8zRETC0m+ltJSKibclRcL5SrFYJ/NCMQGtC2VSEpM5KscEyYJyFJON8FURKL2VOhOR4LShH57QGoOUiSj+dhEvkstFEYu6njZqyfm/mrRiUYnRnrTnP7EolExCUMZPjk3fDHRuzX0QHHkOxjTqTGl85FBZjqyX5AJ7S7i1Ga3FisPlKR+evyDAGnbi0OOtf5+SxJReo/aijgTlKNWrIQoEQwFPhn5of3ElsZQmwa9pfTIEMRETFwujf4f64vI9//f+QtR1JLz04XS36AbVNLtrw8bUc6NSslylr2lgQxzpdLYfgNgYRagPivJ+IR30db3XYlxBiZxXsFqQX5ANxyvUHoJ0xyQxgeP+xNSNtSPg/pXSHEvlYYmqJJAOHgWX96MYwfU8XMnmi+EfOyYMaAF1CtrASdA3c2UojpNx+zs2aXWy5XSAllqbJaW9CYG474IOVlIptpv7UNME+vix2q56OnXHAr4bw6vSeZNDUNMyhZ7HAUFfWoL2so3gCjVInagypbbRcsC5S8Fm05XALFRGXcNmw7kkO+NCrOtoe8C6dg5C9TUnlhKSyx2u/oi2jP3ZgJXWhbTVLEXfHiQmL1BXQwNkpqXOZqVVdT06KL5tZr45bgdhajPGQv4HIsbmXOsbm5I9el976tD+Q9/I6d5cGT719BmrYf/UZR6TPQh1GNg8p1suSLFyfNXCMOYPqJIyjMbGI2CP+HZWprT9VB820F5Tb+DFx5fb2mzY10J51Ey8O/zCgSuMdk3Xvzw/5//tunKtwZVJQs5BR9w0Jr7WGXkorQKptx9lcCI0B1Su61NM0hkHhtvbSjoCo1UVpHTTOoKcnHOY8Sj+5in5+jTrZH/vDF88yct/rJPl5S0XTmlfn3DHBLTQaW/OsYfs4HdK68FpmABtUualUtWbnQEntZKaZl1CZpfn57NLzn8diQ9HU9xkbIFL0iceME1hJdOMvAsToR00nMGuqhjtadOhXupJUBmdAQM5bh7SAgOJwBlq8L+WUbLW2O+N360idDw/fVlsPWkE/14MP5yfz5KkD+LHY/dkiUqmYXO4N8+k3/wB7m6dG6r3jXo2dZ2Hom2hs2yIwnex4+3wvHHSUVJa6asAvddnWMiz5vvkYcqANie/MAziC+OCxYzBJ2K824fGm0EjqgWLtcsO0Icb1V8ShzqNzfpwx8BCjpcXoo72OY5uJC9SO4+Z1NnZq1zTreN3nJwm/jvubzF1IX8iLuo2ukOqdjFZEPKc4Xhyzn/ZLgFfuswN0PpDB7yH6LoH1weIuVfcoeIeFA+R73SIZYXYxavNCrSHv4TYxRUdUz8128Xo2GC8+Fiz63MT4tSW101BmrF1KM7lxcG0/EoqMc3AZMjRkf/7n/8KHF0thbvzBm5KC4VZkZ2XKvSnuaK1jBUdWdodYa7IOVWFFTcLC3wqM+lRQQsUIMECY6kk3zYmM80QHlxYN4KvW0x+YsPmTUtSfElBGfMcFl8DWHqTBx1dr14Z+zxnkyJAiHlD5knqiDoW0gvUCbelpuwi7q2ogXglLywPSZQ5EzPGpflcJpIFc2uxmHjIUWNGrCwCtpuj0PZlB9bE/DrhjCqDI6wxJ/KNi/yc4EbwWS6pcTyAD/IoFaWQlSwigsSkDFNC4bEbOoWYwpMHJl4mFIQ6j9aD4veKcM0a8FgqBYXhFihRMbwZ5pYFeYvaheePBvi0qenDV1jDUy7oSLEawaN+1HdcLKUjLgAl9bObPOozeOjL7CvFTnraPl2sVquDK3+6y/Oj9Isy5ncTs+XLwmFoEEP2/sepiIQnm7ub+R3ZpUy6of+CznEgHreDAZtlp7veWMgf9hm4SSuZkHY0aOOffrz9GZbwfnQuokGT+waDxz9fX335+90XlsttuLl/F6Pz0XnYqY3zOeqBqv13sfBkNHhN2bnIg2eN/z+q/YGPau088rT240Kh1AO42ozlh731QERiMnxHm0ZiwWN88iA2Gw7Yr7w88fFvJVnGANNILNFKjLmjP2xEKh3/nfbT4MVKePtLu3ScwgtPckft74as5gkbHi+aSfRM1d4jYD2to27SsmkNxVVjwNk9y9lKOIBhDBQajk9JQoV/lXaIe25v7u5FJLrdOw9vhsLiih8ZcSUm4lE8ivDmGVpveFfj841QqLMybACikcsAAUvO1BBdPAd00f7Bnh2NyS7saFzhf9mxowx/5nv4E1V/6cmbLy8ytLHtqDk/07qu/wP6UESh",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,j={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:"eJztWM1uG8kRfpVyX2QZI1KS7RyIIFhHNjbCLiJhpYUPEkHUzBSHLfV0z3b3kJwQc8uT5NHyJEH1/HD4I60NBHtJgIVX7Kn/qq76qjfCY+bE5EF8NkmZk/ZOTCORkkusLLw0WkzE/YLgyhJ6go4KPt1eAyplVg4qU4I3kJEmyzSaVpB20iCu4Kl0HgprljKVOgNPeaHQ00ymILXzhCmYOZSFMhgIMIiYS0VvpQa/IJgbmzNNjI7+9AGMhVhqtNUp0JJsBV7mFOzQRCkbkzTmYm/ICO5btY6lgaWCKVJVQekoDdocJKghppY7hbk1OX+2ILUnO8eEAD08vHv3meIyg1+v372bvl14X7jJeIxFMTIFaSczrTB2o8Tk45QJi3R+ykaXLvi/DWdnE4dz9KhFJEzBQZRGX6diIlpDWh9W0i+64MlURKJAizl5spzBjdCYk5iIQXxFJCRnsEC/EPtpNfETJf46BL8zRETC0m+ltJSKibclRcL5SrFYJ/NCMQGtC2VSEpM5KscEyYJyFJON8FURKL2VOhOR4LShH57QGoOUiSj+dhEvkstFEYu6njZqyfm/mrRiUYnRnrTnP7EolExCUMZPjk3fDHRuzX0QHHkOxjTqTGl85FBZjqyX5AJ7S7i1Ga3FisPlKR+evyDAGnbi0OOtf5+SxJReo/aijgTlKNWrIQoEQwFPhn5of3ElsZQmwa9pfTIEMRETFwujf4f64vI9//f+QtR1JLz04XS36AbVNLtrw8bUc6NSslylr2lgQxzpdLYfgNgYRagPivJ+IR30db3XYlxBiZxXsFqQX5ANxyvUHoJ0xyQxgeP+xNSNtSPg/pXSHEvlYYmqJJAOHgWX96MYwfU8XMnmi+EfOyYMaAF1CtrASdA3c2UojpNx+zs2aXWy5XSAllqbJaW9CYG474IOVlIptpv7UNME+vix2q56OnXHAr4bw6vSeZNDUNMyhZ7HAUFfWoL2so3gCjVInagypbbRcsC5S8Fm05XALFRGXcNmw7kkO+NCrOtoe8C6dg5C9TUnlhKSyx2u/oi2jP3ZgJXWhbTVLEXfHiQmL1BXQwNkpqXOZqVVdT06KL5tZr45bgdhajPGQv4HIsbmXOsbm5I9el976tD+Q9/I6d5cGT719BmrYf/UZR6TPQh1GNg8p1suSLFyfNXCMOYPqJIyjMbGI2CP+HZWprT9VB820F5Tb+DFx5fb2mzY10J51Ey8O/zCgSuMdk3Xvzw/5//tunKtwZVJQs5BR9w0Jr7WGXkorQKptx9lcCI0B1Su61NM0hkHhtvbSjoCo1UVpHTTOoKcnHOY8Sj+5in5+jTrZH/vDF88yct/rJPl5S0XTmlfn3DHBLTQaW/OsYfs4HdK68FpmABtUualUtWbnQEntZKaZl1CZpfn57NLzn8diQ9HU9xkbIFL0iceME1hJdOMvAsToR00nMGuqhjtadOhXupJUBmdAQM5bh7SAgOJwBlq8L+WUbLW2O+N360idDw/fVlsPWkE/14MP5yfz5KkD+LHY/dkiUqmYXO4N8+k3/wB7m6dG6r3jXo2dZ2Hom2hs2yIwnex4+3wvHHSUVJa6asAvddnWMiz5vvkYcqANie/MAziC+OCxYzBJ2K824fGm0EjqgWLtcsO0Icb1V8ShzqNzfpwx8BCjpcXoo72OY5uJC9SO4+Z1NnZq1zTreN3nJwm/jvubzF1IX8iLuo2ukOqdjFZEPKc4Xhyzn/ZLgFfuswN0PpDB7yH6LoH1weIuVfcoeIeFA+R73SIZYXYxavNCrSHv4TYxRUdUz8128Xo2GC8+Fiz63MT4tSW101BmrF1KM7lxcG0/EoqMc3AZMjRkf/7n/8KHF0thbvzBm5KC4VZkZ2XKvSnuaK1jBUdWdodYa7IOVWFFTcLC3wqM+lRQQsUIMECY6kk3zYmM80QHlxYN4KvW0x+YsPmTUtSfElBGfMcFl8DWHqTBx1dr14Z+zxnkyJAiHlD5knqiDoW0gvUCbelpuwi7q2ogXglLywPSZQ5EzPGpflcJpIFc2uxmHjIUWNGrCwCtpuj0PZlB9bE/DrhjCqDI6wxJ/KNi/yc4EbwWS6pcTyAD/IoFaWQlSwigsSkDFNC4bEbOoWYwpMHJl4mFIQ6j9aD4veKcM0a8FgqBYXhFihRMbwZ5pYFeYvaheePBvi0qenDV1jDUy7oSLEawaN+1HdcLKUjLgAl9bObPOozeOjL7CvFTnraPl2sVquDK3+6y/Oj9Isy5ncTs+XLwmFoEEP2/sepiIQnm7ub+R3ZpUy6of+CznEgHreDAZtlp7veWMgf9hm4SSuZkHY0aOOffrz9GZbwfnQuokGT+waDxz9fX335+90XlsttuLl/F6Pz0XnYqY3zOeqBqv13sfBkNHhN2bnIg2eN/z+q/YGPau088rT240Kh1AO42ozlh731QERiMnxHm0ZiwWN88iA2Gw7Yr7w88fFvJVnGANNILNFKjLmjP2xEKh3/nfbT4MVKePtLu3ScwgtPckft74as5gkbHi+aSfRM1d4jYD2to27SsmkNxVVjwNk9y9lKOIBhDBQajk9JQoV/lXaIe25v7u5FJLrdOw9vhsLiih8ZcSUm4lE8ivDmGVpveFfj841QqLMybACikcsAAUvO1BBdPAd00f7Bnh2NyS7saFzhf9mxowx/5nv4E1V/6cmbLy8ytLHtqDk/07qu/wP6UESh",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"}},x={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"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)(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)(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:!1}}),(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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(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)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(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)(h.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)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(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)(h.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)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.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/28b19cd2.d03a17e0.js b/assets/js/28b19cd2.d03a17e0.js new file mode 100644 index 000000000..99dbc5e58 --- /dev/null +++ b/assets/js/28b19cd2.d03a17e0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>f,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=s(85893),l=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),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:"eJztWM1uG8kRfpVyX2QZI1KS7RyIIFhHNjbCLiJhpYUPEkHUzBSHLfV0z3b3kJwQc8uT5NHyJEH1/HD4I60NBHtJgIVX7Kn/qq76ujbCY+bE5EF8NkmZk/ZOTCORkkusLLw0WkzE/YLgyhJ6go4KPt1eAyplVg4qU4I3kJEmyzSaVpB20iCu4Kl0HgprljKVOgNPeaHQ00ymILXzhCmYOZSFMhgIMIiYS0VvpQa/IJgbmzNNjI7+9AGMhVhqtNUp0JJsBV7mFOzQRCkbkzTmYm/ICO5btY6lgaWCKVJVQekoDdocJKghppY7hbk1OX+2ILUnO8eEAD08vHv3meIyg1+v372bvl14X7jJeIxFMTIFaSczrTB2o8Tk45QJi3R+ykaXLvi/DWdnE4dz9KhFJEzBQZRGX6diIlpDWh9W0i+64MlURKJAizl5spzBjdCYk5iIQXxFJCRnsEC/EPtpNfETJf46BL8zRETC0m+ltJSKibclRcL5SrFYJ/NCMQGtC2VSEpM5KscEyYJyFJON8FURKL2VOhOR4LShH57QGoOUiSj+dhEvkstFEYu6njZqyfm/mrRiUYnRnrTnP7EolExCUMZPjk3fDHRuzX0QHHkOxjTqTGl85FBZjqyX5AJ7S7i1Ga3FisPlKR+evyDAGnbi0OOtf5+SxJReo/aijgTlKNWrIQoEQwFPhn5of3ElsZQmwa9pfTIEMRETFwujf4f64vI9//f+QtR1JLz04XS36AbVNLtrw8bUc6NSslylr2lgQxzpdLYfgNgYRagPivJ+IR30db3XYlxBiZxXsFqQX5ANxyvUHoJ0xyQxgeP+xNSNtSPg/pXSHEvlYYmqJJAOHgWX96MYwfU8XMnmi+EfOyYMaAF1CtrASdA3c2UojpNx+zs2aXWy5XSAllqbJaW9CYG474IOVlIptpv7UNME+vix2q56OnXHAr4bw6vSeZNDUNMyhZ7HAUFfWoL2so3gCjVInagypbbRcsC5S8Fm05XALFRGXcNmw7kkO+NCrOtoe8C6dg5C9TUnlhKSyx2u/oi2jP3ZgJXWhbTVLEXfHiQmL1BXQwNkpqXOZqVVdT06KL5tZr45bgdhajPGQv4HIsbmXOsbm5I9el976tD+Q9/I6d5cGT719BmrYf/UZR6TPQh1GNg8p1suSLFyfNXCMOYPqJIyjMbGI2CP+HZWprT9VB820F5Tb+DFRy4AjbGim/vbb3HmxS44G7bBUE01E+/OynDgCqNdMyQuz8/5f7ueX2twZZKQc9ARN32Mu0BGHkqrQOrtRxl8Dr0ElevaGpN0xoHhbriSjsBoVQUp3XCPICfnHGY8ub95qL4+/DrZ3zvyF0/y8h/rZHl5y3VW2tcH4jEBLdLaG4vsITv4ndJ6LBsGRpuUealU9WZnHkqtpKZZl5DZ5fn57JLzX0fiw9EUNxlb4JL0iQdMU1jJNCPvwgBp5xJnsKsqBofadCCZehJURmfAuI97jbTAuCNwhhr8r2WUrDX2e+N3qwgdj1tfFltPGsG/F8MP5+ezJOmD+PHYPVmikml4aNybZ9Jv/gB3t84N1ftGPZu6zkPRtkhbNkThu9jxdnjeOOkoKa30VUDq6zMs5FnzffIwZfybk18YxvyFccFihuwTMd7tQ+PNoBHVgsXaZYf/w43qL4lDncZmffgkwUKOlxeijvY5jj5gXqR2HjOps7NXuaZbx+84OU38d9zfQvBC/kRc1G10h1TtO2ZByGOJ48k5/2X7ZvjSZW4A7h86nD4E4z0WPwDYveIORPcYegiUp0PoK8QuvG1eTHtwTYhdGNIx9UO2fUcdm6MXH3cmWDdypZ6bELm24G4K0gzOQ7kuLw7G7VdSiWkmLmOWjvzf//xX4OiqK9ymN3BTWijMiuy8VKFjzRWtZazoyKvfEeaKnFNVeCNnYQOQykx6VNAiDUiwwFgqyfePyUwzxQdX2I3g6xbUn9jwdKclKb62oIx5Di9nA1h6kwcdXfdeGfs8Z5MiQIj5ic2z1RF1LKQXqBNuVE0hRtxtUQPxm76wPDZR5kzMIJnmc5lIFszNxmLiIUeNGbGyCNhujkLbqR1YE/N6wxlVBkdYY07kGxd5H+FG8FkuqXE8oBfyKBWlkJUsIoLEpIxzQimyGzqFmMLOBBMvEwpCnUfrQfHCI1y8Bn2WSkFhuClKVIyPhrllQd6idmF/0iCnNjV9+ApreO4FHSlWI3jUj/qOi6V0xAWgpH52k0d9Bg99mX2l2ElP293HarU6aAKnuzw/Sr8oY168mC1fFg5Dyxiy9z9ORSQ82dzdzO/ILmXSwYAXdI4D8bgdFdi8lroLj4X8YZ+B27aSCWlHg8b+6cfbn2EJ70fnIhq0vW8wePzz9dWXv999YbncmJv7dzE6H52HR7lxPkc9ULW/WAs7p8E6ZuciD/Yi/9/K/YFbuXZCeVr7caFQ6gGAbQb1w96DQURiMlzETSOx4ME+eRCbDQfsV3598fFvJVlGBdNILNFK7vVhdKXS8d9pPx9erIS3v7TPkFN4Yad31P5u7GqeuWH70cymZ6r2toj1tI662cumNRRXjQFn9yxnK+EAmDF0aDg+JQkV/lXaIRK6vbm7F5HoHu95WDoKiyveUuJKTMSjeBRhaRpab1jM8flGKNRZGd4EopHLkAFLztQQbzwHvNH+wZ4djckuEGlc4X/ZsaMMf+Z7+BNVf+nJmy8vMrSx7ag5P9O6rv8DOTlasQ==",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:"eJztWM1uG8kRfpVyX2QZI1KS7RyIIFhHNjbCLiJhpYUPEkHUzBSHLfV0z3b3kJwQc8uT5NHyJEH1/HD4I60NBHtJgIVX7Kn/qq76ujbCY+bE5EF8NkmZk/ZOTCORkkusLLw0WkzE/YLgyhJ6go4KPt1eAyplVg4qU4I3kJEmyzSaVpB20iCu4Kl0HgprljKVOgNPeaHQ00ymILXzhCmYOZSFMhgIMIiYS0VvpQa/IJgbmzNNjI7+9AGMhVhqtNUp0JJsBV7mFOzQRCkbkzTmYm/ICO5btY6lgaWCKVJVQekoDdocJKghppY7hbk1OX+2ILUnO8eEAD08vHv3meIyg1+v372bvl14X7jJeIxFMTIFaSczrTB2o8Tk45QJi3R+ykaXLvi/DWdnE4dz9KhFJEzBQZRGX6diIlpDWh9W0i+64MlURKJAizl5spzBjdCYk5iIQXxFJCRnsEC/EPtpNfETJf46BL8zRETC0m+ltJSKibclRcL5SrFYJ/NCMQGtC2VSEpM5KscEyYJyFJON8FURKL2VOhOR4LShH57QGoOUiSj+dhEvkstFEYu6njZqyfm/mrRiUYnRnrTnP7EolExCUMZPjk3fDHRuzX0QHHkOxjTqTGl85FBZjqyX5AJ7S7i1Ga3FisPlKR+evyDAGnbi0OOtf5+SxJReo/aijgTlKNWrIQoEQwFPhn5of3ElsZQmwa9pfTIEMRETFwujf4f64vI9//f+QtR1JLz04XS36AbVNLtrw8bUc6NSslylr2lgQxzpdLYfgNgYRagPivJ+IR30db3XYlxBiZxXsFqQX5ANxyvUHoJ0xyQxgeP+xNSNtSPg/pXSHEvlYYmqJJAOHgWX96MYwfU8XMnmi+EfOyYMaAF1CtrASdA3c2UojpNx+zs2aXWy5XSAllqbJaW9CYG474IOVlIptpv7UNME+vix2q56OnXHAr4bw6vSeZNDUNMyhZ7HAUFfWoL2so3gCjVInagypbbRcsC5S8Fm05XALFRGXcNmw7kkO+NCrOtoe8C6dg5C9TUnlhKSyx2u/oi2jP3ZgJXWhbTVLEXfHiQmL1BXQwNkpqXOZqVVdT06KL5tZr45bgdhajPGQv4HIsbmXOsbm5I9el976tD+Q9/I6d5cGT719BmrYf/UZR6TPQh1GNg8p1suSLFyfNXCMOYPqJIyjMbGI2CP+HZWprT9VB820F5Tb+DFRy4AjbGim/vbb3HmxS44G7bBUE01E+/OynDgCqNdMyQuz8/5f7ueX2twZZKQc9ARN32Mu0BGHkqrQOrtRxl8Dr0ElevaGpN0xoHhbriSjsBoVQUp3XCPICfnHGY8ub95qL4+/DrZ3zvyF0/y8h/rZHl5y3VW2tcH4jEBLdLaG4vsITv4ndJ6LBsGRpuUealU9WZnHkqtpKZZl5DZ5fn57JLzX0fiw9EUNxlb4JL0iQdMU1jJNCPvwgBp5xJnsKsqBofadCCZehJURmfAuI97jbTAuCNwhhr8r2WUrDX2e+N3qwgdj1tfFltPGsG/F8MP5+ezJOmD+PHYPVmikml4aNybZ9Jv/gB3t84N1ftGPZu6zkPRtkhbNkThu9jxdnjeOOkoKa30VUDq6zMs5FnzffIwZfybk18YxvyFccFihuwTMd7tQ+PNoBHVgsXaZYf/w43qL4lDncZmffgkwUKOlxeijvY5jj5gXqR2HjOps7NXuaZbx+84OU38d9zfQvBC/kRc1G10h1TtO2ZByGOJ48k5/2X7ZvjSZW4A7h86nD4E4z0WPwDYveIORPcYegiUp0PoK8QuvG1eTHtwTYhdGNIx9UO2fUcdm6MXH3cmWDdypZ6bELm24G4K0gzOQ7kuLw7G7VdSiWkmLmOWjvzf//xX4OiqK9ymN3BTWijMiuy8VKFjzRWtZazoyKvfEeaKnFNVeCNnYQOQykx6VNAiDUiwwFgqyfePyUwzxQdX2I3g6xbUn9jwdKclKb62oIx5Di9nA1h6kwcdXfdeGfs8Z5MiQIj5ic2z1RF1LKQXqBNuVE0hRtxtUQPxm76wPDZR5kzMIJnmc5lIFszNxmLiIUeNGbGyCNhujkLbqR1YE/N6wxlVBkdYY07kGxd5H+FG8FkuqXE8oBfyKBWlkJUsIoLEpIxzQimyGzqFmMLOBBMvEwpCnUfrQfHCI1y8Bn2WSkFhuClKVIyPhrllQd6idmF/0iCnNjV9+ApreO4FHSlWI3jUj/qOi6V0xAWgpH52k0d9Bg99mX2l2ElP293HarU6aAKnuzw/Sr8oY168mC1fFg5Dyxiy9z9ORSQ82dzdzO/ILmXSwYAXdI4D8bgdFdi8lroLj4X8YZ+B27aSCWlHg8b+6cfbn2EJ70fnIhq0vW8wePzz9dWXv999YbncmJv7dzE6H52HR7lxPkc9ULW/WAs7p8E6ZuciD/Yi/9/K/YFbuXZCeVr7caFQ6gGAbQb1w96DQURiMlzETSOx4ME+eRCbDQfsV3598fFvJVlGBdNILNFK7vVhdKXS8d9pPx9erIS3v7TPkFN4Yad31P5u7GqeuWH70cymZ6r2toj1tI662cumNRRXjQFn9yxnK+EAmDF0aDg+JQkV/lXaIRK6vbm7F5HoHu95WDoKiyveUuJKTMSjeBRhaRpab1jM8flGKNRZGd4EopHLkAFLztQQbzwHvNH+wZ4djckuEGlc4X/ZsaMMf+Z7+BNVf+nJmy8vMrSx7ag5P9O6rv8DOTlasQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"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:!1}}),(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}})]})]})})}),"\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 b(e={}){const{wrapper:a}={...(0,l.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/2c586be5.3740a736.js b/assets/js/2c586be5.3740a736.js new file mode 100644 index 000000000..203d482d2 --- /dev/null +++ b/assets/js/2c586be5.3740a736.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:()=>b,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),d=(s(82723),s(9487)),o=(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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7Ri4PGRbGwDJeaOdIwmSGnJMfS1NDbfsl+2n7J4vAyM5IlO0mL1otVHhwNeXh4biTP7YZZPjdsfMFeq7QuUVrDLhOWoUm1qKxQko3ZeY7wSiO3CBEKXr45BV4UamGgNqgNWAVzlKgJSuICsogPpg1UWl2LTMg5ZNxyWAibw5QbfHYCKFOVYQYzUeBwIifyx6pQPING1VBlMxASVK3h4uDgNU7rOfx4enBw+XlubWXGh4e8qoaqQmnEXBZ8aoapKg8zAqyy2WPIUaPDlHIJmeYLWIhsjtYAlxmkqmogVQOlRSa5xQQqPkeQdTlFDWoGNsdyCLwwqkXi1gTS1QzevP470Xxw8CUWqoddI5i6qpS2mBELNsdWIuODA1rzSpWlklBxzUu0JEI1iwjGEzmAgwPbVDg+OIBTmYmUWzQOD412sEMPSpQT6NsKUzETAXSNHwmLXKS5Y2XBpSWVVQVP0YFqNBWmVlzjOuJlAg0hfo1SRQpypcWvSlpeODleo7Yi5QWkSulMSEepFx8Yy7UlxVdKSBtHww7wzyDV2ngisqBiIi0joZRCuhmDcM2LGk2gapFATlT9gJVG48ws4LW5oylHMc937sezd7Wxa4ihNkRmn4qwl8ZfaqExc+JFJ7YZLwyCmK3JsuTvsbcbKHd+eDGELxvIcMbrwiYg7CMDVtc4hO+VBV5VhUj5tECYKQ1kx9zWGgdOy8EcAiGSl07Hb9xpQgMcMjGboaYDSZMORbTBQB2ZYnf8SqWJRi5ByZ6iR0M4OGj3dgb6888/T+TNRAJMGNEyYeMJa0EmLAE/RyY2YeNRAmFgOWFjeHL8PAI09P3s+EX8XtD3aHQSv3P6Ph5N5CpsSqx+r6xj9aWFArmxjtx2dxAGolYcz8jT3E2jHsLLouiBzgQWmT+RqSqrujBKN3QnBY0MJ/LYcW95Wd3BOU3//lzHT28rhgbdzjQWOaRBMhgPSzOkaxptyaKJVSfBJ8SQkMIKXpjdPEWIh8dWR9kGZyfEGZZcFLvZctMPj6dA1gZDT4fdwd7Bj0fx0Njxvza4eUbcvFNTsMIWd7DUgjw8vnqkbTD3nJijO4TLZjdrAeDhMdYStsHWC2Ir4/YOddHsw2MoUBUnwn3u545OBqOng+Oj45MexEzpkgeAshxk2aBpmmbCoJMItC9QQEePUHxwvXNADu5Mq3KLN+WcnQ4qOB/ud/RAviO/Yxqf5M45NMFvc+9Zye2602BVxptHxqOKS4NX4OE736/pkemmiI6GfOg0VyINxBNMEDxMyXcdkhAGJMfs8LvvDr1kkm5wUJZBXF4XNErfAyfJ/mhZDrNsuAnbF3h/tIQsS2DL+PaJLIOyLHeN+wky8Yn8C9m1xaWdquVu0w4AD8+6O8K2Gnh4FOJcLmSYCNYBGwAa53XBNS7JXzZCScf9rctgw/Kj4fNoit5Zdj6XC0U8kfD5WfB1HwejJHrWEdDI/etukdlHonGOS4cjrY1VJREjMk4YEjB1mgM3PiglV1fJogmxj0n8V8orQUFLgda6UbTpcJ2IiRwduXs+x/T9nZYTIR6e6fQoi5M+xqHpiwkreXh42Qy738rmqCfssl1jsMDUYtZbC9sWw2XPynhGkiZgFyN15OUiw4JPsejmesQFNfZYpYlSSE9EFMNRxOdm+XJjNkyuthi1Z6JvTfH2izYZpQaFMDH4XRdBf3UIGm3OLUjEjK7/KUJc0Aswthm5l1IvoCRVbsaTBu06YZyiHr90S0zpZBpPX5D1PTsQHDjANl6Pm+3aILCwppm+XAhHKaQo67KXSIlYo8TK8Ar2xUUrKZUUd+hr99YOfHnPDhTl795gIkcu5M20qjK1kO6Uw3bfJ4A8vGPeo+y3HPO1Z8XD/ZZjFKnqH6MtLwqB+rekPUJm9xkawhnd35QE8IuEAZ6mWFnMNi7wkYvmNc+EgmltrZK7r/A+1MPT7wZ1f4COieEP03Kftj9N0z7NUfrM564cR+m0+dB0G8jaftBYwlRFmXSh5GnGxix1yfeYP2aJ2wKN/VJlDRvfsFRJSxPjGxbyibT08J2h9P0NM2mOJadfkTRK+FPCnSXMZ80MS5iLein7T8JjY6am7zCl3SpN5FiBhnC4deObCGWsFnLOkhBdsTHz2XGWMFzysiJgtpHrr7IZW8UN70LVjnSojPvRJtMJz1q14pOwve5hWCWMMt2fiIkSl563Es/VK0WDFl/zxvQQ+meLbdZZaA2djDSsgow3hg5AbbyDkfIirQuK7HBZCd20YaYL73r20RLa7tQSOnq66pTekcS15g1LmLBY9sd3GIFWH6+5FBVJxuXBPnbtO4VTxC/CAFV5nJ54+dFUvFMIU3Q6qnIlP3r96PjJ6Hj0ZHRMGEKu/dPl6GdvU7BuGC8ppsEsOp2DLr2dgMsAD+8zzgjv2OZzvN8Yz3eVj3oVDpOrusiohoFcD10V59NrdWv23T4aw3useZWw5f3MLH2Zz9em4PMCZxbqqkINqdIS9eN+RufBMHd8crJKWHM/e83/JHvPSXmL+7n7yRX1uoLnn0HrkxerhOX30/qPtuz4JxJ78mzVva4bzsPVVGXNVby3VvcBxoeC4GaqyFCTQ3L7vuquGrphDMrsavOenypVIJdbLhphuip4bCqgMJVi4JDSXORIPm0XvTrsnR8ZImZP7RDOXRW3n7EShrxCXeOEDeF01vNKXeC7RkIP1tWSpYJHbr8rU7tr/NFh+CYZPeqX8F3hv03lRhIcMFgsq8LVxheiKIhueteH0P5znl8rSSIgPpdx4/ufilc+M+Y2DIvWC8sQfMchvOIShEyLOjjpMxVTZ3Bz05qBs47VCm5uSKuor+jRXa2SboD2Whtw76of0ZiiuF5b1Q5ht7Ad6y31Ls4VuTh+IBQw+gSIuRRyflXrYrUa3jLDTkcfLLdbYgq6IyT/BxIjck7lmc5Qbz25LbTLBZGIJbUunJ2/+RDwu+8afxl1EUqwf+pLUdJ4d+n46Ij+W1dd25MUkFIqOEVjZnVRNJ+x5MPDo7t9NT+8/f67y/nK34njX5fp9fEbEnGtP9r5jW9FrYuBVQPS4SCKzrvCPckKWQiJV1FsV8dHR1cjku0qYSfbxPdWlWhzMuIFCXGhlZwnUFHbBYLVDfA5FxLo5tK/ozRRa6Xvfko+jrK7hHCyJoSnt4VwKl0S2rW1nav3KP9YTvvbW789kbosna34MIcJD+Tm2Rqz/XHPpMG01sI2bHxxw5YDXomBnx9fXK4uE0aCVZRaqJRxFHObszE7vJVpMKivXaR4ceNNt7VGw2VGieJb3guvxOH1iK2SzRVbfZ2d0MbyuZDzwZ2rLjtW35I6vMTXGO5Cs0p8gxSbBXn2oRImyAxy5HT1kQRJyz90aZavoq5iAmRbTqPTyWaWYvO52ZJ3iGmHtUzC9kTC6GkvhL+I0bgLsNv4elvI3LIeg+A2Bu6Ftb2o9qKz2TaAjPHjyAVexycnLkJ5PnKu/JMXzks+ebZyVtZ5jIyte4UuL7bp2zC2/mbHRe2L5MtG/UcnvkNCzpRTdZD/WYXyrZhLd6KuR7djCixS5bMt9JBH8P/8699uRdSbO/CfwVmtoVIL1LPadzzOClwK6tnrtcFGjxV5WaAxRQNCWpy7hthMzF3hMTy/VIjkU1EIuiIITPkMTu+WMUP4qfN5H2lfg73Ggm4WKJR677oVFfDaqtLtEZ/BhdLvZ0RSAhym1NaIxoBBjEtQ5lym5Db7k5OA0sAloLSoKy0MAhclAbveutlMpMK9r0pazVMLJZd8jrRZ4mIbkkIVmxK1mlJ1x6ii9jljao1EtJ5Fl/4dwmvqM3WMu8wVWi4KzGBeE4oE6EhBsFxiQ2YwJWesou1FiqbrtijwGrW7KbxLVhcFVIrubcELcu77uiVEVnNp6LkNWbOgmlZ8lVbkPbg9Mt4MgcpF9BSRu04GUAj53nfoXrRm9hNOjbDYxXWLxeLWrfV4fc3Xwub1FDRWqls3d4Pujusvbz8e05WAujRns7eor0UaHYQdex464MPwmnEfQsQrglfii80F9LIUIkVpsPf2vPz6zbdwDU+GRyzp3dMfQPDht6evvvr+7VeEl14Sf/5Gw6PhkUtGKWNLLntbbXSabx7dXrZ735i+b0zfN6bvG9P3jekPr8C5b0zfN6bvG9P3jen7xvR9Y/q+MX3fmL5vTN83pu8b07cY9b4xfd+Yvm9M3zemw74xfd+Y/ufr9r7G9FAPJD/psCq4kL2eBl9EvthsV79MWE5V5vEFu7mhDPWP1HxCw7/UqKlEfZmwa64FJRtdgTqJhViqQL5HKgW+8kn/wTntn3hbcxWMjbo81ZH9ipdOOXfC9gvhb87enrOExW6hUmW0RvMFtdvzBRuTT8pca76TrOuC5q59seByXruiKPN4qX7Ma5uvF5/fu+Jz+NGrrXLZ9Khcr0p7VugvMbZ1wV+p4vENNn9rwf3MzgVBthGaVHi5Wq3+CwtFoXM=",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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7Ri4PGRbGwDJeaOdIwmSGnJMfS1NDbfsl+2n7J4vAyM5IlO0mL1otVHhwNeXh4biTP7YZZPjdsfMFeq7QuUVrDLhOWoUm1qKxQko3ZeY7wSiO3CBEKXr45BV4UamGgNqgNWAVzlKgJSuICsogPpg1UWl2LTMg5ZNxyWAibw5QbfHYCKFOVYQYzUeBwIifyx6pQPING1VBlMxASVK3h4uDgNU7rOfx4enBw+XlubWXGh4e8qoaqQmnEXBZ8aoapKg8zAqyy2WPIUaPDlHIJmeYLWIhsjtYAlxmkqmogVQOlRSa5xQQqPkeQdTlFDWoGNsdyCLwwqkXi1gTS1QzevP470Xxw8CUWqoddI5i6qpS2mBELNsdWIuODA1rzSpWlklBxzUu0JEI1iwjGEzmAgwPbVDg+OIBTmYmUWzQOD412sEMPSpQT6NsKUzETAXSNHwmLXKS5Y2XBpSWVVQVP0YFqNBWmVlzjOuJlAg0hfo1SRQpypcWvSlpeODleo7Yi5QWkSulMSEepFx8Yy7UlxVdKSBtHww7wzyDV2ngisqBiIi0joZRCuhmDcM2LGk2gapFATlT9gJVG48ws4LW5oylHMc937sezd7Wxa4ihNkRmn4qwl8ZfaqExc+JFJ7YZLwyCmK3JsuTvsbcbKHd+eDGELxvIcMbrwiYg7CMDVtc4hO+VBV5VhUj5tECYKQ1kx9zWGgdOy8EcAiGSl07Hb9xpQgMcMjGboaYDSZMORbTBQB2ZYnf8SqWJRi5ByZ6iR0M4OGj3dgb6888/T+TNRAJMGNEyYeMJa0EmLAE/RyY2YeNRAmFgOWFjeHL8PAI09P3s+EX8XtD3aHQSv3P6Ph5N5CpsSqx+r6xj9aWFArmxjtx2dxAGolYcz8jT3E2jHsLLouiBzgQWmT+RqSqrujBKN3QnBY0MJ/LYcW95Wd3BOU3//lzHT28rhgbdzjQWOaRBMhgPSzOkaxptyaKJVSfBJ8SQkMIKXpjdPEWIh8dWR9kGZyfEGZZcFLvZctMPj6dA1gZDT4fdwd7Bj0fx0Njxvza4eUbcvFNTsMIWd7DUgjw8vnqkbTD3nJijO4TLZjdrAeDhMdYStsHWC2Ir4/YOddHsw2MoUBUnwn3u545OBqOng+Oj45MexEzpkgeAshxk2aBpmmbCoJMItC9QQEePUHxwvXNADu5Mq3KLN+WcnQ4qOB/ud/RAviO/Yxqf5M45NMFvc+9Zye2602BVxptHxqOKS4NX4OE736/pkemmiI6GfOg0VyINxBNMEDxMyXcdkhAGJMfs8LvvDr1kkm5wUJZBXF4XNErfAyfJ/mhZDrNsuAnbF3h/tIQsS2DL+PaJLIOyLHeN+wky8Yn8C9m1xaWdquVu0w4AD8+6O8K2Gnh4FOJcLmSYCNYBGwAa53XBNS7JXzZCScf9rctgw/Kj4fNoit5Zdj6XC0U8kfD5WfB1HwejJHrWEdDI/etukdlHonGOS4cjrY1VJREjMk4YEjB1mgM3PiglV1fJogmxj0n8V8orQUFLgda6UbTpcJ2IiRwduXs+x/T9nZYTIR6e6fQoi5M+xqHpiwkreXh42Qy738rmqCfssl1jsMDUYtZbC9sWw2XPynhGkiZgFyN15OUiw4JPsejmesQFNfZYpYlSSE9EFMNRxOdm+XJjNkyuthi1Z6JvTfH2izYZpQaFMDH4XRdBf3UIGm3OLUjEjK7/KUJc0Aswthm5l1IvoCRVbsaTBu06YZyiHr90S0zpZBpPX5D1PTsQHDjANl6Pm+3aILCwppm+XAhHKaQo67KXSIlYo8TK8Ar2xUUrKZUUd+hr99YOfHnPDhTl795gIkcu5M20qjK1kO6Uw3bfJ4A8vGPeo+y3HPO1Z8XD/ZZjFKnqH6MtLwqB+rekPUJm9xkawhnd35QE8IuEAZ6mWFnMNi7wkYvmNc+EgmltrZK7r/A+1MPT7wZ1f4COieEP03Kftj9N0z7NUfrM564cR+m0+dB0G8jaftBYwlRFmXSh5GnGxix1yfeYP2aJ2wKN/VJlDRvfsFRJSxPjGxbyibT08J2h9P0NM2mOJadfkTRK+FPCnSXMZ80MS5iLein7T8JjY6am7zCl3SpN5FiBhnC4deObCGWsFnLOkhBdsTHz2XGWMFzysiJgtpHrr7IZW8UN70LVjnSojPvRJtMJz1q14pOwve5hWCWMMt2fiIkSl563Es/VK0WDFl/zxvQQ+meLbdZZaA2djDSsgow3hg5AbbyDkfIirQuK7HBZCd20YaYL73r20RLa7tQSOnq66pTekcS15g1LmLBY9sd3GIFWH6+5FBVJxuXBPnbtO4VTxC/CAFV5nJ54+dFUvFMIU3Q6qnIlP3r96PjJ6Hj0ZHRMGEKu/dPl6GdvU7BuGC8ppsEsOp2DLr2dgMsAD+8zzgjv2OZzvN8Yz3eVj3oVDpOrusiohoFcD10V59NrdWv23T4aw3useZWw5f3MLH2Zz9em4PMCZxbqqkINqdIS9eN+RufBMHd8crJKWHM/e83/JHvPSXmL+7n7yRX1uoLnn0HrkxerhOX30/qPtuz4JxJ78mzVva4bzsPVVGXNVby3VvcBxoeC4GaqyFCTQ3L7vuquGrphDMrsavOenypVIJdbLhphuip4bCqgMJVi4JDSXORIPm0XvTrsnR8ZImZP7RDOXRW3n7EShrxCXeOEDeF01vNKXeC7RkIP1tWSpYJHbr8rU7tr/NFh+CYZPeqX8F3hv03lRhIcMFgsq8LVxheiKIhueteH0P5znl8rSSIgPpdx4/ufilc+M+Y2DIvWC8sQfMchvOIShEyLOjjpMxVTZ3Bz05qBs47VCm5uSKuor+jRXa2SboD2Whtw76of0ZiiuF5b1Q5ht7Ad6y31Ls4VuTh+IBQw+gSIuRRyflXrYrUa3jLDTkcfLLdbYgq6IyT/BxIjck7lmc5Qbz25LbTLBZGIJbUunJ2/+RDwu+8afxl1EUqwf+pLUdJ4d+n46Ij+W1dd25MUkFIqOEVjZnVRNJ+x5MPDo7t9NT+8/f67y/nK34njX5fp9fEbEnGtP9r5jW9FrYuBVQPS4SCKzrvCPckKWQiJV1FsV8dHR1cjku0qYSfbxPdWlWhzMuIFCXGhlZwnUFHbBYLVDfA5FxLo5tK/ozRRa6Xvfko+jrK7hHCyJoSnt4VwKl0S2rW1nav3KP9YTvvbW789kbosna34MIcJD+Tm2Rqz/XHPpMG01sI2bHxxw5YDXomBnx9fXK4uE0aCVZRaqJRxFHObszE7vJVpMKivXaR4ceNNt7VGw2VGieJb3guvxOH1iK2SzRVbfZ2d0MbyuZDzwZ2rLjtW35I6vMTXGO5Cs0p8gxSbBXn2oRImyAxy5HT1kQRJyz90aZavoq5iAmRbTqPTyWaWYvO52ZJ3iGmHtUzC9kTC6GkvhL+I0bgLsNv4elvI3LIeg+A2Bu6Ftb2o9qKz2TaAjPHjyAVexycnLkJ5PnKu/JMXzks+ebZyVtZ5jIyte4UuL7bp2zC2/mbHRe2L5MtG/UcnvkNCzpRTdZD/WYXyrZhLd6KuR7djCixS5bMt9JBH8P/8699uRdSbO/CfwVmtoVIL1LPadzzOClwK6tnrtcFGjxV5WaAxRQNCWpy7hthMzF3hMTy/VIjkU1EIuiIITPkMTu+WMUP4qfN5H2lfg73Ggm4WKJR677oVFfDaqtLtEZ/BhdLvZ0RSAhym1NaIxoBBjEtQ5lym5Db7k5OA0sAloLSoKy0MAhclAbveutlMpMK9r0pazVMLJZd8jrRZ4mIbkkIVmxK1mlJ1x6ii9jljao1EtJ5Fl/4dwmvqM3WMu8wVWi4KzGBeE4oE6EhBsFxiQ2YwJWesou1FiqbrtijwGrW7KbxLVhcFVIrubcELcu77uiVEVnNp6LkNWbOgmlZ8lVbkPbg9Mt4MgcpF9BSRu04GUAj53nfoXrRm9hNOjbDYxXWLxeLWrfV4fc3Xwub1FDRWqls3d4Pujusvbz8e05WAujRns7eor0UaHYQdex464MPwmnEfQsQrglfii80F9LIUIkVpsPf2vPz6zbdwDU+GRyzp3dMfQPDht6evvvr+7VeEl14Sf/5Gw6PhkUtGKWNLLntbbXSabx7dXrZ735i+b0zfN6bvG9P3jekPr8C5b0zfN6bvG9P3jen7xvR9Y/q+MX3fmL5vTN83pu8b07cY9b4xfd+Yvm9M3zemw74xfd+Y/ufr9r7G9FAPJD/psCq4kL2eBl9EvthsV79MWE5V5vEFu7mhDPWP1HxCw7/UqKlEfZmwa64FJRtdgTqJhViqQL5HKgW+8kn/wTntn3hbcxWMjbo81ZH9ipdOOXfC9gvhb87enrOExW6hUmW0RvMFtdvzBRuTT8pca76TrOuC5q59seByXruiKPN4qX7Ma5uvF5/fu+Jz+NGrrXLZ9Khcr0p7VugvMbZ1wV+p4vENNn9rwf3MzgVBthGaVHi5Wq3+CwtFoXM=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Create 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)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded 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:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(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)(o.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)(d.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)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.c16c326c.js b/assets/js/2c586be5.c16c326c.js deleted file mode 100644 index 48ee52eb5..000000000 --- a/assets/js/2c586be5.c16c326c.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:()=>x,default:()=>y,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var a=s(85893),i=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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7RpgmaFMXCMlxq5kjDeIackhxLU0Nv+yX7afsli8PLzEiW7CQtGi9WeXA05OHhuZE8t2tm+dyw8Rl7qdK6RGkNO09YhibVorJCSTZm73KEFxq5RYhQ8PzNKfCiUAsDtUFtwCqYo0RNUBIXkEV8MG2g0upKZELOIeOWw0LYHKbc4JMTQJmqDDOYiQKHEzmRP1WF4hk0qoYqm4GQoGoNZwcHL3Faz+Gn04OD8y9zayszPjzkVTVUFUoj5rLgUzNMVXmYEWCVzR5CjhodppRLyDRfwEJkc7QGuMwgVVUDqRooLTLJLSZQ8TmCrMspalAzsDmWQ+CFUS0StyaQrmbw5uXfieaDg6+xUD3sGsHUVaW0xYxYsDm2EhkfHNCaF6oslYSKa16iJRGqWUQwnsgBHBzYpsLxwQGcykyk3KJxeGi0gx16UKKcQN9WmIqZCKBr/EhY5CLNHSsLLi2prCp4ig5Uo6kwteIK1xEvE2gI8UuUKlKQKy1+U9LywsnxCrUVKS8gVUpnQjpKvfjAWK4tKb5SQto4GnaAfwap1sYTkQUVE2kZCaUU0s0YhCte1GgCVYsEcqLqR6w0GmdmAa/NHU05inm+cz+eva+NXUMMtSEy+1SEvTT+WguNmRMvOrHNeGEQxGxNliW/xN5uoNz54cUQvm4gwxmvC5uAsA8MWF3jEH5QFnhVFSLl0wJhpjSQHXNbaxw4LQdzCIRIXjodv3GnCQ1wyMRshpoOJE06FNEGA3Vkit3xK5UmGrkEJXuKHg3h4KDd2xnoL7/8MpHXEwkwYUTLhI0nrAWZsAT8HJnYhI1HCYSB5YSN4dHx0wjQ0PeT42fxe0Hfo9FJ/M7p+3g0kauwKbH6g7KO1ecWCuTGOnLb3UEYiFpxPCNPczeNegjPi6IHOhNYZP5Epqqs6sIo3dCdFDQynMhjx73lZXUL5zT9x3MdP72tGBp0O9NY5JAGyWA8LM2Qrmm0JYsmVp0EHxFDQgoreGF28xQh7h9bHWUbnJ0QZ1hyUexmy03fP54CWRsMPR52B3sHPx7FfWPH/9rg5glx815NwQpb3MJSC3L/+OqRtsHcU2KO7hAum92sBYD7x1hL2AZbz4itjNtb1EWz94+hQFWcCPe5nzs6GYweD46Pjk96EDOlSx4AynKQZYOmaZoJg04i0L5AAR09QvHB9c4BObgzrcot3pRzdjqo4Hy439EDeUV+xzQ+yZ1zaILf5t6zktt1p8GqjDcPjEcVlwavwMN3vl/TI9NNER0N+dBprkQaiCeYIHiYku86JCEMSI7Z4atXh14ySTc4KMsgLq8LGqXvgZNkf7Qsh1k23ITtC7w/WkKWJbBlfPtElkFZlrvG/QSZ+ET+heza4tJO1XK3aQeA+2fdHWFbDTw8CnEuFzJMBOuADQCN87rgGpfkLxuhpOP+xmWwYfnR8Hk0Re8sO5/LhSKeSPjydfB1HwajJHrWEdDI3etukNlHonGOS4cjrY1VJREjMk4YEjB1mgM3PiglV1fJogmxj0n8V8orQUFLgda6UbTpcJ2IiRwduXs+x/TyVsuJEPfPdHqUxUkf49D02YSVPDy8bIbdb2Vz1BN23q4xWGBqMeuthW2L4bxnZTwjSROwi5E68nKRYcGnWHRzPeKCGnus0kQppCciiuEo4nOzfLkxGyZXW4zaM9G3pnj7RZuMUoNCmBj8rougvzoEjTbnFiRiRtf/FCEu6AUY24zcS6kXUJIqN+NJg3adME5Rj1+6JaZ0Mo2nL8j6jh0IDhxgG6/HzXZtEFhY00xfLoSjFFKUddlLpESsUWJleAX74qKVlEqKO/S1e2MHvrxjB4ryd28wkSMX8mZaVZlaSHfKYbvvE0Du3zHvUfZ7jvnas+Lhfs8xilT1j9GWF4VA/VvSHiGz+wwN4TXd35QE8IuEAZ6mWFnMNi7wkYvmNc+EgmltrZK7r/A+1P3T7wZ1f4KOieEP03Kfts+maZ/mKH3mc1eOo3TavG+6DWRtP2gsYaqiTLpQ8jRjY5a65HvMH7PEbYHGfq2yho2vWaqkpYnxNQv5RFp6+N5Q+v6amTTHktOvSBol/CnhzhLms2aGJcxFvZT9J+GxMVPT95jSbpUmcqxAQzjcuvF1hDJWCzlnSYiu2Jj57DhLGC55WREw28j1V9mMreKGt6FqRzpUxv1ok+mEZ61a8UnYXvYwrBJGme5PxESJS89bie/UC0WDFl/yxvQQ+meLbdZZaA2djDSsgow3hg5AbbyDkfIirQuK7HBZCd20YaYL73r20RLa7tQSOnq86pTekcS15g1LmLBY9sd3GIFWH6+5FBVJxuXBPnbte4VTxK/CAFV5nJ54+dFUvFcIU3Q6qnIlP3r96PjR6Hj0aHRMGEKu/dPl6GdvUrBuGM8ppsEsOp2DLr2dgMsAD+8yzgjv2OZzvNsY3+0qH/UqHCZXdZFRDQO5HroqzqfX6tbsu300hndY8yphy7uZWfoyn69NwZcFzizUVYUaUqUl6of9jM69Ye745GSVsOZu9pr/SfaekvIWd3P3syvqdQXPz0Hro2erhOV30/qPtuz4GYk9ebLqXtcN5+FiqrLmIt5bq7sA40NBcDNVZKjJIbl5X3VXDd0wBmV2sXnPT5UqkMstF40wXRU8NhVQmEoxcEhpLnIkn7aLXh32zo8MEbOndgjvXBW3n7EShrxCXeOEDeF01vNKXeC7RkIP1tWSpYIHbr8LU7tr/MFh+CYZPeiX8F3hv03lRhIcMFgsq8LVxheiKIhueteH0P5znl8rSSIgPpdx47ufihc+M+Y2DIvWC8sQfMchvOAShEyLOjjpMxVTZ3B93ZqBs47VCq6vSauoL+jRXa2SboD2Whtw76of0ZiiuFpb1Q5ht7Ad6y31Ls4FuTh+IBQw+gSIuRRyflHrYrUa3jDDTkcfLLcbYgq6IyT/BxIjck7la52h3npyW2iXC7rj8vC3SxdyBIOmRhMljfd/jo+O6L91XbRNRgEp5XZTNGZWF0XzBUs+PN653fnyw9svtNu8qfy9OP5tmV4dvyGZ1fqjvdl4+de6GFg1IKUMoui8b9uTrJCFkHgRxXZxfHR0MSLZrhJ2sk18b1WJNierXJAQF1rJeQIV9VEgWN0An3Mhga4i/QdKE7VW+va34eMou00IJ2tCeHxTCKfSZZVdn9o7dYnyz+W0v7312xOpy9LZio9bmPBAbp6tMdsf90waTGstbMPGZ9dsOeCVGPj58dn56jxhJFhFuYJKGUcxtzkbs8MbqQOD+sqFfmfX3nRbazRcZpT5veGO8EocXo3YKtlcsdV52QltLJ8LOR/cuuq8Y/UtqcNLfI3hLtaqxHdIwVaQZx8qYYLMIEdOdxlJkLT8Y5c3+SbqKmY0tiUpOp1sph02348tiYSYR1hLDWzPDIwe92Lysxheu4i5DZi3xcAt6zGqbYPaXpzaC1PPOpttI8IYEI5cJHV8cuJCjqcj55s/eubc3pMnK2dlnQvI2Lqb5xJdm84KY+uPcFzUPjH+GSFdzZRTbJD26wrlWzGX7vxcjW6GBFikyidL6B2O4P/517/diqgld7y/gNe1hkotUM9q37A4K3ApqOWu18UaHU7kZYHGFA0IaXHu+lkzMXd1w/B6Uh2RT0Uh6EIgMOUTML07xQzh585lfaB9CfUKC7pHoFDq0jUbKuC1VaXbIz56C6UvZ0RSAhym1JWIxoBBjEtQ5lym5PX6c5KA0sAloLSoKy0MAhclAbvWuNlMpMK9pkpazVMLJZd8jrRZ4kITkkIVewq1mlJxxqii9ilf6mxEtJ5Fl70dwktqE3WMu8QTWi4KzGBeE4oE6ABBsFNiQ2YwJV+qou1FiqZrlijwCrW7F7xHVRcFVIpuacEL8s37uiVEVnNp6HENSa+gmlZ8lVbkK7g9Mt4Mgao99PCQt00GUAh56Rtsz1oz+xmnRljswrLFYnHjjnq4vuZbYfN6Chor1a2bu0F3o/WXtx8P6QJAXZrXs7eor0Qa3YEdex464MPwdnEfAcQLgVfiq80F9I4UIkVpsPfSPP/2zfdwBY+GRyzp3cofQPDh96cvvvnh7TeEl94Nf/5Gw6PhkcslKWNLLntbbTSKbx7dXrJ631e+7yvf95Xv+8r3feX3rz657yvf95Xv+8r3feX7vvJ9X/m+r3zfV77vK9/3le/7yrcY9b6vfN9Xvu8r3/eVw76vfN9X/vl1e1dfeaj+kZ90WBVcyF4Hgy8Zn212m58nLKea8viMXV9Thvon6h2h4V9r1FSQPk/YFdeCko2uHJ3EsivVGy+RCn8vfNJ/8I72T7ytuQrGRhWeqsZ+xXOnnFth+2XvN6/fvmMJi80+pcpojeYL6pbnCzYmn5S5znonWdfEzF33YcHlvHYlUObxUrWY1zZfLzVfulJz+NGrpHLZ9Khcr0F7VugvMbZ1wV+p4vEdNn9rwf3MzgVBthGaVHi+Wq3+C/8Hi2M=",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/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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7RpgmaFMXCMlxq5kjDeIackhxLU0Nv+yX7afsli8PLzEiW7CQtGi9WeXA05OHhuZE8t2tm+dyw8Rl7qdK6RGkNO09YhibVorJCSTZm73KEFxq5RYhQ8PzNKfCiUAsDtUFtwCqYo0RNUBIXkEV8MG2g0upKZELOIeOWw0LYHKbc4JMTQJmqDDOYiQKHEzmRP1WF4hk0qoYqm4GQoGoNZwcHL3Faz+Gn04OD8y9zayszPjzkVTVUFUoj5rLgUzNMVXmYEWCVzR5CjhodppRLyDRfwEJkc7QGuMwgVVUDqRooLTLJLSZQ8TmCrMspalAzsDmWQ+CFUS0StyaQrmbw5uXfieaDg6+xUD3sGsHUVaW0xYxYsDm2EhkfHNCaF6oslYSKa16iJRGqWUQwnsgBHBzYpsLxwQGcykyk3KJxeGi0gx16UKKcQN9WmIqZCKBr/EhY5CLNHSsLLi2prCp4ig5Uo6kwteIK1xEvE2gI8UuUKlKQKy1+U9LywsnxCrUVKS8gVUpnQjpKvfjAWK4tKb5SQto4GnaAfwap1sYTkQUVE2kZCaUU0s0YhCte1GgCVYsEcqLqR6w0GmdmAa/NHU05inm+cz+eva+NXUMMtSEy+1SEvTT+WguNmRMvOrHNeGEQxGxNliW/xN5uoNz54cUQvm4gwxmvC5uAsA8MWF3jEH5QFnhVFSLl0wJhpjSQHXNbaxw4LQdzCIRIXjodv3GnCQ1wyMRshpoOJE06FNEGA3Vkit3xK5UmGrkEJXuKHg3h4KDd2xnoL7/8MpHXEwkwYUTLhI0nrAWZsAT8HJnYhI1HCYSB5YSN4dHx0wjQ0PeT42fxe0Hfo9FJ/M7p+3g0kauwKbH6g7KO1ecWCuTGOnLb3UEYiFpxPCNPczeNegjPi6IHOhNYZP5Epqqs6sIo3dCdFDQynMhjx73lZXUL5zT9x3MdP72tGBp0O9NY5JAGyWA8LM2Qrmm0JYsmVp0EHxFDQgoreGF28xQh7h9bHWUbnJ0QZ1hyUexmy03fP54CWRsMPR52B3sHPx7FfWPH/9rg5glx815NwQpb3MJSC3L/+OqRtsHcU2KO7hAum92sBYD7x1hL2AZbz4itjNtb1EWz94+hQFWcCPe5nzs6GYweD46Pjk96EDOlSx4AynKQZYOmaZoJg04i0L5AAR09QvHB9c4BObgzrcot3pRzdjqo4Hy439EDeUV+xzQ+yZ1zaILf5t6zktt1p8GqjDcPjEcVlwavwMN3vl/TI9NNER0N+dBprkQaiCeYIHiYku86JCEMSI7Z4atXh14ySTc4KMsgLq8LGqXvgZNkf7Qsh1k23ITtC7w/WkKWJbBlfPtElkFZlrvG/QSZ+ET+heza4tJO1XK3aQeA+2fdHWFbDTw8CnEuFzJMBOuADQCN87rgGpfkLxuhpOP+xmWwYfnR8Hk0Re8sO5/LhSKeSPjydfB1HwajJHrWEdDI3etukNlHonGOS4cjrY1VJREjMk4YEjB1mgM3PiglV1fJogmxj0n8V8orQUFLgda6UbTpcJ2IiRwduXs+x/TyVsuJEPfPdHqUxUkf49D02YSVPDy8bIbdb2Vz1BN23q4xWGBqMeuthW2L4bxnZTwjSROwi5E68nKRYcGnWHRzPeKCGnus0kQppCciiuEo4nOzfLkxGyZXW4zaM9G3pnj7RZuMUoNCmBj8rougvzoEjTbnFiRiRtf/FCEu6AUY24zcS6kXUJIqN+NJg3adME5Rj1+6JaZ0Mo2nL8j6jh0IDhxgG6/HzXZtEFhY00xfLoSjFFKUddlLpESsUWJleAX74qKVlEqKO/S1e2MHvrxjB4ryd28wkSMX8mZaVZlaSHfKYbvvE0Du3zHvUfZ7jvnas+Lhfs8xilT1j9GWF4VA/VvSHiGz+wwN4TXd35QE8IuEAZ6mWFnMNi7wkYvmNc+EgmltrZK7r/A+1P3T7wZ1f4KOieEP03Kfts+maZ/mKH3mc1eOo3TavG+6DWRtP2gsYaqiTLpQ8jRjY5a65HvMH7PEbYHGfq2yho2vWaqkpYnxNQv5RFp6+N5Q+v6amTTHktOvSBol/CnhzhLms2aGJcxFvZT9J+GxMVPT95jSbpUmcqxAQzjcuvF1hDJWCzlnSYiu2Jj57DhLGC55WREw28j1V9mMreKGt6FqRzpUxv1ok+mEZ61a8UnYXvYwrBJGme5PxESJS89bie/UC0WDFl/yxvQQ+meLbdZZaA2djDSsgow3hg5AbbyDkfIirQuK7HBZCd20YaYL73r20RLa7tQSOnq86pTekcS15g1LmLBY9sd3GIFWH6+5FBVJxuXBPnbte4VTxK/CAFV5nJ54+dFUvFcIU3Q6qnIlP3r96PjR6Hj0aHRMGEKu/dPl6GdvUrBuGM8ppsEsOp2DLr2dgMsAD+8yzgjv2OZzvNsY3+0qH/UqHCZXdZFRDQO5HroqzqfX6tbsu300hndY8yphy7uZWfoyn69NwZcFzizUVYUaUqUl6of9jM69Ye745GSVsOZu9pr/SfaekvIWd3P3syvqdQXPz0Hro2erhOV30/qPtuz4GYk9ebLqXtcN5+FiqrLmIt5bq7sA40NBcDNVZKjJIbl5X3VXDd0wBmV2sXnPT5UqkMstF40wXRU8NhVQmEoxcEhpLnIkn7aLXh32zo8MEbOndgjvXBW3n7EShrxCXeOEDeF01vNKXeC7RkIP1tWSpYIHbr8LU7tr/MFh+CYZPeiX8F3hv03lRhIcMFgsq8LVxheiKIhueteH0P5znl8rSSIgPpdx47ufihc+M+Y2DIvWC8sQfMchvOAShEyLOjjpMxVTZ3B93ZqBs47VCq6vSauoL+jRXa2SboD2Whtw76of0ZiiuFpb1Q5ht7Ad6y31Ls4FuTh+IBQw+gSIuRRyflHrYrUa3jDDTkcfLLcbYgq6IyT/BxIjck7la52h3npyW2iXC7rj8vC3SxdyBIOmRhMljfd/jo+O6L91XbRNRgEp5XZTNGZWF0XzBUs+PN653fnyw9svtNu8qfy9OP5tmV4dvyGZ1fqjvdl4+de6GFg1IKUMoui8b9uTrJCFkHgRxXZxfHR0MSLZrhJ2sk18b1WJNierXJAQF1rJeQIV9VEgWN0An3Mhga4i/QdKE7VW+va34eMou00IJ2tCeHxTCKfSZZVdn9o7dYnyz+W0v7312xOpy9LZio9bmPBAbp6tMdsf90waTGstbMPGZ9dsOeCVGPj58dn56jxhJFhFuYJKGUcxtzkbs8MbqQOD+sqFfmfX3nRbazRcZpT5veGO8EocXo3YKtlcsdV52QltLJ8LOR/cuuq8Y/UtqcNLfI3hLtaqxHdIwVaQZx8qYYLMIEdOdxlJkLT8Y5c3+SbqKmY0tiUpOp1sph02348tiYSYR1hLDWzPDIwe92Lysxheu4i5DZi3xcAt6zGqbYPaXpzaC1PPOpttI8IYEI5cJHV8cuJCjqcj55s/eubc3pMnK2dlnQvI2Lqb5xJdm84KY+uPcFzUPjH+GSFdzZRTbJD26wrlWzGX7vxcjW6GBFikyidL6B2O4P/517/diqgld7y/gNe1hkotUM9q37A4K3ApqOWu18UaHU7kZYHGFA0IaXHu+lkzMXd1w/B6Uh2RT0Uh6EIgMOUTML07xQzh585lfaB9CfUKC7pHoFDq0jUbKuC1VaXbIz56C6UvZ0RSAhym1JWIxoBBjEtQ5lym5PX6c5KA0sAloLSoKy0MAhclAbvWuNlMpMK9pkpazVMLJZd8jrRZ4kITkkIVewq1mlJxxqii9ilf6mxEtJ5Fl70dwktqE3WMu8QTWi4KzGBeE4oE6ABBsFNiQ2YwJV+qou1FiqZrlijwCrW7F7xHVRcFVIpuacEL8s37uiVEVnNp6HENSa+gmlZ8lVbkK7g9Mt4Mgao99PCQt00GUAh56Rtsz1oz+xmnRljswrLFYnHjjnq4vuZbYfN6Chor1a2bu0F3o/WXtx8P6QJAXZrXs7eor0Qa3YEdex464MPwdnEfAcQLgVfiq80F9I4UIkVpsPfSPP/2zfdwBY+GRyzp3cofQPDh96cvvvnh7TeEl94Nf/5Gw6PhkcslKWNLLntbbTSKbx7dXrJ631e+7yvf95Xv+8r3feX3rz657yvf95Xv+8r3feX7vvJ9X/m+r3zfV77vK9/3le/7yrcY9b6vfN9Xvu8r3/eVw76vfN9X/vl1e1dfeaj+kZ90WBVcyF4Hgy8Zn212m58nLKea8viMXV9Thvon6h2h4V9r1FSQPk/YFdeCko2uHJ3EsivVGy+RCn8vfNJ/8I72T7ytuQrGRhWeqsZ+xXOnnFth+2XvN6/fvmMJi80+pcpojeYL6pbnCzYmn5S5znonWdfEzF33YcHlvHYlUObxUrWY1zZfLzVfulJz+NGrpHLZ9Khcr0F7VugvMbZ1wV+p4vEdNn9rwf3MzgVBthGaVHi+Wq3+C/8Hi2M=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},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 Document"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,a.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,a.jsxs)(n.p,{children:["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.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\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 pdf"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(r.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Document created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function 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/38c56221.510e3b28.js b/assets/js/38c56221.510e3b28.js new file mode 100644 index 000000000..26668b28a --- /dev/null +++ b/assets/js/38c56221.510e3b28.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2403],{75548:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var i=a(85893),n=a(11151),r=a(58219),t=(a(62316),a(51039)),l=a.n(t),o=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(85162);const h={id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1u47YSfpUp96K7gGI72T29EIqiOd09RdCiCZoUi8IxgpE4sphQpEpSdnQM3/VJ+mh9kmIoyZaz2WBTFAUK9Caxyfnh/H/jjQi49CKdi7c2byoywYtFIiT53Kk6KGtEKq5KgrcOiwADEZxenAEZzDR5aG0DwULuCAMBGgkVGlwSyIFaMrOfwFVJnvpvkKOBjKBoXCjJARmn8pIkZC2glMoswaulIeejSGVy62rrMPCNMoEc5kGtCNZKLil4CKWzzbIE2zhoPLmOqMCcAAPMoQyh9ul0inU9sTUZlq4x85PcVouXT16/gpeFdZBr20hYkfPKmldsjvLRE8qDpPhayZ7wwRFWWhmCUBLUzubkPdhi75HaUY1sjDUJoNZ2zWaxEgTPzMwQHBqvmAYKZ6vOcaygUAb1Ttjk2lybFy9ewP8IQ+PIp9fmCOASV7QPWIyfT+GS8saRbsHzdcvOGuR4UAaw1+IDBppEQadSwmUXihROPdu5C02whzJAKkd50G33Yjb/9OJs0r3vBxsovTY/24aDb2zgQIOznEQc4yGSPWvn3Akw/VppDSU/OViQFlTYK9DK3IGjnNSKOFHioSNfW+PZBJEIW1Pn7DMpUhEtpOHJIhGOfmnIh/9a2Yp0I3JrAl+kG4F1rVUeWae3nqthI3xeUoX8ifmUI8n1UyhNIhG9Y0QiggqauJhCW5NIhc1uKWdttePnBEWeZUS+dDNQ+eCUWYpEFNZVGEQqMvT0xRuRCLrHqmbi/gjI5FaShFoWYjsofErU7mQvyscPu/ixnIPi/1PS3o4kbBNhbPiz7+KUYRGDW/dS0DlsRSJUoGp8/hE3U4VKP/cRt5Yyoq/7A+4E0Rysnm3OrSXIKJpSl9Y8m//45PXxyfHr4xOx3Ue6S+QhdDeZle3N4Cgm82TkmTl3ktxIX2atJjRj8QVqT9tEdB39/OriU8iffIfY8v2+PoJrKB50VRlDcjKb8b/DWbNrWN04keCbnLtn0WjdfiaSTy/Op/OhO+Z28LxAlLfq5P/3+erkgmPZuGfn1DBnGqePgj0iqcLRvvpGTlWGJ8jN4LKbk9nsRrJft4l485jrLm1FoeQ5smYHrp01ywRqTegJgmsBl6gMaAzk/kJPknPWPeaFvc3Pe9lTTngzm90c75zwnw+dcGZWqJWMY/nK3pH5ey0dqw+den7qfRXzpOscQnVE8V4cGDs+74z0PK9VaEU634j7I6zVUXefzhfbRSLYsZaHWm19fDGGUqRielCSPJfIrWIDnW+6rN0lokcjM3v/AeiZYq2mq2OxTR5yPAaRPk7tAy6VWR49ybXYW3rJ0egcfmDvvvPX6jvi1t+7c0yVCMVZUBJy02MHcpB/3M/3d0Oohsn72DDdh+TheHwIjR8ZeMO8Oxhhowk23w2jx+bLzqphYuwGxngGLB4099iRD/r30NKVKWz0XW/QeU2GwVzM0NXxBwa9J53bKsIshlED+e+//hY5BkfEAvoMzhsHtV2TKxodIVyh6V5lOqK+Dtfu9oMB1uo2IvOl421BqqUKqCOe5P6QY42Z0opLjsl6eDmqWj+B9yXFlaG1zeeOGLLSijRXKmhr71hOsIBNsFXUMYyUtXV3BT8pAYSs8cowyvZEAwuZEk1OMKRiAgzIDRBvErVTngBVNSB1KgqVqzirrAm8jvSLDytL4h7CXqidXSlJHpzNGh/AW91EQ1hjRRQ6Ew2R9BN4yytNNDzCagqoNElYNiwiAc5R6POFzTASMvK8T/A2lJPv9g90ATStyMXSi5HkAQq15T6oUPMyMo4tC4rrBo+uHtL3oRntLHGPiTokthPgvYNbO69bnAAMxLvlY75Ls/eUeRVo8XJoB+v1+sP96pDnWxXKJgNHtd3zLeNhbBpj9t2XV1y15Cp/XlySW6l8GLYf0TmNxNN+OmAeRiiRW8zXDxm4U2uVk/E06uWn3158Dyt4PZmJZNT4PuHB0+/Pvnn3w+U7ltvvlFzkk9lkFmGi9aFCM1J1uII/rNzR2vLvwv7vwv4PX9j7UR/oPkxrjcqM0HYHceaHWwcv2iVDoHQuNhue6T85vd3y8S8NOcZPi0Ss0CmugYiekgEm8Ei+o1ak4puuhI6uWD2T66ZDHA9AI6OcjuM0z6kOT9KOUdrF+eWVSETW/9JQWck8Dtf8KwSuRSquxbWIv1jEGRF/ZeDzjdBolg0uIzaIchndYMO+GEOjuwiN+g9s2XBl2tErDzFTZwr/ZcMeZfiSy+Y7ar/akXc3H2XofTtQcwQX2+32D45zLGU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",source:"@site/docs/API-docs/draftedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftedocument",permalink:"/docs/API-docs/draftedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1u47YSfpUp96K7gGI72T29EIqiOd09RdCiCZoUi8IxgpE4sphQpEpSdnQM3/VJ+mh9kmIoyZaz2WBTFAUK9Caxyfnh/H/jjQi49CKdi7c2byoywYtFIiT53Kk6KGtEKq5KgrcOiwADEZxenAEZzDR5aG0DwULuCAMBGgkVGlwSyIFaMrOfwFVJnvpvkKOBjKBoXCjJARmn8pIkZC2glMoswaulIeejSGVy62rrMPCNMoEc5kGtCNZKLil4CKWzzbIE2zhoPLmOqMCcAAPMoQyh9ul0inU9sTUZlq4x85PcVouXT16/gpeFdZBr20hYkfPKmldsjvLRE8qDpPhayZ7wwRFWWhmCUBLUzubkPdhi75HaUY1sjDUJoNZ2zWaxEgTPzMwQHBqvmAYKZ6vOcaygUAb1Ttjk2lybFy9ewP8IQ+PIp9fmCOASV7QPWIyfT+GS8saRbsHzdcvOGuR4UAaw1+IDBppEQadSwmUXihROPdu5C02whzJAKkd50G33Yjb/9OJs0r3vBxsovTY/24aDb2zgQIOznEQc4yGSPWvn3Akw/VppDSU/OViQFlTYK9DK3IGjnNSKOFHioSNfW+PZBJEIW1Pn7DMpUhEtpOHJIhGOfmnIh/9a2Yp0I3JrAl+kG4F1rVUeWae3nqthI3xeUoX8ifmUI8n1UyhNIhG9Y0QiggqauJhCW5NIhc1uKWdttePnBEWeZUS+dDNQ+eCUWYpEFNZVGEQqMvT0xRuRCLrHqmbi/gjI5FaShFoWYjsofErU7mQvyscPu/ixnIPi/1PS3o4kbBNhbPiz7+KUYRGDW/dS0DlsRSJUoGp8/hE3U4VKP/cRt5Yyoq/7A+4E0Rysnm3OrSXIKJpSl9Y8m//45PXxyfHr4xOx3Ue6S+QhdDeZle3N4Cgm82TkmTl3ktxIX2atJjRj8QVqT9tEdB39/OriU8iffIfY8v2+PoJrKB50VRlDcjKb8b/DWbNrWN04keCbnLtn0WjdfiaSTy/Op/OhO+Z28LxAlLfq5P/3+erkgmPZuGfn1DBnGqePgj0iqcLRvvpGTlWGJ8jN4LKbk9nsRrJft4l485jrLm1FoeQ5smYHrp01ywRqTegJgmsBl6gMaAzk/kJPknPWPeaFvc3Pe9lTTngzm90c75zwnw+dcGZWqJWMY/nK3pH5ey0dqw+den7qfRXzpOscQnVE8V4cGDs+74z0PK9VaEU634j7I6zVUXefzhfbRSLYsZaHWm19fDGGUqRielCSPJfIrWIDnW+6rN0lokcjM3v/AeiZYq2mq2OxTR5yPAaRPk7tAy6VWR49ybXYW3rJ0egcfmDvvvPX6jvi1t+7c0yVCMVZUBJy02MHcpB/3M/3d0Oohsn72DDdh+TheHwIjR8ZeMO8Oxhhowk23w2jx+bLzqphYuwGxngGLB4099iRD/r30NKVKWz0XW/QeU2GwVzM0NXxBwa9J53bKsIshlED+e+//hY5BkfEAvoMzhsHtV2TKxodIVyh6V5lOqK+Dtfu9oMB1uo2IvOl421BqqUKqCOe5P6QY42Z0opLjsl6eDmqWj+B9yXFlaG1zeeOGLLSijRXKmhr71hOsIBNsFXUMYyUtXV3BT8pAYSs8cowyvZEAwuZEk1OMKRiAgzIDRBvErVTngBVNSB1KgqVqzirrAm8jvSLDytL4h7CXqidXSlJHpzNGh/AW91EQ1hjRRQ6Ew2R9BN4yytNNDzCagqoNElYNiwiAc5R6POFzTASMvK8T/A2lJPv9g90ATStyMXSi5HkAQq15T6oUPMyMo4tC4rrBo+uHtL3oRntLHGPiTokthPgvYNbO69bnAAMxLvlY75Ls/eUeRVo8XJoB+v1+sP96pDnWxXKJgNHtd3zLeNhbBpj9t2XV1y15Cp/XlySW6l8GLYf0TmNxNN+OmAeRiiRW8zXDxm4U2uVk/E06uWn3158Dyt4PZmJZNT4PuHB0+/Pvnn3w+U7ltvvlFzkk9lkFmGi9aFCM1J1uII/rNzR2vLvwv7vwv4PX9j7UR/oPkxrjcqM0HYHceaHWwcv2iVDoHQuNhue6T85vd3y8S8NOcZPi0Ss0CmugYiekgEm8Ei+o1ak4puuhI6uWD2T66ZDHA9AI6OcjuM0z6kOT9KOUdrF+eWVSETW/9JQWck8Dtf8KwSuRSquxbWIv1jEGRF/ZeDzjdBolg0uIzaIchndYMO+GEOjuwiN+g9s2XBl2tErDzFTZwr/ZcMeZfiSy+Y7ar/akXc3H2XofTtQcwQX2+32D45zLGU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},j={},g=[{value:"Features:",id:"features",level:3},{value:"Note:",id:"note",level:3},{value:"Request",id:"request",level:2}];function x(e){const s={a:"a",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsxs)(s.p,{children:["The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com",children:" https://app.opensignlabs.com"})," (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document."]}),"\n",(0,i.jsx)(s.h3,{id:"features",children:"Features:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,i.jsx)(s.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"note",children:"Note:"}),"\n",(0,i.jsx)(s.p,{children:"You cannot add roles and widgets from this API. You will have to do it from the link received in the response."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-edit-document"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/38c56221.78b7485b.js b/assets/js/38c56221.78b7485b.js deleted file mode 100644 index 17a222351..000000000 --- a/assets/js/38c56221.78b7485b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2403],{75548:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>g,toc:()=>f});var n=a(85893),i=a(11151),t=a(58219),r=(a(62316),a(51039)),l=a.n(r),o=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v47gR/ypz3IfuAortZLd9EIri0tvtIbjDJWhSLArHCEbiSGJCkTqSsqMafusn6UfrJymGkmw5mw0uh6JAgXtJbHL+D2fmN96KgKUX6VJ8tHlbkwlerBIhyedONUFZI1JxUxF8dFgEGIng/OoCyGCmyUNnWwgWckcYCNBIqNFgSSBHasnMfgY3FXkavkGOBjKConWhIgdknMorkpB1gFIqU4JXpSHno0hlcusa6zDwjTKBHOZBrQk2SpYUPITK2baswLYOWk+uJyowJ8AAS6hCaHw6n2PTzGxDhqVrzPwst/Xq7YvX7+BtYR3k2rYS1uS8suYdu6N8jITyIClaKzkSPjjCWitDECqCxtmcvAdbHCLSOGqQnbEmAdTabtgtVoLgmZkZgkPjFdNA4WzdB44VFMqg3gub3Zpb8+bNG/gLYWgd+fTWnABc45oOCYv58ylcU9460h14vu44WKMcD8oADlp8wECzKOhcSrjuU5HCuWc/96kJ9lgGSOUoD7rrLWb3z68uZr19P9lA6a35u205+cYGTjQ4y4+IczxmcmDtgzsDpt8oraFik4MFaUGFgwKtzAM4ykmtiR9KPHTkG2s8uyASYRvqg30hRSqihzSaLBLh6OeWfPizlZ1ItyK3JvBFuhXYNFrlkXV+77katsLnFdXIn5hPOZJcP4XSJBIxBEYkIqigiYspdA2JVNjsnnLW1jg2JyjyLCPypduRygenTCkSUVhXYxCpyNDTHz6IRNAj1g0TD0dAJreSJDSyELtR4Uui9icHUT5+2OeP5RwV/6+S9nEiYZcIY8OvtYufDIsYw3qQgs5hJxKhAtXT86+EmWpU+rVG3FvKiL4dDrgTRHewfrU795Ygo+hKU1nzav7Ts/enZ6fvT8/E7pDp/iGPqbvLrOzuxkAxmScjL8ylk+Qm+jJrNaGZii9Qe3pZsNjx/eHBB9dSPOjLLMb4bLHgf8fDY9+B+vkgwbc5t8Oi1br7RiS/vNpeTnB/zPX9ushW9+rsH4/5+uyKk9O6Vz+ScXC0Tp8Ee0JShZNDOU2CqgyPhLsxZHdni8Wd5LjuEvHhudBd25pCxYNhwwHcOGvKBBpN6AmC6wBLVAY0BnL/xUiSc9Y9F4WDz6+z7KUgfFgs7k73Qfj9l0G4MGvUSsY5e2MfyPxvPZ2qD716NvWxju+kbwVC9UTxXhw5Oz3vnfQ8gFXoRLrciscTbNRJf58uV7tVIjiwlqdUY320GEMlUjE/KkkeNOTWsSMut/2r3T9Ej0Zm9vELFDPHRs3Xp2KXPOV4DvN8ndoHLJUpT17kWh08veZs9AE/8vfQyhv1A3EvH8I5pUqE4ldQEXIX4wBykv96GNifxlSNo/S56XhIydN59xTrPjPBxgF2NJMmI2m5ny7PDYy9V+MI2E+AaVNfPenWfUdm5wsbIzWYf9mQYSwW3+P69AvzP5PObR1REqOgkfzf//xX5BjdjuXyDVy2Dhq7IVe0OiKwQtOjynQEbT0s3cP7EZXqLgLr0jHYl6pUAXWEg9wNcmwwU1pxgTHZgA4nNepn8LmiiPg72/7OESNOWpPmugRt7QPLCRawDbaOOsYBsrHuoWCTEkDIWq8Mg2RPNLKQqdDkBOPDS4DxtAHiRaBxyhOgqkegTUWhchUnkzWBt4lhb2FlSVwjOAqNs2slyYOzWesDeKvb6AhrrIlC76Ihkn4GH3kjiY5HVEwBlSYJZcsiEuAXCcPrYDeMhIw8rwO8zOTk+/UBXQBNa3Kx0GImeVxCY7nrKdS8S0xzy4LitsCDakDkQ2omK0dcQ6IOid0MeG3gRs7bEj8AxtH97rDcP7PPlHkVaPV2LP7NZvPlenTM870KVZuBo8Ye+Mp4GFvElH3/5R3XKLnaXxbX5NYqH0frV3TOI/F8mAWYhwnI44by7VMG7sta5WQ8TTr3+fdXP8Ia3s8WIpm0uV9g8PzHi+8+/XT9ieUOKyGX9GwxW0SUZ32o0UxUHW/QTyt3snX8tm//tm//n+/bw2AP9BjmjUZlJti6BzTL4x2D9+SKAU+6FNstT/C/Ob3b8fHPLTlGS6tErNEproGIlZIRFPAAfqBOpOK7voROblg9k+u2xxdPICJjmp7jPM+pCS/STjHZ1eX1jUhENvxQUFvJPA43/CMCbkQqbsWtiD84xBkRfyTg863QaMoWy4gEolzGMthyLKZA6CECoeEDezZemW5i5TFC6l3hv+zYswx/5LL5gbo/7cn7m68yDLEdqTmDq91u9x/zYRZV",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,g={id:"API-docs/draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",source:"@site/docs/API-docs/draftedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftedocument",permalink:"/docs/API-docs/draftedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v47gR/ypz3IfuAortZLd9EIri0tvtIbjDJWhSLArHCEbiSGJCkTqSsqMafusn6UfrJymGkmw5mw0uh6JAgXtJbHL+D2fmN96KgKUX6VJ8tHlbkwlerBIhyedONUFZI1JxUxF8dFgEGIng/OoCyGCmyUNnWwgWckcYCNBIqNFgSSBHasnMfgY3FXkavkGOBjKConWhIgdknMorkpB1gFIqU4JXpSHno0hlcusa6zDwjTKBHOZBrQk2SpYUPITK2baswLYOWk+uJyowJ8AAS6hCaHw6n2PTzGxDhqVrzPwst/Xq7YvX7+BtYR3k2rYS1uS8suYdu6N8jITyIClaKzkSPjjCWitDECqCxtmcvAdbHCLSOGqQnbEmAdTabtgtVoLgmZkZgkPjFdNA4WzdB44VFMqg3gub3Zpb8+bNG/gLYWgd+fTWnABc45oOCYv58ylcU9460h14vu44WKMcD8oADlp8wECzKOhcSrjuU5HCuWc/96kJ9lgGSOUoD7rrLWb3z68uZr19P9lA6a35u205+cYGTjQ4y4+IczxmcmDtgzsDpt8oraFik4MFaUGFgwKtzAM4ykmtiR9KPHTkG2s8uyASYRvqg30hRSqihzSaLBLh6OeWfPizlZ1ItyK3JvBFuhXYNFrlkXV+77katsLnFdXIn5hPOZJcP4XSJBIxBEYkIqigiYspdA2JVNjsnnLW1jg2JyjyLCPypduRygenTCkSUVhXYxCpyNDTHz6IRNAj1g0TD0dAJreSJDSyELtR4Uui9icHUT5+2OeP5RwV/6+S9nEiYZcIY8OvtYufDIsYw3qQgs5hJxKhAtXT86+EmWpU+rVG3FvKiL4dDrgTRHewfrU795Ygo+hKU1nzav7Ts/enZ6fvT8/E7pDp/iGPqbvLrOzuxkAxmScjL8ylk+Qm+jJrNaGZii9Qe3pZsNjx/eHBB9dSPOjLLMb4bLHgf8fDY9+B+vkgwbc5t8Oi1br7RiS/vNpeTnB/zPX9ushW9+rsH4/5+uyKk9O6Vz+ScXC0Tp8Ee0JShZNDOU2CqgyPhLsxZHdni8Wd5LjuEvHhudBd25pCxYNhwwHcOGvKBBpN6AmC6wBLVAY0BnL/xUiSc9Y9F4WDz6+z7KUgfFgs7k73Qfj9l0G4MGvUSsY5e2MfyPxvPZ2qD716NvWxju+kbwVC9UTxXhw5Oz3vnfQ8gFXoRLrciscTbNRJf58uV7tVIjiwlqdUY320GEMlUjE/KkkeNOTWsSMut/2r3T9Ej0Zm9vELFDPHRs3Xp2KXPOV4DvN8ndoHLJUpT17kWh08veZs9AE/8vfQyhv1A3EvH8I5pUqE4ldQEXIX4wBykv96GNifxlSNo/S56XhIydN59xTrPjPBxgF2NJMmI2m5ny7PDYy9V+MI2E+AaVNfPenWfUdm5wsbIzWYf9mQYSwW3+P69AvzP5PObR1REqOgkfzf//xX5BjdjuXyDVy2Dhq7IVe0OiKwQtOjynQEbT0s3cP7EZXqLgLr0jHYl6pUAXWEg9wNcmwwU1pxgTHZgA4nNepn8LmiiPg72/7OESNOWpPmugRt7QPLCRawDbaOOsYBsrHuoWCTEkDIWq8Mg2RPNLKQqdDkBOPDS4DxtAHiRaBxyhOgqkegTUWhchUnkzWBt4lhb2FlSVwjOAqNs2slyYOzWesDeKvb6AhrrIlC76Ihkn4GH3kjiY5HVEwBlSYJZcsiEuAXCcPrYDeMhIw8rwO8zOTk+/UBXQBNa3Kx0GImeVxCY7nrKdS8S0xzy4LitsCDakDkQ2omK0dcQ6IOid0MeG3gRs7bEj8AxtH97rDcP7PPlHkVaPV2LP7NZvPlenTM870KVZuBo8Ye+Mp4GFvElH3/5R3XKLnaXxbX5NYqH0frV3TOI/F8mAWYhwnI44by7VMG7sta5WQ8TTr3+fdXP8Ia3s8WIpm0uV9g8PzHi+8+/XT9ieUOKyGX9GwxW0SUZ32o0UxUHW/QTyt3snX8tm//tm//n+/bw2AP9BjmjUZlJti6BzTL4x2D9+SKAU+6FNstT/C/Ob3b8fHPLTlGS6tErNEproGIlZIRFPAAfqBOpOK7voROblg9k+u2xxdPICJjmp7jPM+pCS/STjHZ1eX1jUhENvxQUFvJPA43/CMCbkQqbsWtiD84xBkRfyTg863QaMoWy4gEolzGMthyLKZA6CECoeEDezZemW5i5TFC6l3hv+zYswx/5LL5gbo/7cn7m68yDLEdqTmDq91u9x/zYRZV",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},x={},f=[{value:"Features:",id:"features",level:3},{value:"Note:",id:"note",level:3},{value:"Request",id:"request",level:2}];function j(e){const s={a:"a",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Draft Document"})}),"\n",(0,n.jsx)(l(),{method:"post",path:"/draftdocument"}),"\n",(0,n.jsxs)(s.p,{children:["The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at ",(0,n.jsx)(s.a,{href:"https://app.opensignlabs.com",children:" https://app.opensignlabs.com"})," (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document."]}),"\n",(0,n.jsx)(s.h3,{id:"features",children:"Features:"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,n.jsx)(s.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"note",children:"Note:"}),"\n",(0,n.jsx)(s.p,{children:"You cannot add roles and widgets from this API. You will have to do it from the link received in the response."}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})}),(0,n.jsx)("strong",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,n.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})}),(0,n.jsx)("span",{className:"openapi-schema__divider"}),(0,n.jsx)("span",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(t.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document created successfully!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-edit-document"}})]})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.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,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.2b8fccd7.js b/assets/js/5a2de241.2b8fccd7.js new file mode 100644 index 000000000..a339e65df --- /dev/null +++ b/assets/js/5a2de241.2b8fccd7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>v});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),u=s(85162);const h={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV+9u2zYQf5Urv6wFFNtJ0xYThmFdW7RBiyVoUhRYYgQn6WyzoUiWpOwYhr7tSfZoe5LhKMmWnTRthm77EjjU/fvdHe93XImAUy/Sc3FGpVUYyItxIgryuZM2SKNFKs5mBB9sgYGgk4LnJ0dAGjNFHpamgmCgNIWcLAF1AVUjHWYEBQWUyoOZAIK3lMuJzCG0dgYiEcaSQ3Z1VIhUNKqdH5EIiw5LCuQ4zJXQWJJIRWfgUhYiEZLDtBhmYjf2o5fsmQPpNCDMMIAmKjxHnVEbLdtx9LmSjgqRBldRInxYKvbmZWkVB0PXVpmCRDpB5Vkgn1GJIl2JsLRRMjippyIRE+NKDJuTuh439smHX02xZJ3tUE+cmcuCICNlFrCGzUF2+exqBA8xgCL0AYymnmwH4JFIRG50IB3YEVqrZB6TPPzk2dvqZugm+0R54Iw7LkmQ5Plrk/CvA+TkYExTKnz8sY5X1InQJtzbzAlDJHA0l7SIjeXlVEOYSQ+FyauS4dU7Jb+fi3VX9G3UrKMKctyRN+1ttFmyuQXHZyc90cwYRaj7srFh6joRQYYtz5e9Vr7MuDPqmuUceWu0b4pwMBrdbJj1ZWwbGHyV5+T9pFJq+eD7dUBz/LVcoC8O3viTwzeWs9KG9DzcrXQwOni8tz/aGz0723+aHv6YPnk6GI1Gv4tEXJdq036iaNuoy17zf+9AaiU1XXZZuzwYjS4ft6k8vC17bXPZ9tbNUckCJpJUAezTf8cEknPG/cPmvyO+u+Az5A784R2to02Aial08X/DvS2iuwEeXj5bQ3xyE+KRblLGTHVmrkj/Fwg3ePruQ+OeQ93uatkIxe9iC2z/vAHpKa+cDMvIgtd7aOVe8z09HzO3lBRmhhnUVjFgZsNUDLvpMlz15kwt2J6bd6RaOSVSMQvB+nQ49KiLzFwPjCXNA1dh5ge5KYdo5XC+L+pkVwOtvYe0DziVerp3p9Z4g/iUq9Ikfgv3Ov1o5VtaiqRLa1+qXQ5mhAW5WAIu9vsNEb/qSrauyi57deT1bXy0u4HcyjB9ghFii0QaouCwJyZibHvi2JI+ZXfcUfP9G34+kspNSbwu8LrTif/1x59Ro4svNvwDOK4cWLMgN6lURDJRdC0z1Wx2qJRZrBc7T1gq8l4tQepAUxfRyKkMqGIGpJ5CjhYzqSRfERYzrO2gd8v8AD7OKMzI8acfHAFCQXNSfLNAGXPFdoIBrIIpo482ZlgYdzXhkBJAyCovNXkPnqhTIT1DnRN0LZOAcYAaSAdy1klPgLJk4YlxQJOJzCUb5nngMA9QosYpsbMEOG7OQjt6PTiTVT6AN6qKQOK2SxQaiHGVHMBLOacGOB82ay8VMK3YRAK5KQja8cAwdAEZ+QCW3cucolEf0PFiNycXr0isJNM5WMNzS6LidbZfWzYUHGrPw7UJqCvNOn3WGd4Loo8ClwO40Bf6lJul8sQNoKS+8umF3oPzdZt9pMzLQOOH3bVdLBY3ruujbZ3XMsyqDBxZs9GbxsN4ufvq6394Vw3kSn88OSU3lzm1s+ILPodReNhOc8zjNKcSpWpGwS+7CjxZlcxJ+/4tf/765B3M4fFgJJLegPqGgIfvjl68+u30FdvlEdrcv/3BaDDiI2t8KFH3XO08nnav7mpDS//2W6sdmIGuw9AqlJF1IvhVyxjnojf30v4za5yImfGBRVarDD19cKqu+fhzRY55aZyIOTrJkUZaKaTn38X6ufRF2A/fdw8XuN+L7VZAHS1o5oQ5qoqaKXtFy52nYz2uk44bOOJG4kUT194Z29lYuLExMLU1Gs/znGy4U7ZP0ScfzkQisvYZWMYXpXC44CcoLkQqLsSFiE/jOG9YKJ6vhEI9rXDK8o1ZZjSsuHJ9OryKdNj+YGC3pmSbJxsk/Jdx3arwE7fiW1r+vBZvvnxRoU1tJ83lGdd1/Tf6s7z3",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV+9u2zYQf5Urv6wFFNtJ0xYThmFdW7RBiyVoUhRYYgQn6WyzoUiWpOwYhr7tSfZoe5LhKMmWnTRthm77EjjU/fvdHe93XImAUy/Sc3FGpVUYyItxIgryuZM2SKNFKs5mBB9sgYGgk4LnJ0dAGjNFHpamgmCgNIWcLAF1AVUjHWYEBQWUyoOZAIK3lMuJzCG0dgYiEcaSQ3Z1VIhUNKqdH5EIiw5LCuQ4zJXQWJJIRWfgUhYiEZLDtBhmYjf2o5fsmQPpNCDMMIAmKjxHnVEbLdtx9LmSjgqRBldRInxYKvbmZWkVB0PXVpmCRDpB5Vkgn1GJIl2JsLRRMjippyIRE+NKDJuTuh439smHX02xZJ3tUE+cmcuCICNlFrCGzUF2+exqBA8xgCL0AYymnmwH4JFIRG50IB3YEVqrZB6TPPzk2dvqZugm+0R54Iw7LkmQ5Plrk/CvA+TkYExTKnz8sY5X1InQJtzbzAlDJHA0l7SIjeXlVEOYSQ+FyauS4dU7Jb+fi3VX9G3UrKMKctyRN+1ttFmyuQXHZyc90cwYRaj7srFh6joRQYYtz5e9Vr7MuDPqmuUceWu0b4pwMBrdbJj1ZWwbGHyV5+T9pFJq+eD7dUBz/LVcoC8O3viTwzeWs9KG9DzcrXQwOni8tz/aGz0723+aHv6YPnk6GI1Gv4tEXJdq036iaNuoy17zf+9AaiU1XXZZuzwYjS4ft6k8vC17bXPZ9tbNUckCJpJUAezTf8cEknPG/cPmvyO+u+Az5A784R2to02Aial08X/DvS2iuwEeXj5bQ3xyE+KRblLGTHVmrkj/Fwg3ePruQ+OeQ93uatkIxe9iC2z/vAHpKa+cDMvIgtd7aOVe8z09HzO3lBRmhhnUVjFgZsNUDLvpMlz15kwt2J6bd6RaOSVSMQvB+nQ49KiLzFwPjCXNA1dh5ge5KYdo5XC+L+pkVwOtvYe0DziVerp3p9Z4g/iUq9Ikfgv3Ov1o5VtaiqRLa1+qXQ5mhAW5WAIu9vsNEb/qSrauyi57deT1bXy0u4HcyjB9ghFii0QaouCwJyZibHvi2JI+ZXfcUfP9G34+kspNSbwu8LrTif/1x59Ro4svNvwDOK4cWLMgN6lURDJRdC0z1Wx2qJRZrBc7T1gq8l4tQepAUxfRyKkMqGIGpJ5CjhYzqSRfERYzrO2gd8v8AD7OKMzI8acfHAFCQXNSfLNAGXPFdoIBrIIpo482ZlgYdzXhkBJAyCovNXkPnqhTIT1DnRN0LZOAcYAaSAdy1klPgLJk4YlxQJOJzCUb5nngMA9QosYpsbMEOG7OQjt6PTiTVT6AN6qKQOK2SxQaiHGVHMBLOacGOB82ay8VMK3YRAK5KQja8cAwdAEZ+QCW3cucolEf0PFiNycXr0isJNM5WMNzS6LidbZfWzYUHGrPw7UJqCvNOn3WGd4Loo8ClwO40Bf6lJul8sQNoKS+8umF3oPzdZt9pMzLQOOH3bVdLBY3ruujbZ3XMsyqDBxZs9GbxsN4ufvq6394Vw3kSn88OSU3lzm1s+ILPodReNhOc8zjNKcSpWpGwS+7CjxZlcxJ+/4tf/765B3M4fFgJJLegPqGgIfvjl68+u30FdvlEdrcv/3BaDDiI2t8KFH3XO08nnav7mpDS//2W6sdmIGuw9AqlJF1IvhVyxjnojf30v4za5yImfGBRVarDD19cKqu+fhzRY55aZyIOTrJkUZaKaTn38X6ufRF2A/fdw8XuN+L7VZAHS1o5oQ5qoqaKXtFy52nYz2uk44bOOJG4kUT194Z29lYuLExMLU1Gs/znGy4U7ZP0ScfzkQisvYZWMYXpXC44CcoLkQqLsSFiE/jOG9YKJ6vhEI9rXDK8o1ZZjSsuHJ9OryKdNj+YGC3pmSbJxsk/Jdx3arwE7fiW1r+vBZvvnxRoU1tJ83lGdd1/Tf6s7z3",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},v=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.9bf52b52.js b/assets/js/5a2de241.9bf52b52.js deleted file mode 100644 index 00615cbb0..000000000 --- a/assets/js/5a2de241.9bf52b52.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const x={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV91u2zYUfpVT3qwFFNtJ0xYThmFdW7RBizVoUhRYYgRH0pHNhiJZkrJjGLrbk+zR9iTDoSRbcdK0HbrtJnCo8/edv49ci4AzL9IzcUqVVRjIi2kiCvK5kzZIo0UqTucE722BgaCXgqfHR0AaM0UeVqaGYKAyhSxXgLqAupUOc4KCAkrlwZSA4C3lspQ5hM7OSCTCWHLIro4KkYpWtfcjEmHRYUWBHIe5FhorEqnoDVzIQiRCcpgWw1zsxn70nD1zIL0GhDkG0ESF56gz6qJlO44+1dJRIdLgakqEDyvF3rysrOJg6MoqU5BIS1SeBfI5VSjStQgrGyWDk3omElEaV2HYnjTNtLVPPvxqihXrXA/12JmFLAgyUmYJG9gcZJ/PvkZwHwMoQh/AaBrI9gAeiETkRgfSgR2htUrmMcnjj569rW+GbrKPlAfOuOOSBEmev7YJ/zJATg7GNKXCxx+beEWTCG3CN5s5ZogEjhaSlrGxvJxpCHPpoTB5XTG8Zqfk3+Zi0xVDGw3rqIIcd+RNe1tt0TSJCDJcM3Ux6M2LjEvdNCznyFujfZvVg8nkZgdspqvrSPB1npP3Za3U6t73K2l7/CVw6IuDV/748JXlhHQhPQ13Kx1MDh7u7U/2Jk9O9x+nhz+mjx6PJpPJ7yIRV5Xa9pMour7os9f+PziQWklNF33WLg4mk4uHXSoPb8te1y22G6MFKllAKUkVwD79d0wgOWfcP+zmO+K7Cz5D7sEf3tE62gQoTa2L/xvubRHdDfDw4skG4qObEI90mzKmnlNzSfq/QLjFM3QfWvcc6vWulq1Q/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HHnWRmauRsaR5gyrM/Cg31RitHC/2RZPsaqC13yDtA86knu3dqTXdIj7hqrSJv4Z7k3608jWtRNKndSjVsf2csCAXS8DFfrdl1hd9yTZV2aWjno2+jmB2rxS3UsaQMQRXXurSRERdB7y1pE/YOPfPYv+G1Q+kclMRsz3fVnrxv/74M2r00cT2vgdvawfWLMmVtYpxl4quZKbaixkqZZabe5knrBR5r1YgdaCZi7HLmQyoIl6pZ5CjxUwqyQPBYoa1HQxmyo/gw5zCnBx/+sERIBS0IMVzBMqYS7YTDGAdTBV9dDHD0rjLkkNKACGrvdTkPXiiXoX0HHVO0DdIAsYBaiAdyFknPQHKioVL44DKUuaSDfP0O8wDVKhxRuwsAY6bs9AtWg/OZLUP4I2qI5B4WSUKLcR4ExzBc7mgFjgftrdWKmBWs4kEclMQdMuAYegCMvIBLLuXOUWjPqDje9mCXByIWEkmb7CGt5RExbfRYW3ZUHCoPa/SNqC+NJv0WWf4FhB9FLgawbk+1yfcLLUnbgAl9aVPz/UenG3a7ANlXgaa3u+HdLlc3hjOB9d1XsowrzNwZM1WbxYP4ygP1Tf/8FUzkKv82/KE3ELm1G2Gz/gcR+Fxt7sxj7ubKpSqHfxfdhV4mpTMSfvhTD99efwGFvBwNBHJYB19RcDjN0fPXvx28oLt8sJs529/NBlN+MgaHyrUA1c7b5/d0V1vSejffip16zHQVRhbhTJyTAS/7vjhTAy2XDp8JU0TMTc+sMh6naGn9041DR9/qskxC00TsUAnOdJIIoX0/LvYvHY+C/v+u/7dAd/24LoVUE8CmhlggaqOV+1EXNJq5+XXTJukZwKOuJV41sa1d8p2thZu3A+YyFqNp3lONtwpOyTk4/enIhFZ94qr4oNQOFzyCxKXIhXn4lzEl23cNywUz9dCoZ7VOGP51izzF9ZcuSH5XUby634wsFtTcp0VWyT8l3HdqvATt+JrWv28EW+/fFahS20vzeWZNk3zNzFrpuc=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV91u2zYUfpVT3qwFFNtJ0xYThmFdW7RBizVoUhRYYgRH0pHNhiJZkrJjGLrbk+zR9iTDoSRbcdK0HbrtJnCo8/edv49ci4AzL9IzcUqVVRjIi2kiCvK5kzZIo0UqTucE722BgaCXgqfHR0AaM0UeVqaGYKAyhSxXgLqAupUOc4KCAkrlwZSA4C3lspQ5hM7OSCTCWHLIro4KkYpWtfcjEmHRYUWBHIe5FhorEqnoDVzIQiRCcpgWw1zsxn70nD1zIL0GhDkG0ESF56gz6qJlO44+1dJRIdLgakqEDyvF3rysrOJg6MoqU5BIS1SeBfI5VSjStQgrGyWDk3omElEaV2HYnjTNtLVPPvxqihXrXA/12JmFLAgyUmYJG9gcZJ/PvkZwHwMoQh/AaBrI9gAeiETkRgfSgR2htUrmMcnjj569rW+GbrKPlAfOuOOSBEmev7YJ/zJATg7GNKXCxx+beEWTCG3CN5s5ZogEjhaSlrGxvJxpCHPpoTB5XTG8Zqfk3+Zi0xVDGw3rqIIcd+RNe1tt0TSJCDJcM3Ux6M2LjEvdNCznyFujfZvVg8nkZgdspqvrSPB1npP3Za3U6t73K2l7/CVw6IuDV/748JXlhHQhPQ13Kx1MDh7u7U/2Jk9O9x+nhz+mjx6PJpPJ7yIRV5Xa9pMour7os9f+PziQWklNF33WLg4mk4uHXSoPb8te1y22G6MFKllAKUkVwD79d0wgOWfcP+zmO+K7Cz5D7sEf3tE62gQoTa2L/xvubRHdDfDw4skG4qObEI90mzKmnlNzSfq/QLjFM3QfWvcc6vWulq1Q/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HHnWRmauRsaR5gyrM/Cg31RitHC/2RZPsaqC13yDtA86knu3dqTXdIj7hqrSJv4Z7k3608jWtRNKndSjVsf2csCAXS8DFfrdl1hd9yTZV2aWjno2+jmB2rxS3UsaQMQRXXurSRERdB7y1pE/YOPfPYv+G1Q+kclMRsz3fVnrxv/74M2r00cT2vgdvawfWLMmVtYpxl4quZKbaixkqZZabe5knrBR5r1YgdaCZi7HLmQyoIl6pZ5CjxUwqyQPBYoa1HQxmyo/gw5zCnBx/+sERIBS0IMVzBMqYS7YTDGAdTBV9dDHD0rjLkkNKACGrvdTkPXiiXoX0HHVO0DdIAsYBaiAdyFknPQHKioVL44DKUuaSDfP0O8wDVKhxRuwsAY6bs9AtWg/OZLUP4I2qI5B4WSUKLcR4ExzBc7mgFjgftrdWKmBWs4kEclMQdMuAYegCMvIBLLuXOUWjPqDje9mCXByIWEkmb7CGt5RExbfRYW3ZUHCoPa/SNqC+NJv0WWf4FhB9FLgawbk+1yfcLLUnbgAl9aVPz/UenG3a7ANlXgaa3u+HdLlc3hjOB9d1XsowrzNwZM1WbxYP4ygP1Tf/8FUzkKv82/KE3ELm1G2Gz/gcR+Fxt7sxj7ubKpSqHfxfdhV4mpTMSfvhTD99efwGFvBwNBHJYB19RcDjN0fPXvx28oLt8sJs529/NBlN+MgaHyrUA1c7b5/d0V1vSejffip16zHQVRhbhTJyTAS/7vjhTAy2XDp8JU0TMTc+sMh6naGn9041DR9/qskxC00TsUAnOdJIIoX0/LvYvHY+C/v+u/7dAd/24LoVUE8CmhlggaqOV+1EXNJq5+XXTJukZwKOuJV41sa1d8p2thZu3A+YyFqNp3lONtwpOyTk4/enIhFZ94qr4oNQOFzyCxKXIhXn4lzEl23cNywUz9dCoZ7VOGP51izzF9ZcuSH5XUby634wsFtTcp0VWyT8l3HdqvATt+JrWv28EW+/fFahS20vzeWZNk3zNzFrpuc=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.46db2c31.js b/assets/js/bbdfc22d.46db2c31.js deleted file mode 100644 index 2a6de6036..000000000 --- a/assets/js/bbdfc22d.46db2c31.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=n(85893),i=n(11151),l=n(58219),t=(n(62316),n(51039)),r=n.n(t),d=(n(82723),n(9487)),c=(n(41429),n(5397)),o=n(4667),m=n(9472),h=n(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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhfNTp4MoWQCNkdHqEZba2mAQy3Fhxqh14vQlyLr9cDm3ELKJUyQ2MmIm0AQdsiZcJpT0iE2FaZiKgg44BqM5Vi+qwrFM1iqGqpsCkKCqjWc93qvcVLP4N1Jr3fxVW5tZUYHB7yqBqpCacRMFnxiBqkqDzICrLLpI8hRo8NEpGWaz2EushlaA1xmkKpqCanqKy0yyS0mUPEZgqzLCWpQU6KyHAAvjGqQuDXExtNjgnjz+h+O6F7vJRaqg14jmLqqlLaYEQ/EcJTDqNejNa9UWSoJFde8REsmoKYRwYgA+iTmZYWjXg9OZCZSMgOHiUZb6IEHJeIJ9CzI1YOusSSDDRE3cy4tqakqeIoOVCOpxIprXEe8SGBJiF+jVJGCXGnxq5KWF06U16itSHkBqVI6E9JR6iUIxnLtzLJSQto4GnaAfwbB1sYTkQUtE2kZiaUU0s0YhGte1GgCVfMEcqLqJ6w0GmdeAa/NHU05ilm+cz+eva+NXUMMtSEyu1SEvTR+qIXGzIkXndimvDAIYromy5JfYWc3UM4H8GIAL5eQ4ZTXhU1A2C8NWF3jAH5UFnhVFSJ1h53OMZkypyPad1oOBhEIkbx0On6j1bXIkE5kJqZT1Cgt0KRDEa0wUEfGWLkFxF6pNNHIJSjZUfRwAL1es7cz0V9++WUsb8YSYMyIljEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuwqZHjhjLy+oOQmj69ycifnrVGRp0O9NYNAMaJP15WJoh0dNoQxZNrFqGHhNDQgoreGF28xQhHh5bLWUbnB0TZ1hyUexmy00/PJ4CWRsMPRm052wHPx7FQ2PH/9rg5ilx815NwApb3MFSA/Lw+OqQtsHcM2IuVWXF5XI3awHg4THWELbB1nNiK+P2DnXR7MNjKFAVJ8KF5+cOj/vDJ/2jw6PjDsRU6ZIHgLLsZ1l/uVwuxwxaiYDjn+6+gI6uv3j/+buaYsypVuWW4MbFHi1UiAXc7xgQ/EBhwCTekG201oannsr1O9yqjC+/NB5VXBouaQ/fhmLLDpluiuhYUlSb5kqkgXiCCYKHCQWTAxJCn+SYHfzww4GXTNIO9ssyiMvrgkbpu+8k2R0ty0GWDTZhuwLvjpaQZQlsGd8+kWVQluWucT9BJj6Wfxm4d8PCTtRit2kHgIdn3S1hWw08XApxLhcyTATrgA0AjbO64BoXFL4aoaTj/pYz2LD8aPg8mqKPXV3Y514Gnkj46jSEno+CURI96who5P51t8jsItE4w4XD4d+sRIzIwuPR1GlO71T3yqXIU8liGZ4iJvFfKa8EvSEKtNaNok0H60SM5fDQ+fkc06s7LSdCPDzT6VAWJ/2Tg6bPx6zk4eJlU2x/K5ujHrOLZo3BAlOLWWctbFsMFx0r4xlJmoDdk6UlLxcZFnyCRTvXIS6oscMqTZRCeiKiGA4jPjfLFxuzYXK1xag9E11rit4v2mSUGhTCxLfougi6q8MbzmUiJPoUxAQhLoBJ4723GbmXUud9R6rcfN4ZtOuEcQNx6ZYnnpNpPH1B1vfsQHDgAJvnc9xs1waBhTXNdOVCOEohRVmXndRGxBolVoZbsCsuWkm5qbhDV7u3duCLe3YI2aEdG4zl0L1AM62qTM2lO+WwPfYJIA/vmHco+y3HfO1a8XC/5RhFqrrHaMuNQqD+LmmOkNl9hgZwSv6bUgh+kTDA0xQri9mGAx+617zmmVAwqa1VcrcL70I9PP1uUPcH6JgY/jgtd2n7szQ9lkOf6Ch9KnJXlqN0+nxo2g1kbVdDuOIkS5iqXJ5dyZOMjZjP2ccMNkvcVmjsS5Ut2eiGpUpalJZ+hkQfLT14b6g2cMNMmmPJ6VckkaoJU1EQKsq1oTYsYe79S6UFEiIbMTV5j6llCQWXFeVe0RAOt250E6GM1ULOWBLeWWzEfOaaJQwXvKwIOAwBylTR68ehWMUd78LVjLS4jPvR5PMJD6WMPxONW7raKKd8FqYuhlUr1xYZ15ov2WblJuaKYwTv1zVZ3WIZr29hKRSI4YUHYwkTFsvuLju0ptWnSzpFRZy4FNanrnVq4eUn70nrqlzJz1oYctJbZP6RUvKztzdeV9kLemxgFqPBfptOT8ClZgf3WUyEd9zyWXdPH9zc2vPtrjJLpxJgclUXGeX6keuBq3Z8flmLSoW8SGtXrWu8+RpnDakNZ8NVwhb3M7PwFTFfw4GvCpxaqKsKNaRKS9SPuqmWB8Pc0fHxKmHL+9lb/k+y94yUN7+fu59d8astDP4ZtD5+vkpYfj+t3zbluT+R2OOnq/au27jLLycqW15Gv7W6DzBeKgRnUGYn8lRnqDuCmChVIJfd/d0L7h7Mfus2PKD4xQ2YSknjnePR4SH92/BLawV9qv43xf5i+QVLPj42udsz+2GKhm5759axvsyPvjWVLNOcPGuJxqw71y1L7mGgKzchCyHxMgrl8ujw8PIJSW6VsONtwjlTJdqc0lJzqp3OtZKzBKoCORWi9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9JlelyPx1t1hfKP5bS7vfXbE6mL0oU0PkRhwgO5ebbGbHfcM2kwrbWwSzY6v2GLPq9E38+Pzi9WF2R1NlcUtVfKOIq5zdmIHdwK4l2TDUWI5zes1gUbseiFDJcZZWNueSJeiYPrIVslmyu2+q2d0MbymZCz/p2rLlpWz0gdXuJrDLdhViW+Q4qzgjy7UAkTZAY5cvJUJEHS8k/tC+brqKv4ttj6XGiVsvkAiPH/Wki/eRNsCdI7Mfp5DJBdzNuEvKzliDVhKf1sAs3z1vSamC6GdEMXCx0dH7ug4dnQ3a6Pn7uL6/jp6sJLuOPEvaMmeU2VE25g+LRCeSZmvp/renj7RsYiVSW6fF+OEMH/869/uxWxJcgdsS/gtNZQqTlq6seiHpZpgQtBnSGddjF6cLhkJC8LNIZeIdLizLdaiZnLpxPH5EFSXvGJKAQdSgJTvu7UOddmAD/nSOkJmvpS+9LCNRZ0lqFQ6sr1xCjgtVVlt50L5kpfTYmkBDhMqHkGjQGDGJegzLlMKavgbTUBpYFLQGlRV1oYBC5KAqYsBk6nIhWEmDyQ5qmFkks+Q9oscZEBSaGKrS9aTShpaVRR+1QINeAgWs+iy2oM4DV1MznGaTBDy0WBGcxqQpEAGTEEh0RsyAwmaCxUtL1I0bRFxAKvUbuz6TRJdxBUijyl4AWFMV3dEiKruTQUe3iComoa8VVa0WXm9sj4cgCUQCHnT4EQGUAh5BV1gvXhvDGzn3FihMU2KprP57f8xKP1Nd8Im9cT0Fipdt3MDTqv0l3efDyiU426NKfTM9TXIsXgpHbseeCAD8L9wVN3f8Szyivx980F5MsLkaI02PH2L7558z1cw+PBIUs6nvEjCD74/uTV1z+efU14yXf78zccHA4O3VNOGVty2dnqle+2fNv6qo1EQ3MR7ls49y2c+xbOfQvnvoVz38K5b+F8SDztWzj3LZz7Fs7fs4Vh38K5b+Ec71s4Yd/CuW/h3Ldw7ls49y2c+xbOfQvnvoVz38L5f9TCGeqCFDEdVAUXrrDsqg03oSZ8vtnYeZGwnIrGo3N2c0PZ43e6WK1o+EONmirOFwm75lpQFtDVm5NYV6VK5BUuqeTgKwr9t7R/4q3OlUc2yuxUFvYrXjg13QnbrWu/OT17yxI2Cc2npcpojeZzakzlczai6JS5JlYnYdd+yF1nUcHlrHbFUebxUjmY1zZfryVfuVpy+NGpsXK57FC5XmT2rNBfYmzrgr9SjeI7XP6tAfczOxcE2UZoUuHFarX6L+XZB5g=",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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhfNTp4MoWQCNkdHqEZba2mAQy3Fhxqh14vQlyLr9cDm3ELKJUyQ2MmIm0AQdsiZcJpT0iE2FaZiKgg44BqM5Vi+qwrFM1iqGqpsCkKCqjWc93qvcVLP4N1Jr3fxVW5tZUYHB7yqBqpCacRMFnxiBqkqDzICrLLpI8hRo8NEpGWaz2EushlaA1xmkKpqCanqKy0yyS0mUPEZgqzLCWpQU6KyHAAvjGqQuDXExtNjgnjz+h+O6F7vJRaqg14jmLqqlLaYEQ/EcJTDqNejNa9UWSoJFde8REsmoKYRwYgA+iTmZYWjXg9OZCZSMgOHiUZb6IEHJeIJ9CzI1YOusSSDDRE3cy4tqakqeIoOVCOpxIprXEe8SGBJiF+jVJGCXGnxq5KWF06U16itSHkBqVI6E9JR6iUIxnLtzLJSQto4GnaAfwbB1sYTkQUtE2kZiaUU0s0YhGte1GgCVfMEcqLqJ6w0GmdeAa/NHU05ilm+cz+eva+NXUMMtSEyu1SEvTR+qIXGzIkXndimvDAIYromy5JfYWc3UM4H8GIAL5eQ4ZTXhU1A2C8NWF3jAH5UFnhVFSJ1h53OMZkypyPad1oOBhEIkbx0On6j1bXIkE5kJqZT1Cgt0KRDEa0wUEfGWLkFxF6pNNHIJSjZUfRwAL1es7cz0V9++WUsb8YSYMyIljEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuwqZHjhjLy+oOQmj69ycifnrVGRp0O9NYNAMaJP15WJoh0dNoQxZNrFqGHhNDQgoreGF28xQhHh5bLWUbnB0TZ1hyUexmy00/PJ4CWRsMPRm052wHPx7FQ2PH/9rg5ilx815NwApb3MFSA/Lw+OqQtsHcM2IuVWXF5XI3awHg4THWELbB1nNiK+P2DnXR7MNjKFAVJ8KF5+cOj/vDJ/2jw6PjDsRU6ZIHgLLsZ1l/uVwuxwxaiYDjn+6+gI6uv3j/+buaYsypVuWW4MbFHi1UiAXc7xgQ/EBhwCTekG201oannsr1O9yqjC+/NB5VXBouaQ/fhmLLDpluiuhYUlSb5kqkgXiCCYKHCQWTAxJCn+SYHfzww4GXTNIO9ssyiMvrgkbpu+8k2R0ty0GWDTZhuwLvjpaQZQlsGd8+kWVQluWucT9BJj6Wfxm4d8PCTtRit2kHgIdn3S1hWw08XApxLhcyTATrgA0AjbO64BoXFL4aoaTj/pYz2LD8aPg8mqKPXV3Y514Gnkj46jSEno+CURI96who5P51t8jsItE4w4XD4d+sRIzIwuPR1GlO71T3yqXIU8liGZ4iJvFfKa8EvSEKtNaNok0H60SM5fDQ+fkc06s7LSdCPDzT6VAWJ/2Tg6bPx6zk4eJlU2x/K5ujHrOLZo3BAlOLWWctbFsMFx0r4xlJmoDdk6UlLxcZFnyCRTvXIS6oscMqTZRCeiKiGA4jPjfLFxuzYXK1xag9E11rit4v2mSUGhTCxLfougi6q8MbzmUiJPoUxAQhLoBJ4723GbmXUud9R6rcfN4ZtOuEcQNx6ZYnnpNpPH1B1vfsQHDgAJvnc9xs1waBhTXNdOVCOEohRVmXndRGxBolVoZbsCsuWkm5qbhDV7u3duCLe3YI2aEdG4zl0L1AM62qTM2lO+WwPfYJIA/vmHco+y3HfO1a8XC/5RhFqrrHaMuNQqD+LmmOkNl9hgZwSv6bUgh+kTDA0xQri9mGAx+617zmmVAwqa1VcrcL70I9PP1uUPcH6JgY/jgtd2n7szQ9lkOf6Ch9KnJXlqN0+nxo2g1kbVdDuOIkS5iqXJ5dyZOMjZjP2ccMNkvcVmjsS5Ut2eiGpUpalJZ+hkQfLT14b6g2cMNMmmPJ6VckkaoJU1EQKsq1oTYsYe79S6UFEiIbMTV5j6llCQWXFeVe0RAOt250E6GM1ULOWBLeWWzEfOaaJQwXvKwIOAwBylTR68ehWMUd78LVjLS4jPvR5PMJD6WMPxONW7raKKd8FqYuhlUr1xYZ15ov2WblJuaKYwTv1zVZ3WIZr29hKRSI4YUHYwkTFsvuLju0ptWnSzpFRZy4FNanrnVq4eUn70nrqlzJz1oYctJbZP6RUvKztzdeV9kLemxgFqPBfptOT8ClZgf3WUyEd9zyWXdPH9zc2vPtrjJLpxJgclUXGeX6keuBq3Z8flmLSoW8SGtXrWu8+RpnDakNZ8NVwhb3M7PwFTFfw4GvCpxaqKsKNaRKS9SPuqmWB8Pc0fHxKmHL+9lb/k+y94yUN7+fu59d8astDP4ZtD5+vkpYfj+t3zbluT+R2OOnq/au27jLLycqW15Gv7W6DzBeKgRnUGYn8lRnqDuCmChVIJfd/d0L7h7Mfus2PKD4xQ2YSknjnePR4SH92/BLawV9qv43xf5i+QVLPj42udsz+2GKhm5759axvsyPvjWVLNOcPGuJxqw71y1L7mGgKzchCyHxMgrl8ujw8PIJSW6VsONtwjlTJdqc0lJzqp3OtZKzBKoCORWi9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9JlelyPx1t1hfKP5bS7vfXbE6mL0oU0PkRhwgO5ebbGbHfcM2kwrbWwSzY6v2GLPq9E38+Pzi9WF2R1NlcUtVfKOIq5zdmIHdwK4l2TDUWI5zes1gUbseiFDJcZZWNueSJeiYPrIVslmyu2+q2d0MbymZCz/p2rLlpWz0gdXuJrDLdhViW+Q4qzgjy7UAkTZAY5cvJUJEHS8k/tC+brqKv4ttj6XGiVsvkAiPH/Wki/eRNsCdI7Mfp5DJBdzNuEvKzliDVhKf1sAs3z1vSamC6GdEMXCx0dH7ug4dnQ3a6Pn7uL6/jp6sJLuOPEvaMmeU2VE25g+LRCeSZmvp/renj7RsYiVSW6fF+OEMH/869/uxWxJcgdsS/gtNZQqTlq6seiHpZpgQtBnSGddjF6cLhkJC8LNIZeIdLizLdaiZnLpxPH5EFSXvGJKAQdSgJTvu7UOddmAD/nSOkJmvpS+9LCNRZ0lqFQ6sr1xCjgtVVlt50L5kpfTYmkBDhMqHkGjQGDGJegzLlMKavgbTUBpYFLQGlRV1oYBC5KAqYsBk6nIhWEmDyQ5qmFkks+Q9oscZEBSaGKrS9aTShpaVRR+1QINeAgWs+iy2oM4DV1MznGaTBDy0WBGcxqQpEAGTEEh0RsyAwmaCxUtL1I0bRFxAKvUbuz6TRJdxBUijyl4AWFMV3dEiKruTQUe3iComoa8VVa0WXm9sj4cgCUQCHnT4EQGUAh5BV1gvXhvDGzn3FihMU2KprP57f8xKP1Nd8Im9cT0Fipdt3MDTqv0l3efDyiU426NKfTM9TXIsXgpHbseeCAD8L9wVN3f8Szyivx980F5MsLkaI02PH2L7558z1cw+PBIUs6nvEjCD74/uTV1z+efU14yXf78zccHA4O3VNOGVty2dnqle+2fNv6qo1EQ3MR7ls49y2c+xbOfQvnvoVz38K5b+F8SDztWzj3LZz7Fs7fs4Vh38K5b+Ec71s4Yd/CuW/h3Ldw7ls49y2c+xbOfQvnvoVz38L5f9TCGeqCFDEdVAUXrrDsqg03oSZ8vtnYeZGwnIrGo3N2c0PZ43e6WK1o+EONmirOFwm75lpQFtDVm5NYV6VK5BUuqeTgKwr9t7R/4q3OlUc2yuxUFvYrXjg13QnbrWu/OT17yxI2Cc2npcpojeZzakzlczai6JS5JlYnYdd+yF1nUcHlrHbFUebxUjmY1zZfryVfuVpy+NGpsXK57FC5XmT2rNBfYmzrgr9SjeI7XP6tAfczOxcE2UZoUuHFarX6L+XZB5g=",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 s={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,a.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(s.p,{children:["Upload you pdf in our ",(0,a.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(s.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)(s.p,{children:(0,a.jsx)(s.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(s.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"2",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"3",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"4",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"5",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"6",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"7",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"8",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(s.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"9",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"10",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"11",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"12",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"13",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{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)(s.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{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)(s.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(s.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)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{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)(s.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.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)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.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)(o.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)(o.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)(o.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)(o.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)(o.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)(s.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)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(l.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.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)(n,{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)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(o.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)(c.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)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.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)(n,{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)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.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)(c.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)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.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)(n,{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)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.a870fd3b.js b/assets/js/bbdfc22d.a870fd3b.js new file mode 100644 index 000000000..7e387ea6c --- /dev/null +++ b/assets/js/bbdfc22d.a870fd3b.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:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var a=s(85893),i=s(11151),r=s(58219),t=(s(62316),s(51039)),l=s.n(t),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UHGg2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3N2hmVVcIuGXSQsQ5NqUVmhJBuxsxwhTsMrjZzG4cWbE+BFoeYGaoPagFWQ0iRCWhurSvErnxQINiJOYJ6LNAeD+hqBG5gUNVZaSGtgqjTMUKLmVsgZZCqtS6SJubA5VBoznAqJGRir69TWGs0A3lVKgqnTFI2Z1kWzkydDKJmAzdERqtHWWhrgUEvxoUbo9SL0pch6PbA5t5ByCRMkdjLiJhCEHXImnOaUdIhNhamYCgIOuAZjOZbvqkLxDJaqhiqbgpCgag3nvd5rnNQzeHfS6118lVtbmdHBAa+qgapQGjGTBZ+YQarKg4wAq2z6CHLU6DARaZnmc5iLbIbWAJcZpKpaQqr6SotMcosJVHyGIOtyghrUlKgsB8ALoxokbg2x8fSYIN68/ocjutd7iYXqoNcIpq4qpS1mxAMxHOUw6vVozStVlkpCxTUv0ZIJqGlEMCKAPol5WeGo14MTmYmUzMBhotEWeuBBiXgCfRvk6kHXWJLBhoibOZeW1FQVPEUHqpFUYsU1riNeJLAkxK9RqkhBrrT4VUnLCyfKa9RWpLyAVCmdCeko9RIEY7l2ZlkpIW0cDTvAP4Nga+OJyIKWibSMxFIK6WYMwjUvajSBqnkCOVH1E1YajTOvgNfmjqYcxSzfuR/P3tfGriGG2hCZXSrCXho/1EJj5sSLTmxTXhgEMV2TZcmvsLMbKOcDeDGAl0vIcMrrwiYg7JcGrK5xAD8qC7yqCpG6w07nmEyZ0xHtOy0HgwiESF46Hb/R6lpkSCcyE9MpapQWaNKhiFYYqCNjrNwCYq9UmmjkEpTsKHo4gF6v2duZ6C+//DKWN2MJMGZEy5iNxqwBGbME/ByZ2JiNhgmEgcWYjeDx0bMIsKTvp0fP4/ecvofD4/id0/fRcCxXYdMjR4zlZXUHITT9+xMRP73qDA26nWksmgENkv48LM2Q6Gm0IYsmVi1Dj4khIYUVvDC7eYoQD4+tlrINzo6JMyy5KHaz5aYfHk+BrA2Gngzac7aDH4/iobHjf21w85S4ea8mYIUt7mCpAXl4fHVI22DuGTGXqrLicrmbtQDw8BhrCNtg6zmxlXF7h7po9uExFKiKE+HC83OHx/3hk/7R4dFxB2KqdMkDQFn2s6y/XC6XYwatRMDxT3dfQEfXX7z//F1NMeZUq3JLcONijxYqxALudwwIfqAwYBJvyDZaa8NTT+X6HW5VxpdfGo8qLg2XtIdvQ7Flh0w3RXQsKapNcyXSQDzBBMHDhILJAQmhT3LMDn744cBLJmkH+2UZxOV1QaP03XeS7I6W5SDLBpuwXYF3R0vIsgS2jG+fyDIoy3LXuJ8gEx/Lvwzcu2FhJ2qx27QDwMOz7pawrQYeLoU4lwsZJoJ1wAaAxlldcI0LCl+NUNJxf8sZbFh+NHweTdHHri7scy8DTyR8dRpCz0fBKImedQQ0cv+6W2R2kWic4cLh8G9WIkZk4fFo6jSnd6p75VLkqWSxDE8Rk/ivlFeC3hAFWutG0aaDdSLGcnjo/HyO6dWdlhMhHp7pdCiLk/7JQdPnY1bycPGyKba/lc1Rj9lFs8ZgganFrLMWti2Gi46V8YwkTcDuydKSl4sMCz7Bop3rEBfU2GGVJkohPRFRDIcRn5vli43ZMLnaYtSeia41Re8XbTJKDQph4lt0XQTd1eEN5zIREn0KYoIQF8Ck8d7bjNxLqfO+I1VuPu8M2nXCuIG4dMsTz8k0nr4g63t2IDhwgM3zOW62a4PAwppmunIhHKWQoqzLTmojYo0SK8Mt2BUXraTcVNyhq91bO/DFPTuE7NCODcZy6F6gmVZVpubSnXLYHvsEkId3zDuU/ZZjvnateLjfcowiVd1jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Eenn43qPsDdEwMf5yWu7T9WZoey6FPdJQ+Fbkry1E6fT407QaytqshXHGSJUxVLs+u5EnGRszn7GMGmyVuKzT2pcqWbHTDUiUtSks/Q6KPlh68N1QbuGEmzbHk9CuSSNWEqSgIFeXaUBuWMPf+pdICCZGNmJq8x9SyhILLinKvaAiHWze6iVDGaiFnLAnvLDZiPnPNEoYLXlYEHIYAZaro9eNQrOKOd+FqRlpcxv1o8vmEh1LGn4nGLV1tlFM+C1MXw6qVa4uMa82XbLNyE3PFMYL365qsbrGM17ewFArE8MKDsYQJi2V3lx1a0+rTJZ2iIk5cCutT1zq18PKT96R1Va7kZy0MOektMv9IKfnZ2xuvq+wFPTYwi9Fgv02nJ+BSs4P7LCbCO275rLunD25u7Xm2q8zSqQSYXNVFRrl+5Hrgqh2fX9aiUiEv0tpV6xpvvsZZQ2rD2XCVsMX9zCx8RczXcOCrAqcW6qpCDanSEvWjbqrlwTB3dHy8StjyfvaW/5PsPSPlze/n7mdX/GoLg38GrY+frxKW30/rt0157k8k9vjpqr3rNu7yy4nKlpfRb63uA4yXCsEZlNmJPNUZ6o4gJkoVyGV3f/eCIz8uqf53evbmY8DvJsRT2kYTFO64AVMpabwvPTo8pH8bbmyt/k/NAk1vQLH8giUfH8rc7cj9MAVPt51564df5kffmkqWaU6OuERj1n3xliX3MNCVm5CFkHgZhXJ5dHh4+YQkt0rY8TbhvFUl2pyyWHMqtc61krMEqgI51a31EviMCwm0vf4dZYVaK303159G2V1COD48vBw2QnhyWwgn0iWGXEvImbpC+cdy2t3e+u2J1EXpIiAf0TDhgdw8W2O2O+6ZNJjWWtglG53fsEWfV6Lv50fnF6sLsjqbKwryK2UcxdzmbMQObsX8rieHAsrzG1brgo1YdFqGy4ySN7ccF6/EwfWQrZLNFVvd3E5oY/lMyFn/zlUXLatvSR1e4msMt1FZJb5DCsuCPLtQCRNkBjlycmwkQdLyT+2D5+uoq/gU2fq6aJWy+V6Iz4W1F8DmxbElpu+E9OcxnnYhchMhs5Yj1kSx9LOJS89b02tCwBgBDl3odHR87GKMZ0N3GT9+7u6546erCy/hjs/36dSuW4+eXsipcuIOIjitUL4VM98Qdj28faVjkaoSXcIwR4jg//nXv92K2FPkDt0XcFprqNQcNTV0URPMtMCFoNaSTr8ZvVhcNpOXBRpDzxhpceZ7tcTMJeRJBuRTUl7xiSgEHVMCU75w1TnpZgA/50j5DZr6UvvaxDUWdLqhUOrKNdUo4LVVZbcfDOZKX02JpAQ4TKj7Bo0BgxiXoMy5TCkt4a03AaWBS0BpUVdaGAQuSgKmNAhOpyIVhJh8kuaphZJLPkPaLHGhBUmhir0zWk0o62lUUftcCnXwIFrPokuLDOA1tUM5xmkwQ8tFgRnMakKRAJk1BBdFbMgMJmgsVLS9SNG0VcgCr1G70+o0SbcSVIp8p+AFxUFd3RIiq7k0FLx4gqJqGvFVWtH15vbI+HIAlIGh64AiKTKAQsgraiXrw3ljZj/jxAiLbVg1n89veY5H62u+ETavJ6CxUu26mRt0fqa7vPl4ROccdWlOp29RX4sUg9vaseeBAz4INwpP3Y0STy+vxN83F5B3L0SK0mDH/7/45s33cA2PB4cs6fjKjyD44PuTV1//+PZrwkve3J+/4eBwcOjegsrYksvOVq98u+ZZ6702MhXN1bjvAd33gO57QPc9oPse0H0P6L4H9CHxtO8B3feA7ntAf88eiH0P6L4HdLzvAYV9D+i+B3TfA7rvAd33gO57QPc9oPse0H0P6P9RD2ioFFLEdFAVXLhSs6s23IQq8flmZ+hFwnIqI4/O2c0NZY/f6WK1ouEPNWqqQV8k7JprQVlAV4FOYqWVapNXuKSSg68o9M9o/8RbnSuPbBTeqVDsV7xwaroTtlvpfnP69owlbBK6V0uV0RrN59TZyudsRNEpc12wTsKuf5G71qSCy1ntyqXM46UCMa9tvl5dvnLV5fCjU3Xlctmhcr3s7Fmhv8TY1gV/pRrFd7j8WwPuZ3YuCLKN0KTCi9Vq9V9Npx2o",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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UHGg2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3N2hmVVcIuGXSQsQ5NqUVmhJBuxsxwhTsMrjZzG4cWbE+BFoeYGaoPagFWQ0iRCWhurSvErnxQINiJOYJ6LNAeD+hqBG5gUNVZaSGtgqjTMUKLmVsgZZCqtS6SJubA5VBoznAqJGRir69TWGs0A3lVKgqnTFI2Z1kWzkydDKJmAzdERqtHWWhrgUEvxoUbo9SL0pch6PbA5t5ByCRMkdjLiJhCEHXImnOaUdIhNhamYCgIOuAZjOZbvqkLxDJaqhiqbgpCgag3nvd5rnNQzeHfS6118lVtbmdHBAa+qgapQGjGTBZ+YQarKg4wAq2z6CHLU6DARaZnmc5iLbIbWAJcZpKpaQqr6SotMcosJVHyGIOtyghrUlKgsB8ALoxokbg2x8fSYIN68/ocjutd7iYXqoNcIpq4qpS1mxAMxHOUw6vVozStVlkpCxTUv0ZIJqGlEMCKAPol5WeGo14MTmYmUzMBhotEWeuBBiXgCfRvk6kHXWJLBhoibOZeW1FQVPEUHqpFUYsU1riNeJLAkxK9RqkhBrrT4VUnLCyfKa9RWpLyAVCmdCeko9RIEY7l2ZlkpIW0cDTvAP4Nga+OJyIKWibSMxFIK6WYMwjUvajSBqnkCOVH1E1YajTOvgNfmjqYcxSzfuR/P3tfGriGG2hCZXSrCXho/1EJj5sSLTmxTXhgEMV2TZcmvsLMbKOcDeDGAl0vIcMrrwiYg7JcGrK5xAD8qC7yqCpG6w07nmEyZ0xHtOy0HgwiESF46Hb/R6lpkSCcyE9MpapQWaNKhiFYYqCNjrNwCYq9UmmjkEpTsKHo4gF6v2duZ6C+//DKWN2MJMGZEy5iNxqwBGbME/ByZ2JiNhgmEgcWYjeDx0bMIsKTvp0fP4/ecvofD4/id0/fRcCxXYdMjR4zlZXUHITT9+xMRP73qDA26nWksmgENkv48LM2Q6Gm0IYsmVi1Dj4khIYUVvDC7eYoQD4+tlrINzo6JMyy5KHaz5aYfHk+BrA2Gngzac7aDH4/iobHjf21w85S4ea8mYIUt7mCpAXl4fHVI22DuGTGXqrLicrmbtQDw8BhrCNtg6zmxlXF7h7po9uExFKiKE+HC83OHx/3hk/7R4dFxB2KqdMkDQFn2s6y/XC6XYwatRMDxT3dfQEfXX7z//F1NMeZUq3JLcONijxYqxALudwwIfqAwYBJvyDZaa8NTT+X6HW5VxpdfGo8qLg2XtIdvQ7Flh0w3RXQsKapNcyXSQDzBBMHDhILJAQmhT3LMDn744cBLJmkH+2UZxOV1QaP03XeS7I6W5SDLBpuwXYF3R0vIsgS2jG+fyDIoy3LXuJ8gEx/Lvwzcu2FhJ2qx27QDwMOz7pawrQYeLoU4lwsZJoJ1wAaAxlldcI0LCl+NUNJxf8sZbFh+NHweTdHHri7scy8DTyR8dRpCz0fBKImedQQ0cv+6W2R2kWic4cLh8G9WIkZk4fFo6jSnd6p75VLkqWSxDE8Rk/ivlFeC3hAFWutG0aaDdSLGcnjo/HyO6dWdlhMhHp7pdCiLk/7JQdPnY1bycPGyKba/lc1Rj9lFs8ZgganFrLMWti2Gi46V8YwkTcDuydKSl4sMCz7Bop3rEBfU2GGVJkohPRFRDIcRn5vli43ZMLnaYtSeia41Re8XbTJKDQph4lt0XQTd1eEN5zIREn0KYoIQF8Ck8d7bjNxLqfO+I1VuPu8M2nXCuIG4dMsTz8k0nr4g63t2IDhwgM3zOW62a4PAwppmunIhHKWQoqzLTmojYo0SK8Mt2BUXraTcVNyhq91bO/DFPTuE7NCODcZy6F6gmVZVpubSnXLYHvsEkId3zDuU/ZZjvnateLjfcowiVd1jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Eenn43qPsDdEwMf5yWu7T9WZoey6FPdJQ+Fbkry1E6fT407QaytqshXHGSJUxVLs+u5EnGRszn7GMGmyVuKzT2pcqWbHTDUiUtSks/Q6KPlh68N1QbuGEmzbHk9CuSSNWEqSgIFeXaUBuWMPf+pdICCZGNmJq8x9SyhILLinKvaAiHWze6iVDGaiFnLAnvLDZiPnPNEoYLXlYEHIYAZaro9eNQrOKOd+FqRlpcxv1o8vmEh1LGn4nGLV1tlFM+C1MXw6qVa4uMa82XbLNyE3PFMYL365qsbrGM17ewFArE8MKDsYQJi2V3lx1a0+rTJZ2iIk5cCutT1zq18PKT96R1Va7kZy0MOektMv9IKfnZ2xuvq+wFPTYwi9Fgv02nJ+BSs4P7LCbCO275rLunD25u7Xm2q8zSqQSYXNVFRrl+5Hrgqh2fX9aiUiEv0tpV6xpvvsZZQ2rD2XCVsMX9zCx8RczXcOCrAqcW6qpCDanSEvWjbqrlwTB3dHy8StjyfvaW/5PsPSPlze/n7mdX/GoLg38GrY+frxKW30/rt0157k8k9vjpqr3rNu7yy4nKlpfRb63uA4yXCsEZlNmJPNUZ6o4gJkoVyGV3f/eCIz8uqf53evbmY8DvJsRT2kYTFO64AVMpabwvPTo8pH8bbmyt/k/NAk1vQLH8giUfH8rc7cj9MAVPt51564df5kffmkqWaU6OuERj1n3xliX3MNCVm5CFkHgZhXJ5dHh4+YQkt0rY8TbhvFUl2pyyWHMqtc61krMEqgI51a31EviMCwm0vf4dZYVaK303159G2V1COD48vBw2QnhyWwgn0iWGXEvImbpC+cdy2t3e+u2J1EXpIiAf0TDhgdw8W2O2O+6ZNJjWWtglG53fsEWfV6Lv50fnF6sLsjqbKwryK2UcxdzmbMQObsX8rieHAsrzG1brgo1YdFqGy4ySN7ccF6/EwfWQrZLNFVvd3E5oY/lMyFn/zlUXLatvSR1e4msMt1FZJb5DCsuCPLtQCRNkBjlycmwkQdLyT+2D5+uoq/gU2fq6aJWy+V6Iz4W1F8DmxbElpu+E9OcxnnYhchMhs5Yj1kSx9LOJS89b02tCwBgBDl3odHR87GKMZ0N3GT9+7u6546erCy/hjs/36dSuW4+eXsipcuIOIjitUL4VM98Qdj28faVjkaoSXcIwR4jg//nXv92K2FPkDt0XcFprqNQcNTV0URPMtMCFoNaSTr8ZvVhcNpOXBRpDzxhpceZ7tcTMJeRJBuRTUl7xiSgEHVMCU75w1TnpZgA/50j5DZr6UvvaxDUWdLqhUOrKNdUo4LVVZbcfDOZKX02JpAQ4TKj7Bo0BgxiXoMy5TCkt4a03AaWBS0BpUVdaGAQuSgKmNAhOpyIVhJh8kuaphZJLPkPaLHGhBUmhir0zWk0o62lUUftcCnXwIFrPokuLDOA1tUM5xmkwQ8tFgRnMakKRAJk1BBdFbMgMJmgsVLS9SNG0VcgCr1G70+o0SbcSVIp8p+AFxUFd3RIiq7k0FLx4gqJqGvFVWtH15vbI+HIAlIGh64AiKTKAQsgraiXrw3ljZj/jxAiLbVg1n89veY5H62u+ETavJ6CxUu26mRt0fqa7vPl4ROccdWlOp29RX4sUg9vaseeBAz4INwpP3Y0STy+vxN83F5B3L0SK0mDH/7/45s33cA2PB4cs6fjKjyD44PuTV1//+PZrwkve3J+/4eBwcOjegsrYksvOVq98u+ZZ6702MhXN1bjvAd33gO57QPc9oPse0H0P6L4H9CHxtO8B3feA7ntAf88eiH0P6L4HdLzvAYV9D+i+B3TfA7rvAd33gO57QPc9oPse0H0P6P9RD2ioFFLEdFAVXLhSs6s23IQq8flmZ+hFwnIqI4/O2c0NZY/f6WK1ouEPNWqqQV8k7JprQVlAV4FOYqWVapNXuKSSg68o9M9o/8RbnSuPbBTeqVDsV7xwaroTtlvpfnP69owlbBK6V0uV0RrN59TZyudsRNEpc12wTsKuf5G71qSCy1ntyqXM46UCMa9tvl5dvnLV5fCjU3Xlctmhcr3s7Fmhv8TY1gV/pRrFd7j8WwPuZ3YuCLKN0KTCi9Vq9V9Npx2o",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)(l(),{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)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(p.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:!1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(r.Z,{children:[(0,a.jsxs)(p.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.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/bfe4b778.a2c58921.js b/assets/js/bfe4b778.a2c58921.js new file mode 100644 index 000000000..659b047a8 --- /dev/null +++ b/assets/js/bfe4b778.a2c58921.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(85162);const u={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV+9u2zYQf5Urv6wFFNtJ0w4ThmFdW7RBizZoUhRYYgQn6WSzoUiWpOwYhr7tSfZoe5LhKMmWkzRth2ID9sWQyfv3+/F4d1yLgDMv0jPxzOR1RTp4MU1EQT530gZptEjF6ZzgvS0wEPRS8OT4CFAps/RQe3IegoHKFLJcAeoC6lY8zAkKCiiVB1MCgreUy1LmUHSGRvDGREEMEObSR8NGq1VvPZjeGEJJS7DosKJAziewMjXkqLUJkM9Rz1qHpVQERucEMrQR9EFLD7kjDFSMRCKMJYcM8agQqWid9PhEIraORHq2FhorEqnobV3IQiRCMj0Ww1xc5+zoGQPe8R4xaqIigsqow8V2HH2qpaNCpMHVlAgfVoq9eVlZRSIRdGWVKUikJSrPAvmcKhTpWoSVjZLBST0TiSiNqzBsV5pm2tonH34zxYp1dkM9dmYhC4KMlBnwO2A+UGUVBvJwHwMoQh/AaBrI9gAeiETkRgemMF0LtFbJPJI8/ujZ2/pm6Cb7SHlk3PGRBEmed1vCvwyQycFIUyp8/NhQLppEaBO+2cwxQyRwtJC0jPns5Uy3+Tm0vcPjt7nYZMXQRsM6qiDHGXnT3labJUljpujt6fFANDNGEeqhbEyYpklEkGHH88UglS8yzoymYTlH3hrt20M4mExuJsymCHQJDL7Oc/K+rJVa3ft+GdAuf4kL9MXBS398+NIyK11IT8LdSgeTg4d7+5O9yY+n+4/Tw5/SR49Hk8nkd5GIq0pt00+wNTFkL/4fLEitpKaLnrWLg8nk4mFH5eFt7HXJZbtbt0AlCyglqQLYp/+OBJJzxv3D5L8jvrvgM+Qe/OEdqcM1uzS1Lv5ruLdFdDfAw4vDDcRHNyEe6ZYybmSn5pL0v4Fwi2foPrTuOdTdrJatUNwXO2CH6y1IT3ntZFjFLni1h1butfvp2ZR7S0VhbriD2rptm2EuUjHuq8t4PagzjWB7btE31dopkYp5CNan47FHXWTmamQsaS64CjM/yk01RivHi33RJNc10NpvkPYBZ1LP9u7Umm4Rn/CptMTv4N7Qj1a+opVIelqHUt1wMCcsyMUj4MN+t23Ez/sj25zK9e7VN6+v60fXJ5BbO8ywwQix00TaRsFhlyZi7HLirSV9wu44oxb7N/x8IJWbinhc4HGnF//rjz+jRh9GTPh78LZ2YM2SXFmriKRUdCUzRcOJkue6YMATVoq8VyuQOtDM8SxSyJkMqCIDUs8gR4uZVJKvCIsZ1nYwuGV+BB/mFObkeOsHx5NkQQtSfLNAGXPJdoIBrIOpoo+euqVxlyWHlABCVnupyXvwRL0K6TnypNmnTALGAWogHchZJz0ByoqFS+OAylLmkg1zPXCYB6hQ44zYWQIcN7PQlV4PzmS1D+CNqiOQOGQThRZiHCVH8EwuqAXOi+20TQXMajaRQG4Kgq48MAxdQEY+gGX3Mqdo1Ad0PNgtyMUr0s7RtVJgDdctiYrH2eHZsqHgUHsurm1A/dFs6LPO8FwQfRS4GsG5PtcnnCy1J04AJfWlT8/1Hpxt0uwDZV4Gmt7vr+1yubxxXR/s6ryQYV5n4Miard4sLsbLPVTf/OFZNZCr/NvyhNxC5tTVis/4HEfhcVfNMY/VnCqUqi0Fv15X4MqqZE7aD2/5kxfHr2EBD0cTkQwK1FcEPH599PT5m5PnbJdLaHv/9keT0YSXrPGhQj1wde3Rdv3qrrdt6f/6xusKdaCrMLYKZex2kfR116nOxKCCpsPn3TQRc+MDi6zXGXp671TT8PKnmhz3w2kiFugkl9DYzgrp+bvYPNM+S/f9d/2DCb7tpXgroL4dae5FC1Q1tdX9klbXnqzNtEn6nsQRtxJP27j2TtnO1sKNSYVbaqvxJM/Jhjtlh6PB8ftTkYise35W8SUrHC756YtLkYpzcS7ikzzWORaK62uhUM9qnLF8a5Y7KdZ8csM2fBnbcPfBwG6lZLc/t0j4l3HdqvAzZ+orWv2yEW93PqvQUdtL8/FMm6b5G+h5E2c=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV+9u2zYQf5Urv6wFFNtJ0w4ThmFdW7RBizZoUhRYYgQn6WSzoUiWpOwYhr7tSfZoe5LhKMmWkzRth2ID9sWQyfv3+/F4d1yLgDMv0jPxzOR1RTp4MU1EQT530gZptEjF6ZzgvS0wEPRS8OT4CFAps/RQe3IegoHKFLJcAeoC6lY8zAkKCiiVB1MCgreUy1LmUHSGRvDGREEMEObSR8NGq1VvPZjeGEJJS7DosKJAziewMjXkqLUJkM9Rz1qHpVQERucEMrQR9EFLD7kjDFSMRCKMJYcM8agQqWid9PhEIraORHq2FhorEqnobV3IQiRCMj0Ww1xc5+zoGQPe8R4xaqIigsqow8V2HH2qpaNCpMHVlAgfVoq9eVlZRSIRdGWVKUikJSrPAvmcKhTpWoSVjZLBST0TiSiNqzBsV5pm2tonH34zxYp1dkM9dmYhC4KMlBnwO2A+UGUVBvJwHwMoQh/AaBrI9gAeiETkRgemMF0LtFbJPJI8/ujZ2/pm6Cb7SHlk3PGRBEmed1vCvwyQycFIUyp8/NhQLppEaBO+2cwxQyRwtJC0jPns5Uy3+Tm0vcPjt7nYZMXQRsM6qiDHGXnT3labJUljpujt6fFANDNGEeqhbEyYpklEkGHH88UglS8yzoymYTlH3hrt20M4mExuJsymCHQJDL7Oc/K+rJVa3ft+GdAuf4kL9MXBS398+NIyK11IT8LdSgeTg4d7+5O9yY+n+4/Tw5/SR49Hk8nkd5GIq0pt00+wNTFkL/4fLEitpKaLnrWLg8nk4mFH5eFt7HXJZbtbt0AlCyglqQLYp/+OBJJzxv3D5L8jvrvgM+Qe/OEdqcM1uzS1Lv5ruLdFdDfAw4vDDcRHNyEe6ZYybmSn5pL0v4Fwi2foPrTuOdTdrJatUNwXO2CH6y1IT3ntZFjFLni1h1butfvp2ZR7S0VhbriD2rptm2EuUjHuq8t4PagzjWB7btE31dopkYp5CNan47FHXWTmamQsaS64CjM/yk01RivHi33RJNc10NpvkPYBZ1LP9u7Umm4Rn/CptMTv4N7Qj1a+opVIelqHUt1wMCcsyMUj4MN+t23Ez/sj25zK9e7VN6+v60fXJ5BbO8ywwQix00TaRsFhlyZi7HLirSV9wu44oxb7N/x8IJWbinhc4HGnF//rjz+jRh9GTPh78LZ2YM2SXFmriKRUdCUzRcOJkue6YMATVoq8VyuQOtDM8SxSyJkMqCIDUs8gR4uZVJKvCIsZ1nYwuGV+BB/mFObkeOsHx5NkQQtSfLNAGXPJdoIBrIOpoo+euqVxlyWHlABCVnupyXvwRL0K6TnypNmnTALGAWogHchZJz0ByoqFS+OAylLmkg1zPXCYB6hQ44zYWQIcN7PQlV4PzmS1D+CNqiOQOGQThRZiHCVH8EwuqAXOi+20TQXMajaRQG4Kgq48MAxdQEY+gGX3Mqdo1Ad0PNgtyMUr0s7RtVJgDdctiYrH2eHZsqHgUHsurm1A/dFs6LPO8FwQfRS4GsG5PtcnnCy1J04AJfWlT8/1Hpxt0uwDZV4Gmt7vr+1yubxxXR/s6ryQYV5n4Miard4sLsbLPVTf/OFZNZCr/NvyhNxC5tTVis/4HEfhcVfNMY/VnCqUqi0Fv15X4MqqZE7aD2/5kxfHr2EBD0cTkQwK1FcEPH599PT5m5PnbJdLaHv/9keT0YSXrPGhQj1wde3Rdv3qrrdt6f/6xusKdaCrMLYKZex2kfR116nOxKCCpsPn3TQRc+MDi6zXGXp671TT8PKnmhz3w2kiFugkl9DYzgrp+bvYPNM+S/f9d/2DCb7tpXgroL4dae5FC1Q1tdX9klbXnqzNtEn6nsQRtxJP27j2TtnO1sKNSYVbaqvxJM/Jhjtlh6PB8ftTkYise35W8SUrHC756YtLkYpzcS7ikzzWORaK62uhUM9qnLF8a5Y7KdZ8csM2fBnbcPfBwG6lZLc/t0j4l3HdqvAzZ+orWv2yEW93PqvQUdtL8/FMm6b5G+h5E2c=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update Document"})}),"\n",(0,t.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document updated successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.d4605a99.js b/assets/js/bfe4b778.d4605a99.js deleted file mode 100644 index bbf9cb382..000000000 --- a/assets/js/bfe4b778.d4605a99.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var l=s(85893),n=s(11151),t=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),o=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLdqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0GYoN2E3gUOfv+3j+uMIgph7Tc3xusqokHTyOE8zJZ07aII3GFM9mBB9sLgJBJwVHJ8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxher5CLUrCFDtblzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfR50o6yjENrqIEfVgq9uZlaRVhgnRtlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT5yZy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzk2dvqZuhm8omyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMCUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8aW+jjXWdYJBhy9RlLzcvJ3zVdc1yjrw12jesHoxGNzNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8MqfHL6yTEgb0lG4W+lgdPB4b3+0N/rxbP9pevhT+uTpYDQa/Y4JXpdqk0/I1rDPXvy/dyC1kpouO9YuD0ajy8ctlYe3sddmi23LaC6UzKGQpHJgn/47EkjOGfcPs/mO+O6Cz5A78Id3pA434cJUOv+v4d4W0d0ADy8P1xCf3IR4rBvKeDKdmSvS/wbCDZ6++9C451C3s1o2QvE7boHtnzcgPWWVk2EZx9r1nrByr/meno95WJQUZoZHoq2aORhmmOKw6y7DVa/P1Mj23LybkpVTmOIsBOvT4dALnU/M9cBY0txBlZj4QWbKobByON/HOtnVENbeQ9oHMZV6unen1niD+JRvpSF+C/eafmHla1pi0tHal2qn/YxETi5eAV/2+81kfdFd2fpWdsdRN42+bcDsrhS3joz+xEC+eakLExG1GfDOkj5l45w/8/0bVj+SykxJPO15W+nE//rjz6jROY3p/QDeVQ6sWZArKhXjLhRdy4mi/kLIa1kw4EmUirxXS5A60NTxKpHLqQxCRbxSTyETVkykklwQLGZY20GvpvwAPs4ozMjxpx8cL4I5zUlxHYEy5ortBAOiCqaMPjqiFsZdFRxSAgImlZeavAdP1KmQngleFLsEScA4EBpIB3LWSU8gZMnChXFARSEzyYa5+p3IApRCiymxswQ4bmahbbQenJlUPoA3qopA4o5MFBqIcRMcwHM5pwY4HzbLMuUwrdhEApnJCdpmwDB0DhPyASy7lxlFoz4Ix3vZnFwsiGYNrpQCa7hLSaF4G+3fLRsKTmjPrbQJqLuaNX3WGd4Coo9cLAdwoS/0KSdL5YkTQEl95dMLvQfn6zT7SBMvA40fdkW6WCxuFOejbZ2XMsyqCTiyZqM3jYexlPvq63941QzkSv+uOCU3lxm1neELPodReNj2bpHF3k2lkKop/F93FbialMxI+35NH708eQNzeDwYYdJrR98Q8PDN8bMXb09fsF1umE397Q9GgxEfWeNDKXTP1c6ba7d0V5sh9H99orVtOdB1GFolZJxtkfRVO5fOsdcv0/7rbJzgzPjAIqvVRHj64FRd8/HnihxPv3GCc+GkmHCjPF9hLj3/ztevrC/S/fB9996B+z30bgXUDR/Nk2cuVBVX/ASvaLnz4qzHddJNII64kXjWxLV3xnY2Fm7sJTxAG42jLCMb7pTtLwInH84wwUn7eizjQxSdWPDLVSwwxQu8wPiijn2OheL5CpXQ00pMWb4xy3NTVHxz/aF7FYdu+4OB3UrJ9jRukPBfxnWrws+cqa9p+ctavPnyRYWW2k6ar2dc1/Xf0BH9SA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLdqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0GYoN2E3gUOfv+3j+uMIgph7Tc3xusqokHTyOE8zJZ07aII3GFM9mBB9sLgJBJwVHJ8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxher5CLUrCFDtblzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfR50o6yjENrqIEfVgq9uZlaRVhgnRtlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT5yZy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzk2dvqZuhm8omyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMCUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8aW+jjXWdYJBhy9RlLzcvJ3zVdc1yjrw12jesHoxGNzNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8MqfHL6yTEgb0lG4W+lgdPB4b3+0N/rxbP9pevhT+uTpYDQa/Y4JXpdqk0/I1rDPXvy/dyC1kpouO9YuD0ajy8ctlYe3sddmi23LaC6UzKGQpHJgn/47EkjOGfcPs/mO+O6Cz5A78Id3pA434cJUOv+v4d4W0d0ADy8P1xCf3IR4rBvKeDKdmSvS/wbCDZ6++9C451C3s1o2QvE7boHtnzcgPWWVk2EZx9r1nrByr/meno95WJQUZoZHoq2aORhmmOKw6y7DVa/P1Mj23LybkpVTmOIsBOvT4dALnU/M9cBY0txBlZj4QWbKobByON/HOtnVENbeQ9oHMZV6unen1niD+JRvpSF+C/eafmHla1pi0tHal2qn/YxETi5eAV/2+81kfdFd2fpWdsdRN42+bcDsrhS3joz+xEC+eakLExG1GfDOkj5l45w/8/0bVj+SykxJPO15W+nE//rjz6jROY3p/QDeVQ6sWZArKhXjLhRdy4mi/kLIa1kw4EmUirxXS5A60NTxKpHLqQxCRbxSTyETVkykklwQLGZY20GvpvwAPs4ozMjxpx8cL4I5zUlxHYEy5ortBAOiCqaMPjqiFsZdFRxSAgImlZeavAdP1KmQngleFLsEScA4EBpIB3LWSU8gZMnChXFARSEzyYa5+p3IApRCiymxswQ4bmahbbQenJlUPoA3qopA4o5MFBqIcRMcwHM5pwY4HzbLMuUwrdhEApnJCdpmwDB0DhPyASy7lxlFoz4Ix3vZnFwsiGYNrpQCa7hLSaF4G+3fLRsKTmjPrbQJqLuaNX3WGd4Coo9cLAdwoS/0KSdL5YkTQEl95dMLvQfn6zT7SBMvA40fdkW6WCxuFOejbZ2XMsyqCTiyZqM3jYexlPvq63941QzkSv+uOCU3lxm1neELPodReNj2bpHF3k2lkKop/F93FbialMxI+35NH708eQNzeDwYYdJrR98Q8PDN8bMXb09fsF1umE397Q9GgxEfWeNDKXTP1c6ba7d0V5sh9H99orVtOdB1GFolZJxtkfRVO5fOsdcv0/7rbJzgzPjAIqvVRHj64FRd8/HnihxPv3GCc+GkmHCjPF9hLj3/ztevrC/S/fB9996B+z30bgXUDR/Nk2cuVBVX/ASvaLnz4qzHddJNII64kXjWxLV3xnY2Fm7sJTxAG42jLCMb7pTtLwInH84wwUn7eizjQxSdWPDLVSwwxQu8wPiijn2OheL5CpXQ00pMWb4xy3NTVHxz/aF7FYdu+4OB3UrJ9jRukPBfxnWrws+cqa9p+ctavPnyRYWW2k6ar2dc1/Xf0BH9SA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Document"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.c3ad1b45.js b/assets/js/runtime~main.247b13be.js similarity index 78% rename from assets/js/runtime~main.c3ad1b45.js rename to assets/js/runtime~main.247b13be.js index 5405e50eb..7d20d6edf 100644 --- a/assets/js/runtime~main.c3ad1b45.js +++ b/assets/js/runtime~main.247b13be.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",2403:"38c56221",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",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:"2a881281",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e68bf28a",339:"4b03478f",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:"5db055b4",1477:"b31b2642",1512:"9637e502",1520:"d1814002",1531:"46db2c31",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"d4605a99",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f2a0d0c3",2267:"a4846e2b",2362:"ebdb1814",2403:"78b7485b",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",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:"000e7fdc",5900:"e113e88d",6011:"6de743c9",6033:"7cf37f7d",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6238:"4daa52ac",6344:"29bab824",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"14209b93",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"cde5db0f",8106:"ab7168d2",8140:"901b2f91",8141:"60a9b3b8",8163:"9bf52b52",8215:"c6b04c16",8468:"7cfe3494",8474:"a75e5064",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"e9f986fb",8784:"fb16cf6f",8866:"381cdff2",8878:"eda4ae1c",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"002f0dec",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"c16c326c",9700:"ad032cc8",9817:"424c677a",9914:"13b02ad4"}[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","38c56221":"2403","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","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,d,f={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=f,t.c=r,e=[],t.O=(a,c,b,d)=>{if(!c){var f=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var f={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,t.d(d,f),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",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",2403:"38c56221",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",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:"2a881281",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e68bf28a",339:"4b03478f",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:"5db055b4",1477:"b31b2642",1512:"9637e502",1520:"d1814002",1531:"a870fd3b",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"a2c58921",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f2a0d0c3",2267:"a4846e2b",2362:"ebdb1814",2403:"510e3b28",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",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:"000e7fdc",5900:"e113e88d",6011:"6de743c9",6033:"d03a17e0",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6238:"4daa52ac",6344:"29bab824",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"14209b93",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"cde5db0f",8106:"ab7168d2",8140:"901b2f91",8141:"60a9b3b8",8163:"2b8fccd7",8215:"c6b04c16",8468:"7cfe3494",8474:"a75e5064",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"44854024",8781:"e9f986fb",8784:"fb16cf6f",8866:"381cdff2",8878:"eda4ae1c",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"002f0dec",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"3740a736",9700:"ad032cc8",9817:"424c677a",9914:"13b02ad4"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},d="OpenSign-Docs:",t.l=(e,a,c,f)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453",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","38c56221":"2403","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","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 d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var f=t.p+t.u(a),r=new Error;t.l(f,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",r.name="ChunkLoadError",r.type=d,r.request=f,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,f=c[0],r=c[1],o=c[2],l=0;if(f.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index ef6386fe5..c3d799237 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 7e93c9c0d..0772a1671 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 8caa1a4fd..73187674b 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 dd79228c4..91871a9a5 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 91d5d5130..0fe4bdf8e 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 34d421bac..254af8e0a 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 970e7f2f5..4bc221cd6 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 4d4ba806a..cef1087b9 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 7f17ab515..6deef4fe7 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 3495b0937..8b81b4f83 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 70b4ef167..43376ecd4 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 61ff907c1..364999bc3 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 5361700ee..906e26ace 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
+

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

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 2287b16a3..2ebcc1c5c 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

+

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

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 25c28c2cd..bcf389031 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 5c0b3b00b..c49f7b925 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
+

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

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 747ff9196..1697d086a 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 33de29339..1a5cff788 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 f862a0f08..6164e78b1 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 04654e486..611dd81fa 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 f9ad5feb8..ea412699f 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/draftedocument/index.html b/docs/API-docs/draftedocument/index.html index 966a08912..b29d8f7be 100644 --- a/docs/API-docs/draftedocument/index.html +++ b/docs/API-docs/draftedocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + @@ -20,7 +20,7 @@

Note:​

You cannot add roles and widgets from this API. You will have to do it from the link received in the response.

Request​

-

Body

required

    file base64required
    title stringrequired
    description string
    note string

    signers

    object[]

    required

  • Array [

    • email string
    name string
    phone string

  • ]

    • sendInOrder boolean
+

Body

required

    file base64required
    title stringrequired
    description string
    note string

    signers

    object[]

    required

  • Array [

    • email string
    name string
    phone string

  • ]

    • sendInOrder boolean
    enableOTP boolean

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index 23e329d3e..c2303ca4e 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 30522ef4a..ddd01e097 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 5ced7894c..8f6d3957b 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 b67486ea9..89bba270b 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 1fcee8e45..b6c8bc23c 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 a2552870d..ab61818e0 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 3fe39515a..50fdd563a 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 752f19366..887270435 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 c0ebf8dfc..a959f2392 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 bf0fc36c8..c22149b6a 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 47b5ec269..db8d91986 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 335375d40..959270aaa 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 271e4307f..f9e7d9e13 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 4e17afb14..881c34f8c 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + @@ -14,7 +14,7 @@

The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.

Request​

Path Parameters

    document_id stringrequired

    ID of the document that needs to be updated

-

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
+

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean

Responses​

Document updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 065bedc73..019389eb6 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + @@ -14,7 +14,7 @@

The Update Template API enables you to modify and update the details of a specific template.

Request​

Path Parameters

    template_id stringrequired

    ID of the template that needs to be updated

-

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
+

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
    enableOTP boolean

Responses​

Template updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index 9b2e23114..5a3911b89 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 0b0a0cb82..f639aa9ac 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 62b565c7f..01f495c6c 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 40d07e9aa..164a16acc 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 8931d93df..e1b74054b 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 783899666..b3fc45388 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 58f3a0227..280d502d0 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 8b7ea14c3..bb7631cca 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 065af6152..c5b92c35c 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 fffc37d9e..f35358d64 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 1f9a997a9..881dcca26 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 634ec9ea0..89c8e7339 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 510d84fb4..1136ec581 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 bc7addfff..035452110 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 8604a07ba..f79ec4961 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 df111eee5..4cb0811a6 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 17729a8b0..7bb0b9fa7 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 5f7969cdd..81ebc8c0d 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 abe5281de..8ca8448c1 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 7fbd316e4..93194c3d7 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 c0c35d097..a47ada4ba 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 0d4950553..79b64c271 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 740a8318e..5d8f30816 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 c07c92db2..c672a76b9 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 5f7f6a275..089cbf683 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/declined/index.html b/docs/help/Reports/declined/index.html index 3e8c53f52..1faae8f86 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 f397d1c1f..2fc01bdc4 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 3decd7918..136126b5c 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 ee982c1a0..24ecbae70 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 59b42fc4d..7b7836eb1 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 cfbb3b2cd..ba4bb5dcc 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 0e697c553..c09129d5e 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 06283c7fe..a215d01a1 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 cc82ed252..0cfd2a173 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 dd540818d..c27dd85de 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 ef8037a86..a4604aeea 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 00a2bd6e7..e66fb6acf 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 1f03bb5ee..ad4f3cf51 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 06ce235dd..545738eb4 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 920314051..7a4e883b7 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 cbcb1e1e1..e540ce8f4 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 3c27bd6c6..540aabc82 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 66a142f94..02f8bd456 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 e3cb50077..556a01eeb 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 af6edbe89..3437a660b 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 1c5169852..89b89598d 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 978e31407..033c22956 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 e88748831..a997bd616 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +