diff --git a/404.html b/404.html index e0a07d48c..43f5dc912 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/28b19cd2.b310fe5e.js b/assets/js/28b19cd2.b310fe5e.js deleted file mode 100644 index 5d0375170..000000000 --- a/assets/js/28b19cd2.b310fe5e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),n=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),d=a(41429),c=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkDKH5L+0UYhmZZ0AUtlqDJsA+OYdDSSWJCkSxJ2fEM/ffhKMmWnbcF6AYYtkQ+PN7dc2/egOe5g3gKv+mkKlF5B7MIUnSJFcYLrSCGmwLZmUXukXUodnp1wbiUeuXYWlfMa5ajQksYhSuWdtLYYs2M1UuRCpUzj6WR3ONcpAOIQBs6IbS6SCGGJFzRnVwJX3RwkUIEhlteokdL6m5A8RIhhp5EiECQuob7Ag5t0Is7TPxFynTGbtozEIHF75WwmELsbYUROL+WJNaJ0kgC4IOROkWIMy4dAZICSw7xBvzaBKS3QuUQQaZtyX1/BR94kBKD+X28KJJJYRZQ17PmWnT+V52uSVSilUfl6ZEbI0USnDK8c6T65vGdjTHkE0su9AJdwIlcBfdsgdxavia/eCzd6wKsJm0fm7Yz5DRJdOUVVx7qCLDkQr7oiwDoC7jT+Kl9GyS6JCkNky/deqeRLRAJbAqtXkGPJyf0ORlDXUfghQ+r+9HVC5v5deu2+nn4vI9fEGsBvB89YcEZrVzjzcloRD/7cXihmKuSBJ1jHTgk0EpIyXL0rLKSCbXbFFnY5xYZl06zhmSCdMox7Qu0K+GQaSXXQUoX7hEr0TnHc4rlHxRmney3JkFxJyZ/PyTLyRURWdmXI+cpAd4bFw+HB/FDFpKBb5S2LWUufDWkZJWU63d7gSOUFArnHSHzyWg0nxD/dQQfnqS4YazgS1Q/ecbTlK1EmqN3jKu0JdARg11UMW2Z0r4tlLiFcKlVzqgSMl+gsIwSNJwMMfjDGEVrtX2r/64kcofMoa/MzpJG8Gs+/DAazcdbH358Kk2WXIo0tJkbfY/q3f9g7c62/vW+uZ5UfShDzLatRzSgsA97xvbXGyMdJpUVfh1a18MxN+K42Y+nM2oIJfpCUxM02gWNqYfFMNwvQ8NNrw7VQGLtsmuIIaG2OeI8z4XKj7kxA21QUUhJvnCUNENuxHA5Brq4U+yanNf4Z0+9XSsx4gtSzLXW91Ft4y2Qp2iDp4iTb7smd955ttekpl2/6TeVbU951Ci2F3fNYNsL+gV/VpMumQ6Kt3xcGlRU4wOby/Gj0eCmEI4JF7Y7T4fIYpm27OA0W3CHKdOKMjJs0vrJYMycwURkbVAO2K26Vde6RFY5zCrJpFD3Lr5Vx2x6mWUiEVyyv3DhhMfZ+4611Wr1iK2jcOaz8EW1YBaN3sHzsBgo7Z/avhxBBB5t6S6za7RLkXRV9JmrhgE8bFONJyHVOkLapU+Hhyj0pUhQOewlx+nnq6/sZDCCqBeY/0Ll4deLs/M/rs9JKoV2Q9F4MBqMQvvXzpdc9S46HEwzq8v+hLfHdW/U+u+m2jZhPD74oZFcqF67a/J6ejBeQARxf5CdRVBQHYinsNlQwP1pZV3T8vcKLRWRWQRLbgVfUIRPN5AKR8/pdk591uz339qh5Yg9MxM/qX9XBRSVgCWXFb1BBPe4PpjCQw62pYBUaxBnjQLHNyRnJ+FRHa+j7sRpkqDxL2L7hfPq8voGIli0I3UZhnawfEVTPl9BDLdwC+FPB0lo5l1a34DkKq/CBAGNXKpgvCKm+uXvPpS/9oEse9In+3WxMYW+ybAnD/xMQfcF179s4c3Oswda33Zo4mdW1/U/JrnFVA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",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 providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkDKH5L+0UYhmZZ0AUtlqDJsA+OYdDSSWJCkSxJ2fEM/ffhKMmWnbcF6AYYtkQ+PN7dc2/egOe5g3gKv+mkKlF5B7MIUnSJFcYLrSCGmwLZmUXukXUodnp1wbiUeuXYWlfMa5ajQksYhSuWdtLYYs2M1UuRCpUzj6WR3ONcpAOIQBs6IbS6SCGGJFzRnVwJX3RwkUIEhlteokdL6m5A8RIhhp5EiECQuob7Ag5t0Is7TPxFynTGbtozEIHF75WwmELsbYUROL+WJNaJ0kgC4IOROkWIMy4dAZICSw7xBvzaBKS3QuUQQaZtyX1/BR94kBKD+X28KJJJYRZQ17PmWnT+V52uSVSilUfl6ZEbI0USnDK8c6T65vGdjTHkE0su9AJdwIlcBfdsgdxavia/eCzd6wKsJm0fm7Yz5DRJdOUVVx7qCLDkQr7oiwDoC7jT+Kl9GyS6JCkNky/deqeRLRAJbAqtXkGPJyf0ORlDXUfghQ+r+9HVC5v5deu2+nn4vI9fEGsBvB89YcEZrVzjzcloRD/7cXihmKuSBJ1jHTgk0EpIyXL0rLKSCbXbFFnY5xYZl06zhmSCdMox7Qu0K+GQaSXXQUoX7hEr0TnHc4rlHxRmney3JkFxJyZ/PyTLyRURWdmXI+cpAd4bFw+HB/FDFpKBb5S2LWUufDWkZJWU63d7gSOUFArnHSHzyWg0nxD/dQQfnqS4YazgS1Q/ecbTlK1EmqN3jKu0JdARg11UMW2Z0r4tlLiFcKlVzqgSMl+gsIwSNJwMMfjDGEVrtX2r/64kcofMoa/MzpJG8Gs+/DAazcdbH358Kk2WXIo0tJkbfY/q3f9g7c62/vW+uZ5UfShDzLatRzSgsA97xvbXGyMdJpUVfh1a18MxN+K42Y+nM2oIJfpCUxM02gWNqYfFMNwvQ8NNrw7VQGLtsmuIIaG2OeI8z4XKj7kxA21QUUhJvnCUNENuxHA5Brq4U+yanNf4Z0+9XSsx4gtSzLXW91Ft4y2Qp2iDp4iTb7smd955ttekpl2/6TeVbU951Ci2F3fNYNsL+gV/VpMumQ6Kt3xcGlRU4wOby/Gj0eCmEI4JF7Y7T4fIYpm27OA0W3CHKdOKMjJs0vrJYMycwURkbVAO2K26Vde6RFY5zCrJpFD3Lr5Vx2x6mWUiEVyyv3DhhMfZ+4611Wr1iK2jcOaz8EW1YBaN3sHzsBgo7Z/avhxBBB5t6S6za7RLkXRV9JmrhgE8bFONJyHVOkLapU+Hhyj0pUhQOewlx+nnq6/sZDCCqBeY/0Ll4deLs/M/rs9JKoV2Q9F4MBqMQvvXzpdc9S46HEwzq8v+hLfHdW/U+u+m2jZhPD74oZFcqF67a/J6ejBeQARxf5CdRVBQHYinsNlQwP1pZV3T8vcKLRWRWQRLbgVfUIRPN5AKR8/pdk591uz339qh5Yg9MxM/qX9XBRSVgCWXFb1BBPe4PpjCQw62pYBUaxBnjQLHNyRnJ+FRHa+j7sRpkqDxL2L7hfPq8voGIli0I3UZhnawfEVTPl9BDLdwC+FPB0lo5l1a34DkKq/CBAGNXKpgvCKm+uXvPpS/9oEse9In+3WxMYW+ybAnD/xMQfcF179s4c3Oswda33Zo4mdW1/U/JrnFVA==",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 from binary",permalink:"/docs/API-docs/createdocumentwithbinary"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create Document from Template"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Create Document API allows you to generate new documents by providing template_id."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.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,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(s.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.fcbda936.js b/assets/js/28b19cd2.fcbda936.js new file mode 100644 index 000000000..e8b283c0e --- /dev/null +++ b/assets/js/28b19cd2.fcbda936.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=a(85893),l=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkLKH5Jty/CMDTLii5osQRNhn1wDIOWThITimRJyo5n6L8PR0k27by0BbYBgWMf7453z71yC56XDtIZ/KazpkblHcwTyNFlVhgvtIIUbipk5xa5RzZwsbOrC8al1GvHNrphXrMSFVriUbhm+aCNLTfMWL0SuVAl81gbyT0uRD6CBLQhCaHVRQ4pZOGKQXItfDWwixwSMNzyGj1aMncLitcIKUQaIQFB5hruKzj2QS/vMPMXOdMFu+llIAGLXxphMYfU2wYTcH4jSa0TtZHEgA9G6hwhLbh0xJBVWHNIt+A3JnB6K1QJCRTa1tzHFHzgQUsK5vfpsspOK7OEtp1316Lzv+p8Q6oyrTwqT1+5MVJkAZTxnSPTt9Gde3Nn4ESpCIx5MpjS+UhQWULWC3RBvGfc28yt5RuCy2Md059RYDU58djjvX9nWaYbr7jy0CaANRfyRYgCQ6zgTuO7/tco0zVp6QL80q13GtkSkZhNpdVXuKenb+nv7RTaNgEvfKAeJl2UTYvrHjbiLrTM0VKWHt/QJuBQ5Ytjn5daS+QqtoAybEBn4ZoO6ydMPkzc88Z5XTMSYr0QK7RlFFXuG4usT6Yd8otln1bfpPiRHhaUMFIyYudcMaEy2eTIfIWs0FTzVMpsux1QWwQw25Ztt4QF2gXFrm2TPYFUHhBCwDqKxQzF6kBqR8K94I4WieKDEXazyLnvCZmuDVeb2ABRKqHKRWNl245eiP0iDn6AsCXmww4RCM5o5brSOJ1M6N8hsheKuSbL0Dk2MIcmuRZSshI9a6xkQu0PRRHOuUXGpdOsq1hiGYxj2ldo18Ih00pugpahpSWsRuccL6lffXMrebnkB93f2+iqO3H690O2Or2idGzsy23gKQXeG5eOx0fNgDwkB79T225cufDRBaVopNy8OsgEoaRQuBgCsjidTBanFP82gR+fDHEXsYqvUP3gGc9zthZ5id4xrvI+gI4iOGQV05Yp7fthiDsWLrUqGU07KjBhGXXbIBly8F+LKFqr7ffidyWRO2QOfWP2nnSKv4bhj5PJYrrD8KenymTFpcjDKnGj71G9+h+83fsWX++768nUhzrkbL9eiI4pnMOBszG9c9Jh1ljhN2E9eTjhRpx05+lsTkO/Rl9pWnSMdsFi2lNSGB+2ofE26kMtkFq7GpaeUFC7GnGel0KVJ9yYkTaoKKUkXzoqmjE3YryaAl08GHZN4HX4HJi33wuM+IiUc733MVe/XFXIc7QBKYrJ5/0i835ANto4ZsPyEG8IuwXh0dTfXTxM9t1gj6f3PJ7H+8jGY7hb5o4mbZQE0ZiMBrlQhQ5o9EG+NKhoCwgpspo+mqA3lXBMuHA8hC+kaxjQR9JsyR3mTKswR+mQ6G9HU+YMZqLoM33EbtWtutY1ssZh0Ugmhbp36a06YbPLohCZ4JL9hUsnPM5fD6mwXq8fpcCbIPNB+KpZMotG79nLQAx5EkvtfryBBDza2l0W12hXIhta8zNXjQPzuK9f3u01Q5R70rtjIYJcigyVw6jizj5cfWJvRxNIomz/BpPHny7O3/9x/Z60Ur10IZqOJqNJWBC18zVX0UXHL5rC6jp+GhzEOtrR/7vnUF+FHh/82EguVDRDu2YxO9pZIIE0fgHNE6iouaQz2G4p4f6krYfIXxq01JnmCay4FXxJGT7bQi4cfc93D5xn3X79ud+E3rBnHlNP2j+0FkV9ZcVlQ78ggXvcHD3f2nmbDP2FTOs4zjsDTm5Iz17Do+HQJoPEWZah8S/yxt346vL6BhIYluY6vPbA8jU9D/kaUriFWwivVdLQvYiIvgXJVdmEtQQ6vdQWeUORinvqfeip/Rfy7ElMDptt5wp9kmNPCvxMSfcRN7/s2LuTZwV6bAduis+8bdt/AIJYl7Q=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",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 providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkLKH5Jty/CMDTLii5osQRNhn1wDIOWThITimRJyo5n6L8PR0k27by0BbYBgWMf7453z71yC56XDtIZ/KazpkblHcwTyNFlVhgvtIIUbipk5xa5RzZwsbOrC8al1GvHNrphXrMSFVriUbhm+aCNLTfMWL0SuVAl81gbyT0uRD6CBLQhCaHVRQ4pZOGKQXItfDWwixwSMNzyGj1aMncLitcIKUQaIQFB5hruKzj2QS/vMPMXOdMFu+llIAGLXxphMYfU2wYTcH4jSa0TtZHEgA9G6hwhLbh0xJBVWHNIt+A3JnB6K1QJCRTa1tzHFHzgQUsK5vfpsspOK7OEtp1316Lzv+p8Q6oyrTwqT1+5MVJkAZTxnSPTt9Gde3Nn4ESpCIx5MpjS+UhQWULWC3RBvGfc28yt5RuCy2Md059RYDU58djjvX9nWaYbr7jy0CaANRfyRYgCQ6zgTuO7/tco0zVp6QL80q13GtkSkZhNpdVXuKenb+nv7RTaNgEvfKAeJl2UTYvrHjbiLrTM0VKWHt/QJuBQ5Ytjn5daS+QqtoAybEBn4ZoO6ydMPkzc88Z5XTMSYr0QK7RlFFXuG4usT6Yd8otln1bfpPiRHhaUMFIyYudcMaEy2eTIfIWs0FTzVMpsux1QWwQw25Ztt4QF2gXFrm2TPYFUHhBCwDqKxQzF6kBqR8K94I4WieKDEXazyLnvCZmuDVeb2ABRKqHKRWNl245eiP0iDn6AsCXmww4RCM5o5brSOJ1M6N8hsheKuSbL0Dk2MIcmuRZSshI9a6xkQu0PRRHOuUXGpdOsq1hiGYxj2ldo18Ih00pugpahpSWsRuccL6lffXMrebnkB93f2+iqO3H690O2Or2idGzsy23gKQXeG5eOx0fNgDwkB79T225cufDRBaVopNy8OsgEoaRQuBgCsjidTBanFP82gR+fDHEXsYqvUP3gGc9zthZ5id4xrvI+gI4iOGQV05Yp7fthiDsWLrUqGU07KjBhGXXbIBly8F+LKFqr7ffidyWRO2QOfWP2nnSKv4bhj5PJYrrD8KenymTFpcjDKnGj71G9+h+83fsWX++768nUhzrkbL9eiI4pnMOBszG9c9Jh1ljhN2E9eTjhRpx05+lsTkO/Rl9pWnSMdsFi2lNSGB+2ofE26kMtkFq7GpaeUFC7GnGel0KVJ9yYkTaoKKUkXzoqmjE3YryaAl08GHZN4HX4HJi33wuM+IiUc733MVe/XFXIc7QBKYrJ5/0i835ANto4ZsPyEG8IuwXh0dTfXTxM9t1gj6f3PJ7H+8jGY7hb5o4mbZQE0ZiMBrlQhQ5o9EG+NKhoCwgpspo+mqA3lXBMuHA8hC+kaxjQR9JsyR3mTKswR+mQ6G9HU+YMZqLoM33EbtWtutY1ssZh0Ugmhbp36a06YbPLohCZ4JL9hUsnPM5fD6mwXq8fpcCbIPNB+KpZMotG79nLQAx5EkvtfryBBDza2l0W12hXIhta8zNXjQPzuK9f3u01Q5R70rtjIYJcigyVw6jizj5cfWJvRxNIomz/BpPHny7O3/9x/Z60Ur10IZqOJqNJWBC18zVX0UXHL5rC6jp+GhzEOtrR/7vnUF+FHh/82EguVDRDu2YxO9pZIIE0fgHNE6iouaQz2G4p4f6krYfIXxq01JnmCay4FXxJGT7bQi4cfc93D5xn3X79ud+E3rBnHlNP2j+0FkV9ZcVlQ78ggXvcHD3f2nmbDP2FTOs4zjsDTm5Iz17Do+HQJoPEWZah8S/yxt346vL6BhIYluY6vPbA8jU9D/kaUriFWwivVdLQvYiIvgXJVdmEtQQ6vdQWeUORinvqfeip/Rfy7ElMDptt5wp9kmNPCvxMSfcRN7/s2LuTZwV6bAduis+8bdt/AIJYl7Q=",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 from binary",permalink:"/docs/API-docs/createdocumentwithbinary"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(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 from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsx)(s.p,{children:"The Create Document API allows you to generate new documents by providing template_id."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",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"}}),(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}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.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)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.417a4dcd.js b/assets/js/2c586be5.417a4dcd.js deleted file mode 100644 index bd0155a0b..000000000 --- a/assets/js/2c586be5.417a4dcd.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:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>h,metadata:()=>j,toc:()=>x});var i=a(85893),r=a(11151),n=a(58219),l=(a(62316),a(51039)),t=a.n(l),o=(a(82723),a(9487)),c=(a(41429),a(5397)),m=a(4667),d=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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztV21v2zYQ/ivcfVoD+TVeWgjD0K7piqBFEywp9sExAlo6SUwkkiUp25qh/z4cZdmyky510U/DviQyeXfkPffyHNfgeGohnMK5isoCpbMwCyBGGxmhnVASQrjJkL01yB2yVoq9ubpgPM/V0rLSorHMKZaiRENSEpcsbu2xecW0UQsRC5mymDvOlsJlbM4tnk0YykjFGLNE5NhnN5mwLMlxJeY5sgJdpuL2nEQZ5jJkQkZ5aYWSTCVswY1QpW3sukqjDVjBH+go4ZgtheNkiXTp3BiZ4TJFUm1vyCLyjezZCCXZs/1beStPTj7rXPGYVapkOk6YkGwa47xM2dX5H7OfM+e0DQcD63gqZNrjWveVRmlFKnM+t/1IFQMyUCQDWitEZBTXeuBt6Dh5wTI06M1HXLLY8CVdMUVnGZcxi5SuWKR6yohYcocB0zxFJstijoY8cBkWfcZzq7ZGvM4GWpXQRU9ObiUEoDTFRih5EUMI3mVsEYAADH4p0brfVVxBuIZISUcb4Rq41rmIvOrg3lJCrMFGGRacvghyCEHN7zEiO9rQQU6gpV0KakfKOiNkCgEkyhTcQQjNTSEAXPFCkzAc5IWOE6gDcMI9Y2q7sjNl/cc20GRnL7O/y9p5x0IdgFTue+/1iVTrACg50NiOFW4MryAA4bCwz8Ns1PHYRKjobCy4yI/VvVc4R3zdLFCaeyB4cfQl7hWyOXoQdKbk0fqj8eloPDodjcnCpnS+H8Zm98hQilRyV5rGB552DTSF2jWwXdkaGNUBrI7UGU8mdQDVkVov6ajlkUqnr+oAsiOVJmf1rmIPWs3dXMXVXRuq+jnBtjSeE2wEqIkJgzGEzpToF6xW0jbhHQ+H9G+f2873SABjZssoQmuTMs+rnyD4UZ2wWabee1x+Zfdi/PcqWoyvKMFKc3SttixVmrznVI8A7bXQNaXbQVbIXEi8a2G7Gw+HdyPCtg5gMvzlMXwXcsFzEftx4EY9oPyBkKExyjzl7s657vGuOZ6uuio8TE1HAtEI+X3Yc7a73jhpMSqNcBWE0zWselyLXrMfTmf1LIBmIoEQtLL+xtxlEMLgEZ9aNAvf06frJmrwTeMC12KwGAEd1V7lmuBqENm70K7LafEBqc1t/O1KBSAoTBnyGI3HhqLw547s37VYtmT9FP/uMDtk1MNR8QmObClyj/U6pDdt+ctT0paRniCZrYctbWxZo0MEHR6Y7lJn26XbJj3ybXc8mfhG+nLkW+PpK9/sJmf1rJ7VhF2iPNAb7y81ymuRSp9vi9Ej7/30KqzfbiFqJkuaPw+0/ZQWMyX9UEubtH7aHzGrMRLJpmz6jGbRa1UgDdpJmbNcyAcb3soem14miYgEz9lfOLfC4W4oXS6Xj7Lrhdd5L1xWzplBrXbiqV/0KdjV2v54QTmAprCXyTWahYja1vKVowZeeLBpBjzyzaCN7Gbp9aESFWcuIpQWO+X75v3VR3baH0LQKaRvuPLg48Xbd5+u35FVKsUmRKP+sD/0XK2sK7jsHHTwxDmMbmco/v9F9F94EW16g8OVG+icC9lh2KavTw/fSbMAMmr84RTWa7L52eR1TctfSjTEGrMAKAAEseeMoO291I0esKI8a9Kod0Pnk3heNm38gCrroNV4E0Wo3b/Kdrnp6vL6BgKYb95yhYpJx/AlvfP4EkK4hVvwb0Ky0DwhuB8Ncy7T0jdIaOwSZfDSZft88+D5ZvPR6bNcVp1b7hNR4wr9JceeVPiVaugDVr9txZudrypssG2lKYSzuq7/AdcoykU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztV21v2zYQ/ivcfVoD+TVeWgjD0K7piqBFEywp9sExAlo6SUwkkiUp25qh/z4cZdmyky510U/DviQyeXfkPffyHNfgeGohnMK5isoCpbMwCyBGGxmhnVASQrjJkL01yB2yVoq9ubpgPM/V0rLSorHMKZaiRENSEpcsbu2xecW0UQsRC5mymDvOlsJlbM4tnk0YykjFGLNE5NhnN5mwLMlxJeY5sgJdpuL2nEQZ5jJkQkZ5aYWSTCVswY1QpW3sukqjDVjBH+go4ZgtheNkiXTp3BiZ4TJFUm1vyCLyjezZCCXZs/1beStPTj7rXPGYVapkOk6YkGwa47xM2dX5H7OfM+e0DQcD63gqZNrjWveVRmlFKnM+t/1IFQMyUCQDWitEZBTXeuBt6Dh5wTI06M1HXLLY8CVdMUVnGZcxi5SuWKR6yohYcocB0zxFJstijoY8cBkWfcZzq7ZGvM4GWpXQRU9ObiUEoDTFRih5EUMI3mVsEYAADH4p0brfVVxBuIZISUcb4Rq41rmIvOrg3lJCrMFGGRacvghyCEHN7zEiO9rQQU6gpV0KakfKOiNkCgEkyhTcQQjNTSEAXPFCkzAc5IWOE6gDcMI9Y2q7sjNl/cc20GRnL7O/y9p5x0IdgFTue+/1iVTrACg50NiOFW4MryAA4bCwz8Ns1PHYRKjobCy4yI/VvVc4R3zdLFCaeyB4cfQl7hWyOXoQdKbk0fqj8eloPDodjcnCpnS+H8Zm98hQilRyV5rGB552DTSF2jWwXdkaGNUBrI7UGU8mdQDVkVov6ajlkUqnr+oAsiOVJmf1rmIPWs3dXMXVXRuq+jnBtjSeE2wEqIkJgzGEzpToF6xW0jbhHQ+H9G+f2873SABjZssoQmuTMs+rnyD4UZ2wWabee1x+Zfdi/PcqWoyvKMFKc3SttixVmrznVI8A7bXQNaXbQVbIXEi8a2G7Gw+HdyPCtg5gMvzlMXwXcsFzEftx4EY9oPyBkKExyjzl7s657vGuOZ6uuio8TE1HAtEI+X3Yc7a73jhpMSqNcBWE0zWselyLXrMfTmf1LIBmIoEQtLL+xtxlEMLgEZ9aNAvf06frJmrwTeMC12KwGAEd1V7lmuBqENm70K7LafEBqc1t/O1KBSAoTBnyGI3HhqLw547s37VYtmT9FP/uMDtk1MNR8QmObClyj/U6pDdt+ctT0paRniCZrYctbWxZo0MEHR6Y7lJn26XbJj3ybXc8mfhG+nLkW+PpK9/sJmf1rJ7VhF2iPNAb7y81ymuRSp9vi9Ej7/30KqzfbiFqJkuaPw+0/ZQWMyX9UEubtH7aHzGrMRLJpmz6jGbRa1UgDdpJmbNcyAcb3soem14miYgEz9lfOLfC4W4oXS6Xj7Lrhdd5L1xWzplBrXbiqV/0KdjV2v54QTmAprCXyTWahYja1vKVowZeeLBpBjzyzaCN7Gbp9aESFWcuIpQWO+X75v3VR3baH0LQKaRvuPLg48Xbd5+u35FVKsUmRKP+sD/0XK2sK7jsHHTwxDmMbmco/v9F9F94EW16g8OVG+icC9lh2KavTw/fSbMAMmr84RTWa7L52eR1TctfSjTEGrMAKAAEseeMoO291I0esKI8a9Kod0Pnk3heNm38gCrroNV4E0Wo3b/Kdrnp6vL6BgKYb95yhYpJx/AlvfP4EkK4hVvwb0Ky0DwhuB8Ncy7T0jdIaOwSZfDSZft88+D5ZvPR6bNcVp1b7hNR4wr9JceeVPiVaugDVr9txZudrypssG2lKYSzuq7/AdcoykU=",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 binary",permalink:"/docs/API-docs/createdocumentwithbinary"}},f={},x=[{value:"Request",id:"request",level:2}];function b(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,r.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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsxs)(s.strong,{children:["Upload you pdf in ",(0,i.jsx)(s.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," 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)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,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)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(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)(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)(m.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"signature"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",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:"]"})})})]})]})})]})]})})}),"\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)(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)(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)(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:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.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)(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 g(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.eaa09736.js b/assets/js/2c586be5.eaa09736.js new file mode 100644 index 000000000..aeefcaa8e --- /dev/null +++ b/assets/js/2c586be5.eaa09736.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:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>g,toc:()=>x});var i=s(85893),r=s(11151),n=s(58219),l=(s(62316),s(51039)),t=s.n(l),o=(s(82723),s(9487)),m=(s(41429),s(5397)),d=s(4667),c=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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWNtuGzcQ/RV2nhpjdbWaBEJRJHXSwEgQG7WDPsiGQO3O7tLeJRmSq0uF/fdiuNqLZMexgj4VfbGlIeeQPDOcM9QWHE8sTGfwToVFjtJZuA0gQhsaoZ1QEqZwnSI7M8gdsnoWe3t5zniWqZVlhUVjmVMsQYmGZklcsajGY4sN00YtRSRkwiLuOFsJl7IFt/hywlCGKsKIxSLDPrtOhWVxhmuxyJDl6FIV1evEyjCXIhMyzAorlGQqZktuhCpshes2Gm3Acn5PSwnHbCEcJyTypXUjZIbLBMm13iEL6WyEZ0OUhGf7N/JGnpx80ZniEduogukoZkKyWYSLImGX7/64/Tl1TtvpYGAdT4RMelzrvtIorUhkxhe2H6p8QAB5PCBbLkKjuNYDj6Gj+AVL0aCHD7lkkeEr2mKCzjIuIxYqvWGh6ikjIskdBkzzBJks8gUaOoFLMe8znlnVgHifHbUqpo2enNxICEBpio1Q8jyCKfgjY80ABGDwa4HW/a6iDUy3ECrpaGC6Ba51JkLvOrizlBBbsGGKOadP5CcMRpRCFEIIIFZZhOY8ggDo2GgsBOCEy5BSi2IEU1CLOwxpYW1oZ06gJTgPMd3Ws6wzQiYe0+TcwRSqo0EAuOa5pslwkEg6iqGsF3wKqrG0UNZ/aDKDcPauwg+hvesglAFI5X50X5/JtWxpbVG4MXwDAQiHedf+DZqNOp6bEBWtjTkX2bG+dwoXiG8qA90LTwTPj97EnUK2QE+CTpU82n80Ph2NR6ejMSHs7tqP01iNHhlKkUjuClOdgSddgOpmdwEaSwMwKgNYH+kznkzKADZHer2ipVZHOp2+LgNIj3SavCzbG3tQm+YLFW3mdajK702srwbNawrRgxDRHUIZzQ+TeaFUhlx29+ZMgXXaz21RJcIjMd+XzLPCOpUzcmI7J69BTfTZruA2V8pv/9nAD3CYB2EE0mdnXFYqGaFXzFiRgpImsu224cvTWJZsuyUu0MzpQpZl0BoIcs/g71xlMRiiWO55NSZsHRtbxxXXWpjNPOJuZwhVrrncdDcgEilkMi9MVpZ9+E7Uq7RopWgXM4NWK2mruzoeDunfPpvv9loAjJgtwhCtjYss2/wEwfN18OlCUZkfy8Sni0V6J8Z/r8Pl+JLypDBHF966RylM1nOqR7T2auqqOtxhVshMSJzXtM3Hw+F8RNyWAUyGvzyk71wueSYi3wxeq3uU/yJlaIwyjx23PVx3eVctT1td556mSl5AVJP8OOwdtmuvDmkxLIxwG5jOtrDucS161fh0dlveBlD1ozAFrazfMXcpTGHwoJuyaJZeoGfbKmrwrGaRazFYjoCWqrdyRXRVjOxtqJUsLT4iadbuvN1ZAQgKU4o8QuO5oSj82bZ672su687rsWaq5eywPTosTo80PHW/s9fCdDqYWd2M+P6iaS8e6RiaE9Y9QNMCdFS9I+qzNnUaya0Vd+Q1dDyZeFV8NfI6d/raK9fkZemD3apHm3td0aAi80AXOmnaKeod2REyVj56O0ovNMorkUifxMvRA0r9g0hYP1zzXj1WSE4OvH3jHzElfdWnQbKf9kfMagxFvLuLfUbPmyuVI73d4iJjmZD3dnoje2x2EcciFDxjf+HCCoftO2e1Wj1I2Rfe54NwabFgBrVqpyfe6PO669V8eUGJhSa3F/EVmqUI63r1jaUGfvJgV2F4pcJ1uuxMbw6diPJMhCgtdmrC2w+Xn9hpfwhB53Y+Y8uDT+dn7z9fvSdUut9ViEb9YX/ouzllXc5lZ6GDV/NhdDvvrP8f2f+FR/au4Dhcu4HOuJAd2a7EYnb49L4NICU1mc5guyXML9TykPlrgYak6DYACgBR7IUoqAs6lbh7pPpyVqVR75rWp+lZUWnDgf6WQe3xNgxRuyfndgXv8uLqGgKoe9RcReRj+Ip+OuArmMIN3ID/mYEQqkcm94+HjMuk8FUXKlzSIV64dF/E7r2I7T50ijeXm84u99WtOgr9pYM96vAr3aGPuPmtmV6NfNNhx209m0J4W5blP4RDpOA=",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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWNtuGzcQ/RV2nhpjdbWaBEJRJHXSwEgQG7WDPsiGQO3O7tLeJRmSq0uF/fdiuNqLZMexgj4VfbGlIeeQPDOcM9QWHE8sTGfwToVFjtJZuA0gQhsaoZ1QEqZwnSI7M8gdsnoWe3t5zniWqZVlhUVjmVMsQYmGZklcsajGY4sN00YtRSRkwiLuOFsJl7IFt/hywlCGKsKIxSLDPrtOhWVxhmuxyJDl6FIV1evEyjCXIhMyzAorlGQqZktuhCpshes2Gm3Acn5PSwnHbCEcJyTypXUjZIbLBMm13iEL6WyEZ0OUhGf7N/JGnpx80ZniEduogukoZkKyWYSLImGX7/64/Tl1TtvpYGAdT4RMelzrvtIorUhkxhe2H6p8QAB5PCBbLkKjuNYDj6Gj+AVL0aCHD7lkkeEr2mKCzjIuIxYqvWGh6ikjIskdBkzzBJks8gUaOoFLMe8znlnVgHifHbUqpo2enNxICEBpio1Q8jyCKfgjY80ABGDwa4HW/a6iDUy3ECrpaGC6Ba51JkLvOrizlBBbsGGKOadP5CcMRpRCFEIIIFZZhOY8ggDo2GgsBOCEy5BSi2IEU1CLOwxpYW1oZ06gJTgPMd3Ws6wzQiYe0+TcwRSqo0EAuOa5pslwkEg6iqGsF3wKqrG0UNZ/aDKDcPauwg+hvesglAFI5X50X5/JtWxpbVG4MXwDAQiHedf+DZqNOp6bEBWtjTkX2bG+dwoXiG8qA90LTwTPj97EnUK2QE+CTpU82n80Ph2NR6ejMSHs7tqP01iNHhlKkUjuClOdgSddgOpmdwEaSwMwKgNYH+kznkzKADZHer2ipVZHOp2+LgNIj3SavCzbG3tQm+YLFW3mdajK702srwbNawrRgxDRHUIZzQ+TeaFUhlx29+ZMgXXaz21RJcIjMd+XzLPCOpUzcmI7J69BTfTZruA2V8pv/9nAD3CYB2EE0mdnXFYqGaFXzFiRgpImsu224cvTWJZsuyUu0MzpQpZl0BoIcs/g71xlMRiiWO55NSZsHRtbxxXXWpjNPOJuZwhVrrncdDcgEilkMi9MVpZ9+E7Uq7RopWgXM4NWK2mruzoeDunfPpvv9loAjJgtwhCtjYss2/wEwfN18OlCUZkfy8Sni0V6J8Z/r8Pl+JLypDBHF966RylM1nOqR7T2auqqOtxhVshMSJzXtM3Hw+F8RNyWAUyGvzyk71wueSYi3wxeq3uU/yJlaIwyjx23PVx3eVctT1td556mSl5AVJP8OOwdtmuvDmkxLIxwG5jOtrDucS161fh0dlveBlD1ozAFrazfMXcpTGHwoJuyaJZeoGfbKmrwrGaRazFYjoCWqrdyRXRVjOxtqJUsLT4iadbuvN1ZAQgKU4o8QuO5oSj82bZ672su687rsWaq5eywPTosTo80PHW/s9fCdDqYWd2M+P6iaS8e6RiaE9Y9QNMCdFS9I+qzNnUaya0Vd+Q1dDyZeFV8NfI6d/raK9fkZemD3apHm3td0aAi80AXOmnaKeod2REyVj56O0ovNMorkUifxMvRA0r9g0hYP1zzXj1WSE4OvH3jHzElfdWnQbKf9kfMagxFvLuLfUbPmyuVI73d4iJjmZD3dnoje2x2EcciFDxjf+HCCoftO2e1Wj1I2Rfe54NwabFgBrVqpyfe6PO669V8eUGJhSa3F/EVmqUI63r1jaUGfvJgV2F4pcJ1uuxMbw6diPJMhCgtdmrC2w+Xn9hpfwhB53Y+Y8uDT+dn7z9fvSdUut9ViEb9YX/ouzllXc5lZ6GDV/NhdDvvrP8f2f+FR/au4Dhcu4HOuJAd2a7EYnb49L4NICU1mc5guyXML9TykPlrgYak6DYACgBR7IUoqAs6lbh7pPpyVqVR75rWp+lZUWnDgf6WQe3xNgxRuyfndgXv8uLqGgKoe9RcReRj+Ip+OuArmMIN3ID/mYEQqkcm94+HjMuk8FUXKlzSIV64dF/E7r2I7T50ijeXm84u99WtOgr9pYM96vAr3aGPuPmtmV6NfNNhx209m0J4W5blP4RDpOA=",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 binary",permalink:"/docs/API-docs/createdocumentwithbinary"}},j={},x=[{value:"Request",id:"request",level:2}];function f(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,r.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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."}),"\n",(0,i.jsx)(a.p,{children:(0,i.jsxs)(a.strong,{children:["Upload you pdf in ",(0,i.jsx)(a.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," 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)(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)(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)(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)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",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"}}),(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}}."}})]})]})})}),"\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)(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)(c.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)(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)(m.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\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)(c.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)(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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,r.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/70853c19.5685c3d8.js b/assets/js/70853c19.5685c3d8.js deleted file mode 100644 index 206f3840a..000000000 --- a/assets/js/70853c19.5685c3d8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>v,frontMatter:()=>m,metadata:()=>x,toc:()=>g});var l=a(85893),i=a(11151),n=a(58219),r=(a(62316),a(51039)),o=a.n(r),t=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),h=a(9472),p=a(85162);const m={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztVm1r20gQ/ivbCRzXIL8lKRziOJoroYSWJpwT8sE2YS2NrW1Wu+ruyoow+u/HrCRbsRMnB0c/9Usi77w+M7PPzhocX1oIJ3CH80TrB5gFEKONjMic0ApCuEmQWb5Cpg3Ls5g7ZI0uO7++ZFxKXbBS58zpWq9opLmRrEhElDBhWW4xJg1nxHKJhuEKlbNTdXR01HyHUzVVoz47Pl4JLDAOj4+nijHGeuwuQcWsWCo0rBayWEd5isoxlwhbe2CFkLIN0K9tp+qEPEYGudt3uXEiLGtUXvV3Sv58Lgfd1RpsXrZ5v+x3qs58jjrNJL6S5dYtl7JxbV/N+QP5jzGS4pWsW5035Q0B6AwNpzm5jCEE6v5v9Yi00xSAwR85Wve3jksI1zuzdW30SsToR8Xppgdsaxxp5VA5MuRZJkXkgw2+W7Jeg40STDl9URRhMKZJvjWSptiVGUIIev4dIwcBZIaydQItGeRG0r9GyToj1BICWGiTctc9wUdOfYEQEucyGw4Gpc5NrxnyXm7kx0alH+kUqioAJ5w3aHTu54S9qkhk0GZa2TqHk+FwvyTjPIrQ2kUu2aa6/6USh2EbtLl0zyHf4mxvd93JmNlNRrJ89wSgUDQt9y2o+5Ph8P6PBunZcLQP7q5DDVwa5HHJ8FFYZ9/9fxjRGG3eCPGZPA4BPBuO7osNwLN9gLcWDVPasYXOVfxzQe3GPgzkbAPjwz6MS7XiUsSe4G/0A6qfi6Qb3tXhKdXH1N9ZxdMaklfycngCtXteg7QY5Ua4EsLJGh57PBO9Wh5OZtUsgBRdoonCMm19xtwlEMKg2DCRRbNCY70Dzx0bOrCOL4Va9niW9XWGinhT8rklOhjwTAxWI6AYbQ5jqlNdiieZbArCM/EFSwhaoF2tAAT1J0Eeo/FFofL/s+XYi7aIu2keZi3yu9A+iaaMVxmqsVgq34TVCPbXAmHpySBx+4T4gWALbdiONZtzev+1Yi5BL6Tz0/6I2QwjsWhmqc/oNRzrFGlfIAqUQj3QZtBjk6vFQkSCS3oerHA4+72FVhTFXuXfe5vPwiX5nBnM9FZ96Q99e7pWmx/vIQCHJrVXizGalYha8n8h1MArD5obwiN/QzDlgsrfHH3cNaKSSxGhstiZ6fPP11/ZaX8IQad7b0h58PXy08W38QV5pTGtWzTqD/tDOqKpTrnqBBo3C93tk4Vut8nr7Z3/tQb+WgNfXAMb4nL46AaZ5MLzcbNh1VQ6aZch2swSItlwAus10cKtkVVFxz9yNMTQswBW3Ag+Jx6azKqgpTvi3gcsIYRP9Vj2bigwqcu8Zs6dZ6kKWovzKMLMHdTtvgPXV+MbCGDebK2pjsnG8II2Wl5ACFOYgt+AyUO9W9H5GiRXy5wvSb/2SyzNc6pCl+IfPMU3H4SsFamyk+VT7q+h0F8C9qzBn3QZv2D510a9lrxo0NS21abezaqq+hdJjdZL",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztVm1r20gQ/ivbCRzXIL8lKRziOJoroYSWJpwT8sE2YS2NrW1Wu+ruyoow+u/HrCRbsRMnB0c/9Usi77w+M7PPzhocX1oIJ3CH80TrB5gFEKONjMic0ApCuEmQWb5Cpg3Ls5g7ZI0uO7++ZFxKXbBS58zpWq9opLmRrEhElDBhWW4xJg1nxHKJhuEKlbNTdXR01HyHUzVVoz47Pl4JLDAOj4+nijHGeuwuQcWsWCo0rBayWEd5isoxlwhbe2CFkLIN0K9tp+qEPEYGudt3uXEiLGtUXvV3Sv58Lgfd1RpsXrZ5v+x3qs58jjrNJL6S5dYtl7JxbV/N+QP5jzGS4pWsW5035Q0B6AwNpzm5jCEE6v5v9Yi00xSAwR85Wve3jksI1zuzdW30SsToR8Xppgdsaxxp5VA5MuRZJkXkgw2+W7Jeg40STDl9URRhMKZJvjWSptiVGUIIev4dIwcBZIaydQItGeRG0r9GyToj1BICWGiTctc9wUdOfYEQEucyGw4Gpc5NrxnyXm7kx0alH+kUqioAJ5w3aHTu54S9qkhk0GZa2TqHk+FwvyTjPIrQ2kUu2aa6/6USh2EbtLl0zyHf4mxvd93JmNlNRrJ89wSgUDQt9y2o+5Ph8P6PBunZcLQP7q5DDVwa5HHJ8FFYZ9/9fxjRGG3eCPGZPA4BPBuO7osNwLN9gLcWDVPasYXOVfxzQe3GPgzkbAPjwz6MS7XiUsSe4G/0A6qfi6Qb3tXhKdXH1N9ZxdMaklfycngCtXteg7QY5Ua4EsLJGh57PBO9Wh5OZtUsgBRdoonCMm19xtwlEMKg2DCRRbNCY70Dzx0bOrCOL4Va9niW9XWGinhT8rklOhjwTAxWI6AYbQ5jqlNdiieZbArCM/EFSwhaoF2tAAT1J0Eeo/FFofL/s+XYi7aIu2keZi3yu9A+iaaMVxmqsVgq34TVCPbXAmHpySBx+4T4gWALbdiONZtzev+1Yi5BL6Tz0/6I2QwjsWhmqc/oNRzrFGlfIAqUQj3QZtBjk6vFQkSCS3oerHA4+72FVhTFXuXfe5vPwiX5nBnM9FZ96Q99e7pWmx/vIQCHJrVXizGalYha8n8h1MArD5obwiN/QzDlgsrfHH3cNaKSSxGhstiZ6fPP11/ZaX8IQad7b0h58PXy08W38QV5pTGtWzTqD/tDOqKpTrnqBBo3C93tk4Vut8nr7Z3/tQb+WgNfXAMb4nL46AaZ5MLzcbNh1VQ6aZch2swSItlwAus10cKtkVVFxz9yNMTQswBW3Ag+Jx6azKqgpTvi3gcsIYRP9Vj2bigwqcu8Zs6dZ6kKWovzKMLMHdTtvgPXV+MbCGDebK2pjsnG8II2Wl5ACFOYgt+AyUO9W9H5GiRXy5wvSb/2SyzNc6pCl+IfPMU3H4SsFamyk+VT7q+h0F8C9qzBn3QZv2D510a9lrxo0NS21abezaqq+hdJjdZL",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},j={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,l.jsx)(o(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,l.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"viewed:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"created:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"signed:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"completed:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"declined:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.583ba3e8.js b/assets/js/70853c19.583ba3e8.js new file mode 100644 index 000000000..61800de31 --- /dev/null +++ b/assets/js/70853c19.583ba3e8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var l=n(85893),a=n(11151),i=n(58219),r=(n(62316),n(51039)),d=n.n(r),o=(n(82723),n(9487)),t=(n(41429),n(5397)),c=n(4667),h=n(9472),m=n(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGjkQ/iuuK52u0fKSJpVOq9OptEU91LygQtQPgFKzO4AbY29tLwSh/e+nsXdhWdIkp+ZyqkQ+BLCfsecZPzvemTW1bGpoOKBfYDxT6oaOAhqDiTRPLFeShrQ/A2LYAojSJE1iZoHkWNLqdggTQi3JSqXEKo9b5rOpFmQ549GMcENSAzEirObTKWgCC5DWDOXLly/z7+FQDuVxnRwdLTgsIQ6PjoaSEEJq5MsMJDF8KkETP0liFaVzkJbYGTd+BbLkQhQb1L3t169f/Ze1/8C/IXXwIQ3JkPrlhjQoz0+4AD/94fL91Xn7on999fmsApJsXgVdtM7bVZSyOaorgBkgGnBLwmTsGHn/CzYV49JB+DUq8z4kBucG2/EdslVfe52PF+3P+57mgZkzLnaA7fNW5+wOZDJTcnfJ7t+XF+0hLQOz7Y/RjuM+6u9WD2xVAFv5YfU75+1ev3XeraAiDczeCStQ2VC+RmnlyKq2NmrihuSQnxVWvsxBWc+rrEdJwUHlCQrCEb1XDx5BxqsiA/2kMPx6lXir8TeIbCce0rB06p0PZdYH9TyZekpmoz3HfzrdZKiuU5du1DwR8EDC2QqMCZGLzDygskfkn2LrQwb6bzT0wwxUBP5Jbi0HlW9QTDFEgj+QrArM06WrYsWDjJ5XRkXcH/GSVECfRHA0oCoBzTCinZiGFN/pf/Mv/kWNEFAN31Mw9p2KVzRcVyqGrlYLHoMrAKzKX6jI1jhS0oK0aMiSRPDIbdb4ZtB6TU00gznDb7gL1xBjfXKlBdYmdpUADfP7kgY00eit5WDQINUCP3KQsZrLKQ3oROk5s+URuGX4lNKQzqxNTNhorFSqa3npUku1eJtD6pGa0ywLqOXWGeSY6zFyzzKc0mASJY334XWzuR+SXhpFYMwkFWQT3X8TiftpazCpsHcx3/IsajZ/kjExG4/E6sUOQS5RTdcFqevXzeb1HznT0+bxPrkvpYKPCQ0sXhG45caaF0/HEbRW+pEU7/DjPoKnzePr5Ybg6T7BKwOaSGXJRKUyfl5S1b3vJ3K6ofFmn0ZHLpjgsSvb++oG5PMyKW9v/fbo6u3cPbOYfx0lB3LzdIdqedyTNBClmtsVDQdreltjCa/5+XAwykYBnYOdKUxhiTLOY2ZnNKSN5SYTGdAL0MYt4HLHJh0Yy6ZcTmssSeoqAYn3iGBjg+mgwRLeWBxT3KPwoYdx8qHY8WQTEJbwT7CiQUG0jAoox/OZAYtBu6Bg+D9vc2y7CGLVzfuzFq47Uc6JPIyXCcge3ql4CItjut/s4QbfI3C6uHGdIMhEaVKxJmOGXR2FNzS4SRw/qR8Tk0DEJ7mW6gQ7Oz01B+wCYQoUXN5gv6dGBpeTCY84E3g9GG5h9HtBbblc7kX+lbP5yO0sHRMNidrCp27QHU/ZavPjFQ2oBT03l5Me6AWPiuT/g60aDtzInxAWuSfEXf40LIbeVo0w5IJHIA2UNN362D0jJ/UmDUqn9wiXG2ed9+2LXhtXRZn6IzquN+tNHEJVz5ksbdTL23RXO2266iGvt8/8obl3eHM9NPcOzb1fRFmH5t5BPYfm3qG5d2juHZp7v7SM/sfmXl6OWri1jUQw7qrsvG/mC+RB0eLCftsMS+dwQNdrLPautMgyHP6egsa6exTQBdOcjbG6HIyyoChisaK+gRUN6XtfbNT6uDHCRerr4UqzIQsKi1YUQWLvxZar++5lr08DOs57kXMVo41mS+xTsiUNKQrH9TVxBd8xw/E1FUxOUzZFvF8Xa2+WYhTKhfuNK9zzL8ismJKrkpe7Fb2ngv+R2J0Gf2KJ9QlWf23gfuaHBnlsCzSe3SjLsn8A10MGxQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGjkQ/iuuK52u0fKSJpVOq9OptEU91LygQtQPgFKzO4AbY29tLwSh/e+nsXdhWdIkp+ZyqkQ+BLCfsecZPzvemTW1bGpoOKBfYDxT6oaOAhqDiTRPLFeShrQ/A2LYAojSJE1iZoHkWNLqdggTQi3JSqXEKo9b5rOpFmQ549GMcENSAzEirObTKWgCC5DWDOXLly/z7+FQDuVxnRwdLTgsIQ6PjoaSEEJq5MsMJDF8KkETP0liFaVzkJbYGTd+BbLkQhQb1L3t169f/Ze1/8C/IXXwIQ3JkPrlhjQoz0+4AD/94fL91Xn7on999fmsApJsXgVdtM7bVZSyOaorgBkgGnBLwmTsGHn/CzYV49JB+DUq8z4kBucG2/EdslVfe52PF+3P+57mgZkzLnaA7fNW5+wOZDJTcnfJ7t+XF+0hLQOz7Y/RjuM+6u9WD2xVAFv5YfU75+1ev3XeraAiDczeCStQ2VC+RmnlyKq2NmrihuSQnxVWvsxBWc+rrEdJwUHlCQrCEb1XDx5BxqsiA/2kMPx6lXir8TeIbCce0rB06p0PZdYH9TyZekpmoz3HfzrdZKiuU5du1DwR8EDC2QqMCZGLzDygskfkn2LrQwb6bzT0wwxUBP5Jbi0HlW9QTDFEgj+QrArM06WrYsWDjJ5XRkXcH/GSVECfRHA0oCoBzTCinZiGFN/pf/Mv/kWNEFAN31Mw9p2KVzRcVyqGrlYLHoMrAKzKX6jI1jhS0oK0aMiSRPDIbdb4ZtB6TU00gznDb7gL1xBjfXKlBdYmdpUADfP7kgY00eit5WDQINUCP3KQsZrLKQ3oROk5s+URuGX4lNKQzqxNTNhorFSqa3npUku1eJtD6pGa0ywLqOXWGeSY6zFyzzKc0mASJY334XWzuR+SXhpFYMwkFWQT3X8TiftpazCpsHcx3/IsajZ/kjExG4/E6sUOQS5RTdcFqevXzeb1HznT0+bxPrkvpYKPCQ0sXhG45caaF0/HEbRW+pEU7/DjPoKnzePr5Ybg6T7BKwOaSGXJRKUyfl5S1b3vJ3K6ofFmn0ZHLpjgsSvb++oG5PMyKW9v/fbo6u3cPbOYfx0lB3LzdIdqedyTNBClmtsVDQdreltjCa/5+XAwykYBnYOdKUxhiTLOY2ZnNKSN5SYTGdAL0MYt4HLHJh0Yy6ZcTmssSeoqAYn3iGBjg+mgwRLeWBxT3KPwoYdx8qHY8WQTEJbwT7CiQUG0jAoox/OZAYtBu6Bg+D9vc2y7CGLVzfuzFq47Uc6JPIyXCcge3ql4CItjut/s4QbfI3C6uHGdIMhEaVKxJmOGXR2FNzS4SRw/qR8Tk0DEJ7mW6gQ7Oz01B+wCYQoUXN5gv6dGBpeTCY84E3g9GG5h9HtBbblc7kX+lbP5yO0sHRMNidrCp27QHU/ZavPjFQ2oBT03l5Me6AWPiuT/g60aDtzInxAWuSfEXf40LIbeVo0w5IJHIA2UNN362D0jJ/UmDUqn9wiXG2ed9+2LXhtXRZn6IzquN+tNHEJVz5ksbdTL23RXO2266iGvt8/8obl3eHM9NPcOzb1fRFmH5t5BPYfm3qG5d2juHZp7v7SM/sfmXl6OWri1jUQw7qrsvG/mC+RB0eLCftsMS+dwQNdrLPautMgyHP6egsa6exTQBdOcjbG6HIyyoChisaK+gRUN6XtfbNT6uDHCRerr4UqzIQsKi1YUQWLvxZar++5lr08DOs57kXMVo41mS+xTsiUNKQrH9TVxBd8xw/E1FUxOUzZFvF8Xa2+WYhTKhfuNK9zzL8ismJKrkpe7Fb2ngv+R2J0Gf2KJ9QlWf23gfuaHBnlsCzSe3SjLsn8A10MGxQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},j={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function b(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,l.jsx)(d(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,l.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"viewed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "viewed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"created:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "created",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"signed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n ]\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"completed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "completed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"declined:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "declined",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,a.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/e2a6fad1.137eb6e8.js b/assets/js/e2a6fad1.137eb6e8.js new file mode 100644 index 000000000..34792c6fc --- /dev/null +++ b/assets/js/e2a6fad1.137eb6e8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6741],{57755:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>x,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>g,toc:()=>b});var i=s(85893),r=s(11151),t=s(58219),n=(s(62316),s(51039)),l=s.n(n),o=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const h={id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVt9v4zYM/lc4Pa2FE6e92x6MYditvTsUd1gLtIc9pEFOsWlbV1nSSXJ+LPD/PlC2E6dNiw7Y07CX1qFIivz4kdSWeV44lkzZpU7rCpV3bBaxDF1qhfFCK5awuxLhwiL3CL0WvLu5Ai6lXjmoHVoHXkOBCi1pKVxB1vuDxQaM1UuRCVVAxj0HX1pdFyV8rWrpheHWx7m21YgOv47hrhQOcolrsZAIFfpSZ/1lubbgSwShUlk7oRXoHJbcCl27zvnGoIug4g90n/DgauE5eSJbDiuRIViuCiTTPkxIKUHy51JU5M+N79W9Oj39YqTmGWx0DSbLQSiYZrioC7i5/DD7sfTeuCSOneeFUMWIGzPWBpUThZJ84caprmJyUOUxySqRWs2NiYMPk+UnUKLF4D7lCjLLVxRigd4BVxmk2mwg1SNtRaa4xwgMLxBUXS3QUga+xGoMXDq9cxJsFtzhz29J4+byw+npvWIR04YKJLS6yljCQsrYI7ASvlwIxe2GRczi9xqd/11nG5ZsWaqVR+Xp80jJSOzSEqvwRabCYkakyoVEFjFKHK1jEfPCSySGUZVYwvTiG6aeRcxYis0LdOQj2CXbXst5K1TBIkZXcs8S1gXa9B6f6DaPSHzkXGl/3LAP96UAuLU83J9rmaElPI95QpXNseJCDo4XWkvkVA5c88pQ9N7W2EQsaM5d3YJy5PrDvryondcVkBF0RoHjFD/3tUXoysh2vhddQV/l+IkfCE6AnIzhgqu2CzMMHZlr6lDqOdhue1LNQ3maBrZbwgLtXPEKmybaC8jlgcCUWnUqFlMUywOrnQj3hjvZwBTXRtjNPOO+E6S6MlxthgGIQglVzGsrm2bMmj2bnm2NFsCGVPc876pn0RmtXMvg88mE/h3ienkwbDADV6cpOpfXUm5+YNGwz7gxUqShWeNvrqXwvslebp9WfIyTAwbvJDsWsvKbOP9rnS7Pb4gxtZX/2EE3DWsrR16PCOBRDyJNwgOMhZJC4byHbX4+mczPCNsmYm8nPz2F70otuRRZ2D13+gHVvwgZWqvtsXT3yQ2v9+31FOq6CjARrUJSQSmcs4Nkh/I2SYdpbYXfsGS6ZesRN2LUnifTWTOLWLv5WMKMdiFi7kuWsPiFue3QLsPomm7b+rFXLShuRLw8Y3RpH9QtAddicxDaDiFuxCekO7vMh1oRE1SwEnmGNqAkVK6DcYfHtUF1KwoV0FyePRlB4Q0gXDjuM233M024R9Zh12WgVRhEdEjyN+MzcAZTkXekGANt9FtdIb1Z8lqCFOrBJfdqBNPrPBep4BL+xIUTHverfbVaPUHsJNh8FL6sF2DR6L16EYQB1qHV7scJrUG0lbvOb9EuRdo3zjNXxUE57qjO28XQ7ZRe9NtjI6KeFCkqhwNyvvt48xnejCcsGpDjFSHHn68u3v9x+568Er3aEp2NJ+MJiYieFVeDix6/FnOrK9iR9NFi3nXw/w/N/8xDs5sRHtc+NpILNVgo7RibPv/8nEWspImXTNl2S96/0IIm8fcaLY3LWcSoFAR2GJZRP2po7j3ghijYsmp0R5GQuqwpomPP1ybqjd6lKRo/UH+yUg7m8s317R2LWP+oqnRGNuQ4+I32n22QvKbMhxP0IUzQ7oOC74/UZhDF4WhtQ6W/FPhRg1+oaz7h5tedenvyrEEHX69N9Zo1TfM3nU39ng==",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/createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",source:"@site/docs/API-docs/createdocumentwithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithbinary",permalink:"/docs/API-docs/createdocumentwithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVt9v4zYM/lc4Pa2FE6e92x6MYditvTsUd1gLtIc9pEFOsWlbV1nSSXJ+LPD/PlC2E6dNiw7Y07CX1qFIivz4kdSWeV44lkzZpU7rCpV3bBaxDF1qhfFCK5awuxLhwiL3CL0WvLu5Ai6lXjmoHVoHXkOBCi1pKVxB1vuDxQaM1UuRCVVAxj0HX1pdFyV8rWrpheHWx7m21YgOv47hrhQOcolrsZAIFfpSZ/1lubbgSwShUlk7oRXoHJbcCl27zvnGoIug4g90n/DgauE5eSJbDiuRIViuCiTTPkxIKUHy51JU5M+N79W9Oj39YqTmGWx0DSbLQSiYZrioC7i5/DD7sfTeuCSOneeFUMWIGzPWBpUThZJ84caprmJyUOUxySqRWs2NiYMPk+UnUKLF4D7lCjLLVxRigd4BVxmk2mwg1SNtRaa4xwgMLxBUXS3QUga+xGoMXDq9cxJsFtzhz29J4+byw+npvWIR04YKJLS6yljCQsrYI7ASvlwIxe2GRczi9xqd/11nG5ZsWaqVR+Xp80jJSOzSEqvwRabCYkakyoVEFjFKHK1jEfPCSySGUZVYwvTiG6aeRcxYis0LdOQj2CXbXst5K1TBIkZXcs8S1gXa9B6f6DaPSHzkXGl/3LAP96UAuLU83J9rmaElPI95QpXNseJCDo4XWkvkVA5c88pQ9N7W2EQsaM5d3YJy5PrDvryondcVkBF0RoHjFD/3tUXoysh2vhddQV/l+IkfCE6AnIzhgqu2CzMMHZlr6lDqOdhue1LNQ3maBrZbwgLtXPEKmybaC8jlgcCUWnUqFlMUywOrnQj3hjvZwBTXRtjNPOO+E6S6MlxthgGIQglVzGsrm2bMmj2bnm2NFsCGVPc876pn0RmtXMvg88mE/h3ienkwbDADV6cpOpfXUm5+YNGwz7gxUqShWeNvrqXwvslebp9WfIyTAwbvJDsWsvKbOP9rnS7Pb4gxtZX/2EE3DWsrR16PCOBRDyJNwgOMhZJC4byHbX4+mczPCNsmYm8nPz2F70otuRRZ2D13+gHVvwgZWqvtsXT3yQ2v9+31FOq6CjARrUJSQSmcs4Nkh/I2SYdpbYXfsGS6ZesRN2LUnifTWTOLWLv5WMKMdiFi7kuWsPiFue3QLsPomm7b+rFXLShuRLw8Y3RpH9QtAddicxDaDiFuxCekO7vMh1oRE1SwEnmGNqAkVK6DcYfHtUF1KwoV0FyePRlB4Q0gXDjuM233M024R9Zh12WgVRhEdEjyN+MzcAZTkXekGANt9FtdIb1Z8lqCFOrBJfdqBNPrPBep4BL+xIUTHverfbVaPUHsJNh8FL6sF2DR6L16EYQB1qHV7scJrUG0lbvOb9EuRdo3zjNXxUE57qjO28XQ7ZRe9NtjI6KeFCkqhwNyvvt48xnejCcsGpDjFSHHn68u3v9x+568Er3aEp2NJ+MJiYieFVeDix6/FnOrK9iR9NFi3nXw/w/N/8xDs5sRHtc+NpILNVgo7RibPv/8nEWspImXTNl2S96/0IIm8fcaLY3LWcSoFAR2GJZRP2po7j3ghijYsmp0R5GQuqwpomPP1ybqjd6lKRo/UH+yUg7m8s317R2LWP+oqnRGNuQ4+I32n22QvKbMhxP0IUzQ7oOC74/UZhDF4WhtQ6W/FPhRg1+oaz7h5tedenvyrEEHX69N9Zo1TfM3nU39ng==",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:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},x={},b=[{value:"Request",id:"request",level:2}];function j(e){const a={a:"a",code:"code",h2:"h2",p:"p",strong:"strong",...(0,r.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 binary"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocumentwithbinary"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,i.jsx)(a.code,{children:"multipart/form-data"}),". This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."]}),"\n",(0,i.jsx)(a.p,{children:(0,i.jsxs)(a.strong,{children:["Upload you pdf in ",(0,i.jsx)(a.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," 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:"multipart/form-data",value:"multipart/form-data-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)(d.Z,{collapsible:!1,name:"file",required:!0,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"signers",required:!0,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",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"}}),(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}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(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)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"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)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\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)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(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 f(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/e2a6fad1.fccbd2af.js b/assets/js/e2a6fad1.fccbd2af.js deleted file mode 100644 index d67b6338d..000000000 --- a/assets/js/e2a6fad1.fccbd2af.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6741],{57755:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>f,toc:()=>x});var i=s(85893),r=s(11151),t=s(58219),n=(s(62316),s(51039)),o=s.n(n),l=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const u={id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVt9v2zYQ/ldufFoC2XLSbg/CMCxr2iJosQRIij04RkpTJ+kaiWRJyo4X+H8fjrIcOXGCDNjTsJdEvt/33fEj70WQpRfZVJwa1TaogxezROTolSMbyGiRiasK4Z1DGRB6Kzi5OANZ12bpofXoPAQDJWp0bKVxCXkfD+YrsM4sKCddQi6DhFA505YVfG3aOpCVLqSFcc2IlV/HcFWRh6LGO5rXCA2GyuR9ssI4CBUCaVW3nowGU8BCOjKt3wRfWfQJNPKW81EA31KQHIl9JSwpR3BSl8iufZmguEGO5xVqjufH1/paHx5+sbWROaxMCzYvgDRMc5y3JVycfpj9WIVgfZamPsiSdDmS1o6NRe2p1LWc+7EyTcoBmiJlWUPKGWltGmPYvDiACh3G8EpqyJ1ccoklBg9S56CMXYEyI+Mo1zJgAlaWCLpt5ui4g1BhMwZZe7MNEn3m0uPPb9ni4vTD4eG1FokwlgdERp/lIhOxZewRWFKo5qSlW4lEOPzeog+/m3wlsnuhjA6oA3/uGRmLvaqwiV+Mv8iEmX9DFUQirOOsgdCztqAaB1Y+ONKlSAQHk0FkYlPCOhGBwj7b9aP13KPXJux35Amg8y8WIJ2TK7F+KOBZnG7mDM+aTRkvcpiLLLgWo8Bbo33X9PFkwv92T9XpzuZhDr5VCr0v2rpe/SCSIejS2ppUnFz6zXddvxbxTswDf6HprQTvZGNj19U3Ov7rTi2OLxi51tX/OMDmaLSuHgUzYuxHPYh8LHYwJl2TxpsetpvjyeTmiLFdJ+Lt5Ken8J3phawpj0R0ZW5R/4uQoXPG7Wv3oblh+tCl51LvmgiTlk3XVDSKerHT7FDeNelRtY7CSmTTe3E3kpZGnT6bztazRHQ0KDJhjY8Vy1CJTKQvHGKPbhG3fXrfzU+8iq2kpXRxJDhpX9QlA9dhs1PaFiFp6RNyzk3nQ6tEEA+sQpmjiyiRLkx03uBxblFfUqkjmosj8fQCIg/ko7rvtCNrpvRH3pH4cjA63hOsZPmb8RF4i4qKzVKMgen90jTIF1jR1lCTvvXZtR7B9LwoSJGs4U+cewr4wPPL5fIJYgfR5yOFqp2DQ2sezMsojLAOvbY/DkQiArrGnxeX6Bak+oPzTKo0GqebVZcqrjo2kni6G9Fvj5149WpSqD0OlvPk48VneDOeiGSwHK8oOf189u79H5fvOSqvVzeio/FkPGERr2cj9SDR46dD4UwD2yV9xOXbE/z/q+M/8+rYcETAu5DaWpIeXCgdjU2ff4vMElEx42VTcX/P0b+4er1m8fcWHdPlLBE8CgY7kmXSUw3z3i2ueAW7rRpdcSVsXrdc0b63zDrpnU6UQhsG5k+ulB1evji/vBKJmG+eTI3J2YcDx7jJw2dXpGy58yGD3kYG3Xxw8b1KrwZV7FJrVyr/5cL3OvzCp+YTrn7dmneaZx028PXWPK/Zer3+G37dREo=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,f={id:"API-docs/createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",source:"@site/docs/API-docs/createdocumentwithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithbinary",permalink:"/docs/API-docs/createdocumentwithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVt9v2zYQ/ldufFoC2XLSbg/CMCxr2iJosQRIij04RkpTJ+kaiWRJyo4X+H8fjrIcOXGCDNjTsJdEvt/33fEj70WQpRfZVJwa1TaogxezROTolSMbyGiRiasK4Z1DGRB6Kzi5OANZ12bpofXoPAQDJWp0bKVxCXkfD+YrsM4sKCddQi6DhFA505YVfG3aOpCVLqSFcc2IlV/HcFWRh6LGO5rXCA2GyuR9ssI4CBUCaVW3nowGU8BCOjKt3wRfWfQJNPKW81EA31KQHIl9JSwpR3BSl8iufZmguEGO5xVqjufH1/paHx5+sbWROaxMCzYvgDRMc5y3JVycfpj9WIVgfZamPsiSdDmS1o6NRe2p1LWc+7EyTcoBmiJlWUPKGWltGmPYvDiACh3G8EpqyJ1ccoklBg9S56CMXYEyI+Mo1zJgAlaWCLpt5ui4g1BhMwZZe7MNEn3m0uPPb9ni4vTD4eG1FokwlgdERp/lIhOxZewRWFKo5qSlW4lEOPzeog+/m3wlsnuhjA6oA3/uGRmLvaqwiV+Mv8iEmX9DFUQirOOsgdCztqAaB1Y+ONKlSAQHk0FkYlPCOhGBwj7b9aP13KPXJux35Amg8y8WIJ2TK7F+KOBZnG7mDM+aTRkvcpiLLLgWo8Bbo33X9PFkwv92T9XpzuZhDr5VCr0v2rpe/SCSIejS2ppUnFz6zXddvxbxTswDf6HprQTvZGNj19U3Ov7rTi2OLxi51tX/OMDmaLSuHgUzYuxHPYh8LHYwJl2TxpsetpvjyeTmiLFdJ+Lt5Ken8J3phawpj0R0ZW5R/4uQoXPG7Wv3oblh+tCl51LvmgiTlk3XVDSKerHT7FDeNelRtY7CSmTTe3E3kpZGnT6bztazRHQ0KDJhjY8Vy1CJTKQvHGKPbhG3fXrfzU+8iq2kpXRxJDhpX9QlA9dhs1PaFiFp6RNyzk3nQ6tEEA+sQpmjiyiRLkx03uBxblFfUqkjmosj8fQCIg/ko7rvtCNrpvRH3pH4cjA63hOsZPmb8RF4i4qKzVKMgen90jTIF1jR1lCTvvXZtR7B9LwoSJGs4U+cewr4wPPL5fIJYgfR5yOFqp2DQ2sezMsojLAOvbY/DkQiArrGnxeX6Bak+oPzTKo0GqebVZcqrjo2kni6G9Fvj5149WpSqD0OlvPk48VneDOeiGSwHK8oOf189u79H5fvOSqvVzeio/FkPGERr2cj9SDR46dD4UwD2yV9xOXbE/z/q+M/8+rYcETAu5DaWpIeXCgdjU2ff4vMElEx42VTcX/P0b+4er1m8fcWHdPlLBE8CgY7kmXSUw3z3i2ueAW7rRpdcSVsXrdc0b63zDrpnU6UQhsG5k+ulB1evji/vBKJmG+eTI3J2YcDx7jJw2dXpGy58yGD3kYG3Xxw8b1KrwZV7FJrVyr/5cL3OvzCp+YTrn7dmneaZx028PXWPK/Zer3+G37dREo=",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:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},x=[{value:"Request",id:"request",level:2}];function g(e){const a={a:"a",code:"code",h2:"h2",p:"p",strong:"strong",...(0,r.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 binary"})}),"\n",(0,i.jsx)(o(),{method:"post",path:"/createdocumentwithbinary"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,i.jsx)(a.code,{children:"multipart/form-data"}),". This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."]}),"\n",(0,i.jsx)(a.p,{children:(0,i.jsxs)(a.strong,{children:["Upload you pdf in ",(0,i.jsx)(a.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," 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)(l.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"multipart/form-data",value:"multipart/form-data-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)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(l.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"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)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\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)(l.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(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,r.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.b32c8971.js b/assets/js/runtime~main.580584a2.js similarity index 77% rename from assets/js/runtime~main.b32c8971.js rename to assets/js/runtime~main.580584a2.js index 03dd3e4e8..69909c834 100644 --- a/assets/js/runtime~main.b32c8971.js +++ b/assets/js/runtime~main.580584a2.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,r,b,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,r,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,r,b]},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,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&r&&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(b,d),b},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",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1344:"f864295c",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",6741:"e2a6fad1",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7917:"0028a090",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",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:"00fbee30",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"7625b669",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"a5657d8a",1344:"4ec293b4",1477:"b31b2642",1512:"7ddd2ec3",1520:"538d99ce",1531:"0275f043",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"ff1818b8",2121:"c8df990c",2241:"e6e648f1",2245:"a13fae7c",2267:"a4846e2b",2362:"ebdb1814",2403:"bd03a448",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"a018c535",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:"ddf2d459",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"a995c609",6011:"6de743c9",6033:"b310fe5e",6103:"ebc8482f",6113:"f155125f",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6741:"fccbd2af",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"b2817a74",7917:"1a71e32c",7971:"37040646",8055:"27482879",8087:"fd9041fd",8106:"67e6c7a4",8140:"901b2f91",8141:"6478079e",8163:"8cdfa423",8468:"a1f30bed",8474:"f58804a4",8475:"d27b3009",8489:"3033ed56",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"5685c3d8",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"2b4fb8c8",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"417a4dcd",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),r={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(r[e])r[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 b=r[e];if(delete r[e],f.parentNode&&f.parentNode.removeChild(f),b&&b.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",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f864295c:"1344",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",e2a6fad1:"6741",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","0028a090":"7917","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",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 r=t.o(e,a)?e[a]:void 0;if(0!==r)if(r)c.push(r[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>r=e[a]=[c,b]));c.push(r[2]=b);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",f.name="ChunkLoadError",f.type=b,f.request=d,r[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var r,b,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(r in f)t.o(f,r)&&(t.m[r]=f[r]);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",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1344:"f864295c",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",6741:"e2a6fad1",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7917:"0028a090",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",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:"00fbee30",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"7625b669",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"a5657d8a",1344:"4ec293b4",1477:"b31b2642",1512:"7ddd2ec3",1520:"538d99ce",1531:"0275f043",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"ff1818b8",2121:"c8df990c",2241:"e6e648f1",2245:"a13fae7c",2267:"a4846e2b",2362:"ebdb1814",2403:"bd03a448",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"a018c535",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:"ddf2d459",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"a995c609",6011:"6de743c9",6033:"fcbda936",6103:"ebc8482f",6113:"f155125f",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6741:"137eb6e8",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"b2817a74",7917:"1a71e32c",7971:"37040646",8055:"27482879",8087:"fd9041fd",8106:"67e6c7a4",8140:"901b2f91",8141:"6478079e",8163:"8cdfa423",8468:"a1f30bed",8474:"f58804a4",8475:"d27b3009",8489:"3033ed56",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"583ba3e8",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"2b4fb8c8",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"eaa09736",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",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f864295c:"1344",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",e2a6fad1:"6741",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","0028a090":"7917","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",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 8f8f9fb1a..3fe7128c2 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 df2dce7e1..89131806f 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 d0816f00d..4ed684c34 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 0c86f5cce..a089133c5 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 f4a36c494..c1ff3a55d 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 a76c12a2d..d50212896 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 454c6aecf..68b3e9f8d 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 0bf8472ea..65a965f7b 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 d97c456a5..c61fe9be3 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 12d332739..c76f066c1 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 f2ff9a116..d5a3f681c 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 bac3c43bb..6442444cf 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 f19c1cc1c..cd88cfa0a 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + @@ -14,7 +14,7 @@

The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.

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

Request​

-

Body

required

    file base64
    title string
    description string
    note string

    signers

    object[]

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string
    page number
    x number
    y number
    w number
    h number

  • ]

  • ]

+

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
    page number
    x number
    y number
    w number
    h number

  • ]

  • ]

    • folderId stringrequired
    send_email boolean
    email_subject string

    Custom mail subject for signature request

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

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocumentwithbinary/index.html b/docs/API-docs/createdocumentwithbinary/index.html index 1a2852547..1a9f34e95 100644 --- a/docs/API-docs/createdocumentwithbinary/index.html +++ b/docs/API-docs/createdocumentwithbinary/index.html @@ -5,7 +5,7 @@ Create Document from binary | OpenSign™ - + @@ -14,7 +14,7 @@

The Create Document API allows users to generate new documents by providing data through multipart/form-data. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.

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

Request​

-

Body

required

    file binary
    title string
    description string
    note string
    signers array
+

Body

required

    file binaryrequired
    title stringrequired
    description string
    note string
    signers arrayrequired
    folderId string
    send_email boolean
    email_subject string

    Custom mail subject for signature request

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

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 f6319f200..8af868cfe 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + @@ -14,7 +14,7 @@

The Create Document API allows you to generate new documents by providing template_id.

Request​

Path Parameters

    template_id stringrequired

    objectId of Template

-

Body

required

    signers

    object[]

  • Array [

    • role string
    email mail
    name string
    phone string

  • ]

+

Body

required

    signers

    object[]

    required

  • Array [

    • role string
    email mail
    name string
    phone string

  • ]

    • folderId string
    send_email boolean
    email_subject string

    Custom mail subject for signature request

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

Responses​

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

Schema

    objectId string
    url string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 04a83ea15..95c42d548 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/createtemplatewithbinary/index.html b/docs/API-docs/createtemplatewithbinary/index.html index f06066b37..499394b60 100644 --- a/docs/API-docs/createtemplatewithbinary/index.html +++ b/docs/API-docs/createtemplatewithbinary/index.html @@ -5,7 +5,7 @@ Create Template from binary | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 5a77540fb..e8ebb4a06 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 4fd7a7b9a..b49d7ae2b 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 505d66571..590a5eefe 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 43c233717..1fd6cecfc 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 ab43af195..0cd3f9549 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/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 2d256d454..3471875a3 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 1caa29cd0..7d9c69a65 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 b4533c2b9..b12b2e283 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index bbceb3b61..daabf92b4 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 bf4e4aa45..261b51794 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 8dd96e2aa..d855d5e25 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 a02187197..8b1b95ddf 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 2d59ca099..3015dec35 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 1c5491c31..aef507acc 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 49dab9bab..fadb2a3b3 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 2cc99bef3..8433282d3 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™ - + @@ -14,35 +14,35 @@

The save or update Webhook API allow you to save webhook url which is used to trigger events

events:​

    -
  1. -

    viewed:

    +
  2. viewed:
    • When signer viewed document this event will trigger.
    +
    {
        "event": "viewed",
        "file": "DOCUMENT_URL",
        "name": "DOCUMENT_NAME",
        "note": "Please review and sign this document",
        "description": "",
        "signers": [
          {
            "name": "SIGNER_NAME",
            "email": "SIGNER_EMAIL",
            "phone": "SIGNER_PHONE"
          }
        ],
        "viewedBy": "SIGNER_EMAIL",
        "viewedAt": "TIMESTAMP",
        "createdAt": "TIMESTAMP"
      }
    3. -
  3. -

    created:

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

    5. -
  5. -

    signed:

    +
  6. signed:
    • When document is signed by signer this event will trigger.
    +
    {
        "event": "signed",
        "objectId":"DOCUMENT_ID"
        "file": "DOCUMENT_URL",
        "name": "DOCUMENT_NAME",
        "note": "Please review and sign this document",
        "description": "",
        "signers": [
          {
            "name": "SIGNER_NAME",
            "email": "SIGNER_EMAIL",
            "phone": "SIGNER_PHONE"
          },
        ]
        "signedAt": "TIMESTAMP",
        "createdAt": "TIMESTAMP"
    }
    7. -
  7. -

    completed:

    +
  8. completed:
    • When document is signed by all signers this event will trigger.
    +
    {
       "event": "completed",
       "file": "DOCUMENT_URL",
       "name": "DOCUMENT_NAME",
       "note": "Please review and sign this document",
       "description": "",
       "signers": [
         {
           "name": "SIGNER_NAME",
           "email": "SIGNER_EMAIL",
           "phone": "SIGNER_PHONE"
         }
       ],
       "completedAt": "TIMESTAMP",
       "createdAt": "TIMESTAMP"
     }

    9. -
  9. -

    declined:

    +
  10. declined:
    • When document is declined by signer this event will trigger.
    +
    {
        "event": "declined",
        "file": "DOCUMENT_URL",
        "name": "DOCUMENT_NAME",
        "note": "Please review and sign this document",
        "description": "",
        "signers": [
          {
            "name": "SIGNER_NAME",
            "email": "SIGNER_EMAIL",
            "phone": "SIGNER_PHONE"
          }
        ],
        "declinedBy": "SIGNER_EMAIL",
        "declinedAt": "TIMESTAMP",
        "createdAt": "TIMESTAMP"
      }

Request​

diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index f7ba1d1c7..46e8b8f40 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 dd473c476..23db387e3 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/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index 406c32694..61fab807c 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 7a69a9a35..989a4c0eb 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 16efb8e4e..dd9a780d2 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 627bbce70..c04ed54f5 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 66de84aca..a17ed4672 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 2aa1fbe58..85d79bb2b 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 9a8c460d5..1e80443a8 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 a68435c43..a8ce95dde 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 d31a6f89c..e69c05a7a 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ INSTALLATON INSTRUCTIONS | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 5b82caf73..5128f907c 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 b931a1b3b..8d7501ef0 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 1ffcd221a..f84428a52 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 22b14fb75..5d4cf06ca 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 3b475e3e6..f7db4340d 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 987205c44..5217d7ce2 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 5f4ebd0f9..12d0a6f40 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 49d3a9a5f..7bef1f679 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 adfa1e401..700eab3e0 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 8331d7398..1bffda75e 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 0d84b9ce4..cf76a1184 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 3d04e55ec..af7ad0828 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 ce903e31c..d18365b45 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 35ab507fd..b6bf77784 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 3c0609ac7..97a575742 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 bf9a21c54..eccb69779 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 e18135058..d577b5b24 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 4a2152be5..a4e429adf 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 a4469a56a..a5e6c3fcd 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 dcf70c567..5d04c42f6 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 52ac3d795..c91066076 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 511b64152..bb8b353e0 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 4d247a473..1aecdabd7 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/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index 1758d0e5c..04aca450c 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 897d68a45..793602b0d 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 0a82e1097..d0a98db15 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 c86d71858..c24586bfb 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +