Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sign.Plus API","colors":{"primary":"#0a69ff","light":"#0a69ff","dark":"#0a69ff"},"logo":{"light":"https://mintcdn.com/alohi/KnYKDC0EFTC2S5WS/resources/logo/light.svg?fit=max\u0026auto=format\u0026n=KnYKDC0EFTC2S5WS\u0026q=85\u0026s=a36aa041d10277b8e69a0d12954482ba","dark":"https://mintlify.s3.us-west-1.amazonaws.com/alohi/resources/logo/dark.svg"},"favicon":"https://mintcdn.com/alohi/KnYKDC0EFTC2S5WS/favicon.svg?fit=max\u0026auto=format\u0026n=KnYKDC0EFTC2S5WS\u0026q=85\u0026s=35bc7e677ad3a5a365357ea9e7d09682","appearance":{"default":"light","strict":true},"navbar":{"links":[],"primary":{"type":"button","label":"Create an account","href":"https://app.sign.plus"}},"footer":{"socials":{"website":"https://www.alohi.com","linkedin":"https://www.linkedin.com/company/alohi"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity",{"title":"Connect to Cursor","description":"Install MCP server on Cursor","icon":"/resources/logo/cursor.svg","href":"cursor://anysphere.cursor-deeplink/mcp/install?name=Sign.Plus%20API\u0026config=eyJuYW1lIjoiU2lnbi5QbHVzIEFQSSIsInVybCI6Imh0dHBzOi8vbWNwLnNpZ24ucGx1cy9tY3AiLCJoZWFkZXJzIjp7IkF1dGhvcml6YXRpb24iOiJCZWFyZXIgWU9VUl9QRVJTT05BTF9BQ0NFU1NfVE9LRU4ifX0="},{"title":"Connect to VS Code","description":"Install MCP server on VS Code","icon":"/resources/logo/vscode.svg","href":"vscode:mcp/install?%7B%22name%22%3A%22Sign.Plus%20API%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.sign.plus%2Fmcp%22%2C%22type%22%3A%22http%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20PERSONAL_ACCESS_TOKEN%22%7D%7D"}],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"graduation-cap","href":"https://help.alohi.com/hc/en-us"},{"anchor":"Release Notes","icon":"rss","href":"https://www.alohi.com/release-notes"},{"anchor":"Compliance \u0026 Security","icon":"shield-halved","href":"https://www.alohi.com/trust/compliance"},{"anchor":"Blog","icon":"newspaper","href":"https://www.alohi.com/blog"},{"anchor":"Changelog","icon":"code-commit","href":"https://apidoc.sign.plus/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"alohi","hasAudioNarration":false,"actualSubdomain":"alohi","customDomains":["apidoc.sign.plus"],"gitSource":{"type":"github","owner":"alohihq","repo":"signplus-apidoc","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab0e1f08e0118a0c61eb33e","collectionId":"b62cbe74-7d02-46e3-a7d4-d849d6521818","schemaVersion":"v2","latestBuiltDeploymentHistoryId":"6ab0e1f08e0118a0c61eb33e"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ab0e1f08e0118a0c61eb33e","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Documentation","count":79},{"language":"default","tag":"API Reference","count":49},{"language":"default","tag":"Envelope","count":28},{"language":"default","tag":"Template","count":18},{"language":"default","tag":"Backend SDKs","count":12},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Concepts","count":6},{"language":"default","tag":"Envelopes","count":6},{"language":"default","tag":"Webhook","count":3},{"language":"default","tag":"Go","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/signplus/get-envelope","slug":"/api-reference/endpoints/signplus/get-envelope","pageMetadata":{"openapi":"get /envelope/{envelope_id}","title":"Get envelope","description":null,"href":"/api-reference/endpoints/signplus/get-envelope"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /envelope/{envelope_id}","title":"Get envelope","description":null,"href":"/api-reference/endpoints/signplus/get-envelope"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/alohi/2cb5dfef0e2c35ed/intercom-settings.js","/_mintlify/custom/alohi/d717ff9473dc3e96/intercom.js"],"openApiReferenceData":{"operation":{"summary":"Get envelope","operationId":"get_envelope","x-mint":{"mcp":{"enabled":true,"name":"get_envelope","description":"Retrieve detailed information about a specific envelope. **Authentication:** Handled automatically by MCP server. **Example:** get_envelope(envelope_id='env_abc123'). **Required:** envelope_id (path param, string). **Returns:** Complete envelope object with ID, name, comment, status, dates (creation/modification/expiration), documents (with page counts), signing steps (with recipients), and settings (notifications, attachments, legality level). **Use cases:** Check status after sending, display envelope details, get document list, view signing workflow."}},"tags":["signplus"],"security":["e3065611-1442-4cb9-97dd-c7e153d87154"],"parameters":["0327a751-499d-40b1-8a78-7d4d26743e72"],"responses":{"200":"3571016e-10b7-41db-9754-203029b9fb7f"},"method":"get","type":"path","servers":["669e017a-51b1-4421-ac23-a0f6452848b1"],"path":"/envelope/{envelope_id}","baseUrlOptions":["https://restapi.sign.plus/v2"],"title":"Get envelope","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0327a751-499d-40b1-8a78-7d4d26743e72":{"in":"path","name":"envelope_id","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"3571016e-10b7-41db-9754-203029b9fb7f":{"description":"Envelope details retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the envelope","uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"Name of the envelope","uniqueKey":"name","typeLabel":"string"},"comment":{"type":"string","description":"Comment for the envelope","uniqueKey":"comment","typeLabel":"string"},"pages":{"type":"integer","description":"Total number of pages in the envelope","uniqueKey":"pages","typeLabel":"integer"},"flow_type":{"type":"string","description":"Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)","enum":["REQUEST_SIGNATURE","SIGN_MYSELF"],"uniqueKey":"flow_type","typeLabel":"enum\u003cstring>"},"legality_level":{"type":"string","description":"Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)","enum":["SES","QES_EIDAS","QES_ZERTES"],"uniqueKey":"legality_level","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Status of the envelope","enum":["DRAFT","IN_PROGRESS","COMPLETED","EXPIRED","DECLINED","VOIDED","PENDING"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"integer","description":"Unix timestamp of the creation date","uniqueKey":"created_at","typeLabel":"integer"},"updated_at":{"type":"integer","description":"Unix timestamp of the last modification date","uniqueKey":"updated_at","typeLabel":"integer"},"expires_at":{"type":"integer","description":"Unix timestamp of the expiration date","uniqueKey":"expires_at","typeLabel":"integer"},"num_recipients":{"type":"integer","description":"Number of recipients in the envelope","uniqueKey":"num_recipients","typeLabel":"integer"},"is_duplicable":{"type":"boolean","description":"Whether the envelope can be duplicated","uniqueKey":"is_duplicable","typeLabel":"boolean"},"signing_steps":{"type":"array","items":{"type":"object","properties":{"recipients":{"type":"array","description":"List of recipients","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the recipient","isRequired":true,"uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","description":"Email of the recipient","isRequired":true,"uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX].email","typeLabel":"string"},"role":{"type":"string","description":"Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)","enum":["SIGNER","RECEIVES_COPY","IN_PERSON_SIGNER"],"isRequired":true,"uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Unique identifier of the recipient","uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX].id","typeLabel":"string"},"uid":{"type":"string","description":"Unique identifier of the user associated with the recipient","uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX].uid","typeLabel":"string"},"verification":{"type":"object","properties":{"type":{"type":"string","description":"Type of verification the recipient must complete before accessing the envelope.\n\n- `PASSCODE`: requires a code to be entered. \n- `SMS`: sends a code via SMS. \n- `ID_VERIFICATION`: prompts the recipient to complete an automated ID and selfie check.","enum":["SMS","PASSCODE","ID_VERIFICATION"],"uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX].verification.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Required for `PASSCODE` and `SMS` verification.\n\n- `PASSCODE`: code required by the recipient to sign the document.\n- `SMS`: recipient's phone number.\n- `ID_VERIFICATION`: leave empty.","uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX].verification.value","typeLabel":"string"}},"uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX].verification","typeLabel":"object"}},"required":["name","email","role"],"uniqueKey":"signing_steps.items.[INDEX].recipients.items.[INDEX]","typeLabel":"object"},"uniqueKey":"signing_steps.items.[INDEX].recipients","typeLabel":"object[]"}},"uniqueKey":"signing_steps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"signing_steps","typeLabel":"object[]"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document","uniqueKey":"documents.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Name of the document","uniqueKey":"documents.items.[INDEX].name","typeLabel":"string"},"filename":{"type":"string","description":"Filename of the document","uniqueKey":"documents.items.[INDEX].filename","typeLabel":"string"},"page_count":{"type":"integer","description":"Number of pages in the document","uniqueKey":"documents.items.[INDEX].page_count","typeLabel":"integer"},"pages":{"type":"array","description":"List of pages in the document","items":{"type":"object","properties":{"width":{"type":"integer","description":"Width of the page in pixels","uniqueKey":"documents.items.[INDEX].pages.items.[INDEX].width","typeLabel":"integer"},"height":{"type":"integer","description":"Height of the page in pixels","uniqueKey":"documents.items.[INDEX].pages.items.[INDEX].height","typeLabel":"integer"}},"uniqueKey":"documents.items.[INDEX].pages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"documents.items.[INDEX].pages","typeLabel":"object[]"}},"uniqueKey":"documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"documents","typeLabel":"object[]"},"notification":{"type":"object","properties":{"subject":{"type":"string","description":"Subject of the notification","uniqueKey":"notification.subject","typeLabel":"string"},"message":{"type":"string","description":"Message of the notification","uniqueKey":"notification.message","typeLabel":"string"},"reminder_interval":{"type":"integer","description":"Interval in days to send reminder","uniqueKey":"notification.reminder_interval","typeLabel":"integer"}},"uniqueKey":"notification","typeLabel":"object"},"attachments":{"type":"object","properties":{"settings":{"type":"object","properties":{"visible_to_recipients":{"type":"boolean","description":"Whether the attachment is visible to the recipients or only to the sender","uniqueKey":"attachments.settings.visible_to_recipients","typeLabel":"boolean"}},"uniqueKey":"attachments.settings","typeLabel":"object"},"recipients":{"type":"array","items":{"type":"object","properties":{"recipient_id":{"type":"string","description":"ID of the recipient","uniqueKey":"attachments.recipients.items.[INDEX].recipient_id","typeLabel":"string"},"recipient_name":{"type":"string","description":"Name of the recipient","uniqueKey":"attachments.recipients.items.[INDEX].recipient_name","typeLabel":"string"},"placeholders":{"type":"array","items":{"type":"object","properties":{"recipient_id":{"type":"string","description":"ID of the recipient","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].recipient_id","typeLabel":"string"},"id":{"type":"string","description":"ID of the attachment placeholder","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Name of the attachment placeholder","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].name","typeLabel":"string"},"hint":{"type":"string","description":"Hint of the attachment placeholder","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].hint","typeLabel":"string"},"required":{"type":"boolean","description":"Whether the attachment placeholder is required","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].required","typeLabel":"boolean"},"multiple":{"type":"boolean","description":"Whether the attachment placeholder can have multiple files","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].multiple","typeLabel":"boolean"},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the file","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].files.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Name of the file","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].files.items.[INDEX].name","typeLabel":"string"},"size":{"type":"integer","description":"Size of the file in bytes","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].files.items.[INDEX].size","typeLabel":"integer"},"mimetype":{"type":"string","description":"MIME type of the file","uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].files.items.[INDEX].mimetype","typeLabel":"string"}},"uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].files.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX].files","typeLabel":"object[]"}},"uniqueKey":"attachments.recipients.items.[INDEX].placeholders.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachments.recipients.items.[INDEX].placeholders","typeLabel":"object[]"}},"uniqueKey":"attachments.recipients.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachments.recipients","typeLabel":"object[]"}},"description":"Requested attachments for the envelope. See [Set Attachment Requests guide](/guides/set-attachment-requests) for more details.","uniqueKey":"attachments","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","comment":"\u003cstring>","pages":123,"flow_type":"REQUEST_SIGNATURE","legality_level":"SES","status":"DRAFT","created_at":123,"updated_at":123,"expires_at":123,"num_recipients":123,"is_duplicable":true,"signing_steps":[{"recipients":[{"name":"\u003cstring>","email":"\u003cstring>","role":"SIGNER","id":"\u003cstring>","uid":"\u003cstring>","verification":{"type":"SMS","value":"\u003cstring>"}}]}],"documents":[{"id":"\u003cstring>","name":"\u003cstring>","filename":"\u003cstring>","page_count":123,"pages":[{"width":123,"height":123}]}],"notification":{"subject":"\u003cstring>","message":"\u003cstring>","reminder_interval":123},"attachments":{"settings":{"visible_to_recipients":true},"recipients":[{"recipient_id":"\u003cstring>","recipient_name":"\u003cstring>","placeholders":[{"recipient_id":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","hint":"\u003cstring>","required":true,"multiple":true,"files":[{"id":"\u003cstring>","name":"\u003cstring>","size":123,"mimetype":"\u003cstring>"}]}]}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e3065611-1442-4cb9-97dd-c7e153d87154":{"BearerAuth":{"type":"http","scheme":"bearer","scopes":["SIGN_ALL_READ"]}}},"servers":{"669e017a-51b1-4421-ac23-a0f6452848b1":{"url":"https://restapi.sign.plus/v2","description":"Sign.Plus API - Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":["SIGN_ALL_READ"]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"alohi","siteName":"Sign.Plus API","title":"Get envelope - Sign.Plus API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-28T14:29:23.686Z","originalFileLocation":"api-reference/endpoints/signplus/get-envelope.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Sign.Plus API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get envelope - Sign.Plus API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sign.Plus API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://alohi.mintlify.app/_mintlify/api/og/v2?division=Envelope\u0026amp;title=Get+envelope\u0026amp;theme=46bfa0e7adb943a0855744a3\u0026amp;signature=370f3af81879079382715640f523fc3f1be8897e255adc985b2d1b19a2ed10d7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get envelope - Sign.Plus API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://alohi.mintlify.app/_mintlify/api/og/v2?division=Envelope\u0026amp;title=Get+envelope\u0026amp;theme=46bfa0e7adb943a0855744a3\u0026amp;signature=370f3af81879079382715640f523fc3f1be8897e255adc985b2d1b19a2ed10d7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/alohi/qaMTdj2VO0FwUxYO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sign.Plus API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0a69ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/signplus/get-envelope.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidoc.sign.plus/#organization\",\"name\":\"Sign.Plus API\",\"url\":\"https://apidoc.sign.plus\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/alohi/KnYKDC0EFTC2S5WS/resources/logo/light.svg?fit=max\u0026auto=format\u0026n=KnYKDC0EFTC2S5WS\u0026q=85\u0026s=a36aa041d10277b8e69a0d12954482ba\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidoc.sign.plus#website\",\"name\":\"Sign.Plus API\",\"url\":\"https://apidoc.sign.plus\",\"publisher\":{\"@id\":\"https://apidoc.sign.plus/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope#webpage\",\"url\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope\",\"name\":\"Get envelope\",\"dateModified\":\"2026-04-28T14:29:23.686Z\",\"isPartOf\":{\"@id\":\"https://apidoc.sign.plus#website\"},\"breadcrumb\":{\"@id\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/create-new-envelope\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Envelope\",\"item\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/create-new-envelope\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get envelope\",\"item\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope#apireference\",\"headline\":\"Get envelope\",\"name\":\"Get envelope\",\"url\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope\",\"mainEntityOfPage\":{\"@id\":\"https://apidoc.sign.plus/api-reference/endpoints/signplus/get-envelope#webpage\"},\"dateModified\":\"2026-04-28T14:29:23.686Z\",\"publisher\":{\"@id\":\"https://apidoc.sign.plus/#organization\"},\"isPartOf\":{\"@id\":\"https://apidoc.sign.plus#website\"}}]}\u003c/script>","siteName":"Sign.Plus API","nav":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"graduation-cap","href":"https://help.alohi.com/hc/en-us"},{"anchor":"Release Notes","icon":"rss","href":"https://www.alohi.com/release-notes"},{"anchor":"Compliance \u0026 Security","icon":"shield-halved","href":"https://www.alohi.com/trust/compliance"},{"anchor":"Blog","icon":"newspaper","href":"https://www.alohi.com/blog"},{"anchor":"Changelog","icon":"code-commit","href":"https://apidoc.sign.plus/changelog"}]},"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":"Introduction","icon":"signature","href":"/get-started/introduction"},{"title":"Quickstart","icon":"bolt","href":"/get-started/quickstart"}]},{"group":"MCP","pages":[{"title":"Sign.Plus MCP Server","icon":"robot","href":"/get-started/sign-plus-mcp"}]},{"group":"Concepts","pages":[{"title":"Envelope","icon":"envelope","href":"/concepts/envelope"},{"title":"Document","icon":"file","href":"/concepts/document"},{"title":"Annotation","icon":"pen-to-square","href":"/concepts/annotation"},{"title":"Signing Steps","icon":"bars-staggered","href":"/concepts/signing-steps"},{"title":"Template","icon":"copy","href":"/concepts/template"},{"title":"Webhook","icon":"bell","href":"/concepts/webhook"}]},{"group":"Guides","pages":[{"group":"Account","icon":"lock","pages":[{"title":"Setup your account","href":"/guides/setup-your-account"}]},{"group":"Envelopes","icon":"envelopes-bulk","pages":[{"title":"Create your first envelope","href":"/guides/create-your-first-envelope"},{"title":"Add Signature annotation","href":"/guides/add-signature-annotation"},{"title":"Add Text annotation","href":"/guides/add-text-annotation"},{"title":"Set Envelope Legality Level","href":"/guides/set-envelope-legality-level"},{"title":"Set Attachment Requests","href":"/guides/set-attachment-requests"},{"title":"Build signing flow","href":"/guides/build-signing-flow"}]},{"group":"Templates","icon":"paste","pages":[{"title":"Create your first template","href":"/guides/create-your-first-template"}]},{"group":"Webhooks","icon":"link","pages":[{"title":"Get notified using webhooks","href":"/guides/get-notified-using-webhooks"}]}]},{"group":"Backend SDKs","pages":[{"group":"Python","icon":"python","pages":[{"title":"Install","href":"/backend-sdks/python/install"},{"title":null,"href":"/backend-sdks/python/sdk-reference"}]},{"group":"Typescript","icon":"js","pages":[{"title":"Install","href":"/backend-sdks/typescript/install"},{"title":null,"href":"/backend-sdks/typescript/sdk-reference"}]},{"group":"Go","icon":"golang","pages":[{"title":"Install","href":"/backend-sdks/go/install"},{"title":null,"href":"/backend-sdks/go/sdk-reference"}]},{"group":"Java","icon":"java","pages":[{"title":"Install","href":"/backend-sdks/java/install"},{"title":null,"href":"/backend-sdks/java/sdk-reference"}]},{"group":"C#","icon":"hashtag","pages":[{"title":"Install","href":"/backend-sdks/sharp/install"},{"title":null,"href":"/backend-sdks/sharp/sdk-reference"}]},{"group":"PHP","icon":"php","pages":[{"title":"Install","href":"/backend-sdks/php/install"},{"title":null,"href":"/backend-sdks/php/sdk-reference"}]}]},{"group":"API Reference","pages":[{"group":"Envelope","icon":"envelope","pages":[{"openapi":"post /envelope","title":"Create new envelope","href":"/api-reference/endpoints/signplus/create-new-envelope"},{"openapi":"post /envelope/from_template/{template_id}","title":"Create new envelope from template","href":"/api-reference/endpoints/signplus/create-new-envelope-from-template"},{"openapi":"post /envelopes","title":"List envelopes","description":null,"href":"/api-reference/endpoints/signplus/list-envelopes"},{"openapi":"get /envelope/{envelope_id}","title":"Get envelope","href":"/api-reference/endpoints/signplus/get-envelope"},{"openapi":"delete /envelope/{envelope_id}","title":"Delete envelope","description":null,"href":"/api-reference/endpoints/signplus/delete-envelope"},{"openapi":"get /envelope/{envelope_id}/document/{document_id}","title":"Get envelope document","href":"/api-reference/endpoints/signplus/get-envelope-document"},{"openapi":"get /envelope/{envelope_id}/documents","title":"Get envelope documents","href":"/api-reference/endpoints/signplus/get-envelope-documents"},{"openapi":"post /envelope/{envelope_id}/document","title":"Add envelope document","href":"/api-reference/endpoints/signplus/add-envelope-document"},{"openapi":"put /envelope/{envelope_id}/dynamic_fields","title":"Set envelope dynamic fields","href":"/api-reference/endpoints/signplus/set-envelope-dynamic-fields"},{"openapi":"post /envelope/{envelope_id}/signing_steps","title":"Add envelope signing steps","href":"/api-reference/endpoints/signplus/add-envelope-signing-steps"},{"openapi":"post /envelope/{envelope_id}/send","title":"Send envelope for signature","href":"/api-reference/endpoints/signplus/send-envelope-for-signature"},{"openapi":"post /envelope/{envelope_id}/duplicate","title":"Duplicate envelope","href":"/api-reference/endpoints/signplus/duplicate-envelope"},{"openapi":"put /envelope/{envelope_id}/void","title":"Void envelope","href":"/api-reference/endpoints/signplus/void-envelope"},{"openapi":"put /envelope/{envelope_id}/rename","title":"Rename envelope","href":"/api-reference/endpoints/signplus/rename-envelope"},{"openapi":"put /envelope/{envelope_id}/set_comment","title":"Set envelope comment","href":"/api-reference/endpoints/signplus/set-envelope-comment"},{"openapi":"put /envelope/{envelope_id}/set_notification","title":"Set envelope notification","href":"/api-reference/endpoints/signplus/set-envelope-notification"},{"openapi":"put /envelope/{envelope_id}/set_expiration_date","title":"Set envelope expiration date","href":"/api-reference/endpoints/signplus/set-envelope-expiration-date"},{"openapi":"put /envelope/{envelope_id}/set_legality_level","title":"Set envelope legality level","href":"/api-reference/endpoints/signplus/set-envelope-legality-level"},{"openapi":"get /envelope/{envelope_id}/annotations","title":"Get envelope annotations","href":"/api-reference/endpoints/signplus/get-envelope-annotations"},{"openapi":"get /envelope/{envelope_id}/annotations/{document_id}","title":"Get envelope document annotations","href":"/api-reference/endpoints/signplus/get-envelope-document-annotations"},{"openapi":"post /envelope/{envelope_id}/annotation","title":"Add envelope annotation","href":"/api-reference/endpoints/signplus/add-envelope-annotation"},{"openapi":"delete /envelope/{envelope_id}/annotation/{annotation_id}","title":"Delete envelope annotation","href":"/api-reference/endpoints/signplus/delete-envelope-annotation"},{"openapi":"get /envelope/{envelope_id}/signed_documents","title":"Download signed documents","href":"/api-reference/endpoints/signplus/get-envelope-signed_documents"},{"openapi":"get /envelope/{envelope_id}/signed_documents/{document_id}","title":"Download a single signed document","href":"/api-reference/endpoints/signplus/get-envelope-signed-document"},{"openapi":"get /envelope/{envelope_id}/certificate","title":"Download certificate of completion","href":"/api-reference/endpoints/signplus/get-envelope-certificate"},{"openapi":"put /envelope/{envelope_id}/attachments/placeholders","title":"Set envelope attachment placeholders","href":"/api-reference/endpoints/signplus/set-envelope-attachment-placeholders"},{"openapi":"put /envelope/{envelope_id}/attachments/settings","title":"Set envelope attachment settings","href":"/api-reference/endpoints/signplus/set-envelope-attachment-settings"},{"openapi":"get /envelope/{envelope_id}/attachments/{file_id}","title":"Get envelope attachment file","href":"/api-reference/endpoints/signplus/get-envelope-attachment-file"}]},{"group":"Template","icon":"copy","pages":[{"openapi":"post /template","title":"Create new template","href":"/api-reference/endpoints/signplus/create-new-template"},{"openapi":"post /templates","title":"List templates","href":"/api-reference/endpoints/signplus/list-templates"},{"openapi":"get /template/{template_id}","title":"Get template","href":"/api-reference/endpoints/signplus/get-template"},{"openapi":"delete /template/{template_id}","title":"Delete template","href":"/api-reference/endpoints/signplus/delete-template"},{"openapi":"post /template/{template_id}/duplicate","title":"Duplicate template","href":"/api-reference/endpoints/signplus/duplicate-template"},{"openapi":"post /template/{template_id}/document","title":"Add template document","href":"/api-reference/endpoints/signplus/add-template-document"},{"openapi":"get /template/{template_id}/document/{document_id}","title":"Get template document","href":"/api-reference/endpoints/signplus/get-template-document"},{"openapi":"get /template/{template_id}/documents","title":"Get template documents","href":"/api-reference/endpoints/signplus/get-template-documents"},{"openapi":"post /template/{template_id}/signing_steps","title":"Add template signing steps","href":"/api-reference/endpoints/signplus/add-template-signing-steps"},{"openapi":"put /template/{template_id}/rename","title":"Rename template","href":"/api-reference/endpoints/signplus/rename-template"},{"openapi":"put /template/{template_id}/set_comment","title":"Set template comment","href":"/api-reference/endpoints/signplus/set-template-comment"},{"openapi":"put /template/{template_id}/set_notification","title":"Set template notification","href":"/api-reference/endpoints/signplus/set-template-notification"},{"openapi":"get /template/{template_id}/annotations","title":"Get template annotations","href":"/api-reference/endpoints/signplus/get-template-annotations"},{"openapi":"get /template/{template_id}/annotations/{document_id}","title":"Get document template annotations","href":"/api-reference/endpoints/signplus/get-document-template-annotations"},{"openapi":"post /template/{template_id}/annotation","title":"Add template annotation","href":"/api-reference/endpoints/signplus/add-template-annotation"},{"openapi":"delete /template/{template_id}/annotation/{annotation_id}","title":"Delete template annotation","href":"/api-reference/endpoints/signplus/delete-template-annotation"},{"openapi":"put /template/{template_id}/attachments/placeholders","title":"Set template attachment placeholders","href":"/api-reference/endpoints/signplus/set-template-attachment-placeholders"},{"openapi":"put /template/{template_id}/attachments/settings","title":"Set template attachment settings","href":"/api-reference/endpoints/signplus/set-template-attachment-settings"}]},{"group":"Webhook","icon":"bell","pages":[{"openapi":"post /webhook","title":"Create webhook","href":"/api-reference/endpoints/signplus/create-webhook"},{"openapi":"post /webhooks","title":"List webhooks","href":"/api-reference/endpoints/signplus/list-webhooks"},{"openapi":"delete /webhook/{webhook_id}","title":"Delete webhook","href":"/api-reference/endpoints/signplus/delete-webhook"}]}]}]}]},"title":"Get envelope - Sign.Plus API","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}