Secure API access with organization-scoped authentication
Overview
Alto Health uses API key-based authentication to secure all API endpoints. Authentication ensures that only authorized users can access your organization’s medical data and processing capabilities.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Alto Health","colors":{"primary":"#130185","light":"#130185","dark":"#130185"},"logo":{"light":"https://mintcdn.com/altohealth/FJ1TdHE9cySYCJ6Y/logo/Alto_logo.png?fit=max\u0026auto=format\u0026n=FJ1TdHE9cySYCJ6Y\u0026q=85\u0026s=ddb5b0cdbe8609c4b94f6b18eb1b8410","dark":"https://mintcdn.com/altohealth/FJ1TdHE9cySYCJ6Y/logo/Alto_logo.png?fit=max\u0026auto=format\u0026n=FJ1TdHE9cySYCJ6Y\u0026q=85\u0026s=ddb5b0cdbe8609c4b94f6b18eb1b8410"},"favicon":"/favicon.svg","footer":{"socials":{"linkedin":"https://www.linkedin.com/company/altohealthcare"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"]},"navigation":{"global":{"anchors":[{"anchor":"API Status","icon":"heart-pulse","href":"https://app.arahealth.io/api/v1/pub/health"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"altohealth","hasAudioNarration":false,"actualSubdomain":"altohealth","customDomains":["docs.altohealth.io"],"gitSource":{"type":"github","owner":"xiao11lam","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae943a3070c244b02aede4e:success","clientVersion":"0.0.4142","searchFilterCounts":[{"language":"default","tag":"API Reference","count":7},{"language":"default","tag":"Documentation","count":6},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"File Endpoints","count":2},{"language":"default","tag":"Automation Use Cases","count":2},{"language":"default","tag":"Getting Started","count":2},{"language":"default","tag":"System","count":1},{"language":"default","tag":"Automation","count":1},{"language":"default","tag":"Overview","count":1},{"language":"default","tag":"Core Concepts","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"guides/authentication","slug":"/guides/authentication","pageMetadata":{"title":"Authentication","description":"Secure API access with organization-scoped authentication","href":"/guides/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: \"Secure API access with organization-scoped authentication\"\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={p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`Alto Health uses API key-based authentication to secure all API endpoints. Authentication ensures that only authorized users can access your organization’s medical data and processing capabilities.`})]})}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":"Authentication","description":"Secure API access with organization-scoped authentication","href":"/guides/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"altohealth","siteName":"Alto Health","title":"Authentication - Alto Health","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"guides/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=\"Secure API access with organization-scoped authentication\">\u003cmeta data-mint-head name=\"application-name\" content=\"Alto Health\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/altohealth/ynKzTbtBuyxjcSXh/_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/altohealth/ynKzTbtBuyxjcSXh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/altohealth/ynKzTbtBuyxjcSXh/_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/altohealth/ynKzTbtBuyxjcSXh/_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/altohealth/ynKzTbtBuyxjcSXh/_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/altohealth/ynKzTbtBuyxjcSXh/_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/altohealth/ynKzTbtBuyxjcSXh/_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/altohealth/ynKzTbtBuyxjcSXh/_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/altohealth/ynKzTbtBuyxjcSXh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Alto Health\">\u003cmeta data-mint-head property=\"og:description\" content=\"Secure API access with organization-scoped authentication\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Alto Health\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.altohealth.io/guides/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://altohealth.mintlify.site/_mintlify/api/og/v2?division=Guides\u0026amp;title=Authentication\u0026amp;description=Secure+API+access+with+organization-scoped+authentication\u0026amp;theme=671ed4dbee7b0b1c92a4edc0\u0026amp;signature=792eac631c6b3f3dd23ab7c9b07f5934c4e9488f2fd048ccf34a4f0a4b631258\">\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 - Alto Health\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Secure API access with organization-scoped authentication\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://altohealth.mintlify.site/_mintlify/api/og/v2?division=Guides\u0026amp;title=Authentication\u0026amp;description=Secure+API+access+with+organization-scoped+authentication\u0026amp;theme=671ed4dbee7b0b1c92a4edc0\u0026amp;signature=792eac631c6b3f3dd23ab7c9b07f5934c4e9488f2fd048ccf34a4f0a4b631258\">\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/altohealth/ynKzTbtBuyxjcSXh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Alto Health\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#130185\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.altohealth.io/guides/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.altohealth.io/#organization\",\"name\":\"Alto Health\",\"url\":\"https://docs.altohealth.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/altohealth/FJ1TdHE9cySYCJ6Y/logo/Alto_logo.png?fit=max\u0026auto=format\u0026n=FJ1TdHE9cySYCJ6Y\u0026q=85\u0026s=ddb5b0cdbe8609c4b94f6b18eb1b8410\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.altohealth.io#website\",\"name\":\"Alto Health\",\"url\":\"https://docs.altohealth.io\",\"publisher\":{\"@id\":\"https://docs.altohealth.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.altohealth.io/guides/authentication#webpage\",\"url\":\"https://docs.altohealth.io/guides/authentication\",\"name\":\"Authentication\",\"description\":\"Secure API access with organization-scoped authentication\",\"isPartOf\":{\"@id\":\"https://docs.altohealth.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.altohealth.io/guides/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.altohealth.io/guides/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Guides\",\"item\":\"https://docs.altohealth.io/guides/webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.altohealth.io/guides/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.altohealth.io/guides/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Secure API access with organization-scoped authentication\",\"url\":\"https://docs.altohealth.io/guides/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.altohealth.io/guides/authentication#webpage\"},\"publisher\":{\"@id\":\"https://docs.altohealth.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.altohealth.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Alto Health\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Alto Health\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/guides/authentication.md","siteName":"Alto Health","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"heart-pulse","href":"https://app.arahealth.io/api/v1/pub/health"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"Welcome to Alto Health","href":""},{"title":"Quickstart (5 minutes)","href":"/quickstart"}]},{"group":"Core Concepts","pages":[{"title":"Supported File Formats","href":"/concepts/supported-formats"}]},{"group":"Guides","pages":[{"title":"Webhooks","description":"Get real-time notifications when your document processing completes","href":"/guides/webhooks"},{"title":"Authentication","href":"/guides/authentication"},{"title":"Error Handling","description":"Handle errors gracefully and troubleshoot common issues","href":"/guides/error-handling"}]}]},{"tab":"User Guides","pages":[{"title":"User Guides","href":"/guides/decision-trees"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Authentication - Alto Health","buildId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","deploymentId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","dynamics":[],"chunks":[]}
