diff --git a/404.html b/404.html index cc16bd4e2..424d7dba5 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/28b19cd2.654c559e.js b/assets/js/28b19cd2.654c559e.js new file mode 100644 index 000000000..bde77bc9c --- /dev/null +++ b/assets/js/28b19cd2.654c559e.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:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>g,toc:()=>f});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),c=s(41429),m=s(5397),d=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://staging-ap.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1v2zYQ/1eufElTKLaTdnswhqFdWnTBiiVoUuzBMQxaOllMKZIlKTuaof99OOrTjpO2wNCXDShSi7w73vf9yC3zfOXYdMbe6rjIUXnH5hFL0MVWGC+0YlN2kyGcW+QeoaWCN1cXwKXUGwelLsBrWKFCSzQKN5C00mBZwl3hPBir1yIRagUecyO5x4VIQCjnkSegUyiM1DwQ8CAiFRKfCwU+Q0i1zYlmyR3+/Aq0haVQ3JbHgGu0JXiRY9BDISakTFyryztFRnDTHOtIGlg0RJHIEgqHSTjNQcwVLLHhTiC1OqdtC0J5tCmPEbiH2YsXb3FZrODTxYsX8+eZ98ZNx2Pn+Uqo1Qk3I21QObFSki/dKNb5OCF6k6THpHvhght6r7aqkVdHt4pFTBvypdDqImFT1ujTmLIRPmt9KBIWMcMtz9GjpUBumeI5sikbuJlFTFAgDfcZ24+uXt5h7C9CDFpFWMQsfimExYRNvS0wYs6XksQ6kRtJBHhvpE6QTVMuHRHEGeacTbfMlyZQeivUikWMosf9cAXveZAyZeb302UWn2VmyapqXh+Lzv+mk5JExVp5VJ5+cmOkiINTxneOVN8OzuzVnTHyPDljHrWq1DaSqyx51gt0gb0h7HXm1vKS3OUxH64/IsBqMuKhxb19b+JYF15x5VkVMcy5kE+6KBAMBdxpfN18USaRlDrAT516pxGWiERsMq2+Qn169pL+vTxlVRUxL3xY3U26QTYtrhu3EXWqZYKWsvSpE0gRhypZ7DtgqbVErh4k5U0mHHR5vddpnMFYpCVsMvQZ2rC84cpDkO6IZIngqE0Rda3tCKiNJZjyQnpYc1kgCAe3jNL7lo3gIg0lWe9o+thRYUALXCWgNByF8xauCMlxNG6+lzopj3pOB9xio7PApFMhEHfN0MFGSEl6Uzuqm0DnPzq2zZ72uEMO3/XheeG8ziEc0zCF1kcO4b6wCE2xjeCcKxAqlkWCTb8lh1OXgu22TYFFyIyqgu2WYol2QYlYVVG/QGftLITsq1csxijWO1zdEvaM3dqAFe+NsOUi4b5ZiHVuuCqHCoiVEmq1KKysqtGD5Osj881+e+CmJmIk5D/gMVLnQl3aBO3Beu2oQ/t/vHEshp0jBKAi4t3xEhac0crVffVsMqH/duNyocAVcYzOQUtclz4Vzgo9FFaCUP2mSMM+lR+Xru0ERNIqB5oayEY4BK1kGaS08zCCHJ1zfEXD7pvn0NPzopX9vVMyuxNnf9/H67MrCk1hn54hhwQ0GGVvkpCFZOB3SutQYOixTVDSQsry2c4IEUoKhYs2IIuzyWRxRvGvIvbqYIjriGV8jerIA08S2Ihkhd6Fntu0copgm1WEp5Ru4SV2JFxqtQKCSlSewgKN6sAZcvBfiyhaq+33+u9KInc0oXxhektqwV/z4avJZBHHnRN/OlQnay5FEiD6jf6M6tkPMLc3bni8r48nVe/zkLQNOBU1UdhnO9YO12sjHcaFFb4M4Pb+hBtxUu9PZ3OCjDn6TBNMNtoFjQnlTtl4tw+Nt4NGVDESa9ctZA4V1RUJNwcQPDdivD5lVbRP3cP+J7jmvRnX5OramzvG9BjUiD+QUrTx1ZCqAfIZcurL5B2K4MceNL9r4zBAt7MWqA7RaAdGHyDM7uAWRXYgcogU50Psx9guvquvDHt4hbHdOdwydVOmniRkYqqDP5qkuDSoCHOGlFqfHgaLwoXtNtwhvQPc2eMOd8gEdH2xpE1afzk6bSFaXRkjuFW36lrnAZClhQQp1Gc3vVUnMLtMUxELLuEvXDrhsb8DbjabB0lwHHjeC58VS7p36p58FRZDpgy5uo9jFjGPNneX6TXatYjbXv7IUeNAPG7qndcosY1zs/R6n4nqT4oYlcNBhb55f/UB1vByNGHRIOO/Qenxh4vzd39evyO5VGF1kE5Hk9EkXEi08zlXg6P23xbCtXtwFd2J9uBO+P/DxI9/mGh6lMd7PzaSCzUAJHXjne0BQBax6fAtYh6xjBr1dMa2W/LbJwKgtPylQEtdfh6xNbeCL6n6Z1uWCEe/k+6p4dGEeP6xgZXH8MizxkH928arqOuGC2DdnT5jufeQUs2rqO2+pFpNcV4rcHJDcnoJDwYtDY+a400co/FP0g4n29Xl9Q2LWHt/ycO7C7N8Qw81fMOm7JbdsvBuRBLqtwla3zLJ1aoIGI/Vcmlo8IIiNZw4n8PEaX6QZQd9sjuKalPoLxl2kOEXKsc/sPy1I693HmVofNtSU3zmVVX9A4pyQ0E=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://staging-ap.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://staging-ap.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1v2zYQ/1eufElTKLaTdnswhqFdWnTBiiVoUuzBMQxaOllMKZIlKTuaof99OOrTjpO2wNCXDShSi7w73vf9yC3zfOXYdMbe6rjIUXnH5hFL0MVWGC+0YlN2kyGcW+QeoaWCN1cXwKXUGwelLsBrWKFCSzQKN5C00mBZwl3hPBir1yIRagUecyO5x4VIQCjnkSegUyiM1DwQ8CAiFRKfCwU+Q0i1zYlmyR3+/Aq0haVQ3JbHgGu0JXiRY9BDISakTFyryztFRnDTHOtIGlg0RJHIEgqHSTjNQcwVLLHhTiC1OqdtC0J5tCmPEbiH2YsXb3FZrODTxYsX8+eZ98ZNx2Pn+Uqo1Qk3I21QObFSki/dKNb5OCF6k6THpHvhght6r7aqkVdHt4pFTBvypdDqImFT1ujTmLIRPmt9KBIWMcMtz9GjpUBumeI5sikbuJlFTFAgDfcZ24+uXt5h7C9CDFpFWMQsfimExYRNvS0wYs6XksQ6kRtJBHhvpE6QTVMuHRHEGeacTbfMlyZQeivUikWMosf9cAXveZAyZeb302UWn2VmyapqXh+Lzv+mk5JExVp5VJ5+cmOkiINTxneOVN8OzuzVnTHyPDljHrWq1DaSqyx51gt0gb0h7HXm1vKS3OUxH64/IsBqMuKhxb19b+JYF15x5VkVMcy5kE+6KBAMBdxpfN18USaRlDrAT516pxGWiERsMq2+Qn169pL+vTxlVRUxL3xY3U26QTYtrhu3EXWqZYKWsvSpE0gRhypZ7DtgqbVErh4k5U0mHHR5vddpnMFYpCVsMvQZ2rC84cpDkO6IZIngqE0Rda3tCKiNJZjyQnpYc1kgCAe3jNL7lo3gIg0lWe9o+thRYUALXCWgNByF8xauCMlxNG6+lzopj3pOB9xio7PApFMhEHfN0MFGSEl6Uzuqm0DnPzq2zZ72uEMO3/XheeG8ziEc0zCF1kcO4b6wCE2xjeCcKxAqlkWCTb8lh1OXgu22TYFFyIyqgu2WYol2QYlYVVG/QGftLITsq1csxijWO1zdEvaM3dqAFe+NsOUi4b5ZiHVuuCqHCoiVEmq1KKysqtGD5Osj881+e+CmJmIk5D/gMVLnQl3aBO3Beu2oQ/t/vHEshp0jBKAi4t3xEhac0crVffVsMqH/duNyocAVcYzOQUtclz4Vzgo9FFaCUP2mSMM+lR+Xru0ERNIqB5oayEY4BK1kGaS08zCCHJ1zfEXD7pvn0NPzopX9vVMyuxNnf9/H67MrCk1hn54hhwQ0GGVvkpCFZOB3SutQYOixTVDSQsry2c4IEUoKhYs2IIuzyWRxRvGvIvbqYIjriGV8jerIA08S2Ihkhd6Fntu0copgm1WEp5Ru4SV2JFxqtQKCSlSewgKN6sAZcvBfiyhaq+33+u9KInc0oXxhektqwV/z4avJZBHHnRN/OlQnay5FEiD6jf6M6tkPMLc3bni8r48nVe/zkLQNOBU1UdhnO9YO12sjHcaFFb4M4Pb+hBtxUu9PZ3OCjDn6TBNMNtoFjQnlTtl4tw+Nt4NGVDESa9ctZA4V1RUJNwcQPDdivD5lVbRP3cP+J7jmvRnX5OramzvG9BjUiD+QUrTx1ZCqAfIZcurL5B2K4MceNL9r4zBAt7MWqA7RaAdGHyDM7uAWRXYgcogU50Psx9guvquvDHt4hbHdOdwydVOmniRkYqqDP5qkuDSoCHOGlFqfHgaLwoXtNtwhvQPc2eMOd8gEdH2xpE1afzk6bSFaXRkjuFW36lrnAZClhQQp1Gc3vVUnMLtMUxELLuEvXDrhsb8DbjabB0lwHHjeC58VS7p36p58FRZDpgy5uo9jFjGPNneX6TXatYjbXv7IUeNAPG7qndcosY1zs/R6n4nqT4oYlcNBhb55f/UB1vByNGHRIOO/Qenxh4vzd39evyO5VGF1kE5Hk9EkXEi08zlXg6P23xbCtXtwFd2J9uBO+P/DxI9/mGh6lMd7PzaSCzUAJHXjne0BQBax6fAtYh6xjBr1dMa2W/LbJwKgtPylQEtdfh6xNbeCL6n6Z1uWCEe/k+6p4dGEeP6xgZXH8MizxkH928arqOuGC2DdnT5jufeQUs2rqO2+pFpNcV4rcHJDcnoJDwYtDY+a400co/FP0g4n29Xl9Q2LWHt/ycO7C7N8Qw81fMOm7JbdsvBuRBLqtwla3zLJ1aoIGI/Vcmlo8IIiNZw4n8PEaX6QZQd9sjuKalPoLxl2kOEXKsc/sPy1I693HmVofNtSU3zmVVX9A4pyQ0E=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},j={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,t.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,t.jsx)(a.a,{href:"https://staging-ap.opensignlabs.com/debugpdf",children:(0,t.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\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)(c.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,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})}),(0,t.jsx)("span",{className:"openapi-schema__divider"}),(0,t.jsx)("span",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",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)(l.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.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,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.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,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.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)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.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)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.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 b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.8efd80de.js b/assets/js/28b19cd2.8efd80de.js deleted file mode 100644 index c85d69bb3..000000000 --- a/assets/js/28b19cd2.8efd80de.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:()=>g,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var i=s(85893),t=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),m=s(41429),d=s(5397),c=s(4667),p=s(9472),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://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v2zYQ/itXfklTKLaTdvtgDEO7tOiCFUvQpNgHxzBo6WQxpUiWpOxohv77cNSrHSdtgWEYsAFFah3vjvfGu4fcMs9Xjk1n7K2OixyVd2wesQRdbIXxQis2ZTcZwrlF7hFaLnhzdQFcSr1xUOoCvIYVKrTEo3ADSasNliXcFc6DsXotEqFW4DE3kntciASEch55AjqFwkjNAwMPKlIh8blQ4DOEVNuceJbc4Y+vQFtYCsVteQy4RluCFzkGOxRiQsbEtbm8M2QEN822jrSBRUMciSyhcJiE3RzEXMESG+kEUqtzWrYglEeb8hiBe5i9ePEWl8UKPl28eDF/nnlv3HQ8dp6vhFqdcDPSBpUTKyX50o1inY/JtTwdEy0XsdXcmHFCOkySHpM/hQuh6SPdmkuRHt0qFjFtKL5Cq4uETVljY+PeRvisjatIWMQMtzxHj5aSu2WK58imbBB6FjFByTXcZ2w/43p5h7G/CHlpDWERs/ilEBYTNvW2wIg5X0pS60RuJDHgvZE6QTZNuXTEEGeYczbdMl+awOmtUCsWMcoo90MK3vOgZcrMr6fLLD7LzJJV1bzeFp3/RSclqYq18qg8/eTGSBGHoIzvHJm+HezZmztjFHkKxjxqTal9pFBZiqwX6IJ4w9jbzK3lJYXLYz6kP6LAanLioce9f2/iWBdeceVZFTHMuZBPhigwDBXcaXzdfFF1kZY6wU/teqcRlojEbDKtvsJ9evaS/r08ZVUVMS98oO4W3aCaFtdN2Ig71TJBS1X61A5kiEOVLPYDsNRaIlcPivImEw66ut7rPs5gLNISNhn6DG0gb7jyELQ7YlkiOGpdxF1bOwJqbQmmvJAe1lwWCMLBLaPyvmUjuEjDkaxXNH3smDDgBa4SUBqOwn4LV4TiOBo330udlEe9pANusbFZYNKZEJi7BulgI6Qku6lF1U2gix9t21ZPu92hgO/G8LxwXucQtmmEQjukgHBfWITmsI3gnCsQKpZFgk0PpoBTl4Ltti2BRaiMqoLtlnKJdkGFWFVRT6C9dgih+mqKxRjFekeqI2Ev2NEGonhvhC0XCfcNIda54aocGiBWSqjVorCyqkYPiq/PzDfH7UGYmoyRkv9AxMicC3VpE7QHz2vHHdr/441jMewcIQEVMe+Ol0BwRitX99WzyYT+283LhQJXxDE6By1zffTp4KzQQ2ElCNUvijSs0/Hj0rWdgFha40BTA9kIh6CVLIOWdh5GkKNzjq9o2H3zHHp6XrS6v3dKZnfi7M/7eH12Rakp7NMz5JCCBrfsTRLykBz8Tm0dMgw9tklKWkhZPtsZIUJJoXDRJmRxNpkszij/VcReHUxxnbGMr1EdeeBJAhuRrNC70HObVk4ZbKuK8JTSLeTEjoVLrVZAUImOp7BAozpIhhr82zKK1mr7vfG7ksgdTShfmN6TWvHXYvhqMlnEcRfEHw6dkzWXIgmw/UZ/RvXsH3C3d264va+3J1Pv81C0DTgVNVNYZzveDum1kw7jwgpfBnB7f8KNOKnXp7M5QcYcfaYJJhvtgsWEcqdsvNuHxttBI6oYqbXrFjKHE9UdEm4OoHpuxHh9yqpon7u/CjwhNe/duKZQ19HccabHoEb8hlSiTayGXA2Qz5BTX6boUAY/9qD5XZuHAbqdtUB1iEY7MPoAYXYbtyiyA5FDpDgfYj/GdvFdfWXYwyuM7c7hVqibMvUkIRdTHeLRFMWlQUWYM5TU+vQwWBQuLLfpDuUd4M6edLhXJqDryyYtEv3l6LSFaPXJGMGtulXXOg+ALC0kSKE+u+mtOoHZZZqKWHAJf+DSCY/9vXCz2TwoguMg8174rFjSXVT37KtADJUylOo+jlnEPNrcXabXaNcibnv5I1uNA/O4Oe+8RoltnhvS630hOn9SxKgcDk7om/dXH2ANL0cTFg0q/huMHn+4OH/3+/U70ksnrE7S6WgymoQLiXY+52qw1f57Q7iKD66iO9ke3An/f6z4dzxWNH3L470fG8mFGoCUuhnP9kAhi9h0+D4xj1hGzXs6Y9stxfITgVIifynQUuefR2zNreBL6gizLUuEo99J9/zwaJE8/9hAzWN45KnjoP1tM1bUicOlsO5Yn7Hce1yp5lXUdmQyreY4rw04uSE9vYYHw5cGSi3xJo7R+Cd5h9Pu6vL6hkWsvdPk4S2GWb6hxxu+YVN2y25ZeEsiDfV7BdG3THK1KgLuY7VeGiS8oEwNp9DnMIWaH+TZwZjsjqfaFfpLjh0U+ImO6G9Y/tyx1yuPCjSxbbkpP/Oqqv4CuQhS+w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=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://staging-ap.opensignlabs.com/loadmf/signmicroapp/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://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v2zYQ/itXfklTKLaTdvtgDEO7tOiCFUvQpNgHxzBo6WQxpUiWpOxohv77cNSrHSdtgWEYsAFFah3vjvfGu4fcMs9Xjk1n7K2OixyVd2wesQRdbIXxQis2ZTcZwrlF7hFaLnhzdQFcSr1xUOoCvIYVKrTEo3ADSasNliXcFc6DsXotEqFW4DE3kntciASEch55AjqFwkjNAwMPKlIh8blQ4DOEVNuceJbc4Y+vQFtYCsVteQy4RluCFzkGOxRiQsbEtbm8M2QEN822jrSBRUMciSyhcJiE3RzEXMESG+kEUqtzWrYglEeb8hiBe5i9ePEWl8UKPl28eDF/nnlv3HQ8dp6vhFqdcDPSBpUTKyX50o1inY/JtTwdEy0XsdXcmHFCOkySHpM/hQuh6SPdmkuRHt0qFjFtKL5Cq4uETVljY+PeRvisjatIWMQMtzxHj5aSu2WK58imbBB6FjFByTXcZ2w/43p5h7G/CHlpDWERs/ilEBYTNvW2wIg5X0pS60RuJDHgvZE6QTZNuXTEEGeYczbdMl+awOmtUCsWMcoo90MK3vOgZcrMr6fLLD7LzJJV1bzeFp3/RSclqYq18qg8/eTGSBGHoIzvHJm+HezZmztjFHkKxjxqTal9pFBZiqwX6IJ4w9jbzK3lJYXLYz6kP6LAanLioce9f2/iWBdeceVZFTHMuZBPhigwDBXcaXzdfFF1kZY6wU/teqcRlojEbDKtvsJ9evaS/r08ZVUVMS98oO4W3aCaFtdN2Ig71TJBS1X61A5kiEOVLPYDsNRaIlcPivImEw66ut7rPs5gLNISNhn6DG0gb7jyELQ7YlkiOGpdxF1bOwJqbQmmvJAe1lwWCMLBLaPyvmUjuEjDkaxXNH3smDDgBa4SUBqOwn4LV4TiOBo330udlEe9pANusbFZYNKZEJi7BulgI6Qku6lF1U2gix9t21ZPu92hgO/G8LxwXucQtmmEQjukgHBfWITmsI3gnCsQKpZFgk0PpoBTl4Ltti2BRaiMqoLtlnKJdkGFWFVRT6C9dgih+mqKxRjFekeqI2Ev2NEGonhvhC0XCfcNIda54aocGiBWSqjVorCyqkYPiq/PzDfH7UGYmoyRkv9AxMicC3VpE7QHz2vHHdr/441jMewcIQEVMe+Ol0BwRitX99WzyYT+283LhQJXxDE6By1zffTp4KzQQ2ElCNUvijSs0/Hj0rWdgFha40BTA9kIh6CVLIOWdh5GkKNzjq9o2H3zHHp6XrS6v3dKZnfi7M/7eH12Rakp7NMz5JCCBrfsTRLykBz8Tm0dMgw9tklKWkhZPtsZIUJJoXDRJmRxNpkszij/VcReHUxxnbGMr1EdeeBJAhuRrNC70HObVk4ZbKuK8JTSLeTEjoVLrVZAUImOp7BAozpIhhr82zKK1mr7vfG7ksgdTShfmN6TWvHXYvhqMlnEcRfEHw6dkzWXIgmw/UZ/RvXsH3C3d264va+3J1Pv81C0DTgVNVNYZzveDum1kw7jwgpfBnB7f8KNOKnXp7M5QcYcfaYJJhvtgsWEcqdsvNuHxttBI6oYqbXrFjKHE9UdEm4OoHpuxHh9yqpon7u/CjwhNe/duKZQ19HccabHoEb8hlSiTayGXA2Qz5BTX6boUAY/9qD5XZuHAbqdtUB1iEY7MPoAYXYbtyiyA5FDpDgfYj/GdvFdfWXYwyuM7c7hVqibMvUkIRdTHeLRFMWlQUWYM5TU+vQwWBQuLLfpDuUd4M6edLhXJqDryyYtEv3l6LSFaPXJGMGtulXXOg+ALC0kSKE+u+mtOoHZZZqKWHAJf+DSCY/9vXCz2TwoguMg8174rFjSXVT37KtADJUylOo+jlnEPNrcXabXaNcibnv5I1uNA/O4Oe+8RoltnhvS630hOn9SxKgcDk7om/dXH2ANL0cTFg0q/huMHn+4OH/3+/U70ksnrE7S6WgymoQLiXY+52qw1f57Q7iKD66iO9ke3An/f6z4dzxWNH3L470fG8mFGoCUuhnP9kAhi9h0+D4xj1hGzXs6Y9stxfITgVIifynQUuefR2zNreBL6gizLUuEo99J9/zwaJE8/9hAzWN45KnjoP1tM1bUicOlsO5Yn7Hce1yp5lXUdmQyreY4rw04uSE9vYYHw5cGSi3xJo7R+Cd5h9Pu6vL6hkWsvdPk4S2GWb6hxxu+YVN2y25ZeEsiDfV7BdG3THK1KgLuY7VeGiS8oEwNp9DnMIWaH+TZwZjsjqfaFfpLjh0U+ImO6G9Y/tyx1yuPCjSxbbkpP/Oqqv4CuQhS+w==",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={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(a.a,{href:"https://staging-ap.opensignlabs.com/loadmf/signmicroapp/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}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(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,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.544f11c6.js b/assets/js/2c586be5.544f11c6.js new file mode 100644 index 000000000..d368dfa8c --- /dev/null +++ b/assets/js/2c586be5.544f11c6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>x,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>g,toc:()=>j});var i=s(85893),l=s(11151),r=s(58219),n=(s(62316),s(51039)),t=s.n(n),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const u={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:"eJztWG1vGzcS/itz/JImWEmWrKaFcDg05+Rao0VtnBP0gywI1O7sLp1dkiW5klVh//thuK96iRXnivYOd/ng2NwZcuaZ4TMz3DHHE8tmc/ZWhUWO0lm2CFiENjRCO6Ekm7H3KcKVQe4QGil4c3sNPMvUxkJh0VhwChKUaEhK4gaiZj9YbUEbtRaRkAlE3HHYCJfCilt8PQWUoYowglhkOLyX9/KDzhSPYKsK0FEMQoIqDMxfvXqLqyKBD9evXi2+Sp3TdjYaca2HSqO0IpEZX9lhqPJRRII6il9Cigb9TiGXEBm+gY2IEnQWuIwgVHoLoRooIyLJHQageYIgi3yFBlQMLsV8CDyzqt3E69Smqxhu3/7jXrKAKU2eCyWvIzZjoQerQYAFzOCvBVr3dxVt2WzHQiUdfZjtGNc6E6FXHT1YgnvHbJhizuk30hMGIwoQAcQCRp6isSxgTrgMKVpuq5HNmFo9YEinaUPmOIGW9vB6s10jZZ0RMmEBi5XJuWMzVnnDAoaPPNckzA5io6OYlc2BT23VrnRbWf9Lmw60z152fdFub3s7lAGTyn2pXT+TatnB2u3CjeFbFjDhMO+vfwJmo56PTYiKzsaci+y5ug8KV4jfVQuU9h4Inj/biAeFsEIPgk6VfLb+eHI5nowvxxPaob5eXw5j9fXYgn1GekPMgxGseVaghQFQ+LgrDAZgHc/18Fz0G3nvNk/6Z1b3/+hMYsE9fpCwSUWYEkvUtAI2VUUWAdcauRkSM/4b5OUUhDwLi4wolQ7x3u551praejYuA/Z43pnHivciQbwHX2UYOyi0RgOhMhLNS4iNymsH/2Ocm0ynZcC2593b/le69w0Fb3Peu19E5FKqPpXlf4qtl9+WAUvP2/oDiiR1f7Kx09dlV74OqvNypaLtsuGt8pxgUydILlZZhIYq/jFfdVTjqwvKaHlI8yulMuTyBNEIC5obnqND03RZ1IA4BVZjKOItbFJ0KRq/vOHSgd/dt2ErBEstGklX1g6ByCvCmBeZqxADYeGeOVPgPRvCddxhWTU+eyb0ZH3jJBW88OctbeFp/MWo/pswetFpWuAGa5sFRq0JXhgc5priaGEjsozsLixGQ2j/+daqRZIMaKplc/D5UnFVWKdy8AfWShAr01UMqJuzIVxxCUKGWRFVqRUrgp66Vtjt2jTw2VGWsNtRVNEsqeiWZdAt0Fl7C76uVisGQxTrPa12CTvFdq2nio9amO0y4q5eCFWuudz2DRCJFDJZFiYry+FRGnYx+mzcjmCqY0eb/A8gRuZcyxsToTl5c1vpmGcWz5BHxS5dT18ntEGrlbRV/zO5uKD/9mPRTl31pmCLMERr4yLLtn9hwecPFE83X9XyaUJ7qptKH8Tkt8dwPbklzArz7Ga2If/CZAOnBhSUQQNd1dv2kBUyExKXDWzLycXFckzYlgGbnoLvTuXoUsrKDYG4MUomAegMuUVwZgs84UICUZH5HdFEY5R5ujY8z7KnQJjugfD1MQjXcs0zEfnB/b36iPKP9bR/vKuOJ1Mfc58r1dzCRCXkv7M9Z/vrlZMWw8IIt2Wz+Y49DrgWg+r7bL4oFwEjYBUN41pZbzF3KZux0dFsbtGs/eQ331Wpy55sRbgWo/WYlcGhtHU8ETIZPKm16Ay/I3Ar/PbM7yYnLX5EGp1qdPpSARMU1BQ5MRPhQTH7Z/fM8K5BvnkAODXTdwgfTumH1eDE3N2M3XuTdG+QnjczsR9z2yn3xODaetiMou0k2hsue7PlvEu0doxrprixH38m06mfE74Z+4b68lvfq05flz41ur6Nsf3ejBj5qMNgbL9yNkptXai4n0ISKx+/GtQbjfJOJNIn/Xp8utET1n9ukPcX0DcoB9r+0SmiqZMKLX2k9cvhuGmvqrs7BHpDI16hZiouMsiE/Ghn93IA85s4FqHgGfyCKyscdl33ZrM5StqXXud74dJiBQa16sQTv+gzu6/V/vGSUgtNbm/iOzRrETYk/4mjRl54VDMSr/q6JmHqpe8OlYghMhGitNjjkDff3/4Ea7gcXrCgd0M/w+jRT9dX736+e0f7EiNUQRoPL4YX/pVAWZdz2Tvq4E30ML69d77/P6Gef0Ktr7TDRzfSGRey10tU5D0/fFhdBCwldp/N2W5HO36gLo6Wfy3QUGlYBGzNjeArupDzBc2sFWUSiXxEus1XVZAG7+l8Es+Kin0P6iExfqXxJgxRuydl+wXo9ubuPQtY03bnKiIdwzf0MMw3bMbu2T3zj8i0Q/WayP07QMZlUnheY9W+xPS8cOl+mfjoy0T9S48eudz2rNyvH5Ur9JMcO6nwV8rQH3H7t1a8+vJJhRrbRppCuCjL8l8ZXXpP",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,g={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:"eJztWG1vGzcS/itz/JImWEmWrKaFcDg05+Rao0VtnBP0gywI1O7sLp1dkiW5klVh//thuK96iRXnivYOd/ng2NwZcuaZ4TMz3DHHE8tmc/ZWhUWO0lm2CFiENjRCO6Ekm7H3KcKVQe4QGil4c3sNPMvUxkJh0VhwChKUaEhK4gaiZj9YbUEbtRaRkAlE3HHYCJfCilt8PQWUoYowglhkOLyX9/KDzhSPYKsK0FEMQoIqDMxfvXqLqyKBD9evXi2+Sp3TdjYaca2HSqO0IpEZX9lhqPJRRII6il9Cigb9TiGXEBm+gY2IEnQWuIwgVHoLoRooIyLJHQageYIgi3yFBlQMLsV8CDyzqt3E69Smqxhu3/7jXrKAKU2eCyWvIzZjoQerQYAFzOCvBVr3dxVt2WzHQiUdfZjtGNc6E6FXHT1YgnvHbJhizuk30hMGIwoQAcQCRp6isSxgTrgMKVpuq5HNmFo9YEinaUPmOIGW9vB6s10jZZ0RMmEBi5XJuWMzVnnDAoaPPNckzA5io6OYlc2BT23VrnRbWf9Lmw60z152fdFub3s7lAGTyn2pXT+TatnB2u3CjeFbFjDhMO+vfwJmo56PTYiKzsaci+y5ug8KV4jfVQuU9h4Inj/biAeFsEIPgk6VfLb+eHI5nowvxxPaob5eXw5j9fXYgn1GekPMgxGseVaghQFQ+LgrDAZgHc/18Fz0G3nvNk/6Z1b3/+hMYsE9fpCwSUWYEkvUtAI2VUUWAdcauRkSM/4b5OUUhDwLi4wolQ7x3u551praejYuA/Z43pnHivciQbwHX2UYOyi0RgOhMhLNS4iNymsH/2Ocm0ynZcC2593b/le69w0Fb3Peu19E5FKqPpXlf4qtl9+WAUvP2/oDiiR1f7Kx09dlV74OqvNypaLtsuGt8pxgUydILlZZhIYq/jFfdVTjqwvKaHlI8yulMuTyBNEIC5obnqND03RZ1IA4BVZjKOItbFJ0KRq/vOHSgd/dt2ErBEstGklX1g6ByCvCmBeZqxADYeGeOVPgPRvCddxhWTU+eyb0ZH3jJBW88OctbeFp/MWo/pswetFpWuAGa5sFRq0JXhgc5priaGEjsozsLixGQ2j/+daqRZIMaKplc/D5UnFVWKdy8AfWShAr01UMqJuzIVxxCUKGWRFVqRUrgp66Vtjt2jTw2VGWsNtRVNEsqeiWZdAt0Fl7C76uVisGQxTrPa12CTvFdq2nio9amO0y4q5eCFWuudz2DRCJFDJZFiYry+FRGnYx+mzcjmCqY0eb/A8gRuZcyxsToTl5c1vpmGcWz5BHxS5dT18ntEGrlbRV/zO5uKD/9mPRTl31pmCLMERr4yLLtn9hwecPFE83X9XyaUJ7qptKH8Tkt8dwPbklzArz7Ga2If/CZAOnBhSUQQNd1dv2kBUyExKXDWzLycXFckzYlgGbnoLvTuXoUsrKDYG4MUomAegMuUVwZgs84UICUZH5HdFEY5R5ujY8z7KnQJjugfD1MQjXcs0zEfnB/b36iPKP9bR/vKuOJ1Mfc58r1dzCRCXkv7M9Z/vrlZMWw8IIt2Wz+Y49DrgWg+r7bL4oFwEjYBUN41pZbzF3KZux0dFsbtGs/eQ331Wpy55sRbgWo/WYlcGhtHU8ETIZPKm16Ay/I3Ar/PbM7yYnLX5EGp1qdPpSARMU1BQ5MRPhQTH7Z/fM8K5BvnkAODXTdwgfTumH1eDE3N2M3XuTdG+QnjczsR9z2yn3xODaetiMou0k2hsue7PlvEu0doxrprixH38m06mfE74Z+4b68lvfq05flz41ur6Nsf3ejBj5qMNgbL9yNkptXai4n0ISKx+/GtQbjfJOJNIn/Xp8utET1n9ukPcX0DcoB9r+0SmiqZMKLX2k9cvhuGmvqrs7BHpDI16hZiouMsiE/Ghn93IA85s4FqHgGfyCKyscdl33ZrM5StqXXud74dJiBQa16sQTv+gzu6/V/vGSUgtNbm/iOzRrETYk/4mjRl54VDMSr/q6JmHqpe8OlYghMhGitNjjkDff3/4Ea7gcXrCgd0M/w+jRT9dX736+e0f7EiNUQRoPL4YX/pVAWZdz2Tvq4E30ML69d77/P6Gef0Ktr7TDRzfSGRey10tU5D0/fFhdBCwldp/N2W5HO36gLo6Wfy3QUGlYBGzNjeArupDzBc2sFWUSiXxEus1XVZAG7+l8Es+Kin0P6iExfqXxJgxRuydl+wXo9ubuPQtY03bnKiIdwzf0MMw3bMbu2T3zj8i0Q/WayP07QMZlUnheY9W+xPS8cOl+mfjoy0T9S48eudz2rNyvH5Ur9JMcO6nwV8rQH3H7t1a8+vJJhRrbRppCuCjL8l8ZXXpP",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"}},x={},j=[{value:"Request",id:"request",level:2}];function f(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"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(a.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(a.p,{children:["Upload you pdf in our ",(0,i.jsx)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(a.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)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(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)(m.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(m.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)(m.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(m.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)(m.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)(m.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)(m.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)(m.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)(m.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)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(m.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)(m.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)(m.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)(m.Z,{collapsible:!1,name:"sendInOrder",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)(a.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)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.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)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.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)(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)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.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 b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.5e09231a.js b/assets/js/2c586be5.5e09231a.js deleted file mode 100644 index 380cc9bf9..000000000 --- a/assets/js/2c586be5.5e09231a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>g,toc:()=>x});var i=a(85893),l=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),o=(a(41429),a(5397)),d=a(4667),c=a(9472),p=a(85162);const h={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:"eJztWFtvG7cS/itz+JImWEmWrKaFcHDQ1Elbo0VtHCfogywI1O7sLp1dkiG5klVh/3sx3KsuseOgKIK2eXBs7gw5883wmxnumOOJZbM5e63CIkfpLFsELEIbGqGdUJLN2NsU4cIgdwiNFLy6vgSeZWpjobBoLDgFCUo0JCVxA1GzH6y2oI1ai0jIBCLuOGyES2HFLb6cAspQRRhBLDIc3spb+U5nikewVQXoKAYhQRUG5i9evMZVkcC7yxcvFl+lzmk7G4241kOlUVqRyIyv7DBU+Yj083hEa7kIjeJajyJS1lH8HFI06HcPuYTI8A1sRJSgs8BlBKHSWwjVQBkRSe4wAM0TBFnkKzSgYnAp5kPgmVXtJl6ndkfFcP36h1vJAqY0oSGUvIzYjIUewAYVFjCDHwq07nsVbdlsx0IlHX2Y7RjXOhOhVx3dWQrBjtkwxZzTb6QnDEYUNAKNBYw8RWNZwJxwGVIE3VYjmzG1usOQTtOGzHECLe3h9Wa7Rso6I2TCAhYrk3PHZqzyhgUM73muSZgdxEtHMSubAx/aql3ptrL+lzZFaJ+9jPus3V73digDJpX7XLt+JdWyg7XbhRvDtyxgwmHeX/8IzEY9HZsQFZ2NORfZU3XvFK4Qv6sW6Cp4IHj+ZCPuFMIKPQg6VfLJ+uPJ+XgyPh9PaIf6en0+jNXXYwv2WeoVsRFGsOZZgRYGQOHjrjAYgHU818PHot/Ie7d50j+zuv9HZxIz7vGDhE0qwpRYoqYVsKkqsgi41sjNkNjyTyY0pyDkWVhkRL10sEdgz9vW/NbbcRmw+8cdvK+4MBLEhfBVhrGDQms0ECoj0TyH2Ki8dvqLdngynZYB2z7u8vZv4/I3FOTN4x7/JiKXUuWqvPli7D//tgxY+rj9P6FIUvcFOjB9WXYl8qADWK5UtF023Fg+JtjUIpKLVRahoa7imBM7OvMVDGW0PCwlK6Uy5PIEmQkLmhueo0PTdHfU5DgFVmMo4i1sUnQpGr+84dKB3923fysES60hSVfWDoEIMsKYF5mrEANh4ZY5U+AtG8Jl3GFZNVd7JvRkfXMmFTzz5y1t4UvFs1H9N2H0rNO0wA3WNguMWhO8MDjMNcXRwkZkGdldWIyG0P7z7VuLJBnQVOTm4MfL0UVhncrBH1grQaxMV5WgbgCHcMElCBlmRVSlVqwIeuqWYbdr08BnR1nCbkdRRbOkwl6WQbdAZ+0t+NpdrRgMUaz3tNol7BTbtZ4q3mthtsuIu3ohVLnmcts3QCRSyGRZmKwsh0dp2MXok3E7gqmOHW3yD0CMzLmUVyZCc/LmttIxzyw+Qh4Vu3RzQ53QBq1W0lY91uTsjP7bj0U77dWbgi3CEK2Niyzb/ocFnz60PNzgVcunCe2hji29E5Pf78P15JowK8yTG+amIBQmGzg1oKAMGuiq/rmHrJCZkLhsYFtOzs6WY8K2DNj0FHw3KkeXUlZuCMSNUTIJQGfILYIzW+AJFxKIisyfiCYao8zDteFplj0EwnQPhK+PQbiUa56JyD8YvFXvUf61nvaPd9XxZOp97nOlmo2YqIT8d7bnbH+9ctJiWBjhtmw237H7AddiUH2fzRflImAErKKBXyvrLeYuZTM2Opr/LZq1ny7nuyp12YPtCdditB6zMjiUto4nQiaDB7UWneE3BG6F35753XSmxc9I41mNTl8qYIKCmiInZiI8KGb/754y3jTIN48Mp94NOoQPXwIOq8GJ2b4Z7fem9d6wPm/mbj9Kt5P0ieG49bAZd9tptzfA9ubXeZdo7ajYTIpjP05NplM/Y3wz9o33+be+f52+LH1qdH0bY/u9GTHyUYfB2H7lbJTaulBxP4UkVj5+NahXGuWNSKRP+vX4dKMnrP/cIO8voG9QDrT9w1ZEky0VWvpI6+fDcdNeVXd3CPR2R7xCzVRcZJAJ+d7ObuUA5ldxLELBM/gNV1Y47DrxzWZzlLTPvc6PwqXFCgxq1YknftFndl+r/eM5pRaa3F7FN2jWImxI/iNHjbzwqGYkXvV1TcLUS98dKhFDZCJEabHHIa9+vP4F1nA+PGNB74Z+gtGjXy4v3vx684b2JUaogjQeng3P/EuEsi7nsnfUwVvsYXx7b4n/Pt1+3tNtfc0d3ruRzriQvf6iIvT54YPuImApMf5sznY72vEddXa0/KFAQ+ViEbA1N4Kv6JLOFzTbVjRKxPIe6YZfVIEbvKXzSTwrKkY+qJFUBSqNV2GI2j0o2y9K11c3b1nAmlY8VxHpGL6hB2m+YTN2y26Zf7ymHapXTO7fEDIuk8JzHav2JfbnhUv3S8d7XzrqX3qUyeW2Z+V+TalcoZ/k2EmF/1LW/ozb/7Xi1ZePKtTYNtIUwkVZln8Aqc6xWg==",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/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:"eJztWFtvG7cS/itz+JImWEmWrKaFcHDQ1Elbo0VtHCfogywI1O7sLp1dkiG5klVh/3sx3KsuseOgKIK2eXBs7gw5883wmxnumOOJZbM5e63CIkfpLFsELEIbGqGdUJLN2NsU4cIgdwiNFLy6vgSeZWpjobBoLDgFCUo0JCVxA1GzH6y2oI1ai0jIBCLuOGyES2HFLb6cAspQRRhBLDIc3spb+U5nikewVQXoKAYhQRUG5i9evMZVkcC7yxcvFl+lzmk7G4241kOlUVqRyIyv7DBU+Yj083hEa7kIjeJajyJS1lH8HFI06HcPuYTI8A1sRJSgs8BlBKHSWwjVQBkRSe4wAM0TBFnkKzSgYnAp5kPgmVXtJl6ndkfFcP36h1vJAqY0oSGUvIzYjIUewAYVFjCDHwq07nsVbdlsx0IlHX2Y7RjXOhOhVx3dWQrBjtkwxZzTb6QnDEYUNAKNBYw8RWNZwJxwGVIE3VYjmzG1usOQTtOGzHECLe3h9Wa7Rso6I2TCAhYrk3PHZqzyhgUM73muSZgdxEtHMSubAx/aql3ptrL+lzZFaJ+9jPus3V73digDJpX7XLt+JdWyg7XbhRvDtyxgwmHeX/8IzEY9HZsQFZ2NORfZU3XvFK4Qv6sW6Cp4IHj+ZCPuFMIKPQg6VfLJ+uPJ+XgyPh9PaIf6en0+jNXXYwv2WeoVsRFGsOZZgRYGQOHjrjAYgHU818PHot/Ie7d50j+zuv9HZxIz7vGDhE0qwpRYoqYVsKkqsgi41sjNkNjyTyY0pyDkWVhkRL10sEdgz9vW/NbbcRmw+8cdvK+4MBLEhfBVhrGDQms0ECoj0TyH2Ki8dvqLdngynZYB2z7u8vZv4/I3FOTN4x7/JiKXUuWqvPli7D//tgxY+rj9P6FIUvcFOjB9WXYl8qADWK5UtF023Fg+JtjUIpKLVRahoa7imBM7OvMVDGW0PCwlK6Uy5PIEmQkLmhueo0PTdHfU5DgFVmMo4i1sUnQpGr+84dKB3923fysES60hSVfWDoEIMsKYF5mrEANh4ZY5U+AtG8Jl3GFZNVd7JvRkfXMmFTzz5y1t4UvFs1H9N2H0rNO0wA3WNguMWhO8MDjMNcXRwkZkGdldWIyG0P7z7VuLJBnQVOTm4MfL0UVhncrBH1grQaxMV5WgbgCHcMElCBlmRVSlVqwIeuqWYbdr08BnR1nCbkdRRbOkwl6WQbdAZ+0t+NpdrRgMUaz3tNol7BTbtZ4q3mthtsuIu3ohVLnmcts3QCRSyGRZmKwsh0dp2MXok3E7gqmOHW3yD0CMzLmUVyZCc/LmttIxzyw+Qh4Vu3RzQ53QBq1W0lY91uTsjP7bj0U77dWbgi3CEK2Niyzb/ocFnz60PNzgVcunCe2hji29E5Pf78P15JowK8yTG+amIBQmGzg1oKAMGuiq/rmHrJCZkLhsYFtOzs6WY8K2DNj0FHw3KkeXUlZuCMSNUTIJQGfILYIzW+AJFxKIisyfiCYao8zDteFplj0EwnQPhK+PQbiUa56JyD8YvFXvUf61nvaPd9XxZOp97nOlmo2YqIT8d7bnbH+9ctJiWBjhtmw237H7AddiUH2fzRflImAErKKBXyvrLeYuZTM2Opr/LZq1ny7nuyp12YPtCdditB6zMjiUto4nQiaDB7UWneE3BG6F35753XSmxc9I41mNTl8qYIKCmiInZiI8KGb/754y3jTIN48Mp94NOoQPXwIOq8GJ2b4Z7fem9d6wPm/mbj9Kt5P0ieG49bAZd9tptzfA9ubXeZdo7ajYTIpjP05NplM/Y3wz9o33+be+f52+LH1qdH0bY/u9GTHyUYfB2H7lbJTaulBxP4UkVj5+NahXGuWNSKRP+vX4dKMnrP/cIO8voG9QDrT9w1ZEky0VWvpI6+fDcdNeVXd3CPR2R7xCzVRcZJAJ+d7ObuUA5ldxLELBM/gNV1Y47DrxzWZzlLTPvc6PwqXFCgxq1YknftFndl+r/eM5pRaa3F7FN2jWImxI/iNHjbzwqGYkXvV1TcLUS98dKhFDZCJEabHHIa9+vP4F1nA+PGNB74Z+gtGjXy4v3vx684b2JUaogjQeng3P/EuEsi7nsnfUwVvsYXx7b4n/Pt1+3tNtfc0d3ruRzriQvf6iIvT54YPuImApMf5sznY72vEddXa0/KFAQ+ViEbA1N4Kv6JLOFzTbVjRKxPIe6YZfVIEbvKXzSTwrKkY+qJFUBSqNV2GI2j0o2y9K11c3b1nAmlY8VxHpGL6hB2m+YTN2y26Zf7ymHapXTO7fEDIuk8JzHav2JfbnhUv3S8d7XzrqX3qUyeW2Z+V+TalcoZ/k2EmF/1LW/ozb/7Xi1ZePKtTYNtIUwkVZln8Aqc6xWg==",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={},x=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Document"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(s.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(s.p,{children:["Upload you pdf in our ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:(0,i.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,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(m.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:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.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)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"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/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(c.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-sign-document.com"}})]})]})}),(0,i.jsx)(p.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)(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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(c.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)(o.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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(c.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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.914a8d69.js b/assets/js/935f2afb.914a8d69.js new file mode 100644 index 000000000..e49a889de --- /dev/null +++ b/assets/js/935f2afb.914a8d69.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send template to a signer","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Profile","href":"/docs/help/Settings/profile","docId":"help/Settings/profile","unlisted":false}],"href":"/docs/category/settings"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Localhost Setup with Docker","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftedocument","className":"api-method post","docId":"API-docs/draftedocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"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.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"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://staging-ap.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/draftedocument":{"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.","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allow you to save webhook url which is used to trigger events","sidebar":"apiSidebar"},"API-docs/update-document":{"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.","sidebar":"apiSidebar"},"API-docs/update-template":{"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.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/profile":{"id":"help/Settings/profile","title":"Profile","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send template to a signer","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost Setup with Docker","description":"Steps to run OpenSign\u2122 with docker in macos/linux:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.b319ac64.js b/assets/js/935f2afb.b319ac64.js deleted file mode 100644 index 4625ad3ca..000000000 --- a/assets/js/935f2afb.b319ac64.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send template to a signer","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Profile","href":"/docs/help/Settings/profile","docId":"help/Settings/profile","unlisted":false}],"href":"/docs/category/settings"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Localhost Setup with Docker","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftedocument","className":"api-method post","docId":"API-docs/draftedocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"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.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"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://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/draftedocument":{"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.","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allow you to save webhook url which is used to trigger events","sidebar":"apiSidebar"},"API-docs/update-document":{"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.","sidebar":"apiSidebar"},"API-docs/update-template":{"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.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/profile":{"id":"help/Settings/profile","title":"Profile","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send template to a signer","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost Setup with Docker","description":"Steps to run OpenSign\u2122 with docker in macos/linux:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.10ca4231.js b/assets/js/bbdfc22d.10ca4231.js new file mode 100644 index 000000000..b94e93013 --- /dev/null +++ b/assets/js/bbdfc22d.10ca4231.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),c=(a(82723),a(9487)),d=(a(41429),a(5397)),o=a(4667),m=a(9472),p=a(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:"eJztWG1v2zYQ/is3fmoCxXZSryuMYVjftgUblmBJMAyOEdDSSeJKkSxJ2fEM/ffhSMmWnTRpu2Ev2L4kMnl3vDsen3vINfO8cGwyZZdYGck9OjZLWIYutcJ4oRWbsMsSoZuGVxY5jcOL81PgUuqlg9qhdeA1pDSJkNbO60r8xucSwXeGE1iWIi3BoV0gcAdzWaOxQnkHubZQoELLvVAFZDqtK6SJpfAlGIsZ5kJhBs7bOvW1RTeAK6MVuDpN0bm8lpuVohtCqwR8icFRi762ygGHWol3NcLhYSd9I7LDQ/Al95ByBXOkcDKKpnUIe+7MOc1pFQw7g6nIBQm3tgZwra7VlZGaZ7DSNZgsB6FA1xamh4evcV4XcHV6eDh7Unpv3GQ45MYMtEHlRKEkn7tBqqthRoImyw+gRIvBEvmWWb6EpcgK9A64yiDVZgWpPtJWZIp7TMDwAkHV1Rwt6JzcrAbApdMbI0GH4ng2Jonz198MrhVLmDYh+1qdZmzC4k52cbGEWXxXo/MvdbZikzVLtfKoPH1yY6RIg+rwV0cVs2YuLbHi9EV6wmJGNZYLSaYoVLSOJcwLL5EKzq8MsgnT818x9SxhxpI7XqAjG0Fvsu6knLdCFSxhubYV92zCYjgsYXjLK0PC7RCgSnWGGQQTTbfiQ7Y2I1tbLnxsdpnsKO0/1UxQbfYO2SdZ6ltotnndGuPW8hXbP8+/tJVgrF6IDCHqgQ7zXMoViDyUi/B0TDPMeS19K8YSJjxW/VXes2tWf3ymU9QUCVZcyI/VDdvCq49ek/RMqdUnKban8Z6cf2CW4uzdhXe37AUBLWaw4LJGB0dhMzjhYALO88oMHquYTj5Ey4v+mhEu7qxJsL8DJ6oFcMK+GDe4UtcyA24Mcjsg5PwDWEcNhMu0DhhOi4RodyLbuLqJ7LhJ2O3jwdxGmMwEwSQ8kZh7qI1BC6m2Cu0B5FZXbYD/mOBOxuMmYavHw1v9K8P7gjZv+Xh0P4vMl9Ssoud/i69PnzcJKx/39TsURen/ZmfHz5ptr9vr5Tdzna1uOtxqHhPsmgrJOVTZqTqzGdpeIuZaS+Sqv37OpcNHLMelt/TA2xrDgDNauQiOJ6MR/dvDpR2aR5xwQwHl6jOWfDg3eRiZ4zCxobvovAXWl+XJd86oKi0JWSt0bhdc71F5JIB+3oSSQuFNl5Sbk9Ho5nPKXJOw8X3JudAV+pI49BKVh6XVqkjASOQOwdsV8IILBbS8/RNzhdZq+3DUH+fZQ0kYj0Y3x5skfH43CadqwaXIAvO/1G9R/bWR9pf3cXly9bYKlCZSFCaiUJhnO8H2x2OQDtPaCr9ik+ma3R5xI47i/GQ6a2ZUdb7UxNqNdsFj7ks2YcM7JD5cvYghTtestpJN2IMoxI0YLo5Zk+xLO88LoYqjB7VmW8cvKLkxfzvub0mTEd8jsaY2O32phAna1BI54Q7lg/bsp+195E2X+e6mcC/536Z4n853bH6HoO/j+j2Uu8e4px3dDQx2Q2DZNiK2IZn0uaGN020hbRhaR9COA7M5GY8DBfjiOPTKp89DGxo/a2Yxwz1IjrBL+cp1SG4b8JlBdSGKeGdfHN/D9IQD4cJ0d9eNl3y6l+9p796BaZLGnw6Ou/twPFjxKkyHnhogXc+lUG/d5FodwfQsz0UquISfce6Ex203XC6XdyrqIOh8K3xZz8Gi0VvxIgyGsutrbX4c0LajrdxZfoF2IVJsq/g9Sw2D8LCFC54GuOg2sx36el+Jjq8UKSqHvQP+4tvzH2ABTwcjlvSOzwc4Pfzh9NWbHy/ekF06rnGTjgejwSiwd+18xVVvqVfx2eVyW9B7d8sN9v3/lvOfeMtpIcXjrR8ayUXoMKEG121zmO6/8MwSVlL3mEzZek0mr6xsGhp+V6Ol1jNL2IJbQYUQGk/SQTKB2FtcUSHGOju6pPVJXNYR3ff6LXWUqPEiTdH4B2X7De787OKSJWzevkJVOiMdy5f0QsWXbMKu2TULr1lkIb5D8HDFkFwVdcBVFu1SJ+G1L3fb0NvQhtqPHjxztep5udufYij0lwK7V+FLqtzvcfXVRjzOvFehzW0nTVs4a5rmd4Ayguk=",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:"eJztWG1v2zYQ/is3fmoCxXZSryuMYVjftgUblmBJMAyOEdDSSeJKkSxJ2fEM/ffhSMmWnTRpu2Ev2L4kMnl3vDsen3vINfO8cGwyZZdYGck9OjZLWIYutcJ4oRWbsMsSoZuGVxY5jcOL81PgUuqlg9qhdeA1pDSJkNbO60r8xucSwXeGE1iWIi3BoV0gcAdzWaOxQnkHubZQoELLvVAFZDqtK6SJpfAlGIsZ5kJhBs7bOvW1RTeAK6MVuDpN0bm8lpuVohtCqwR8icFRi762ygGHWol3NcLhYSd9I7LDQ/Al95ByBXOkcDKKpnUIe+7MOc1pFQw7g6nIBQm3tgZwra7VlZGaZ7DSNZgsB6FA1xamh4evcV4XcHV6eDh7Unpv3GQ45MYMtEHlRKEkn7tBqqthRoImyw+gRIvBEvmWWb6EpcgK9A64yiDVZgWpPtJWZIp7TMDwAkHV1Rwt6JzcrAbApdMbI0GH4ng2Jonz198MrhVLmDYh+1qdZmzC4k52cbGEWXxXo/MvdbZikzVLtfKoPH1yY6RIg+rwV0cVs2YuLbHi9EV6wmJGNZYLSaYoVLSOJcwLL5EKzq8MsgnT818x9SxhxpI7XqAjG0Fvsu6knLdCFSxhubYV92zCYjgsYXjLK0PC7RCgSnWGGQQTTbfiQ7Y2I1tbLnxsdpnsKO0/1UxQbfYO2SdZ6ltotnndGuPW8hXbP8+/tJVgrF6IDCHqgQ7zXMoViDyUi/B0TDPMeS19K8YSJjxW/VXes2tWf3ymU9QUCVZcyI/VDdvCq49ek/RMqdUnKban8Z6cf2CW4uzdhXe37AUBLWaw4LJGB0dhMzjhYALO88oMHquYTj5Ey4v+mhEu7qxJsL8DJ6oFcMK+GDe4UtcyA24Mcjsg5PwDWEcNhMu0DhhOi4RodyLbuLqJ7LhJ2O3jwdxGmMwEwSQ8kZh7qI1BC6m2Cu0B5FZXbYD/mOBOxuMmYavHw1v9K8P7gjZv+Xh0P4vMl9Ssoud/i69PnzcJKx/39TsURen/ZmfHz5ptr9vr5Tdzna1uOtxqHhPsmgrJOVTZqTqzGdpeIuZaS+Sqv37OpcNHLMelt/TA2xrDgDNauQiOJ6MR/dvDpR2aR5xwQwHl6jOWfDg3eRiZ4zCxobvovAXWl+XJd86oKi0JWSt0bhdc71F5JIB+3oSSQuFNl5Sbk9Ho5nPKXJOw8X3JudAV+pI49BKVh6XVqkjASOQOwdsV8IILBbS8/RNzhdZq+3DUH+fZQ0kYj0Y3x5skfH43CadqwaXIAvO/1G9R/bWR9pf3cXly9bYKlCZSFCaiUJhnO8H2x2OQDtPaCr9ik+ma3R5xI47i/GQ6a2ZUdb7UxNqNdsFj7ks2YcM7JD5cvYghTtestpJN2IMoxI0YLo5Zk+xLO88LoYqjB7VmW8cvKLkxfzvub0mTEd8jsaY2O32phAna1BI54Q7lg/bsp+195E2X+e6mcC/536Z4n853bH6HoO/j+j2Uu8e4px3dDQx2Q2DZNiK2IZn0uaGN020hbRhaR9COA7M5GY8DBfjiOPTKp89DGxo/a2Yxwz1IjrBL+cp1SG4b8JlBdSGKeGdfHN/D9IQD4cJ0d9eNl3y6l+9p796BaZLGnw6Ou/twPFjxKkyHnhogXc+lUG/d5FodwfQsz0UquISfce6Ex203XC6XdyrqIOh8K3xZz8Gi0VvxIgyGsutrbX4c0LajrdxZfoF2IVJsq/g9Sw2D8LCFC54GuOg2sx36el+Jjq8UKSqHvQP+4tvzH2ABTwcjlvSOzwc4Pfzh9NWbHy/ekF06rnGTjgejwSiwd+18xVVvqVfx2eVyW9B7d8sN9v3/lvOfeMtpIcXjrR8ayUXoMKEG121zmO6/8MwSVlL3mEzZek0mr6xsGhp+V6Ol1jNL2IJbQYUQGk/SQTKB2FtcUSHGOju6pPVJXNYR3ff6LXWUqPEiTdH4B2X7De787OKSJWzevkJVOiMdy5f0QsWXbMKu2TULr1lkIb5D8HDFkFwVdcBVFu1SJ+G1L3fb0NvQhtqPHjxztep5udufYij0lwK7V+FLqtzvcfXVRjzOvFehzW0nTVs4a5rmd4Ayguk=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create Template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.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,t.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsxs)(s.p,{children:["Upload you pdf in our ",(0,t.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,t.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,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(s.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,t.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object[]"})}),(0,t.jsx)("span",{className:"openapi-schema__divider"}),(0,t.jsx)("span",{className:"openapi-schema__required",children:(0,t.jsx)(s.p,{children:"required"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"widgets"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.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,t.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,t.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,t.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,t.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,t.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,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})}),(0,t.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",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)(l.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.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,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.298e9aa8.js b/assets/js/bbdfc22d.298e9aa8.js deleted file mode 100644 index dc5f67a03..000000000 --- a/assets/js/bbdfc22d.298e9aa8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=a(85893),l=a(11151),t=a(58219),r=(a(62316),a(51039)),n=a.n(r),c=(a(82723),a(9487)),m=(a(41429),a(5397)),o=a(4667),p=a(9472),d=a(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:"eJztWG1v2zYQ/is3fmoDxXZSrxuMYVjWdlvQYQmWFMXgGAEtnSQ2FMmSlB3P0H8fjpRs2UmTthiGYtuXRCbvncfn7rhmnheOTabsEisjuUfHZgnL0KVWGC+0YhN2WSJ02/DCIqd1ODk/BS6lXjqoHVoHXkNKmwhp7byuxJ98LhF8JziBZSnSEhzaBQJ3MJc1GiuUd5BrCwUqtNwLVUCm07pC2lgKX4KxmGEuFGbgvK1TX1t0A3hjtAJXpyk6l9dyoymaIbRKwJcYDLXoa6sccKiVeF8jHBx01NciOzgAX3IPKVcwR3InI29ag7BnzpzTnlZBsDOYilwQcStrAFfqSr0xUvMMVroGk+UgFOjawvTg4CXO6wLenB4czJ6U3hs3GQ65MQNtUDlRKMnnbpDqakj8VT6ktUqkVnNjhhkxmyx/CiVaDNLJ3szyJSxFVqB3wFUGqTYrSPWhtiJT3GMChhcIqq7maEHnZHo1AC6d3ggJPOTb8zFRnL/8aXClWMK0CSei1WnGJiyebucrS5jF9zU6/6POVmyyZqlWHpWnT26MFGlgHb5zlEVr5tISK05fxCcsZpR3uZAkilxF61jCvPASKQn9yiCbMD1/h6lnCTOWzPECHckIfJN1R+W8FapgCcu1rbhnExbdYQnDW14ZIm6XAFWqM8wgiGg6jQ/J2qxsZbnwsTl5kqO0/1wxgbXZu3ifJakvodnGdSuMW8tXbP+O/9FmgrF6ITKEyAc67HMpVyDykC7C09XNMOe19C0ZS5jwWPW1fODUrP70SKeoyROsuJCfyhuOhVefrJP4TKnVZzG2t/GemH9klOLuXcW7R3ZC4IsZLLis0cFhOAxO2JiA87wyg8cypqMP3vKirzPCxR2dVAp24ES1oE54GP0GV+paZsCNQW4HhKZ/M/5RoeEyrQPWk+IQgR1vN+ZvvD1qEnb7uIO3ETozQdAJTyTmHmpj0EKqrUL7FHKrq9bpL9rh4/G4SdjqcZdX/xqXv6FDXj7u8VuR+ZIKXfTmi7H/2bdNwsrH7f8FRVH6L9CB8fNmW0/3+oXruc5W1x02No8RdoWL6Byq7FSd2QxtLzhzrSVy1defc+nwEclR9bYF8bbGsOCMVi4C8PFoRP/2sG+nvaRedNN6ytVXLPn4/udh9I/L1HHdrQBb8P6xPP7FGVWlJaF3hc7tAvg9LI840I+bUFIovO6Ccn08Gl1/TZFrEja+LzgXukJfUu++ROVhabUqEjASuUPwdgW84EIBqbd/Y6zQWm0f9vrTLHsoCOPR6PpoE4Sv7wbhVC24FFmYOC71Dap/1tO+eh/Vk6m3VWibYhvERCQK+2zH2f56dNJhWlvhV2wyXbPbQ27EYdyfTGfNjLLOl5omA6NdsJj7kk3Y8M6gEEY+6kKna1ZbySbsQWTiRgwXR6xJ9qmd54VQxeGDXLOt4RcU3Bi/HfO3jZkRr5E6szY6faqECTrUEjnhDsWDzuz37czzqot8N43cO2BsQ7w/MnQTw84QsI/197T1va5+2rXUoUveNMls6xHbNLL0uWlNp9tE2nSBXRN4FDql4/E4tA/fHIWa+uzbUJrGz5tZjHAPkiPsUrxyHYLbOnxmUF2IIr4VLI7u6SaFA+HCdjdjx8cFeg/Y496dvWmT1p8Njro5PF6sOILTpaeiSM8CUqgbN7lShzA9y3ORCi7hLc6d8LitkMvl8k5GPQ08Pwtf1nOwaPSWvAiLIe36XJsfT+nY0VbuLL9AuxAptln8AVXDQDxs4YKnAS66w2yXfthnousrRYrKYe+Cn/x8/iss4NlgxJLe9fkIo4e/nr549dvFK5JL1zUe0tFgNBiFCUE7X3HVU/UiPvdcbhN6b37dYN//b0j/2TekFmY83vqhkVyEqhPyct0WjOn+y9IsYSVVlMmUrdck8o2VTUPL72u0VI5mCVtwKyg5QjFKOpgmYLvBFSVnzL3DS9JP5LKOiL9Xg6nKRI6TNEXjH6TtF73zs4tLlrB5+/pV6Yx4LF/Syxhfsgm7YlcsvKKRhPj+wcN4Irkq6oC1LMql6sJrX+6WpptQmtqPHmRztepZuVuzoiv0lxy7l+E7yubXuPp+Qx53PsjQxrajpiOcNU3zFzjFufQ=",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:"eJztWG1v2zYQ/is3fmoDxXZSrxuMYVjWdlvQYQmWFMXgGAEtnSQ2FMmSlB3P0H8fjpRs2UmTthiGYtuXRCbvncfn7rhmnheOTabsEisjuUfHZgnL0KVWGC+0YhN2WSJ02/DCIqd1ODk/BS6lXjqoHVoHXkNKmwhp7byuxJ98LhF8JziBZSnSEhzaBQJ3MJc1GiuUd5BrCwUqtNwLVUCm07pC2lgKX4KxmGEuFGbgvK1TX1t0A3hjtAJXpyk6l9dyoymaIbRKwJcYDLXoa6sccKiVeF8jHBx01NciOzgAX3IPKVcwR3InI29ag7BnzpzTnlZBsDOYilwQcStrAFfqSr0xUvMMVroGk+UgFOjawvTg4CXO6wLenB4czJ6U3hs3GQ65MQNtUDlRKMnnbpDqakj8VT6ktUqkVnNjhhkxmyx/CiVaDNLJ3szyJSxFVqB3wFUGqTYrSPWhtiJT3GMChhcIqq7maEHnZHo1AC6d3ggJPOTb8zFRnL/8aXClWMK0CSei1WnGJiyebucrS5jF9zU6/6POVmyyZqlWHpWnT26MFGlgHb5zlEVr5tISK05fxCcsZpR3uZAkilxF61jCvPASKQn9yiCbMD1/h6lnCTOWzPECHckIfJN1R+W8FapgCcu1rbhnExbdYQnDW14ZIm6XAFWqM8wgiGg6jQ/J2qxsZbnwsTl5kqO0/1wxgbXZu3ifJakvodnGdSuMW8tXbP+O/9FmgrF6ITKEyAc67HMpVyDykC7C09XNMOe19C0ZS5jwWPW1fODUrP70SKeoyROsuJCfyhuOhVefrJP4TKnVZzG2t/GemH9klOLuXcW7R3ZC4IsZLLis0cFhOAxO2JiA87wyg8cypqMP3vKirzPCxR2dVAp24ES1oE54GP0GV+paZsCNQW4HhKZ/M/5RoeEyrQPWk+IQgR1vN+ZvvD1qEnb7uIO3ETozQdAJTyTmHmpj0EKqrUL7FHKrq9bpL9rh4/G4SdjqcZdX/xqXv6FDXj7u8VuR+ZIKXfTmi7H/2bdNwsrH7f8FRVH6L9CB8fNmW0/3+oXruc5W1x02No8RdoWL6Byq7FSd2QxtLzhzrSVy1defc+nwEclR9bYF8bbGsOCMVi4C8PFoRP/2sG+nvaRedNN6ytVXLPn4/udh9I/L1HHdrQBb8P6xPP7FGVWlJaF3hc7tAvg9LI840I+bUFIovO6Ccn08Gl1/TZFrEja+LzgXukJfUu++ROVhabUqEjASuUPwdgW84EIBqbd/Y6zQWm0f9vrTLHsoCOPR6PpoE4Sv7wbhVC24FFmYOC71Dap/1tO+eh/Vk6m3VWibYhvERCQK+2zH2f56dNJhWlvhV2wyXbPbQ27EYdyfTGfNjLLOl5omA6NdsJj7kk3Y8M6gEEY+6kKna1ZbySbsQWTiRgwXR6xJ9qmd54VQxeGDXLOt4RcU3Bi/HfO3jZkRr5E6szY6faqECTrUEjnhDsWDzuz37czzqot8N43cO2BsQ7w/MnQTw84QsI/197T1va5+2rXUoUveNMls6xHbNLL0uWlNp9tE2nSBXRN4FDql4/E4tA/fHIWa+uzbUJrGz5tZjHAPkiPsUrxyHYLbOnxmUF2IIr4VLI7u6SaFA+HCdjdjx8cFeg/Y496dvWmT1p8Njro5PF6sOILTpaeiSM8CUqgbN7lShzA9y3ORCi7hLc6d8LitkMvl8k5GPQ08Pwtf1nOwaPSWvAiLIe36XJsfT+nY0VbuLL9AuxAptln8AVXDQDxs4YKnAS66w2yXfthnousrRYrKYe+Cn/x8/iss4NlgxJLe9fkIo4e/nr549dvFK5JL1zUe0tFgNBiFCUE7X3HVU/UiPvdcbhN6b37dYN//b0j/2TekFmY83vqhkVyEqhPyct0WjOn+y9IsYSVVlMmUrdck8o2VTUPL72u0VI5mCVtwKyg5QjFKOpgmYLvBFSVnzL3DS9JP5LKOiL9Xg6nKRI6TNEXjH6TtF73zs4tLlrB5+/pV6Yx4LF/Syxhfsgm7YlcsvKKRhPj+wcN4Irkq6oC1LMql6sJrX+6WpptQmtqPHmRztepZuVuzoiv0lxy7l+E7yubXuPp+Qx53PsjQxrajpiOcNU3zFzjFufQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Template"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(s.p,{children:["Upload you pdf in our ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:(0,i.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,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(d.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)(o.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(o.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)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(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,i.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/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.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/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.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/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.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/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.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/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",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)(d.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(d.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(d.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(d.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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(d.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)(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,i.jsx)(d.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(d.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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(d.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)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(d.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.a1172d1b.js b/assets/js/runtime~main.6bc5ec2f.js similarity index 79% rename from assets/js/runtime~main.a1172d1b.js rename to assets/js/runtime~main.6bc5ec2f.js index cfada7e36..526ba38ca 100644 --- a/assets/js/runtime~main.a1172d1b.js +++ b/assets/js/runtime~main.6bc5ec2f.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,d,r={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return r[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=r,t.c=f,e=[],t.O=(a,c,b,d)=>{if(!c){var r=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!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 r={};a=a||[null,c({}),c([]),c(c)];for(var f=2&b&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>r[a]=()=>e[a]));return r.default=()=>e,t.d(d,r),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",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",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",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",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:"b319ac64",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"142abd15",339:"965bda1f",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6965f6a9",948:"b2da1fd1",1332:"bdf7e411",1477:"b31b2642",1512:"7ddd2ec3",1520:"cfe051cf",1531:"298e9aa8",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"9ac115fd",2121:"c8df990c",2241:"e6e648f1",2245:"e95152b3",2267:"a4846e2b",2362:"ebdb1814",2403:"98102502",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"450477a3",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"804248b0",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"8f728b1e",4985:"c2841a57",5377:"4f515bc1",5507:"36c41078",5858:"86987606",5900:"395b3964",6011:"6de743c9",6033:"8efd80de",6103:"ebc8482f",6113:"8e8c149c",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"f9046360",7971:"8323da14",8055:"27482879",8087:"fd9041fd",8106:"015e4a9a",8140:"901b2f91",8141:"6478079e",8163:"7d7e666b",8468:"4f2bfead",8474:"f58804a4",8475:"d27b3009",8489:"40a02a7c",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"d6b7d755",8781:"38246912",8784:"c7f9aad2",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"3b8abbdf",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"5e09231a",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[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,r)=>{if(b[e])b[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var d=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},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",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","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","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","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 r=t.p+t.u(a),f=new Error;t.l(r,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),r=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+d+": "+r+")",f.name="ChunkLoadError",f.type=d,f.request=r,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,r=c[0],f=c[1],o=c[2],l=0;if(r.some((a=>0!==e[a]))){for(b in f)t.o(f,b)&&(t.m[b]=f[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,r,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[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=f,e=[],t.O=(a,c,b,r)=>{if(!c){var d=1/0;for(n=0;n=r)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,r0&&e[n-1][2]>r;n--)e[n]=e[n-1];e[n]=[c,b,r]},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 r=Object.create(null);t.r(r);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&b&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(r,d),r},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",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",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",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",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:"914a8d69",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"142abd15",339:"965bda1f",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6965f6a9",948:"b2da1fd1",1332:"bdf7e411",1477:"b31b2642",1512:"7ddd2ec3",1520:"cfe051cf",1531:"10ca4231",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"9ac115fd",2121:"c8df990c",2241:"e6e648f1",2245:"e95152b3",2267:"a4846e2b",2362:"ebdb1814",2403:"98102502",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"450477a3",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"804248b0",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"8f728b1e",4985:"c2841a57",5377:"4f515bc1",5507:"36c41078",5858:"86987606",5900:"395b3964",6011:"6de743c9",6033:"654c559e",6103:"ebc8482f",6113:"8e8c149c",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"f9046360",7971:"8323da14",8055:"27482879",8087:"fd9041fd",8106:"015e4a9a",8140:"901b2f91",8141:"6478079e",8163:"7d7e666b",8468:"4f2bfead",8474:"f58804a4",8475:"d27b3009",8489:"40a02a7c",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"d6b7d755",8781:"38246912",8784:"c7f9aad2",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"3b8abbdf",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"544f11c6",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[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={},r="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var r=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),r&&r.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},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",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","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","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","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 r=new Promise(((c,r)=>b=e[a]=[c,r]));c.push(b[2]=r);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var r=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+r+": "+d+")",f.name="ChunkLoadError",f.type=r,f.request=d,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,r,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in f)t.o(f,b)&&(t.m[b]=f[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 7f1906ea0..0d9603937 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 423793bf8..728465316 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 f7868c439..b0fa83463 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 e7103d997..7c4f47f67 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 ef57e5630..c790992ee 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 c7e0ceab3..5c88f7a82 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 c14ce2e0e..d2bff9c73 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 5e8b3898a..51a369030 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 c9fd2007c..9b9e81659 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 a1e93f16a..9be699786 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 da1456da5..728566ca5 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 0cb1dd075..d1c493240 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 775b920f4..ea3f0f180 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,16 +5,16 @@ Create Document | OpenSign™ - +

Create Document

POST 
/createdocument

The Create Document API allows users to generate new documents by providing data with base64 encoded file.

-

Upload you pdf in our Debug UI here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

+

Upload you pdf in our Debug UI here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

Request​

-

Body

required

    file base64required
    title stringrequired
    description string
    note string

    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

    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

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 8403e0dcb..ede3e7391 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -3,15 +3,15 @@ -Create Document from Template | OpenSign™ +Create Document from Template | OpenSign™ - +

Create Document from Template

POST 
/createdocument/:template_id
-

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.

+

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
diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index d10de831e..4de34bb9d 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,16 +5,16 @@ Create Template | OpenSign™ - +

Create Template

POST 
/createtemplate

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.

-

Upload you pdf in our Debug UI here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF.

+

Upload you pdf in our Debug UI here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF.

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

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 35bc299ee..ce1192ee5 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 66c2ea032..79f49467d 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 5e6be8352..5e407606b 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 45bededae..aaf289e3d 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/draftedocument/index.html b/docs/API-docs/draftedocument/index.html index b634b65a1..a7748d913 100644 --- a/docs/API-docs/draftedocument/index.html +++ b/docs/API-docs/draftedocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 738ed1d42..363037df1 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 d1a992ca5..f82d40406 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 cca5a9b8a..1e8744a0f 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 f9d8d3655..1816204fc 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 dfaef6ba7..cf6f4c096 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 f01e42d32..642e4a027 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/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index f42b6bbae..fa90b3780 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 e6b24dde1..77c704a84 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 ad7fa01b4..ca5a32a85 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/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 9d44ec93b..dc4ad5cdf 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 379dca0d9..19613c605 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 857145b5b..0d3197c28 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index 3c1489a3c..bcb19848b 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 5903714f5..41edebc0c 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 659458707..4fbe2ec69 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index 0930444b0..eb1d1b392 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 cdbd7729a..8c5f1048b 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 c2d638e62..5f6cddb07 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 efaefecd9..09f586ce6 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 dfe0693d5..471e74e52 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 401449f40..7d7281317 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 6e4185c54..11f6f9bc8 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 3cf547a57..6c2f128b9 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 cab7045ec..382158bcc 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/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index e542c827b..ec97f1dad 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 0f02fb29d..2e610717e 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign yourself | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index bdaf10185..63f4666d3 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 ed8f36f46..6783012d5 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 aa0105151..8eb10cd83 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 5487dc3ff..d99d7b474 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 62ed7a9b9..05933b45d 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 d7bf89ea5..6674ae70c 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 9c0eaf1aa..e7f540830 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 4a89bd178..54d047e04 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 43f87f10e..dcdcdb680 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 27e436734..db4eb7258 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/manage-users/index.html b/docs/help/Settings/manage-users/index.html index 7cc562efd..18519994e 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 be0a544ff..6032feee6 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/Settings/profile/index.html b/docs/help/Settings/profile/index.html index 065725361..c7dfa5c92 100644 --- a/docs/help/Settings/profile/index.html +++ b/docs/help/Settings/profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index b64fe9a10..56f6b2d5b 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 e8535ff97..b38eeaa91 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send template to a signer | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index ef94a95d7..a0c6e40a4 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 921170328..e09887e65 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 b79308701..54e38399f 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 871e22d79..48a8274f9 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 a41b58a94..7feaa2e11 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 051094107..b68849ebe 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Localhost Setup with Docker | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 3f9cb2b92..041b02cad 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 e8babf4f9..81d8df822 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Hello from OpenSign™ | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index cff06cc1c..ca1d03e53 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +