Both healthKERI.net and the Gateways will expose APIs accessible for advanced management and configuration. Documentation for these APIs is coming soon…
Every interaction with all API endpoints will be authenticated using signed and encrypted transactions using the same
Encrypt Sender / Sign Receiver (ESSR) technology that power our Gateways. More information will be available soon.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"healthKERI","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/healthkeri/OvbovaMHLtIokDX_/logo/healthKERI-logo-primary-black.png?fit=max\u0026auto=format\u0026n=OvbovaMHLtIokDX_\u0026q=85\u0026s=4b58f58e85de69940101a726d3cd4386","dark":"https://mintcdn.com/healthkeri/OvbovaMHLtIokDX_/logo/healthKERI-logo-primary-white.png?fit=max\u0026auto=format\u0026n=OvbovaMHLtIokDX_\u0026q=85\u0026s=d899e13a33cc39dbbc571cb622528797"},"favicon":"/favicon.png","navbar":{"links":[{"label":"Support","href":"mailto:info@healthKERI.com"}],"primary":{"type":"button","label":"Get Started","href":"https://app.healthkeri.net"}},"footer":{"socials":{"x":"https://x.com/healthKERI","github":"https://github.com/healthKERI","linkedin":"https://linkedin.com/company/healthKERI"}},"navigation":{"global":{"anchors":[{"anchor":"healthKERI","icon":"lock","href":"https://healthKERI.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.healthdatamanagement.com/articles/the-necessity-to-adopt-the-five-rights-of-secure-health-data?id=134713"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"healthkeri","hasAudioNarration":false,"actualSubdomain":"healthkeri","customDomains":["docs.healthkeri.com"],"gitSource":{"type":"github","owner":"healthkeri","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c750faa2f94379e1fa4d","collectionId":"9ec7ebd2-abb3-4495-a939-6509149bc37e","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c750faa2f94379e1fa4d:success","clientVersion":"0.0.3894","searchFilterCounts":[{"language":"default","tag":"Guides","count":13},{"language":"default","tag":"Get Started","count":8},{"language":"default","tag":"KERI","count":5},{"language":"default","tag":"API Reference","count":1},{"language":"default","tag":"API Documentation","count":1}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"healthKERI.net and RACK Gateway APIs","href":"/api-reference/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: \"healthKERI.net and RACK Gateway APIs\"\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,Note,Tooltip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tooltip)_missingMdxReference(`Tooltip`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`Both healthKERI.net and the `,_jsx(Tooltip,{tip:`Routing, Authentication and Confidentiality with KERI`,children:`RACK`}),` Gateways will expose APIs accessible for advanced management and configuration. Documentation for these APIs is coming soon…`]})}),`\n`,_jsx(Heading,{level:`2`,id:`welcome`,children:`Welcome`}),`\n`,_jsx(_components.p,{children:`Please check back in a few weeks for our RACK Gateway and healthKERI.net API documentation here.`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Every interaction with all API endpoints will be authenticated using signed and encrypted transactions using the same\nEncrypt Sender / Sign Receiver (ESSR) technology that power our `,_jsx(Tooltip,{tip:`Routing, Authentication and Confidentiality with KERI`,children:`RACK`}),` Gateways. More information will be available soon.`]})]})}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":"Introduction","description":"healthKERI.net and RACK Gateway APIs","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome","slug":"welcome","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"healthkeri","siteName":"healthKERI","title":"Introduction - healthKERI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T06:45:03.934Z","originalFileLocation":"api-reference/introduction.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"healthKERI.net and RACK Gateway APIs\">\u003cmeta data-mint-head name=\"application-name\" content=\"healthKERI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/healthkeri/1DdVgn7iqrNsB5qK/_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/healthkeri/1DdVgn7iqrNsB5qK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/healthkeri/1DdVgn7iqrNsB5qK/_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/healthkeri/1DdVgn7iqrNsB5qK/_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/healthkeri/1DdVgn7iqrNsB5qK/_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/healthkeri/1DdVgn7iqrNsB5qK/_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/healthkeri/1DdVgn7iqrNsB5qK/_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/healthkeri/1DdVgn7iqrNsB5qK/_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/healthkeri/1DdVgn7iqrNsB5qK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - healthKERI\">\u003cmeta data-mint-head property=\"og:description\" content=\"healthKERI.net and RACK Gateway APIs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"healthKERI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.healthkeri.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - healthKERI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"healthKERI.net and RACK Gateway APIs\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/healthkeri/1DdVgn7iqrNsB5qK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"healthKERI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.healthkeri.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.healthkeri.com/#organization\",\"name\":\"healthKERI\",\"url\":\"https://docs.healthkeri.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/healthkeri/OvbovaMHLtIokDX_/logo/healthKERI-logo-primary-black.png?fit=max\u0026auto=format\u0026n=OvbovaMHLtIokDX_\u0026q=85\u0026s=4b58f58e85de69940101a726d3cd4386\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.healthkeri.com#website\",\"name\":\"healthKERI\",\"url\":\"https://docs.healthkeri.com\",\"publisher\":{\"@id\":\"https://docs.healthkeri.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.healthkeri.com/api-reference/introduction#webpage\",\"url\":\"https://docs.healthkeri.com/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"healthKERI.net and RACK Gateway APIs\",\"dateModified\":\"2026-01-07T06:45:03.934Z\",\"isPartOf\":{\"@id\":\"https://docs.healthkeri.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.healthkeri.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.healthkeri.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"healthKERI\",\"item\":\"https://docs.healthkeri.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.healthkeri.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.healthkeri.com/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"healthKERI.net and RACK Gateway APIs\",\"url\":\"https://docs.healthkeri.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.healthkeri.com/api-reference/introduction#webpage\"},\"dateModified\":\"2026-01-07T06:45:03.934Z\",\"publisher\":{\"@id\":\"https://docs.healthkeri.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.healthkeri.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"healthKERI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"healthKERI","nav":{"global":{"anchors":[{"anchor":"healthKERI","icon":"lock","href":"https://healthKERI.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.healthdatamanagement.com/articles/the-necessity-to-adopt-the-five-rights-of-secure-health-data?id=134713"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]}]}]},"title":"Introduction - healthKERI","buildId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","deploymentId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","dynamics":[],"chunks":[]}