Generate an access token to start using an Invopop workspace.
Invopop API keys are created in Admin under API keys, or by clicking Manage API keys from Configuration → API keys in the Console. Click New API key, choose the workspace the key will act on, give it a name and an optional description, and tick the Read or Admin permission for each service the key needs (All services, Access, Transform, Silo). The token is shown once on creation. For security reasons, we don’t store it. Copy it now, or you’ll need to create a new API key if it’s lost. See API keys for the full permission model.
Invopop uses JSON Web Tokens. If you’re interested in seeing the contents, head over to JWT.io and paste your token to see what’s
inside.
Tokens must be included in the Authorization HTTP header in all requests as a type Bearer.Test everything is working correctly using the ping
endpoint and curl:
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Invopop","colors":{"primary":"#169958","light":"#169958","dark":"#103830"},"logo":{"light":"https://mintcdn.com/invopop/tvrHhZ01dWh1WgVy/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=tvrHhZ01dWh1WgVy\u0026q=85\u0026s=acee80bf7ace42a69f7bc31d48bac07d","dark":"https://mintcdn.com/invopop/tvrHhZ01dWh1WgVy/assets/logos/dark.svg?fit=max\u0026auto=format\u0026n=tvrHhZ01dWh1WgVy\u0026q=85\u0026s=8682d855b2ae592f840a2e75835dd6a4"},"favicon":"https://mintcdn.com/invopop/RHaqrZ8_qKav21l4/favicon.png?fit=max\u0026auto=format\u0026n=RHaqrZ8_qKav21l4\u0026q=85\u0026s=40f5b8d569abe96aa51c7d89f608f971","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.invopop.com"}},"navbar":{"links":[{"href":"https://www.invopop.com/contact","label":"Contact us"},{"href":"https://community.invopop.com","label":"Community"}]},"footer":{"socials":{"x":"https://x.com/goInvopop","linkedin":"https://www.linkedin.com/company/invopop","github":"https://github.com/invopop"}},"fonts":{"family":"Inter"},"styling":{"codeblocks":"system","latex":true},"integrations":{"plausible":{"domain":"docs.invopop.com"}},"contextual":{"options":["copy","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"invopop","hasAudioNarration":false,"actualSubdomain":"invopop","customDomains":["docs.invopop.com"],"gitSource":{"type":"github","owner":"invopop","repo":"docs.invopop.com","deployBranch":"main","contentDirectory":"","mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af58d9a9aa4e2cefaca34cb","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":93},{"language":"default","tag":"Apps","count":93},{"language":"default","tag":"Get Started","count":91},{"language":"default","tag":"Country compliance","count":86},{"language":"default","tag":"Guides","count":86},{"language":"default","tag":"Countries","count":60},{"language":"default","tag":"Europe","count":46},{"language":"default","tag":"Platform","count":39},{"language":"default","tag":"France","count":28},{"language":"default","tag":"Console","count":25}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"[data-component-part=card-icon]{min-width:24px}.card .icon{margin:0;position:relative;top:-1px;width:20px!important;height:20px!important}.pop-count{position:absolute;top:16px;right:16px;font-size:12px;font-weight:bold}.pop-count .icon{margin-right:3px}table tr:has(th:empty){display:none}.update table td,.tab-container table td{min-width:auto}.tab-container table td{white-space:nowrap}.dark\\:bg-primary-light:is(.dark *){background:transparent}h4 .icon,h4 .icon+a{opacity:0.7;font-size:14px;border-bottom:none}h4 .icon{margin-left:1em}h4 .icon+a:hover{opacity:1}h4+div>.table td{min-width:auto}button:has(svg[style*=\"transporter-empty\"]),a:has(svg[style*=\"transporter-empty\"]){opacity:0.4}button:has(img[src*=\"coming-soon\"]),a:has(img[src*=\"coming-soon\"]){opacity:0.4}div:has(>svg[style*=\"transporter-empty\"]),svg[style*=\"transporter-empty\"]{position:absolute;display:none}td .icon{margin-top:12px!important;margin-bottom:12px!important;margin-right:8px!important}.country{margin:-2em 0;background:#f6f6f6;padding:4px}h2:has(+.country){margin-bottom:2em}div[data-component-part=\"accordion-content\"]{overflow-x:hidden!important}.grow+[data-table-wrapper=true]{padding:0}.grow+[data-table-wrapper=true]>div.table{margin:0 0 0 1rem}a[href=\"https://www.mintlify.com?utm_campaign=poweredBy\u0026utm_medium=referral\u0026utm_source=undefined\"]{display:none}img[src*=\"apps/tables/icon.svg\"]:is(.dark *){content:url(\"https://assets.invopop.com/apps/tables/icon-white.svg\")}"}],"page":{"pagePath":"api-ref/authentication","slug":"/api-ref/authentication","pageMetadata":{"title":"Authentication","icon":"lock-a","description":"Generate an access token to start using an Invopop workspace.","href":"/api-ref/authentication"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Generate an access token to start using an Invopop workspace.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Invopop API keys are created in `,_jsx(_components.a,{href:`https://access.invopop.com`,children:`Admin`}),` under `,_jsx(_components.strong,{children:`API keys`}),`, or by clicking `,_jsx(`kbd`,{children:`Manage API keys`}),` from `,_jsx(_components.strong,{children:`Configuration → API keys`}),` in the `,_jsx(_components.a,{href:`https://console.invopop.com`,children:`Console`}),`. Click `,_jsx(`kbd`,{children:`New API key`}),`, choose the workspace the key will act on, give it a name and an optional description, and tick the `,_jsx(_components.strong,{children:`Read`}),` or `,_jsx(_components.strong,{children:`Admin`}),` permission for each service the key needs (All services, Access, Transform, Silo). The token is shown once on creation. For security reasons, we don’t store it. Copy it now, or you’ll need to create a new API key if it’s lost. See `,_jsx(_components.a,{href:`/console/api-keys`,children:`API keys`}),` for the full permission model.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Invopop uses JSON Web Tokens. If you’re interested in seeing the contents, head over to `,_jsx(_components.a,{href:`https://jwt.io`,children:`JWT.io`}),` and paste your token to see what’s\ninside.`]})}),`\n`,_jsxs(_components.p,{children:[`Tokens must be included in the `,_jsx(_components.code,{children:`Authorization`}),` HTTP header in all requests as a type `,_jsx(_components.code,{children:`Bearer`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Test everything is working correctly using the `,_jsx(_components.a,{href:`/api-ref/utils/ping`,children:`ping`}),`\nendpoint and curl:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`$`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer [token]\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.invopop.com/utils/v1/ping`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`\"ping\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`:`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`\"pong\"`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`}`})]}),`\n`]})})})]})}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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Authentication","icon":"lock-a","description":"Generate an access token to start using an Invopop workspace.","href":"/api-ref/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"invopop","siteName":"Invopop","title":"Authentication - Invopop","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T09:58:33.364Z","originalFileLocation":"api-ref/authentication.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=\"description\" content=\"Generate an access token to start using an Invopop workspace.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Invopop\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/invopop/HVc7roIt8SKteIfU/_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/invopop/HVc7roIt8SKteIfU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/invopop/HVc7roIt8SKteIfU/_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/invopop/HVc7roIt8SKteIfU/_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/invopop/HVc7roIt8SKteIfU/_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/invopop/HVc7roIt8SKteIfU/_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/invopop/HVc7roIt8SKteIfU/_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/invopop/HVc7roIt8SKteIfU/_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/invopop/HVc7roIt8SKteIfU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Invopop\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate an access token to start using an Invopop workspace.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Invopop\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.invopop.com/api-ref/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://invopop.mintlify.site/_mintlify/api/og/v2?division=API\u0026amp;title=Authentication\u0026amp;description=Generate+an+access+token+to+start+using+an+Invopop+workspace.\u0026amp;theme=dac54da033d40b1e92880c2c\u0026amp;signature=2ce319c72c82311715202bb13ddee5c0289798a5fb4a7d921ecc8b29a991bffe\">\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=\"Authentication - Invopop\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate an access token to start using an Invopop workspace.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://invopop.mintlify.site/_mintlify/api/og/v2?division=API\u0026amp;title=Authentication\u0026amp;description=Generate+an+access+token+to+start+using+an+Invopop+workspace.\u0026amp;theme=dac54da033d40b1e92880c2c\u0026amp;signature=2ce319c72c82311715202bb13ddee5c0289798a5fb4a7d921ecc8b29a991bffe\">\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/invopop/HVc7roIt8SKteIfU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Invopop\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#169958\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.invopop.com/api-ref/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-ref/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.invopop.com/#organization\",\"name\":\"Invopop\",\"url\":\"https://docs.invopop.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/invopop/tvrHhZ01dWh1WgVy/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=tvrHhZ01dWh1WgVy\u0026q=85\u0026s=acee80bf7ace42a69f7bc31d48bac07d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.invopop.com#website\",\"name\":\"Invopop\",\"url\":\"https://docs.invopop.com\",\"publisher\":{\"@id\":\"https://docs.invopop.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.invopop.com/api-ref/authentication#webpage\",\"url\":\"https://docs.invopop.com/api-ref/authentication\",\"name\":\"Authentication\",\"description\":\"Generate an access token to start using an Invopop workspace.\",\"dateModified\":\"2026-10-09T09:58:33.364Z\",\"isPartOf\":{\"@id\":\"https://docs.invopop.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.invopop.com/api-ref/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.invopop.com/api-ref/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API\",\"item\":\"https://docs.invopop.com/api-ref/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.invopop.com/api-ref/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.invopop.com/api-ref/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Generate an access token to start using an Invopop workspace.\",\"url\":\"https://docs.invopop.com/api-ref/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.invopop.com/api-ref/authentication#webpage\"},\"dateModified\":\"2026-10-09T09:58:33.364Z\",\"publisher\":{\"@id\":\"https://docs.invopop.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.invopop.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Invopop\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Invopop\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-ref/authentication.md","siteName":"Invopop","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"compass","pages":[{"title":"Get Started","href":""}]},{"tab":"Platform","icon":"sidebar","pages":[{"title":"Platform","href":"/console"}]},{"tab":"Guides","icon":"map","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Apps","icon":"app-store","pages":[{"title":"Apps","href":"/apps"}]},{"tab":"API Reference","icon":"code","pages":[{"group":"API","pages":[{"title":"Introduction","icon":"info","href":"/api-ref/introduction"},{"title":"Technical glossary","description":"A brief glossary of the main terms used in the platform.","icon":"book-open-cover","href":"/api-ref/glossary"},{"title":"Authentication","icon":"lock-a","href":"/api-ref/authentication"},{"title":"Idempotency","icon":"rotate-right","description":"Ensuring API requests are safe.","href":"/api-ref/idempotency"},{"title":"Versioning","icon":"code-branch","href":"/api-ref/versioning"},{"title":"Postman collections","sidebarTitle":"Postman","icon":"user-astronaut","href":"/api-ref/postman"}]},{"group":"Silo","icon":"database","pages":[{"group":"Entries","pages":[{"title":"Fetch all entries","openapi":"GET /silo/v1/entries","href":"/api-ref/silo/entries/fetch-all-entries"},{"title":"Search entries","openapi":"GET /silo/v1/search","href":"/api-ref/silo/entries/search-entries"},{"title":"Fetch an entry","sidebarTitle":"Fetch entry","openapi":"GET /silo/v1/entries/{id}","href":"/api-ref/silo/entries/fetch-an-entry"},{"title":"Fetch an entry version","sidebarTitle":"Fetch entry version","openapi":"GET /silo/v1/entries/{id}/versions/{version}","href":"/api-ref/silo/entries/fetch-entry-version"},{"title":"Fetch an entry by key","sidebarTitle":"Fetch entry by key","openapi":"GET /silo/v1/entries/key/{key}","href":"/api-ref/silo/entries/fetch-an-entry-by-key"},{"title":"Create an entry with ID","sidebarTitle":"Create entry","openapi":"PUT /silo/v1/entries/{id}","href":"/api-ref/silo/entries/create-an-entry-put"},{"title":"Create an entry without UUID","sidebarTitle":"Create entry (no ID)","openapi":"POST /silo/v1/entries","href":"/api-ref/silo/entries/create-an-entry-post"},{"title":"Update an entry","sidebarTitle":"Update entry","openapi":"PATCH /silo/v1/entries/{id}","href":"/api-ref/silo/entries/update-an-entry"},{"title":"Find related entries","openapi":"GET /silo/v1/entries/{id}/related","href":"/api-ref/silo/entries/find-related"},{"title":"Fetch a file","sidebarTitle":"Fetch file","openapi":"GET /silo/v1/entries/{entry_id}/files/{id}","href":"/api-ref/silo/entries/files-fetch"},{"title":"Create a file with ID","sidebarTitle":"Create file","openapi":"PUT /silo/v1/entries/{entry_id}/files/{id}","href":"/api-ref/silo/entries/files-put"},{"title":"Create a file without UUID","sidebarTitle":"Create file (no ID)","openapi":"POST /silo/v1/entries/{entry_id}/files","href":"/api-ref/silo/entries/files-post"}]},{"group":"GOBL","pages":[{"title":"Build GOBL document","openapi":"POST /silo/v1/gobl/build","href":"/api-ref/silo/gobl/build"},{"title":"Correct GOBL envelope","openapi":"POST /silo/v1/gobl/correct","href":"/api-ref/silo/gobl/correct"},{"title":"Sign GOBL document","openapi":"POST /silo/v1/gobl/sign","href":"/api-ref/silo/gobl/sign"}]},{"group":"Spool","pages":[{"title":"Upload a file","sidebarTitle":"Upload","openapi":"POST /silo/v1/spool","href":"/api-ref/silo/spool/upload"},{"title":"Download a file","sidebarTitle":"Download","openapi":"GET /silo/v1/spool/{key}","href":"/api-ref/silo/spool/download"},{"title":"Delete a file","sidebarTitle":"Delete","openapi":"DELETE /silo/v1/spool/{key}","href":"/api-ref/silo/spool/delete"}]}]},{"group":"Transform","icon":"arrow-right-arrow-left","pages":[{"group":"Workflows","pages":[{"title":"Fetch all workflows","openapi":"GET /transform/v1/workflows","href":"/api-ref/transform/workflows/fetch-all-workflows"},{"title":"Create a workflow","openapi":"PUT /transform/v1/workflows/{id}","href":"/api-ref/transform/workflows/create-a-workflow"},{"title":"Fetch a workflow","openapi":"GET /transform/v1/workflows/{id}","href":"/api-ref/transform/workflows/fetch-a-workflow"},{"title":"Update a workflow","openapi":"PATCH /transform/v1/workflows/{id}","href":"/api-ref/transform/workflows/update-a-workflow"}]},{"group":"Jobs","pages":[{"title":"Fetch all jobs","openapi":"GET /transform/v1/jobs","href":"/api-ref/transform/jobs/fetch-all-jobs"},{"title":"Create a job with a UUID","sidebarTitle":"Create a job","openapi":"PUT /transform/v1/jobs/{id}","href":"/api-ref/transform/jobs/create-a-job-put"},{"title":"Create a job without a UUID","sidebarTitle":"Create a job (no ID)","openapi":"POST /transform/v1/jobs","href":"/api-ref/transform/jobs/create-a-job-post"},{"title":"Fetch a job","openapi":"GET /transform/v1/jobs/{id}","href":"/api-ref/transform/jobs/fetch-a-job"},{"title":"Fetch a job by key","openapi":"GET /transform/v1/jobs/key/{key}","href":"/api-ref/transform/jobs/fetch-a-job-by-key"}]}]},{"group":"Sequences","icon":"list","pages":[{"title":"Introduction","href":"/api-ref/sequences/introduction"},{"group":"Series","pages":[{"title":"Overview","href":"/api-ref/sequences/series/overview"},{"title":"Fetch all series","openapi":"GET /sequence/v1/series","href":"/api-ref/sequences/series/fetch-all-series"},{"title":"Create a series","openapi":"PUT /sequence/v1/series/{id}","href":"/api-ref/sequences/series/create-a-series"},{"title":"Fetch a series","openapi":"GET /sequence/v1/series/{id}","href":"/api-ref/sequences/series/fetch-a-series"}]},{"group":"Entries","pages":[{"title":"Overview","href":"/api-ref/sequences/entries/overview"},{"title":"Fetch all series entries","openapi":"GET /sequence/v1/series/{series_id}/entries","href":"/api-ref/sequences/entries/fetch-all-series-entries"},{"title":"Create a series entry","openapi":"PUT /sequence/v1/series/{series_id}/entries/{id}","href":"/api-ref/sequences/entries/create-a-series-entry"},{"title":"Fetch a series entry","openapi":"GET /sequence/v1/series/{series_id}/entries/{id}","href":"/api-ref/sequences/entries/fetch-a-series-entry"}]}]},{"group":"Access","icon":"building","pages":[{"group":"Workspaces","pages":[{"title":"Fetch workspace","openapi":"GET /access/v1/workspace","href":"/api-ref/access/workspace/fetch"},{"title":"Update workspace","openapi":"PATCH /access/v1/workspace","href":"/api-ref/access/workspace/update"}]},{"group":"Enrollments","pages":[{"title":"Authorize enrollment","openapi":"POST /access/v1/enrollment/authorize","href":"/api-ref/access/enrollment/authorize"},{"title":"Fetch enrollment","openapi":"GET /access/v1/enrollment","href":"/api-ref/access/enrollment/fetch"},{"title":"Update enrollment","openapi":"PATCH /access/v1/enrollment","href":"/api-ref/access/enrollment/update"}]}]},{"group":"Apps","icon":"puzzle-piece","pages":[{"group":"AT Portugal","pages":[{"title":"Set AT credentials","openapi":"POST /apps/at-pt/v1/entry/{silo_entry_id}/credentials","href":"/api-ref/apps/at-pt/credentials"},{"title":"Register series","openapi":"POST /apps/at-pt/v1/entry/{silo_entry_id}/series","href":"/api-ref/apps/at-pt/series-register"},{"title":"List series","openapi":"GET /apps/at-pt/v1/entry/{silo_entry_id}/series","href":"/api-ref/apps/at-pt/series-list"},{"title":"Get series details","openapi":"GET /apps/at-pt/v1/entry/{silo_entry_id}/series/{id}","href":"/api-ref/apps/at-pt/series-get"},{"title":"Generate SAF-T report","openapi":"GET /apps/at-pt/v1/entry/{silo_entry_id}/saft","href":"/api-ref/apps/at-pt/saft"}]},{"group":"Colombia","pages":[{"title":"Fetch enablement status","openapi":"GET /apps/gov-co/v1/entries/{silo_entry_id}/enablement","href":"/api-ref/apps/gov-co/enablement-get"},{"title":"Submit test set","openapi":"POST /apps/gov-co/v1/entries/{silo_entry_id}/enablement","href":"/api-ref/apps/gov-co/enablement-submit"},{"title":"List resolutions","openapi":"GET /apps/gov-co/v1/entries/{silo_entry_id}/resolutions","href":"/api-ref/apps/gov-co/resolutions-list"},{"title":"Upload contingency resolution","openapi":"POST /apps/gov-co/v1/entries/{silo_entry_id}/resolutions/contingency","href":"/api-ref/apps/gov-co/resolutions-upload"}]},{"group":"PDF Generator","pages":[{"title":"Generate a PDF preview","openapi":"POST /apps/pdf/v1/preview","href":"/api-ref/apps/pdf/preview"}]},{"group":"France","pages":[{"title":"Look up directory entries by SIREN","openapi":"GET /apps/gov-fr/v1/directory/siren/{siren}","href":"/api-ref/apps/gov-fr/lookup-siren"},{"title":"Look up directory entries by electronic address","openapi":"GET /apps/gov-fr/v1/directory/identifier/{identifier}","href":"/api-ref/apps/gov-fr/lookup-identifier"},{"title":"Download agreement PDF","openapi":"GET /apps/gov-fr/v1/entry/{silo_entry_id}/agreement","href":"/api-ref/apps/gov-fr/agreement-fetch"},{"title":"Upload pre-signed agreement","openapi":"POST /apps/gov-fr/v1/entry/{silo_entry_id}/agreement","href":"/api-ref/apps/gov-fr/agreement-upload"},{"title":"Upload identity image","openapi":"POST /apps/gov-fr/v1/entry/{silo_entry_id}/identity","href":"/api-ref/apps/gov-fr/identity-upload"},{"title":"Sign agreement mandate","openapi":"POST /apps/gov-fr/v1/entry/{silo_entry_id}/sign","href":"/api-ref/apps/gov-fr/sign"},{"title":"Confirm submission","openapi":"POST /apps/gov-fr/v1/entry/{silo_entry_id}/confirm","href":"/api-ref/apps/gov-fr/confirm"},{"title":"List migrations","openapi":"GET /apps/gov-fr/v1/migrations","href":"/api-ref/apps/gov-fr/migrations-list"},{"title":"List a silo entry's migrations","openapi":"GET /apps/gov-fr/v1/migrations/{silo_entry_id}","href":"/api-ref/apps/gov-fr/migrations-entry"},{"title":"Answer a migration request","openapi":"POST /apps/gov-fr/v1/migrations/{silo_entry_id}","href":"/api-ref/apps/gov-fr/migration-answer"},{"title":"Fetch e-reporting summary","openapi":"GET /apps/gov-fr/v1/reports/{siren}","href":"/api-ref/apps/gov-fr/reports-summary"},{"title":"List e-reporting periods","openapi":"GET /apps/gov-fr/v1/reports/{siren}/periods","href":"/api-ref/apps/gov-fr/reports-periods"},{"title":"Fetch an e-reporting period","openapi":"GET /apps/gov-fr/v1/reports/{siren}/periods/{period_id}","href":"/api-ref/apps/gov-fr/reports-period"},{"title":"Download a period's Flux 10 XML","openapi":"GET /apps/gov-fr/v1/reports/{siren}/periods/{period_id}/xml","href":"/api-ref/apps/gov-fr/reports-period-xml"},{"title":"Preview the current window's Flux 10 report","openapi":"GET /apps/gov-fr/v1/reports/{siren}/preview","href":"/api-ref/apps/gov-fr/reports-preview"}]},{"group":"Peppol","pages":[{"title":"Look up a Peppol participant","openapi":"GET /apps/peppol/v1/lookup","href":"/api-ref/apps/peppol/lookup-participant"},{"title":"Upload proof of ownership PDF","openapi":"POST /apps/peppol/v1/entry/{silo_entry_id}/ownership","href":"/api-ref/apps/peppol/ownership-upload"}]},{"group":"Poland","pages":[{"title":"Upload KSeF certificate","openapi":"POST /apps/gov-pl/v1/entry/{silo_entry_id}/certificate","href":"/api-ref/apps/gov-pl/certificate-upload"}]},{"group":"Romania","pages":[{"title":"Fetch terms","openapi":"GET /apps/gov-ro/v1/entry/{silo_entry_id}/terms","href":"/api-ref/apps/gov-ro/terms-fetch"},{"title":"Accept terms","openapi":"POST /apps/gov-ro/v1/entry/{silo_entry_id}/terms","href":"/api-ref/apps/gov-ro/terms-accept"},{"title":"Fetch ANAF link","openapi":"GET /apps/gov-ro/v1/entry/{silo_entry_id}/link","href":"/api-ref/apps/gov-ro/link-fetch"},{"title":"Fetch sent archive","openapi":"GET /apps/gov-ro/v1/sent/{silo_entry_id}/archive","href":"/api-ref/apps/gov-ro/sent-archive-fetch"},{"title":"Fetch received archive","openapi":"GET /apps/gov-ro/v1/received/{silo_entry_id}/archive","href":"/api-ref/apps/gov-ro/received-archive-fetch"}]},{"group":"Saudi Arabia","pages":[{"title":"Submit OTP","openapi":"POST /apps/gov-sa/v1/entry/{silo_entry_id}/otp","href":"/api-ref/apps/gov-sa/otp-submit"}]},{"group":"SW Sapien","pages":[{"title":"Upload e.firma certificate","openapi":"POST /apps/sw-sapien/v1/entry/{silo_entry_id}/certificate","href":"/api-ref/apps/sw-sapien/certificate-upload"}]},{"group":"Spain","pages":[{"title":"Generate agreement PDF","openapi":"GET /apps/gov-es/v1/entry/{silo_entry_id}/{system}/agreement","href":"/api-ref/apps/gov-es/agreement-fetch"},{"title":"Upload agreement PDF","openapi":"POST /apps/gov-es/v1/entry/{silo_entry_id}/{system}/agreement","href":"/api-ref/apps/gov-es/agreement-upload"},{"title":"Upload identity image","openapi":"POST /apps/gov-es/v1/entry/{silo_entry_id}/{system}/identity","href":"/api-ref/apps/gov-es/identity-upload"},{"title":"Confirm","openapi":"POST /apps/gov-es/v1/entry/{silo_entry_id}/{system}/confirm","href":"/api-ref/apps/gov-es/confirm"},{"title":"Verify tax ID","openapi":"POST /apps/gov-es/v1/lookup","href":"/api-ref/apps/gov-es/lookup"}]},{"group":"VERI*FACTU","pages":[{"title":"Generate agreement PDF","openapi":"GET /apps/verifactu/v1/entry/{silo_entry_id}/agreement","href":"/api-ref/apps/verifactu/agreement-fetch"},{"title":"Upload agreement PDF","openapi":"POST /apps/verifactu/v1/entry/{silo_entry_id}/agreement","href":"/api-ref/apps/verifactu/agreement-upload"},{"title":"Upload identity image","openapi":"POST /apps/verifactu/v1/entry/{silo_entry_id}/identity","href":"/api-ref/apps/verifactu/identity-upload"},{"title":"Confirm","openapi":"POST /apps/verifactu/v1/entry/{silo_entry_id}/confirm","href":"/api-ref/apps/verifactu/confirm"}]}]},{"group":"Utils","icon":"wrench","pages":[{"title":"Ping","openapi":"GET /utils/v1/ping","href":"/api-ref/utils/ping"},{"title":"UUID","openapi":"GET /utils/v1/uuid","href":"/api-ref/utils/uuid"}]}]}]},"basePath":"","title":"Authentication - Invopop","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":[],"chunks":[]}