Build, validate, sign, and query tax-aware business documents via REST
The GOBL API provides a hosted REST service for working with GOBL documents without needing to install or run any libraries locally. It’s ideal for integrations in any language.Base URL:
An MCP (Model Context Protocol) server is also available for integrating GOBL with AI assistants like Claude. It exposes the same document operations plus tax reference data as MCP tools.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"GOBL","colors":{"primary":"#15c6f6","light":"#24abd0","dark":"#15c6f6"},"logo":{"light":"https://mintcdn.com/gobl/zyouEYmv9f3mqhdP/static/logo_long_dark.svg?fit=max\u0026auto=format\u0026n=zyouEYmv9f3mqhdP\u0026q=85\u0026s=1a7a14c20c1709445dce0157e3294b38","dark":"https://mintcdn.com/gobl/zyouEYmv9f3mqhdP/static/logo_long_light.svg?fit=max\u0026auto=format\u0026n=zyouEYmv9f3mqhdP\u0026q=85\u0026s=ffdd0be9c2b5aa62b5216717f46b65f2"},"favicon":"https://mintcdn.com/gobl/zyouEYmv9f3mqhdP/static/favicon.svg?fit=max\u0026auto=format\u0026n=zyouEYmv9f3mqhdP\u0026q=85\u0026s=ecca8eeaed2f91171e4e0618ab6ee6ce","navbar":{"primary":{"type":"github","href":"https://github.com/invopop/gobl"}},"footer":{"socials":{"github":"https://github.com/invopop/gobl","linkedin":"https://www.linkedin.com/company/invopop","twitter":"https://twitter.com/goInvopop"}},"styling":{"codeblocks":"system","latex":true},"integrations":{"plausible":{"domain":"docs.gobl.org"}},"navigation":{"global":{"anchors":[{"anchor":"Builder","icon":"gear","href":"https://build.gobl.org"},{"anchor":"GitHub","icon":"github","href":"https://github.com/invopop/gobl"},{"anchor":"Community","icon":"comments","href":"https://community.invopop.com/c/gobl/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gobl","hasAudioNarration":false,"actualSubdomain":"gobl","customDomains":["docs.gobl.org"],"gitSource":{"type":"github","owner":"invopop","repo":"gobl.docs","deployBranch":"main","contentDirectory":"","mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aea167ecee1c80579e55c1b","collectionId":"ef758fab-f31c-4bf1-a733-4eebe9cf3301","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea167ecee1c80579e55c1b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea167ecee1c80579e55c1b","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Documentation","count":186},{"language":"default","tag":"Schemas (Draft 0)","count":104},{"language":"default","tag":"Tax Regimes","count":34},{"language":"default","tag":"Countries","count":33},{"language":"default","tag":"Definitions","count":30},{"language":"default","tag":"Addons","count":28},{"language":"default","tag":"Tax","count":24},{"language":"default","tag":"Bill","count":23},{"language":"default","tag":"Org","count":18},{"language":"default","tag":"API Reference","count":16}]},"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":"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":"vite-origin","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":[{"filePath":"style.css","content":".prose table tr td code{white-space:nowrap;display:inline-block;padding:0.2em 0.5em;margin:0 0 0.4em -0.5em}.prose table tr td code.code-block{display:block}.prose table tr td ul.gobl-test li{padding-left:1em!important}.prose table tr td ul.gobl-test li:before{top:calc(.6em);left:0;background-color:#aaa;width:.3em;height:.3em;box-shadow:0 0 0 2px #99999922}.prose table tr td ul.gobl-test li.gobl-test-present:only-child:before{background-color:#15c6f6;box-shadow:0 0 0 2px #15c6f622}.prose table tr td small{font-size:100%;color:#aaa}.prose table tr td small.gobl-field-calculated{color:#15c6f6;font-size:12px}.prose table tr td{min-width:120px!important}"}],"page":{"pagePath":"api/introduction","slug":"/api/introduction","pageMetadata":{"title":"GOBL API","description":"Build, validate, sign, and query tax-aware business documents via REST","icon":"info","href":"/api/introduction"},"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: \"Build, validate, sign, and query tax-aware business documents via REST\"\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`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.a,{href:`https://gobl.dev`,children:`GOBL API`}),` provides a hosted REST service for working with GOBL documents without needing to install or run any libraries locally. It’s ideal for integrations in any language.`]}),`\n`,_jsx(_components.p,{children:`Base URL:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://gobl.dev/v0`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsx(_components.p,{children:`The API is organized into three groups:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Documents`}),` — `,_jsx(_components.a,{href:`/api/documents/build`,children:`Build`}),`, `,_jsx(_components.a,{href:`/api/documents/validate`,children:`validate`}),`, `,_jsx(_components.a,{href:`/api/documents/correct`,children:`correct`}),`, and `,_jsx(_components.a,{href:`/api/documents/replicate`,children:`replicate`}),` GOBL documents.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Signing`}),` — `,_jsx(_components.a,{href:`/api/signing/sign`,children:`Sign`}),` and `,_jsx(_components.a,{href:`/api/signing/verify`,children:`verify`}),` envelopes, or `,_jsx(_components.a,{href:`/api/signing/keygen`,children:`generate key pairs`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Reference`}),` — Query available `,_jsx(_components.a,{href:`/api/reference/list-schemas`,children:`JSON schemas`}),`, `,_jsx(_components.a,{href:`/api/reference/list-regimes`,children:`tax regimes`}),`, and `,_jsx(_components.a,{href:`/api/reference/list-addons`,children:`addons`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`quick-example`,children:`Quick Example`}),`\n`,_jsx(_components.p,{children:`Build and validate an invoice in a single request:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`27`,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:`27`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://gobl.dev/v0/build`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"$schema\": \"https://gobl.org/draft-0/bill/invoice\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"series\": \"EXAMPLE\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"currency\": \"USD\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"issue_date\": \"2024-01-15\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"supplier\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"Seller Co.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"tax_id\": { \"country\": \"US\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"customer\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"Buyer Inc.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"tax_id\": { \"country\": \"US\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"lines\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"quantity\": \"1\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"item\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"Service\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"price\": \"100.00\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`No authentication is required. The API is free to use.`}),`\n`,_jsx(Heading,{level:`2`,id:`mcp-server`,children:`MCP Server`}),`\n`,_jsxs(_components.p,{children:[`An `,_jsx(_components.a,{href:`/api/mcp`,children:`MCP (Model Context Protocol) server`}),` is also available for integrating GOBL with AI assistants like Claude. It exposes the same document operations plus tax reference data as MCP tools.`]})]})}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":"GOBL API","description":"Build, validate, sign, and query tax-aware business documents via REST","icon":"info","href":"/api/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"Quick Example","slug":"quick-example","depth":2,"children":[]},{"title":"MCP Server","slug":"mcp-server","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"gobl","siteName":"GOBL","title":"GOBL API - GOBL","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-15T09:20:16.778Z","originalFileLocation":"api/introduction.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=\"Build, validate, sign, and query tax-aware business documents via REST\">\u003cmeta data-mint-head name=\"application-name\" content=\"GOBL\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gobl/OyALMBHzSClav_Z0/_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/gobl/OyALMBHzSClav_Z0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gobl/OyALMBHzSClav_Z0/_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/gobl/OyALMBHzSClav_Z0/_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/gobl/OyALMBHzSClav_Z0/_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/gobl/OyALMBHzSClav_Z0/_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/gobl/OyALMBHzSClav_Z0/_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/gobl/OyALMBHzSClav_Z0/_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/gobl/OyALMBHzSClav_Z0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"GOBL API - GOBL\">\u003cmeta data-mint-head property=\"og:description\" content=\"Build, validate, sign, and query tax-aware business documents via REST\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GOBL\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gobl.org/api/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gobl.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=GOBL+API\u0026amp;description=Build%2C+validate%2C+sign%2C+and+query+tax-aware+business+documents+via+REST\u0026amp;theme=e6dc098335879cf1cde80760\u0026amp;signature=e40d99a2f921eb2737d69230bf21e818f1f7094550b59641338bd2f129df239f\">\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=\"GOBL API - GOBL\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Build, validate, sign, and query tax-aware business documents via REST\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gobl.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=GOBL+API\u0026amp;description=Build%2C+validate%2C+sign%2C+and+query+tax-aware+business+documents+via+REST\u0026amp;theme=e6dc098335879cf1cde80760\u0026amp;signature=e40d99a2f921eb2737d69230bf21e818f1f7094550b59641338bd2f129df239f\">\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/gobl/OyALMBHzSClav_Z0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GOBL\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#15c6f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gobl.org/api/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gobl.org/#organization\",\"name\":\"GOBL\",\"url\":\"https://docs.gobl.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gobl/zyouEYmv9f3mqhdP/static/logo_long_dark.svg?fit=max\u0026auto=format\u0026n=zyouEYmv9f3mqhdP\u0026q=85\u0026s=1a7a14c20c1709445dce0157e3294b38\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gobl.org#website\",\"name\":\"GOBL\",\"url\":\"https://docs.gobl.org\",\"publisher\":{\"@id\":\"https://docs.gobl.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gobl.org/api/introduction#webpage\",\"url\":\"https://docs.gobl.org/api/introduction\",\"name\":\"GOBL API\",\"description\":\"Build, validate, sign, and query tax-aware business documents via REST\",\"dateModified\":\"2026-04-15T09:20:16.778Z\",\"isPartOf\":{\"@id\":\"https://docs.gobl.org#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gobl.org/api/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gobl.org/api/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"GOBL\",\"item\":\"https://docs.gobl.org\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"GOBL API\",\"item\":\"https://docs.gobl.org/api/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.gobl.org/api/introduction#article\",\"headline\":\"GOBL API\",\"name\":\"GOBL API\",\"description\":\"Build, validate, sign, and query tax-aware business documents via REST\",\"url\":\"https://docs.gobl.org/api/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gobl.org/api/introduction#webpage\"},\"dateModified\":\"2026-04-15T09:20:16.778Z\",\"publisher\":{\"@id\":\"https://docs.gobl.org/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gobl.org#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GOBL\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"GOBL","nav":{"global":{"anchors":[{"anchor":"Builder","icon":"gear","href":"https://build.gobl.org"},{"anchor":"GitHub","icon":"github","href":"https://github.com/invopop/gobl"},{"anchor":"Community","icon":"comments","href":"https://community.invopop.com/c/gobl/"}]},"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"GOBL API","icon":"info","href":"/api/introduction"},{"title":"MCP Server","description":"Use GOBL with AI assistants via the Model Context Protocol","icon":"microchip-ai","href":"/api/mcp"}]},{"group":"Documents","pages":[{"title":"Build a GOBL document","deprecated":null,"version":null,"openapi":"/openapi/v0.json post /build","href":"/api-reference/documents/build-a-gobl-document"},{"title":"Validate a GOBL document","deprecated":null,"version":null,"openapi":"/openapi/v0.json post /validate","href":"/api-reference/documents/validate-a-gobl-document"},{"title":"Create a corrective document","deprecated":null,"version":null,"openapi":"/openapi/v0.json post /correct","href":"/api-reference/documents/create-a-corrective-document"},{"title":"Replicate a document","deprecated":null,"version":null,"openapi":"/openapi/v0.json post /replicate","href":"/api-reference/documents/replicate-a-document"}]},{"group":"Signing","pages":[{"title":"Sign a GOBL document","deprecated":null,"version":null,"openapi":"/openapi/v0.json post /sign","href":"/api-reference/signing/sign-a-gobl-document"},{"title":"Verify a signed envelope","deprecated":null,"version":null,"openapi":"/openapi/v0.json post /verify","href":"/api-reference/signing/verify-a-signed-envelope"},{"title":"Generate a signing key pair","deprecated":null,"version":null,"openapi":"/openapi/v0.json post /keygen","href":"/api-reference/signing/generate-a-signing-key-pair"}]},{"group":"Reference","pages":[{"title":"List available JSON schemas","deprecated":null,"version":null,"openapi":"/openapi/v0.json get /schemas","href":"/api-reference/reference/list-available-json-schemas"},{"title":"Get a JSON schema","deprecated":null,"version":null,"openapi":"/openapi/v0.json get /schemas/{path}","href":"/api-reference/reference/get-a-json-schema"},{"title":"List tax regimes","deprecated":null,"version":null,"openapi":"/openapi/v0.json get /regimes","href":"/api-reference/reference/list-tax-regimes"},{"title":"Get a tax regime definition","deprecated":null,"version":null,"openapi":"/openapi/v0.json get /regimes/{code}","href":"/api-reference/reference/get-a-tax-regime-definition"},{"title":"List format addons","deprecated":null,"version":null,"openapi":"/openapi/v0.json get /addons","href":"/api-reference/reference/list-format-addons"},{"title":"Get an addon definition","deprecated":null,"version":null,"openapi":"/openapi/v0.json get /addons/{key}","href":"/api-reference/reference/get-an-addon-definition"}]},{"group":"Meta","pages":[{"title":"Version and health check","deprecated":null,"version":null,"openapi":"/openapi/v0.json get /","href":"/api-reference/meta/version-and-health-check"}]}]}]},"basePath":"","title":"GOBL API - GOBL","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":[],"chunks":[]}