Understand the safe public boundary of Directory, Relay, and Cache nodes
These docs describe only the network interfaces that application developers need to build compatible OpenPayload clients.
Public developer APIs
Service
What your client uses it for
Directory
Resolve public identities, Personas, and delivery policies and submit authorized public-state changes
Relay
Send an encrypted DDN envelope toward its recipient
Cache
Temporarily store, retrieve, and acknowledge encrypted messages when immediate delivery is unavailable
The examples explain HTTP methods, paths, fields, encodings, signatures, responses, and errors. You do not need to understand how a node stores data or communicates with other nodes.Public clients submit original envelopes and never create or submit policy provenance. Node-to-node routes, attestations, and graph cursors are intentionally outside this public contract.
What is intentionally excluded
This reference does not describe:
Private keys, seed phrases, or account secrets
Administrative cleanup or maintenance operations
Health checks intended only for operators
Chain RPC credentials or server signing configuration
A legitimate public OpenPayload endpoint never needs your private key or seed phrase. Sign locally and send only the resulting public payload and signature.
Public does not mean unencrypted
DIDs, public keys, aliases, Personas, service endpoints, delivery policies, policy conditions, and top-level message tags may be publicly discoverable. Message contents should remain encrypted inside the DDN envelope. Relay and Cache nodes route or store the envelope without needing to decrypt its payload.Persona DNS validation proves control of a DNS name at validation time. It does not establish organizational identity, reputation, or trustworthiness.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpenPayload Developer Network","description":"Build secure, interoperable applications on the OpenPayload protocol and community-operated data network.","colors":{"primary":"#2563EB","light":"#3B82F6","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/mandolare-llc/cLF6QiqDxlGwTIfr/logo/light.png?fit=max\u0026auto=format\u0026n=cLF6QiqDxlGwTIfr\u0026q=85\u0026s=cf9d640eea7a9f799bdf5e8c9612a470","dark":"https://mintcdn.com/mandolare-llc/cLF6QiqDxlGwTIfr/logo/dark.png?fit=max\u0026auto=format\u0026n=cLF6QiqDxlGwTIfr\u0026q=85\u0026s=5c2c6acbdf2af6fdac111521eb5ef211","href":"/"},"favicon":{"light":"https://mintcdn.com/mandolare-llc/DIH5nQyU7xY66Mmw/favicon.png?fit=max\u0026auto=format\u0026n=DIH5nQyU7xY66Mmw\u0026q=85\u0026s=4e0d2078d5595acea38838aeeb168851","dark":"https://mintcdn.com/mandolare-llc/DIH5nQyU7xY66Mmw/favicon.png?fit=max\u0026auto=format\u0026n=DIH5nQyU7xY66Mmw\u0026q=85\u0026s=4e0d2078d5595acea38838aeeb168851"},"api":{"playground":{"display":"none"}},"appearance":{"default":"light"},"background":{"decoration":"grid","color":{"light":"#FFFFFF","dark":"#07152E"}},"navbar":{"links":[{"href":"https://github.com/Mandolare-LLC/OpenPayload/discussions","label":"Community"}],"primary":{"type":"button","label":"Start building","href":"/quickstart"}},"footer":{"socials":{"github":"https://github.com/Mandolare-LLC/OpenPayload"}},"banner":{"content":"Public alpha: [start building with OpenPayload](/quickstart) and help shape the protocol.","dismissible":true,"color":{"light":"#1D4ED8","dark":"#1E40AF"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://github.com/Mandolare-LLC/OpenPayload/discussions"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mandolare-llc","hasAudioNarration":false,"actualSubdomain":"mandolare-llc","customDomains":["docs.openpayload.io"],"gitSource":{"type":"github","owner":"mandolare-llc","repo":"talaria-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae3e119b7fb0fcce49dac41","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Directory API","count":61},{"language":"default","tag":"DIDs","count":16},{"language":"default","tag":"Personas","count":16},{"language":"default","tag":"DID documents","count":12},{"language":"default","tag":"Getting Started","count":12},{"language":"default","tag":"Delivery policies","count":8},{"language":"default","tag":"Cache API","count":6},{"language":"default","tag":"Applications","count":6},{"language":"default","tag":"Aliases","count":3},{"language":"default","tag":"Relay API","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"concepts/public-api-boundary","slug":"/concepts/public-api-boundary","pageMetadata":{"title":"What these APIs expose","description":"Understand the safe public boundary of Directory, Relay, and Cache nodes","href":"/concepts/public-api-boundary"},"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: \"Understand the safe public boundary of Directory, Relay, and Cache nodes\"\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={li:`li`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`These docs describe only the network interfaces that application developers need to build compatible OpenPayload clients.`}),`\n`,_jsx(Heading,{level:`2`,id:`public-developer-apis`,children:`Public developer APIs`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Service`}),_jsx(_components.th,{children:`What your client uses it for`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Directory`}),_jsx(_components.td,{children:`Resolve public identities, Personas, and delivery policies and submit authorized public-state changes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Relay`}),_jsx(_components.td,{children:`Send an encrypted DDN envelope toward its recipient`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Cache`}),_jsx(_components.td,{children:`Temporarily store, retrieve, and acknowledge encrypted messages when immediate delivery is unavailable`})]})]})]}),`\n`,_jsx(_components.p,{children:`The examples explain HTTP methods, paths, fields, encodings, signatures, responses, and errors. You do not need to understand how a node stores data or communicates with other nodes.`}),`\n`,_jsx(_components.p,{children:`Public clients submit original envelopes and never create or submit policy provenance. Node-to-node routes, attestations, and graph cursors are intentionally outside this public contract.`}),`\n`,_jsx(Heading,{level:`2`,id:`what-is-intentionally-excluded`,children:`What is intentionally excluded`}),`\n`,_jsx(_components.p,{children:`This reference does not describe:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Private keys, seed phrases, or account secrets`}),`\n`,_jsx(_components.li,{children:`Administrative cleanup or maintenance operations`}),`\n`,_jsx(_components.li,{children:`Health checks intended only for operators`}),`\n`,_jsx(_components.li,{children:`Chain RPC credentials or server signing configuration`}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`A legitimate public OpenPayload endpoint never needs your private key or seed phrase. Sign locally and send only the resulting public payload and signature.`})}),`\n`,_jsx(Heading,{level:`2`,id:`public-does-not-mean-unencrypted`,children:`Public does not mean unencrypted`}),`\n`,_jsx(_components.p,{children:`DIDs, public keys, aliases, Personas, service endpoints, delivery policies, policy conditions, and top-level message tags may be publicly discoverable. Message contents should remain encrypted inside the DDN envelope. Relay and Cache nodes route or store the envelope without needing to decrypt its payload.`}),`\n`,_jsx(_components.p,{children:`Persona DNS validation proves control of a DNS name at validation time. It does not establish organizational identity, reputation, or trustworthiness.`})]})}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":"What these APIs expose","description":"Understand the safe public boundary of Directory, Relay, and Cache nodes","href":"/concepts/public-api-boundary"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Public developer APIs","slug":"public-developer-apis","depth":2,"children":[]},{"title":"What is intentionally excluded","slug":"what-is-intentionally-excluded","depth":2,"children":[]},{"title":"Public does not mean unencrypted","slug":"public-does-not-mean-unencrypted","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"mandolare-llc","siteName":"OpenPayload Developer Network","title":"What these APIs expose - OpenPayload Developer Network","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T03:10:30.751Z","originalFileLocation":"concepts/public-api-boundary.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=\"light\"}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=\"Understand the safe public boundary of Directory, Relay, and Cache nodes\">\u003cmeta data-mint-head name=\"application-name\" content=\"OpenPayload Developer Network\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mandolare-llc/J6PBBs34pEq32feV/_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/mandolare-llc/J6PBBs34pEq32feV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mandolare-llc/J6PBBs34pEq32feV/_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/mandolare-llc/J6PBBs34pEq32feV/_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/mandolare-llc/J6PBBs34pEq32feV/_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/mandolare-llc/J6PBBs34pEq32feV/_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/mandolare-llc/J6PBBs34pEq32feV/_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/mandolare-llc/J6PBBs34pEq32feV/_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/mandolare-llc/J6PBBs34pEq32feV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"What these APIs expose - OpenPayload Developer Network\">\u003cmeta data-mint-head property=\"og:description\" content=\"Understand the safe public boundary of Directory, Relay, and Cache nodes\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenPayload Developer Network\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openpayload.io/concepts/public-api-boundary\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mandolare-llc.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=What+these+APIs+expose\u0026amp;description=Understand+the+safe+public+boundary+of+Directory%2C+Relay%2C+and+Cache+nodes\u0026amp;theme=e4ecf45cb997513f4d4cee95\u0026amp;signature=a82dc7534df3aa631c80123b4e2fc692fd0da63e38251fa685ead49e70609f70\">\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=\"What these APIs expose - OpenPayload Developer Network\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Understand the safe public boundary of Directory, Relay, and Cache nodes\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mandolare-llc.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=What+these+APIs+expose\u0026amp;description=Understand+the+safe+public+boundary+of+Directory%2C+Relay%2C+and+Cache+nodes\u0026amp;theme=e4ecf45cb997513f4d4cee95\u0026amp;signature=a82dc7534df3aa631c80123b4e2fc692fd0da63e38251fa685ead49e70609f70\">\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/mandolare-llc/J6PBBs34pEq32feV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpenPayload Developer Network\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openpayload.io/concepts/public-api-boundary\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/concepts/public-api-boundary.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.openpayload.io/#organization\",\"name\":\"OpenPayload Developer Network\",\"url\":\"https://docs.openpayload.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mandolare-llc/cLF6QiqDxlGwTIfr/logo/light.png?fit=max\u0026auto=format\u0026n=cLF6QiqDxlGwTIfr\u0026q=85\u0026s=cf9d640eea7a9f799bdf5e8c9612a470\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.openpayload.io#website\",\"name\":\"OpenPayload Developer Network\",\"url\":\"https://docs.openpayload.io\",\"publisher\":{\"@id\":\"https://docs.openpayload.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.openpayload.io/concepts/public-api-boundary#webpage\",\"url\":\"https://docs.openpayload.io/concepts/public-api-boundary\",\"name\":\"What these APIs expose\",\"description\":\"Understand the safe public boundary of Directory, Relay, and Cache nodes\",\"dateModified\":\"2026-10-01T03:10:30.751Z\",\"isPartOf\":{\"@id\":\"https://docs.openpayload.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.openpayload.io/concepts/public-api-boundary#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.openpayload.io/concepts/public-api-boundary#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.openpayload.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"What these APIs expose\",\"item\":\"https://docs.openpayload.io/concepts/public-api-boundary\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.openpayload.io/concepts/public-api-boundary#article\",\"headline\":\"What these APIs expose\",\"name\":\"What these APIs expose\",\"description\":\"Understand the safe public boundary of Directory, Relay, and Cache nodes\",\"url\":\"https://docs.openpayload.io/concepts/public-api-boundary\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openpayload.io/concepts/public-api-boundary#webpage\"},\"dateModified\":\"2026-10-01T03:10:30.751Z\",\"publisher\":{\"@id\":\"https://docs.openpayload.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.openpayload.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpenPayload Developer Network\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"OpenPayload Developer Network\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/concepts/public-api-boundary.md","siteName":"OpenPayload Developer Network","nav":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://github.com/Mandolare-LLC/OpenPayload/discussions"}]},"pages":[{"group":"Getting Started","pages":[{"title":"Welcome to OpenPayload","href":"/index"},{"title":"Your first OpenPayload requests","href":"/quickstart"},{"title":"Public alpha endpoints","href":"/public-alpha-endpoints"},{"title":"What is an OpenPayload DID?","href":"/concepts/what-is-a-did"},{"title":"A complete messaging DID document","href":"/concepts/complete-did-document"},{"title":"Delivery policies","href":"/concepts/delivery-policies"},{"title":"Shared policies and control actions","href":"/concepts/policy-v3"},{"title":"Applications and Personas","description":"Keep integration identity separate from delivery policy","href":"/concepts/application-registry"},{"title":"What these APIs expose","href":"/concepts/public-api-boundary"},{"title":"Authorize a Directory update","description":"A beginner-friendly guide to nonces, canonical payloads, and signatures","href":"/guides/authorization"},{"title":"Build a DDN message envelope","href":"/guides/ddn-envelope"},{"title":"Register a Persona","href":"/guides/register-persona"}]},{"group":"Directory API","root":{"title":"OpenPayload Directory API","href":"/openpayload-directory-api"},"pages":[{"group":"DIDs","pages":[{"title":"Resolve a DID","api":"GET /resolve/{did}","playground":"none","href":"/api-reference/directory/dids/resolve"},{"title":"Resolve a delivery target","api":"GET /delivery-resolution/{target}","playground":"none","href":"/api-reference/directory/dids/delivery-resolution"},{"title":"Resolve an alias","api":"GET /aliases/{alias}","playground":"none","href":"/api-reference/directory/dids/resolve-alias"},{"title":"Register a DID","api":"POST /register-did","playground":"none","href":"/api-reference/directory/dids/register"},{"title":"Get registration status","api":"GET /registration-status/{did}","playground":"none","href":"/api-reference/directory/dids/registration-status"},{"title":"Get authorization nonces","api":"GET /dids/{did}/nonces","playground":"none","href":"/api-reference/directory/dids/get-nonces"},{"title":"Prepare a DID update","api":"POST /dids/{did}/prepare","playground":"none","href":"/api-reference/directory/dids/prepare"},{"title":"Add a device","api":"POST /dids/{did}/devices","playground":"none","href":"/api-reference/directory/dids/add-device"},{"title":"Rename a device","api":"PATCH /dids/{did}/devices/{deviceId}","playground":"none","href":"/api-reference/directory/dids/update-device"},{"title":"Remove a device","api":"DELETE /dids/{did}/devices/{deviceId}","playground":"none","href":"/api-reference/directory/dids/remove-device"},{"title":"Tombstone a device","api":"POST /dids/{did}/devices/{deviceId}/tombstone","playground":"none","href":"/api-reference/directory/dids/tombstone-device"},{"title":"Deactivate a DID","api":"POST /dids/{did}/deactivate","playground":"none","href":"/api-reference/directory/dids/deactivate"},{"title":"Delete a DID","api":"DELETE /dids/{did}","playground":"none","href":"/api-reference/directory/dids/delete"},{"title":"Replace a DID document with proof","api":"PUT /dids/{did}/document/proof","playground":"none","href":"/api-reference/directory/dids/set-document-proof"},{"title":"Get DID delivery constraints","api":"GET /dids/{did}/delivery-constraints","playground":"none","href":"/api-reference/directory/dids/get-delivery-constraints"},{"title":"Set DID delivery constraints","api":"PUT /dids/{did}/delivery-constraints","playground":"none","href":"/api-reference/directory/dids/set-delivery-constraints"}]},{"group":"Aliases","pages":[{"title":"Add an alias","api":"POST /dids/{did}/aliases","playground":"none","href":"/api-reference/directory/aliases/add-alias"},{"title":"Update an alias","api":"PATCH /dids/{did}/aliases/{oldAlias}","playground":"none","href":"/api-reference/directory/aliases/update-alias"},{"title":"Remove an alias","api":"DELETE /dids/{did}/aliases/{alias}","playground":"none","href":"/api-reference/directory/aliases/remove-alias"}]},{"group":"Personas","pages":[{"title":"Create a Persona DNS challenge","api":"POST /personas/{persona}/dns-challenges","playground":"none","href":"/api-reference/directory/personas/create-dns-challenge"},{"title":"Verify a Persona DNS challenge","api":"POST /personas/{persona}/dns-challenges/{challenge_id}/verify","playground":"none","href":"/api-reference/directory/personas/verify-dns-challenge"},{"title":"Submit a Persona registration or renewal","api":"PUT /personas/{persona}","playground":"none","href":"/api-reference/directory/personas/put"},{"title":"Prepare a single-label Persona","api":"POST /personas/{persona}/named/prepare","playground":"none","href":"/api-reference/directory/personas/prepare-named"},{"title":"Register a single-label Persona","api":"PUT /personas/{persona}/named","playground":"none","href":"/api-reference/directory/personas/register-named"},{"title":"Get a Persona","api":"GET /personas/{persona}","playground":"none","href":"/api-reference/directory/personas/get"},{"title":"Get Persona nonces","api":"GET /personas/{persona}/nonces","playground":"none","href":"/api-reference/directory/personas/get-nonces"},{"title":"Read a Persona operator nonce","api":"GET /persona-operators/{did}/nonce","playground":"none","href":"/api-reference/directory/personas/get-operator-nonce"},{"title":"Recover a domain Persona","api":"POST /personas/{persona}/recovery/challenges","playground":"none","href":"/api-reference/directory/personas/recovery"},{"title":"Create a Persona transfer DNS challenge","api":"POST /personas/{persona}/transfer/dns-challenges","playground":"none","href":"/api-reference/directory/personas/create-transfer-challenge"},{"title":"Verify a Persona transfer challenge","api":"POST /personas/{persona}/transfer/dns-challenges/{challenge_id}/verify","playground":"none","href":"/api-reference/directory/personas/verify-transfer-challenge"},{"title":"Prepare a Persona transfer","api":"POST /personas/{persona}/transfer/dns-challenges/{challenge_id}/prepare","playground":"none","href":"/api-reference/directory/personas/prepare-transfer"},{"title":"Transfer a Persona operator","api":"PUT /personas/{persona}/operator","playground":"none","href":"/api-reference/directory/personas/transfer-operator"},{"title":"Rotate Persona controllers","api":"PUT /personas/{persona}/controllers","playground":"none","href":"/api-reference/directory/personas/rotate-controllers"},{"title":"Set Persona delivery constraints","api":"PUT /personas/{persona}/delivery-constraints","playground":"none","href":"/api-reference/directory/personas/set-delivery-constraints"},{"title":"Revoke a Persona","api":"DELETE /personas/{persona}","playground":"none","href":"/api-reference/directory/personas/delete"}]},{"group":"DID documents","pages":[{"title":"Add verification method","api":"POST /dids/{did}/document/verification-methods","playground":"none","href":"/api-reference/directory/document/add-verification-method"},{"title":"Update verification method","api":"PUT /dids/{did}/document/verification-methods/{methodId}","playground":"none","href":"/api-reference/directory/document/update-verification-method"},{"title":"Remove verification method","api":"DELETE /dids/{did}/document/verification-methods/{methodId}","playground":"none","href":"/api-reference/directory/document/remove-verification-method"},{"title":"Add authentication method","api":"POST /dids/{did}/document/authentication","playground":"none","href":"/api-reference/directory/document/add-authentication"},{"title":"Remove authentication method","api":"DELETE /dids/{did}/document/authentication/{methodId}","playground":"none","href":"/api-reference/directory/document/remove-authentication"},{"title":"Add key agreement","api":"POST /dids/{did}/document/key-agreements","playground":"none","href":"/api-reference/directory/document/add-key-agreement"},{"title":"Update key agreement","api":"PUT /dids/{did}/document/key-agreements/{keyAgreementId}","playground":"none","href":"/api-reference/directory/document/update-key-agreement"},{"title":"Remove key agreement","api":"DELETE /dids/{did}/document/key-agreements/{keyAgreementId}","playground":"none","href":"/api-reference/directory/document/remove-key-agreement"},{"title":"Add a DID service","api":"POST /dids/{did}/document/services","playground":"none","href":"/api-reference/directory/document/add-service"},{"title":"Update a DID service","api":"PUT /dids/{did}/document/services/{serviceId}","playground":"none","href":"/api-reference/directory/document/update-service"},{"title":"Remove a DID service","api":"DELETE /dids/{did}/document/services/{serviceId}","playground":"none","href":"/api-reference/directory/document/remove-service"},{"title":"Update the root public key","api":"PUT /dids/{did}/root-pubkey","playground":"none","href":"/api-reference/directory/document/update-root-key"}]},{"group":"Delivery policies","pages":[{"title":"Resolve a delivery policy","api":"POST /delivery-policies/v4/resolve","playground":"none","href":"/api-reference/directory/policies/resolve"},{"title":"Get a DID delivery policy","api":"GET /delivery-policies/dids/{did}","playground":"none","href":"/api-reference/directory/policies/get-did"},{"title":"Set a DID delivery policy","playground":"none","href":"/api-reference/directory/policies/set-did"},{"title":"Delete a DID delivery policy","playground":"none","href":"/api-reference/directory/policies/delete-did"},{"title":"Get a Persona delivery policy","api":"GET /delivery-policies/personas/{persona}","playground":"none","href":"/api-reference/directory/policies/get-persona"},{"title":"Set a Persona delivery policy","playground":"none","href":"/api-reference/directory/policies/set-persona"},{"title":"Delete a Persona delivery policy","playground":"none","href":"/api-reference/directory/policies/delete-persona"},{"title":"Manage a policy document","playground":"none","href":"/api-reference/directory/policies/v3"}]},{"group":"Applications","pages":[{"title":"Get an application","api":"GET /applications/{applicationId}","playground":"none","href":"/api-reference/directory/applications/get"},{"title":"Prepare Application registration","api":"POST /applications/{applicationId}/registration/prepare","playground":"none","href":"/api-reference/directory/applications/prepare-registration"},{"title":"Submit Application registration","api":"PUT /applications/{applicationId}/registration","playground":"none","href":"/api-reference/directory/applications/register"},{"title":"Prepare Application authorization","api":"POST /applications/{applicationId}/authorization/prepare","playground":"none","href":"/api-reference/directory/applications/prepare-authorization"},{"title":"Submit Application authorization","api":"PUT /applications/{applicationId}/authorization","playground":"none","href":"/api-reference/directory/applications/authorize"},{"title":"Read an Application policy","playground":"none","href":"/api-reference/directory/applications/get-policy"}]}]},{"group":"Relay API","root":{"title":"OpenPayload Relay API","href":"/openpayload-relay-api"},"pages":[{"title":"Send an encrypted message","api":"POST /relay","playground":"none","href":"/api-reference/relay/send"},{"title":"Send to a path-bound recipient","api":"POST /relay/{recipientDid}","playground":"none","href":"/api-reference/relay/send-to-recipient"}]},{"group":"Cache API","root":{"title":"OpenPayload Cache API","href":"/openpayload-cache-api"},"pages":[{"title":"Store an encrypted message","api":"POST /cache/store","playground":"none","href":"/api-reference/cache/store"},{"title":"Get cached messages","api":"GET /cache/messages/{did}","playground":"none","href":"/api-reference/cache/get-messages"},{"title":"Summarize cached messages","api":"GET /cache/summary/{did}","playground":"none","href":"/api-reference/cache/get-summary"},{"title":"Get messages for a device","api":"GET /cache/messages/{did}/{deviceId}","playground":"none","href":"/api-reference/cache/get-device-messages"},{"title":"Get message chunks","api":"GET /cache/chunks/{did}/{messageGroupId}","playground":"none","href":"/api-reference/cache/get-chunks"},{"title":"Acknowledge cached messages","api":"POST /cache/ack","playground":"none","href":"/api-reference/cache/acknowledge"}]}]},"basePath":"","title":"What these APIs expose - OpenPayload Developer Network","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["10e4515597"],"chunks":["BannerMarkdown-Dlc3Qr3h.js","dist-D2J8knkn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-Dq9TQuNi.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js"]}