Welcome to the iinked Sign by Syngrafii API documentation. This guide provides an overview of the available endpoints, usage examples, and best practices for integrating with our API.
Quick start
Sandbox
Guides
API
Webhooks
⌘I
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"iinked Sign","description":"This repository contains the official documentation for the iinked Sign API, providing comprehensive guides, reference materials, and best practices for developers and integrators working with iinked Sign platform.","colors":{"primary":"#7614FF","light":"#F5F5F5","dark":"#7614FF"},"logo":{"light":"https://mintcdn.com/syngrafiiinc/_k0NRRGysMSfLRzj/assets/logo.svg?fit=max\u0026auto=format\u0026n=_k0NRRGysMSfLRzj\u0026q=85\u0026s=979273c306b7b05ff3ca16660db67744","dark":"https://mintcdn.com/syngrafiiinc/_k0NRRGysMSfLRzj/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=_k0NRRGysMSfLRzj\u0026q=85\u0026s=c33268df5f15d60a6a2873c3c50b429e"},"favicon":{"light":"https://mintcdn.com/syngrafiiinc/pbkUy3Y4RGnQsvQI/assets/favicon.ico?fit=max\u0026auto=format\u0026n=pbkUy3Y4RGnQsvQI\u0026q=85\u0026s=aa2c76b36ed6f74a221741e472aacb3d","dark":"https://mintcdn.com/syngrafiiinc/pbkUy3Y4RGnQsvQI/assets/favicon.ico?fit=max\u0026auto=format\u0026n=pbkUy3Y4RGnQsvQI\u0026q=85\u0026s=aa2c76b36ed6f74a221741e472aacb3d"},"api":{"playground":{"display":"simple"},"examples":{"defaults":"required"},"mdx":{"auth":{"method":"key","name":"api_key"},"server":["https://sandbox.syngrafii.com/api/v1","https://sandbox.syngrafii.eu/api/v1","https://sign.syngrafii.com/api/v1","https://sign.syngrafii.ca/api/v1","https://sign.syngrafii.eu/api/v1"]}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"icon":"circle-question","href":"https://support.syngrafii.com","label":"Support"},{"icon":"user","href":"https://iinkedsign.com/login","label":"Log in"}]},"footer":{"socials":{"x":"https://x.com/syngrafii","linkedin":"https://www.linkedin.com/company/syngrafii-inc-"},"links":[{"header":"Resources","items":[{"label":"Request Demo","href":"https://iinkedsign.com/demo"},{"label":"Start Free Trial","href":"https://iinkedsign.com/start-trial"},{"label":"Support","href":"https://support.syngrafii.com"}]},{"header":"Company","items":[{"label":"About Us","href":"https://syngrafii.com/about"},{"label":"Privacy Policy","href":"https://iinkedsign.com/privacy-policy"},{"label":"Terms of Use","href":"https://iinkedsign.com/terms-of-use"}]}]},"seo":{"metatags":{"canonical":"https://docs.iinkedsign.com"}},"integrations":{"ga4":{"measurementId":"G-9TWCM1Y4DS"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"syngrafiiinc","hasAudioNarration":false,"actualSubdomain":"syngrafiiinc","customDomains":["docs.iinkedsign.com"],"gitSource":{"type":"github","owner":"iinkedsign","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abad61c1c6d3fe019da47ba","collectionId":"0c8d2dcf-7c19-417b-bf43-094d82543414","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abad61c1c6d3fe019da47ba"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6abad61c1c6d3fe019da47ba","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Documentation","count":121},{"language":"default","tag":"Reference","count":53},{"language":"default","tag":"API","count":24},{"language":"default","tag":"Guides","count":22},{"language":"default","tag":"Packages","count":17},{"language":"default","tag":"Webhooks","count":17},{"language":"default","tag":"Events","count":16},{"language":"default","tag":"Package options","count":13},{"language":"default","tag":"Verifications","count":12},{"language":"default","tag":"Template Tagging","count":6}]},"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":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Documentation","icon":"book","mode":"center","description":null,"href":"/index"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card,Columns}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Columns)_missingMdxReference(`Columns`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Welcome to the `,_jsx(_components.strong,{children:`iinked Sign by Syngrafii`}),` API documentation. This guide provides an overview of the available endpoints, usage examples, and best practices for integrating with our API.`]}),`\n`,_jsxs(Columns,{cols:2,children:[_jsx(Card,{title:`Quick start`,icon:`rocket-launch`,href:`v4/quickstart`}),_jsx(Card,{title:`Sandbox`,icon:`flask-vial`,href:`v4/sandbox`}),_jsx(Card,{title:`Guides`,icon:`books`,href:`v4/guides`}),_jsx(Card,{title:`API`,icon:`file-code`,href:`v4/api`}),_jsx(Card,{title:`Webhooks`,icon:`rss`,href:`v4/webhooks`})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Documentation","icon":"book","mode":"center","description":null,"href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"syngrafiiinc","siteName":"iinked Sign","title":"Documentation - iinked Sign","navMaps":{"firstHrefInVersion":{"4.x":{"href":"/index","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-08T16:22:09.806Z","originalFileLocation":"index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;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=\"system\"}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=\"iinked Sign\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_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/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_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/syngrafiiinc/EYxp6_FoaYqOvoQc/_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/syngrafiiinc/EYxp6_FoaYqOvoQc/_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/syngrafiiinc/EYxp6_FoaYqOvoQc/_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/syngrafiiinc/EYxp6_FoaYqOvoQc/_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/syngrafiiinc/EYxp6_FoaYqOvoQc/_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/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Documentation - iinked Sign\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"iinked Sign\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.iinkedsign.com\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://syngrafiiinc.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Documentation\u0026amp;theme=51d2742c5b8f9baace1e66c7\u0026amp;signature=e8e6614c0d03cbc77af72deae6a0a2bec3993cd2c0d203b654e30947a56093db\">\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=\"Documentation - iinked Sign\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://syngrafiiinc.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Documentation\u0026amp;theme=51d2742c5b8f9baace1e66c7\u0026amp;signature=e8e6614c0d03cbc77af72deae6a0a2bec3993cd2c0d203b654e30947a56093db\">\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/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"iinked Sign\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7614FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.iinkedsign.com\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"iinked Sign\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"iinked Sign","nav":{"global":null,"versions":[{"version":"4.x","tabs":[{"tab":"Documentation","icon":"book","pages":[{"group":"Getting started","pages":[{"title":"Introduction","icon":"hand-wave","href":"/v4/introduction"},{"title":"Quickstart","icon":"rocket-launch","href":"/v4/quickstart"},{"title":"Authentication","icon":"lock","href":"/v4/authentication"},{"title":"OAuth 2.0","icon":"key","href":"/v4/oauth"},{"title":"Sandbox","icon":"flask-vial","href":"/v4/sandbox"}]},{"group":"Guides","icon":"books","pages":[{"sidebarTitle":"Workflows","title":"Workflows","icon":"arrow-progress","href":"/v4/guides/workflows"},{"sidebarTitle":"Signing","title":"Signing","icon":"file-contract","href":"/v4/guides/sign"},{"sidebarTitle":"IDV","title":"Identity verification (IDV)","icon":"id-card","href":"/v4/guides/sign-idv"},{"sidebarTitle":"QES","title":"Qualified Electronic Signatures (QES)","icon":"file-signature","href":"/v4/guides/sign-qes"},{"sidebarTitle":"Links","title":"Links","icon":"link","href":"/v4/guides/sign-links"},{"sidebarTitle":"Webhooks","title":"Webhooks guide","icon":"share-nodes","href":"/v4/guides/webhooks"},{"group":"Embed","icon":"code","expanded":true,"pages":[{"sidebarTitle":"Signing","title":"Embed signing","icon":"file-contract","href":"/v4/guides/embed-signing"},{"sidebarTitle":"Editor","title":"Embed editor","icon":"browser","href":"/v4/guides/embed-editor"},{"sidebarTitle":"Messaging","title":"Embed messaging","icon":"code","href":"/v4/guides/embed-messaging"}]},{"group":"Templating","icon":"hammer","expanded":false,"pages":[{"sidebarTitle":"Templates","title":"Templates","icon":"file-invoice","href":"/v4/guides/templates"},{"sidebarTitle":"Auto templates","title":"Auto templates","icon":"file-search","href":"/v4/guides/auto-templates"},{"sidebarTitle":"Template data","title":"Template data","icon":"input-text","href":"/v4/guides/template-data"}]},{"group":"Template Tagging","icon":"file-brackets-curly","expanded":false,"pages":[{"sidebarTitle":"Introduction","title":"Introduction","icon":"hand-wave","href":"/v4/guides/template-tagging/introduction"},{"sidebarTitle":"Tags","title":"Tags","icon":"brackets-curly","href":"/v4/guides/template-tagging/tags"},{"sidebarTitle":"Options","title":"Tag options","icon":"list-check","href":"/v4/guides/template-tagging/tag-options"},{"sidebarTitle":"Date formats","title":"Date formats","icon":"calendar","href":"/v4/guides/template-tagging/date-formats"},{"sidebarTitle":"Signer tags","title":"Signer tags","icon":"user-tag","href":"/v4/guides/template-tagging/signer-tags"},{"sidebarTitle":"Custom tags","title":"Custom tags","icon":"input-text","href":"/v4/guides/template-tagging/custom-tags"}]},{"sidebarTitle":"Package options","title":"Package options","icon":"toggle-on","href":"/v4/guides/package-options"},{"title":"Data formats","icon":"binary","href":"/v4/guides/data-formats"},{"sidebarTitle":"External data","title":"External data","icon":"table-cells","href":"/v4/guides/external-data"},{"title":"Errors","icon":"circle-exclamation","href":"/v4/guides/errors"}]},{"group":"API","icon":"file-code","pages":[{"group":"Packages","icon":"file-contract","pages":[{"title":"Add","api":"POST /packages/add","href":"/v4/api/packages/add"},{"title":"Data","api":"GET /packages/{packageId}/data","href":"/v4/api/packages/data"},{"title":"Delete","api":"POST /packages/delete","href":"/v4/api/packages/delete"},{"title":"Download","api":"GET /packages/{packageId}/documents/{documentId}/pdf/{version}/download","href":"/v4/api/packages/download"},{"title":"Get","api":"GET /packages/{packageId}","href":"/v4/api/packages/get"},{"title":"List","api":"POST /packages/list","href":"/v4/api/packages/list"},{"title":"Remind signer","api":"POST /packages/signers/remind","href":"/v4/api/packages/remind"},{"title":"Rescind","api":"POST /packages/rescind","href":"/v4/api/packages/rescind"},{"title":"Send","api":"POST /packages/send","href":"/v4/api/packages/send"},{"title":"Status","api":"GET /packages/{packageId}/status","href":"/v4/api/packages/status"},{"title":"Update","api":"POST /packages/update","href":"/v4/api/packages/update"}]},{"group":"Files","icon":"files","pages":[{"title":"Upload","api":"POST /files/upload","playground":"simple","href":"/v4/api/files/upload"}]},{"group":"Links","icon":"link","pages":[{"title":"Edit","api":"POST /packages/{packageId}/link/edit","href":"/v4/api/links/edit"},{"title":"Sign","api":"POST /packages/{packageId}/link/sign/{signerId}","href":"/v4/api/links/sign"}]},{"group":"Videos","icon":"video","pages":[{"title":"Delete","api":"POST /packages/{packageId}/videos/delete","href":"/v4/api/videos/delete"},{"title":"List","api":"GET /packages/{packageId}/videos","href":"/v4/api/videos/list"}]},{"group":"Verifications","icon":"id-card","pages":[{"title":"Signer","api":"GET /packages/{packageId}/signers/{signerId}/verification","href":"/v4/api/verifications/signer"},{"title":"View","api":"GET /verifications/{verificationId}/view","href":"/v4/api/verifications/view"}]},{"group":"Templates","icon":"file-invoice","pages":[{"title":"List","api":"POST /templates/list","href":"/v4/api/templates/list"}]},{"group":"MasterFile","icon":"file-certificate","pages":[{"title":"Get","api":"GET /masterfiles/{packageId}","href":"/v4/api/masterfile/get"},{"sidebarTitle":"Download","title":"Download","api":"GET /masterfiles/{packageId}/pdf/download","href":"/v4/api/masterfile/download"},{"title":"Export","api":"POST /masterfiles/export/pdf","href":"/v4/api/masterfile/export"},{"group":"Signer","icon":"user-edit","expanded":true,"pages":[{"title":"Get","api":"GET /masterfiles/{packageId}/signer/{signerId}","href":"/v4/api/masterfile/signer/get"},{"title":"Download","api":"GET /masterfiles/{packageId}/signer/{signerId}/pdf/download","href":"/v4/api/masterfile/signer/download"}]}]}]},{"group":"Webhooks","icon":"rss","pages":[{"sidebarTitle":"Setup","title":"Setup webhooks","icon":"gear","href":"/v4/webhooks/setup"},{"group":"Events","icon":"bolt","pages":[{"title":null,"href":"/v4/webhooks/events/package-add"},{"title":null,"href":"/v4/webhooks/events/package-decline"},{"title":null,"href":"/v4/webhooks/events/package-delete"},{"title":null,"href":"/v4/webhooks/events/package-executed"},{"title":null,"href":"/v4/webhooks/events/package-expired"},{"title":null,"href":"/v4/webhooks/events/package-rescind"},{"title":null,"href":"/v4/webhooks/events/package-send"},{"title":null,"href":"/v4/webhooks/events/package-sent"},{"title":null,"href":"/v4/webhooks/events/package-update"},{"title":null,"href":"/v4/webhooks/events/document-accessed"},{"title":null,"href":"/v4/webhooks/events/document-executed"},{"title":null,"href":"/v4/webhooks/events/document-next"},{"title":null,"href":"/v4/webhooks/events/document-signed"},{"title":null,"href":"/v4/webhooks/events/notification-status"},{"title":null,"href":"/v4/webhooks/events/verification-status"},{"title":null,"href":"/v4/webhooks/events/video-delete"}]}]},{"group":"Reference","icon":"books","expanded":false,"pages":[{"group":"Documents","icon":"files","expanded":false,"pages":[{"sidebarTitle":"Document","title":"Document","icon":"file","tag":"object","href":"/v4/reference/documents/document"},{"sidebarTitle":"Document signer","title":"Document signer","icon":"user-edit","tag":"object","href":"/v4/reference/documents/document-signer"},{"sidebarTitle":"Document status","title":"Document status","icon":"file","tag":"object","href":"/v4/reference/documents/document-status"},{"sidebarTitle":"States","title":"Document states","icon":"arrow-progress","tag":"enum","href":"/v4/reference/documents/document-states"},{"sidebarTitle":"Revision","title":"Document revision","icon":"file","tag":"object","href":"/v4/reference/documents/document-revision"},{"sidebarTitle":"Revision status","title":"Revision status","icon":"check-circle","tag":"object","href":"/v4/reference/documents/revision-status"}]},{"group":"Embed","icon":"code","expanded":false,"pages":[{"sidebarTitle":"Actions","title":"Embed actions","icon":"play-circle","tag":"enum","href":"/v4/reference/embed/embed-actions"},{"sidebarTitle":"Sources","title":"Embed sources","icon":"boxes","tag":"enum","href":"/v4/reference/embed/embed-source"}]},{"group":"Files","icon":"file","expanded":false,"pages":[{"sidebarTitle":"Types","title":"File types","icon":"tags","tag":"enum","href":"/v4/reference/files/file-types"}]},{"sidebarTitle":"Locales","title":"Locales","icon":"globe","tag":"enum","href":"/v4/reference/locales"},{"group":"MasterFiles","icon":"file-certificate","expanded":false,"pages":[{"sidebarTitle":"Access actions","title":"Access history actions","icon":"circle-play","tag":"enum","href":"/v4/reference/masterfiles/masterfile-access-history-actions"},{"sidebarTitle":"Access types","title":"Access history types","icon":"tags","tag":"enum","href":"/v4/reference/masterfiles/masterfile-access-history-types"},{"sidebarTitle":"Log types","title":"Log types","icon":"tags","tag":"enum","href":"/v4/reference/masterfiles/masterfile-log-types"},{"sidebarTitle":"Notifications","title":"Notification templates","icon":"file-invoice","tag":"enum","href":"/v4/reference/masterfiles/masterfile-notification-templates"},{"sidebarTitle":"Notification types","title":"Notification types","icon":"tags","tag":"enum","href":"/v4/reference/masterfiles/masterfile-notification-types"},{"sidebarTitle":"History types","title":"History types","icon":"tags","tag":"enum","href":"/v4/reference/masterfiles/masterfile-package-history-types"}]},{"group":"Meetings","icon":"calendar-days","expanded":false,"pages":[{"sidebarTitle":"Meeting","title":"Meeting","icon":"calendar-day","tag":"object","href":"/v4/reference/packages/meeting"},{"sidebarTitle":"Meeting types","title":"Meeting types","icon":"tags","tag":"enum","href":"/v4/reference/packages/meeting-types"}]},{"group":"Packages","icon":"file-contract","expanded":false,"pages":[{"sidebarTitle":"Package","title":"Package","icon":"file-contract","tag":"object","href":"/v4/reference/packages/package"},{"sidebarTitle":"Consent","title":"Consent","icon":"shield-check","tag":"object","href":"/v4/reference/packages/consent"},{"sidebarTitle":"Package status","title":"Package status","icon":"check-circle","tag":"object","href":"/v4/reference/packages/package-status"},{"sidebarTitle":"Sort by","title":"Sort by","icon":"sort-amount-down","tag":"enum","href":"/v4/reference/packages/package-filter-sort"},{"sidebarTitle":"States","title":"Package states","icon":"arrow-progress","tag":"enum","href":"/v4/reference/packages/package-states"},{"sidebarTitle":"Types","title":"Package types","icon":"tags","tag":"enum","href":"/v4/reference/packages/package-types"}]},{"group":"Package options","icon":"toggle-on","expanded":false,"pages":[{"sidebarTitle":"Options","title":"Package options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/package-options"},{"sidebarTitle":"Consent","title":"Consent options","icon":"shield-check","tag":"object","href":"/v4/reference/package-options/consent-options"},{"sidebarTitle":"Digital signatures","title":"Digital signature options","icon":"file-signature","tag":"object","href":"/v4/reference/package-options/digital-signature-options"},{"sidebarTitle":"Embed","title":"Embed options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/package-embed-options"},{"sidebarTitle":"Geolocation","title":"Geolocation options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/geo-location-options"},{"sidebarTitle":"PDF security","title":"PDF security options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/pdf-security-options"},{"sidebarTitle":"Reminder","title":"Reminder options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/reminder-options"},{"sidebarTitle":"Signer tools","title":"Signer tools","icon":"list-check","tag":"object","href":"/v4/reference/package-options/signer-tools"},{"sidebarTitle":"Verification","title":"Verification options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/verification-options"},{"sidebarTitle":"CAC","title":"CAC values","icon":"file-certificate","tag":"enum","href":"/v4/reference/package-options/package-options-cac"},{"sidebarTitle":"Form flattening","title":"Form flattening","icon":"layer-group","tag":"enum","href":"/v4/reference/package-options/package-options-form-flattening"},{"sidebarTitle":"Mark types","title":"Mark types","icon":"signature","tag":"enum","href":"/v4/reference/package-options/package-options-default-mark"},{"sidebarTitle":"Unused tags","title":"Unused tags","icon":"brackets-curly","tag":"enum","href":"/v4/reference/package-options/package-options-template-unused-signer-tags"}]},{"group":"Recipients","icon":"users","expanded":false,"pages":[{"sidebarTitle":"Recipient","title":"Recipient","icon":"users","tag":"object","href":"/v4/reference/recipients/recipient"},{"sidebarTitle":"Types","title":"Recipient types","icon":"tags","tag":"enum","href":"/v4/reference/recipients/recipient-types"}]},{"group":"Signers","icon":"signature","expanded":false,"pages":[{"sidebarTitle":"Signer","title":"Signer","icon":"user-edit","tag":"object","href":"/v4/reference/signers/signer"},{"sidebarTitle":"Roles","title":"Signer roles","icon":"tags","tag":"enum","href":"/v4/reference/signers/signer-roles"},{"sidebarTitle":"Types","title":"Signer types","icon":"tags","tag":"enum","href":"/v4/reference/signers/signer-types"}]},{"group":"Templates","icon":"file-invoice","expanded":false,"pages":[{"sidebarTitle":"Types","title":"Template types","tag":"enum","href":"/v4/reference/templates/template-types"}]},{"group":"Verifications","icon":"id-card","expanded":false,"pages":[{"sidebarTitle":"Verification","title":"Verification","icon":"id-card","tag":"object","href":"/v4/reference/verifications/verification-view"},{"sidebarTitle":"Result","title":"Verification result","icon":"check-circle","tag":"object","href":"/v4/reference/verifications/verification-view-result"},{"sidebarTitle":"Document","title":"Verification document","icon":"file","tag":"object","href":"/v4/reference/verifications/verification-view-document"},{"sidebarTitle":"Document types","title":"Document types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-document-types"},{"sidebarTitle":"Field types","title":"Field types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-field-types"},{"sidebarTitle":"Image types","title":"Image types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-image-types"},{"sidebarTitle":"Result states","title":"Result states","icon":"arrow-progress","tag":"enum","href":"/v4/reference/verifications/verification-result-states"},{"sidebarTitle":"Result types","title":"Result types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-result-types"},{"sidebarTitle":"Score types","title":"Score types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-score-types"},{"sidebarTitle":"Verification states","title":"Verification states","icon":"arrow-progress","tag":"enum","href":"/v4/reference/verifications/verification-states"}]}]}]},{"tab":"API reference","icon":"code","hidden":true,"pages":[{"group":"API Reference","pages":[{"title":"Introduction","icon":"hand-wave","href":"/v4/api-ref/introduction"},{"title":"Authentication","icon":"lock","href":"/v4/api-ref/authentication"}]},{"group":"Packages","pages":[{"title":"Get packages","deprecated":null,"version":null,"openapi":"/v4/api-ref/openapi.json get /packages","href":"/api-reference/packages/get-packages"},{"title":"Post packageslist","deprecated":null,"version":null,"openapi":"/v4/api-ref/openapi.json post /packages/list","href":"/api-reference/packages/post-packageslist"},{"title":"Post packagesadd","deprecated":null,"version":null,"openapi":"/v4/api-ref/openapi.json post /packages/add","href":"/api-reference/packages/post-packagesadd"},{"title":"Post packagesupdate","deprecated":null,"version":null,"openapi":"/v4/api-ref/openapi.json post /packages/update","href":"/api-reference/packages/post-packagesupdate"},{"title":"Post packagessend","deprecated":null,"version":null,"openapi":"/v4/api-ref/openapi.json post /packages/send","href":"/api-reference/packages/post-packagessend"},{"title":"Post packagessignersremind","deprecated":null,"version":null,"openapi":"/v4/api-ref/openapi.json post /packages/signers/remind","href":"/api-reference/packages/post-packagessignersremind"}]},{"group":"Templates","pages":[{"title":"Post packageslist","deprecated":null,"version":null,"openapi":"/v4/api-ref/openapi.json post /packages/list","href":"/api-reference/packages/post-packageslist"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Updates","icon":"up-from-bracket","href":"/v4/updates"}]}]}]},"basePath":"","title":"Documentation - iinked Sign","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}