OpenSign/assets/js/94e1fa32.afa5864c.js

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[6582],{41501(e,t,n){n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>y,default:()=>S,frontMatter:()=>g,metadata:()=>a,toc:()=>h});const a=JSON.parse('{"id":"API-docs/v1.2/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.2/getdocument.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getdocument","permalink":"/docs/API-docs/v1.2/getdocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar_label":"Get Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Gdtu28j1V07noU0EWpIvSbbalw26adZtsAnWDgLUNoQheShOPJyZnRlKFgwB+9A/6FNf+2n5kuLMkBRlKbaVzebFFofnnDn3G2+Z5zPHJhfsR53VFSrv2FXCcnSZFcYLrdiEnZcIr9FDCwIv350CKp5KdLDUNXgNFr0VOEfI0XMhHfBU1x44OIOZKEQGeYM9ZAnTBi0n6qc5m7AZ+vYlS5jhllfo0RJbt0zxCtmEtQBTkbOECWLLcF+yu7zq9CNm/jQHXXT8soRZ/LUWFnM28bbGhDm/lETWicpIZAnDGyN1jmxScOkIICux4mxyy/zSBEhvhZqxhBXaVtz3T/CGByoTZn46TMvsqDQpW62u6FpntHLoiNDReEz/Nvl1dZahc0UtoVMKS1imlSfOJ7eMGyNFFl6MPjpCut3mLopN2rNExot4pfPc125fKYQ6MFbPLDrHVkmn0n3J/P21uD46Tsv3/yAqhaDD/SiU3hs3GY2ak9rKYaYropaRjAWp5YuJ9kj0CHvh9+fThR/k4URC6f2ZMhK5Q3BiprpACVrTMkf7sKG/jo1irO1HIXIIAXW1VuA6YBsRyJEWakOWR9H/qBFSRMIn7YS00FHg1vIl5QOPlXtYS1bvtu36tgz1fYrYyRZWXMgHoVPEH5qD1tdMqdUD15w8e350ePzdi0OCX4h8hv53yB/f7qd/jzc+1TeBXz7ro6u6StH20buTDv1wlbCbPXGOTk5WCVvuifWCrlrsiXT83Sph5Z5IJ8/Jl0MCf4TOvySmOp2v+hHlsTKSe5yexTiYtv5wL1QISocqP1Vv7WYuSbWWyFX/aqqODfxUqKkmjClxmPn7EUPZXCWMS6kXU10UUiicUsTuxNssgh9K9CVaaAIcMq7A1WklqIHItFlSNfelcF1ujKA51E6oGXAFeOPRKi7Bay2h0BZCtgGLc4GLIfyIBa+ld9SrBF6Hu7jPLHKP+Ut/f1QejY+ODw7HB+MX54fPJyd/nTx7PhyPx/9iCbup5NrqLKf61E+KzXNt8m9yT2zSznX9OLNbzIXFzE9ruzOh3eezrDN+pfNYV+8EyH1eU+fCT73dTKR7ZrcvzsPkIbizdH5FU0SH/UMv2VF9F8KXsQmc9nUcQNtEIR7gqgcIwoFWcgl8zoUk34JFiQp8ievQFA6aOILC6go4tBSGwUlqr6cWK6EezEate0ToqVYZUlbCOdqd5aFDHFO1QjXNtNSPahgasVc9GhcslTWG2YFGjlTy7JpdrRKWZtmXUqwd2g3vS8LR0cbZFVnnjr23zMnuNXZTOU52TRxnukJfUtpckLUWVqtZAk0D6u0S+IwLBWQv+6evN4qgtXpn87d2tP0467u7UKHctOPW9GQ8nh52SjjZVkI3yirtodC1yr+tqLvuv1+gk+lxJ9CzbYFO1ZxLkYfR/Fxfo/q28vSv9/H6bS8WESi8ZxvC9s+jkA6z2gq/DDuAmwNuxEF8P7m4osmaPEU3y4OwNPAlm7BRGwqj297CYMWInp23K4VQ3bo50HGVp/pmqA0qStKSp47icMSNGM0Ph0dsldzF4cbsBY/1wb4ozvOZULOH8K7Wqjojc0aLbShsnaqM+CdSrmrs0Ydqdiol8jCsrei50AG5sdJbg4p6ymDjcPlWG4cy0xVSi0UFYTBoUT79+38d1mDQVYrgjcNLdane1haMXqClPQhXORQSbwSVl7BqqsK7btfkkFcSnZNLEMrjzHKPkIuZ8FyGxpBSSMYNT4UU5MQEpgnbQi8O3BDaxnOp679YBA45zlGS7wOVqYp7ItVVtoW214XUC5cAh5R6T3QOUJVcZQTYWiIBbUNTqjxaYwVN9t4S1yLyppW3PPNQccVnSLQT6CsrRynIXcHqtHYenJZ1YBlouaYt5tAKpBBzF5T4ilZYFoFOM10ZiyW5zRxhVoscXQKZzhHisoJEUDmk6DwY4kVkGJrjWkmdXQcDFrWUYDSlEMEl9eB9HgndW64cdYWRl9YGncKM1bTdwsjgYPDeIVn4jVDXbjIYXKoDuOj86gOmTni8etKGwGKx2HL9p5s4r4X/qU7hFzTaCa/tco09E76s0xAufSLdQ6T0GhUG/+kFw5pGrjO3HX10OipRmtEZevIQN3r57jRk3afw6bf/wBvkVkGpF9Fbs9qiXMKsvYo0Fy0f1dYlzTC38NqXpPEsOh9tLtH5VoMfSu4//fZfBz/jAoRqQopEGQxoR3vetFrwZ9h4fCOcHwwmYLHScxqclEIyDbdLWG9cA2sO6YDaN2OxEFJCzj2PvVyc0HoYQ7r6Mmz3poY7t9A2v2RrAOB5jjlxGnvCrhdMIA5BvYMGYh1uwpe917nlhV+/jazKIi7NrK59dGBj9VzkCC03QanGao9ZkCkvWqa3Z9VHcR5uvsN87/5AFaitC49xBKOEkAsXf8YLu0xF/PkShe2otQxGbU9pbbWbM4rSdmiOxZuidFNRW3p9UNFbliKBTZ1Kkd0VeAgvswwNKXbOZY1uAoNB5GgwgCd5nLqfJjAYhCnLDgb0mxuyEj0NodlTQEWJruRzBO6Bej4PutES97VFiOuO7yES6iMo3bx030NL2kHFlw09tWzfB1GbDxMd4ebjQPg4cUml8E753KxyFgu0pLtg3nVQG9EE8UWbDIByxO9JJmHTrZXncfvSDLhUx3+4Syf0U2gr97Y4QzsXWbvq/kweHQXgEUuYFBkqh70+7eXrd29gfjwc03jSNSWPSKmjN6d/e/Xz2aswVKN1UWGHw/FwHPaH2vmKq95N/a9Kd9uJ23X7+gd8gWpaItq0jYzkIjSkzdojNpMXrPdRatL//nSVsFI7TyC3tyl3+N7K1YqOf63DZHpxlbA5t4L4Cx1nE/p593nps5I++aX5UvUUPvMpayfnbYenqL0LkUgrmYRd4/LOx7MVjbBNm0esRYgYxT3crXlho+l+/eqchUm+3Gwvr0N72fwg6jv52uw7IwP0l5rgnQi3t7F1Xa06+PjqsxiNgC00KelqtVr9H6jXDyU=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.2/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.2/update-document"}}');var o=n(74848),r=n(28453),i=n(57742),s=n.n(i),p=n(78178),l=n.n(p),c=n(19624),m=n.n(c),d=n(96226),u=n.n(d),b=(n(77675),n(19365),n(51107)),x=n(21312);const g={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Gdtu28j1V07noU0EWpIvSbbalw26adZtsAnWDgLUNoQheShOPJyZnRlKFgwB+9A/6FNf+2n5kuLMkBRlKbaVzebFFofnnDn3G2+Z5zPHJhfsR53VFSrv2FXCcnSZFcYLrdiEnZcIr9FDCwIv350CKp5KdLDUNXgNFr0VOEfI0XMhHfBU1x44OIOZKEQGeYM9ZAnTBi0n6qc5m7AZ+vYlS5jhllfo0RJbt0zxCtmEtQBTkbOECWLLcF+yu7zq9CNm/jQHXXT8soRZ/LUWFnM28bbGhDm/lETWicpIZAnDGyN1jmxScOkIICux4mxyy/zSBEhvhZqxhBXaVtz3T/CGByoTZn46TMvsqDQpW62u6FpntHLoiNDReEz/Nvl1dZahc0UtoVMKS1imlSfOJ7eMGyNFFl6MPjpCut3mLopN2rNExot4pfPc125fKYQ6MFbPLDrHVkmn0n3J/P21uD46Tsv3/yAqhaDD/SiU3hs3GY2ak9rKYaYropaRjAWp5YuJ9kj0CHvh9+fThR/k4URC6f2ZMhK5Q3BiprpACVrTMkf7sKG/jo1irO1HIXIIAXW1VuA6YBsRyJEWakOWR9H/qBFSRMIn7YS00FHg1vIl5QOPlXtYS1bvtu36tgz1fYrYyRZWXMgHoVPEH5qD1tdMqdUD15w8e350ePzdi0OCX4h8hv53yB/f7qd/jzc+1TeBXz7ro6u6StH20buTDv1wlbCbPXGOTk5WCVvuifWCrlrsiXT83Sph5Z5IJ8/Jl0MCf4TOvySmOp2v+hHlsTKSe5yexTiYtv5wL1QISocqP1Vv7WYuSbWWyFX/aqqODfxUqKkmjClxmPn7EUPZXCWMS6kXU10UUiicUsTuxNssgh9K9CVaaAIcMq7A1WklqIHItFlSNfelcF1ujKA51E6oGXAFeOPRKi7Bay2h0BZCtgGLc4GLIfyIBa+ld9SrBF6Hu7jPLHKP+Ut/f1QejY+ODw7HB+MX54fPJyd/nTx7PhyPx/9iCbup5NrqLKf61E+KzXNt8m9yT2zSznX9OLNbzIXFzE9ruzOh3eezrDN+pfNYV+8EyH1eU+fCT73dTKR7ZrcvzsPkIbizdH5FU0SH/UMv2VF9F8KXsQmc9nUcQNtEIR7gqgcIwoFWcgl8zoUk34JFiQp8ievQFA6aOILC6go4tBSGwUlqr6cWK6EezEate0ToqVYZUlbCOdqd5aFDHFO1QjXNtNSPahgasVc9GhcslTWG2YFGjlTy7JpdrRKWZtmXUqwd2g3vS8LR0cbZFVnnjr23zMnuNXZTOU52TRxnukJfUtpckLUWVqtZAk0D6u0S+IwLBWQv+6evN4qgtXpn87d2tP0467u7UKHctOPW9GQ8nh52SjjZVkI3yirtodC1yr+tqLvuv1+gk+lxJ9CzbYFO1ZxLkYfR/Fxfo/q28vSv9/H6bS8WESi8ZxvC9s+jkA6z2gq/DDuAmwNuxEF8P7m4osmaPEU3y4OwNPAlm7BRGwqj297CYMWInp23K4VQ3bo50HGVp/pmqA0qStKSp47icMSNGM0Ph0dsldzF4cbsBY/1wb4ozvOZULOH8K7Wqjojc0aLbShsnaqM+CdSrmrs0Ydqdiol8jCsrei50AG5sdJbg4p6ymDjcPlWG4cy0xVSi0UFYTBoUT79+38d1mDQVYrgjcNLdane1haMXqClPQhXORQSbwSVl7BqqsK7btfkkFcSnZNLEMrjzHKPkIuZ8FyGxpBSSMYNT4UU5MQEpgnbQi8O3BDaxnOp679YBA45zlGS7wOVqYp7ItVVtoW214XUC5cAh5R6T3QOUJVcZQTYWiIBbUNTqjxaYwVN9t4S1yLyppW3PPNQccVnSLQT6CsrRynIXcHqtHYenJZ1YBlouaYt5tAKpBBzF5T4ilZYFoFOM10ZiyW5zRxhVoscXQKZzhHisoJEUDmk6DwY4kVkGJrjWkmdXQcDFrWUYDSlEMEl9eB9HgndW64cdYWRl9YGncKM1bTdwsjgYPDeIVn4jVDXbjIYXKoDuOj86gOmTni8etKGwGKx2HL9p5s4r4X/qU7hFzTaCa/tco09E76s0xAufSLdQ6T0GhUG/+kFw5pGrjO3HX10OipRmtEZevIQN3r57jRk3afw6bf/wBvkVkGpF9Fbs9qiXMKsvYo0Fy0f1dYlzTC38NqXpPEsOh9tLtH5VoMfSu4//fZfBz/jAoRqQopEGQxoR3vetFrwZ9h4fCOcHwwmYLHScxqclEIyDbdLWG9cA2sO6YDaN2OxEFJCzj2PvVyc0HoYQ7r6Mmz3poY7t9A2v2RrAOB5jjlxGnvCrhdMIA5BvYMGYh1uwpe917nlhV+/jazKIi7NrK59dGBj9VzkCC03QanGao9ZkCkvWqa3Z9VHcR5uvsN87/5AFaitC49xBKOEkAsXf8YLu0xF/PkShe2otQxGbU9pbbWbM4rSdmiOxZuidFNRW3p9UNFbliKBTZ1Kkd0VeAgvswwNKXbOZY1uAoNB5GgwgCd5nLqfJjAYhCnLDgb0mxuyEj0NodlTQEWJruRzBO6Bej4PutES97VFiOuO7yES6iMo3bx030NL2kHFlw09tWzfB1GbDxMd4ebjQPg4cUml8E753KxyFgu0pLtg3nVQG9EE8UWbDIByxO9JJmHTrZXncfvSDLhUx3+4Syf0U2gr97Y4QzsXWbvq/kweHQXgEUuYFBkqh70+7eXrd29gfjwc03jSNSWPSKmjN6d/e/Xz2aswVKN1UWGHw/FwHPaH2vmKq95N/a9Kd9uJ23X7+gd8gWpaItq0jYzkIjSkzdojNpMXrPdRatL//nSVsFI7TyC3tyl3+N7K1YqOf63DZHpxlbA5t4L4Cx1nE/p593nps5I++aX5UvUUPvMpayfnbYenqL0LkUgrmYRd4/LOx7MVjbBNm0esRYgYxT3crXlho+l+/eqchUm+3Gwvr0N72fwg6jv52uw7IwP0l5rgnQi3t7F1Xa06+PjqsxiNgC00KelqtVr9H6jXDyU=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},y=void 0,f={},h=[];function j(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,o.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,o.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(x.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(l(),{...n(33154)}),"\n",(0,o.jsx)(m(),{...n(68936)}),"\n",(0,o.jsx)(u(),{...n(53026)})]})}function S(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(j,{...e})}):j(e)}},33154(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},68936(e){e.exports={title:"Body"}},53026(e){e.exports=JSON.parse('{"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","format":"string","example":"in-progress"},"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"file":{"type":"string","format":"string","example":"https://exampleurl.com"},"certificate":{"type":"string","format":"string","example":"https://certificateurl.com"},"title":{"type":"string","format":"string","example":"sample doc"},"note":{"type":"string","format":"string","example":"please sign document"},"folder":{"type":"object","properties":{"objectId":{"type":"string","format":"string","example":"FGik23bhUJ"},"name":{"type":"string","format":"string","example":"folder name"}},"title":"document_folder"},"owner":{"type":"string","format":"string","example":"joe bee"},"signers":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","example":"ceo"},"name":{"type":"string","example":"joe bee"},"email":{"type":"string","example":"joebee@example.com"},"phone":{"type":"string","example":"456213871"},"widgets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","format":"string","example":"textbox"},"page":{"type":"number","format":"number","example":1},"x":{"type":"number","format":"number","example":244},"y":{"type":"number","format":"number","example":71},"w":{"type":"number","format":"number","example":38},"h":{"type":"number","format":"number","example":46},"options":{"type":"object","properties":{"name":{"type":"string","format":"string","example":"textbox"}}}},"title":"template_Signers_widgets"}}},"title":"template_Signers"}},"sendInOrder":{"type":"boolean","example":true},"send_in_order_strict":{"type":"boolean","example":false},"allow_offline_sign":{"type":"boolean","description":"Whether signers can submit a copy of this document signed using an external tool for owner review. Defaults to false.","example":false},"createdAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"updatedAt":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"enableTour":{"type":"boolean","example":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"audit_trail":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"joebee@example.com"},"viewed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"},"signed":{"type":"string","example":"2023-10-07T16:49:56.000Z","xml":{"name":"date"},"title":"date"}},"title":"documentwithstatus_audit_trail"}},"template_id":{"type":"string","example":"template_id is only available when the document is created from a template."},"auto_reminder":{"type":"boolean","example":false},"remind_once_in_every":{"type":"number","example":0},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]}},"xml":{"name":"documentwithstatus"},"title":"documentwithstatus"}}}},"400":{"description":"Something went wrong, please try again later!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Something went wrong, please try again later!"}},"title":"inline_response_400_1"}}}},"404":{"description":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Document not found!"}},"title":"inline_response_404_3"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]);