The Directory submits register_with_document_proof as an ownerless DID-key operation. It does not attach a
chain account owner, even if the server environment contains an account seed.
Registration creates the first public record for an identity. First send did, root_pubkey, did_document and optional alias to POST /register-did/prepare. Preparation validates the public fields without submitting a transaction and returns request plus payload_to_sign as 0x-prefixed hex.Decode that hex into binary bytes and sign them locally with the Ed25519 private key corresponding to the root public key. Add the Base64 signature to the returned request and submit it to this endpoint. The proof binds the DID, normalized alias, root key and exact encoded document; changing any of them requires preparing and signing again. See the Quickstart for copyable examples.This flow requires the Directory and runtime supporting v2 DID proofs (runtime spec 125). The former UTF-8 DID|timestamp signature is rejected. Preparation defaults to a five-minute lifetime; prepare and sign again if it expires.
Request
string
required
The canonical did:<platform>:<Base58Address> identifier. The platform must contain 1–32 lowercase ASCII letters or digits. The address must contain 16–96 Bitcoin Base58 characters. The identifier must exactly match did_document.id.
string
required
The returned v2:0:<valid-until-epoch-milliseconds> signing token. It must be unexpired and no more than one hour ahead; copy it unchanged from preparation.
string
required
Base64 Ed25519 signature over the decoded binary payload_to_sign bytes.
object
required
The public DID document.
string
The root Ed25519 public key. If omitted, the Directory selects a supported Ed25519 verification method controlled by this DID. Supply it explicitly for documents containing only application-specific key suites.
string
An optional lowercase public alias. It cannot contain @ or #.
202 means the Directory accepted the registration for processing. It does not confirm final settlement.
Poll Get registration status until the state is confirmed.
Understand the complete document
Learn how each key and service entry participates in encryption, Relay delivery, and Cache retrieval.
Straight to the point
POST /register-didContent-Type: application/json
Prepare: POST /register-did/prepare with unsigned public registration input
Signed bytes: binary hex-decoded payload_to_sign from preparation
Submit: returned request plus Base64 signature, unchanged before expiry
Signature: Ed25519, Base64 encoded
Private key: never submitted
Confirmation: poll GET /registration-status/{did}
{"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":"api-reference/directory/dids/register","slug":"/api-reference/directory/dids/register","pageMetadata":{"title":"Register a DID","description":"Submit a new public DID record.","api":"POST /register-did","playground":"none","href":"/api-reference/directory/dids/register"},"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: \"Submit a new public DID record.\"\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`,ul:`ul`,..._provideComponents(),...props.components},{Card,CodeBlock,Heading,Note,ParamField,ResponseField}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Submit a new public DID record.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The Directory submits `,_jsx(_components.code,{children:`register_with_document_proof`}),` as an ownerless DID-key operation. It does not attach a\nchain account owner, even if the server environment contains an account seed.`]})}),`\n`,_jsxs(_components.p,{children:[`Registration creates the first public record for an identity. First send `,_jsx(_components.code,{children:`did`}),`, `,_jsx(_components.code,{children:`root_pubkey`}),`, `,_jsx(_components.code,{children:`did_document`}),` and optional `,_jsx(_components.code,{children:`alias`}),` to `,_jsx(_components.code,{children:`POST /register-did/prepare`}),`. Preparation validates the public fields without submitting a transaction and returns `,_jsx(_components.code,{children:`request`}),` plus `,_jsx(_components.code,{children:`payload_to_sign`}),` as `,_jsx(_components.code,{children:`0x`}),`-prefixed hex.`]}),`\n`,_jsxs(_components.p,{children:[`Decode that hex into binary bytes and sign them locally with the Ed25519 private key corresponding to the root public key. Add the Base64 signature to the returned `,_jsx(_components.code,{children:`request`}),` and submit it to this endpoint. The proof binds the DID, normalized alias, root key and exact encoded document; changing any of them requires preparing and signing again. See the `,_jsx(_components.a,{href:`/quickstart#prepare-and-sign-registration`,children:`Quickstart`}),` for copyable examples.`]}),`\n`,_jsxs(_components.p,{children:[`This flow requires the Directory and runtime supporting v2 DID proofs (runtime spec 125). The former UTF-8 `,_jsx(_components.code,{children:`DID|timestamp`}),` signature is rejected. Preparation defaults to a five-minute lifetime; prepare and sign again if it expires.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(ParamField,{body:`did`,type:`string`,required:true,id:`param-did`,children:_jsxs(_components.p,{children:[`The canonical `,_jsx(_components.code,{children:`did:\u003cplatform>:\u003cBase58Address>`}),` identifier. The platform must contain 1–32 lowercase ASCII letters or digits. The address must contain 16–96 Bitcoin Base58 characters. The identifier must exactly match `,_jsx(_components.code,{children:`did_document.id`}),`.`]})}),`\n`,_jsx(ParamField,{body:`timestamp`,type:`string`,required:true,id:`param-timestamp`,children:_jsxs(_components.p,{children:[`The returned `,_jsx(_components.code,{children:`v2:0:\u003cvalid-until-epoch-milliseconds>`}),` signing token. It must be unexpired and no more than one hour ahead; copy it unchanged from preparation.`]})}),`\n`,_jsx(ParamField,{body:`signature`,type:`string`,required:true,id:`param-signature`,children:_jsxs(_components.p,{children:[`Base64 Ed25519 signature over the decoded binary `,_jsx(_components.code,{children:`payload_to_sign`}),` bytes.`]})}),`\n`,_jsx(ParamField,{body:`did_document`,type:`object`,required:true,id:`param-did-document`,children:_jsx(_components.p,{children:`The public DID document.`})}),`\n`,_jsx(ParamField,{body:`root_pubkey`,type:`string`,id:`param-root-pubkey`,children:_jsx(_components.p,{children:`The root Ed25519 public key. If omitted, the Directory selects a supported Ed25519 verification method controlled by this DID. Supply it explicitly for documents containing only application-specific key suites.`})}),`\n`,_jsx(ParamField,{body:`alias`,type:`string`,id:`param-alias`,children:_jsxs(_components.p,{children:[`An optional lowercase public alias. It cannot contain `,_jsx(_components.code,{children:`@`}),` or `,_jsx(_components.code,{children:`#`}),`.`]})}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status`,children:_jsx(_components.p,{children:`A human-readable registration status.`})}),`\n`,_jsx(ResponseField,{name:`registration_status`,type:`string`,required:true,id:`param-registration-status`,children:_jsx(_components.p,{children:`The public registration state.`})}),`\n`,_jsx(ResponseField,{name:`tx_id`,type:`string`,required:true,id:`param-tx-id`,children:_jsx(_components.p,{children:`The submitted transaction identifier.`})}),`\n`,_jsx(ResponseField,{name:`did`,type:`string`,required:true,id:`param-did-1`,children:_jsx(_components.p,{children:`The submitted DID.`})}),`\n`,_jsx(ResponseField,{name:`did_document`,type:`object`,required:true,id:`param-did-document-1`,children:_jsx(_components.p,{children:`The submitted public DID document.`})}),`\n`,`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`202`}),` means the Directory accepted the registration for processing. It does not confirm final settlement.\nPoll `,_jsx(_components.a,{href:`/api-reference/directory/dids/registration-status`,children:`Get registration status`}),` until the state is `,_jsx(_components.code,{children:`confirmed`}),`.`]})}),`\n`,_jsx(Card,{title:`Understand the complete document`,icon:`file-code`,href:`/concepts/complete-did-document`,children:_jsx(_components.p,{children:`Learn how each key and service entry participates in encryption, Relay delivery, and Cache retrieval.`})}),`\n`,_jsx(Heading,{level:`2`,id:`straight-to-the-point`,children:`Straight to the point`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`POST`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` /register-did`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Content-Type`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` application/json`})]}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Prepare: `,_jsx(_components.code,{children:`POST /register-did/prepare`}),` with unsigned public registration input`]}),`\n`,_jsxs(_components.li,{children:[`Signed bytes: binary hex-decoded `,_jsx(_components.code,{children:`payload_to_sign`}),` from preparation`]}),`\n`,_jsxs(_components.li,{children:[`Submit: returned `,_jsx(_components.code,{children:`request`}),` plus Base64 signature, unchanged before expiry`]}),`\n`,_jsx(_components.li,{children:`Signature: Ed25519, Base64 encoded`}),`\n`,_jsx(_components.li,{children:`Private key: never submitted`}),`\n`,_jsxs(_components.li,{children:[`Confirmation: poll `,_jsx(_components.code,{children:`GET /registration-status/{did}`})]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Register a DID","description":"Submit a new public DID record.","api":"POST /register-did","playground":"none","href":"/api-reference/directory/dids/register"}}},"mdxSourceWithNoJs":{"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`,ul:`ul`,..._provideComponents(),...props.components},{Card,CodeBlock,Heading,Note,ParamField,RequestExample,ResponseExample,ResponseField}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Submit a new public DID record.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The Directory submits `,_jsx(_components.code,{children:`register_with_document_proof`}),` as an ownerless DID-key operation. It does not attach a\nchain account owner, even if the server environment contains an account seed.`]})}),`\n`,_jsxs(_components.p,{children:[`Registration creates the first public record for an identity. First send `,_jsx(_components.code,{children:`did`}),`, `,_jsx(_components.code,{children:`root_pubkey`}),`, `,_jsx(_components.code,{children:`did_document`}),` and optional `,_jsx(_components.code,{children:`alias`}),` to `,_jsx(_components.code,{children:`POST /register-did/prepare`}),`. Preparation validates the public fields without submitting a transaction and returns `,_jsx(_components.code,{children:`request`}),` plus `,_jsx(_components.code,{children:`payload_to_sign`}),` as `,_jsx(_components.code,{children:`0x`}),`-prefixed hex.`]}),`\n`,_jsxs(_components.p,{children:[`Decode that hex into binary bytes and sign them locally with the Ed25519 private key corresponding to the root public key. Add the Base64 signature to the returned `,_jsx(_components.code,{children:`request`}),` and submit it to this endpoint. The proof binds the DID, normalized alias, root key and exact encoded document; changing any of them requires preparing and signing again. See the `,_jsx(_components.a,{href:`/quickstart#prepare-and-sign-registration`,children:`Quickstart`}),` for copyable examples.`]}),`\n`,_jsxs(_components.p,{children:[`This flow requires the Directory and runtime supporting v2 DID proofs (runtime spec 125). The former UTF-8 `,_jsx(_components.code,{children:`DID|timestamp`}),` signature is rejected. Preparation defaults to a five-minute lifetime; prepare and sign again if it expires.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(ParamField,{body:`did`,type:`string`,required:true,id:`param-did`,children:_jsxs(_components.p,{children:[`The canonical `,_jsx(_components.code,{children:`did:\u003cplatform>:\u003cBase58Address>`}),` identifier. The platform must contain 1–32 lowercase ASCII letters or digits. The address must contain 16–96 Bitcoin Base58 characters. The identifier must exactly match `,_jsx(_components.code,{children:`did_document.id`}),`.`]})}),`\n`,_jsx(ParamField,{body:`timestamp`,type:`string`,required:true,id:`param-timestamp`,children:_jsxs(_components.p,{children:[`The returned `,_jsx(_components.code,{children:`v2:0:\u003cvalid-until-epoch-milliseconds>`}),` signing token. It must be unexpired and no more than one hour ahead; copy it unchanged from preparation.`]})}),`\n`,_jsx(ParamField,{body:`signature`,type:`string`,required:true,id:`param-signature`,children:_jsxs(_components.p,{children:[`Base64 Ed25519 signature over the decoded binary `,_jsx(_components.code,{children:`payload_to_sign`}),` bytes.`]})}),`\n`,_jsx(ParamField,{body:`did_document`,type:`object`,required:true,id:`param-did-document`,children:_jsx(_components.p,{children:`The public DID document.`})}),`\n`,_jsx(ParamField,{body:`root_pubkey`,type:`string`,id:`param-root-pubkey`,children:_jsx(_components.p,{children:`The root Ed25519 public key. If omitted, the Directory selects a supported Ed25519 verification method controlled by this DID. Supply it explicitly for documents containing only application-specific key suites.`})}),`\n`,_jsx(ParamField,{body:`alias`,type:`string`,id:`param-alias`,children:_jsxs(_components.p,{children:[`An optional lowercase public alias. It cannot contain `,_jsx(_components.code,{children:`@`}),` or `,_jsx(_components.code,{children:`#`}),`.`]})}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`Request`,numberOfLines:`46`,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:`46`,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:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_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:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://directory.example.com/register-did\"`}),_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:` --header`}),_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:` --data`}),_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:` \"did\": \"did:openpayload:1111111111111111111111\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"timestamp\": \"v2:0:\u003cfuture-epoch-milliseconds-from-preparation>\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"signature\": \"\u003csignature>\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"root_pubkey\": \"z\u003ced25519-public-key>\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"did_document\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"id\": \"did:openpayload:1111111111111111111111\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"verificationMethod\": [`})}),`\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:` \"id\": \"did:openpayload:1111111111111111111111#keys-1\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"Ed25519VerificationKey2020\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"controller\": \"did:openpayload:1111111111111111111111\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"publicKeyMultibase\": \"z\u003ced25519-public-key>\"`})}),`\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:` \"authentication\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"did:openpayload:1111111111111111111111#keys-1\"`})}),`\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:` \"keyAgreement\": [`})}),`\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:` \"id\": \"did:openpayload:1111111111111111111111#x25519-1\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"X25519KeyAgreementKey2020\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"controller\": \"did:openpayload:1111111111111111111111\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"publicKeyMultibase\": \"z\u003cx25519-public-key>\"`})}),`\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:` \"service\": [`})}),`\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:` \"id\": \"did:openpayload:1111111111111111111111#relay\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"OpenPayloadRelayService\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"serviceEndpoint\": [\"https://relay.example.com\"]`})}),`\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:` \"id\": \"did:openpayload:1111111111111111111111#cache\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"OpenPayloadCacheService\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"serviceEndpoint\": [\"https://cache.example.com\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"authorization\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"did:openpayload:1111111111111111111111#keys-1\"`})}),`\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(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status`,children:_jsx(_components.p,{children:`A human-readable registration status.`})}),`\n`,_jsx(ResponseField,{name:`registration_status`,type:`string`,required:true,id:`param-registration-status`,children:_jsx(_components.p,{children:`The public registration state.`})}),`\n`,_jsx(ResponseField,{name:`tx_id`,type:`string`,required:true,id:`param-tx-id`,children:_jsx(_components.p,{children:`The submitted transaction identifier.`})}),`\n`,_jsx(ResponseField,{name:`did`,type:`string`,required:true,id:`param-did-1`,children:_jsx(_components.p,{children:`The submitted DID.`})}),`\n`,_jsx(ResponseField,{name:`did_document`,type:`object`,required:true,id:`param-did-document-1`,children:_jsx(_components.p,{children:`The submitted public DID document.`})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`202 Response`,numberOfLines:`43`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`43`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did registration pending\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"registration_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pending\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tx_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003ctransaction-id>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"did\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did:openpayload:1111111111111111111111\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"did_document\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did:openpayload:1111111111111111111111\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"verificationMethod\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did:openpayload:1111111111111111111111#keys-1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Ed25519VerificationKey2020\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"controller\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did:openpayload:1111111111111111111111\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"publicKeyMultibase\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"z\u003ced25519-public-key>\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"authentication\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"did:openpayload:1111111111111111111111#keys-1\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"keyAgreement\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did:openpayload:1111111111111111111111#x25519-1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"X25519KeyAgreementKey2020\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"controller\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did:openpayload:1111111111111111111111\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"publicKeyMultibase\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"z\u003cx25519-public-key>\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"service\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did:openpayload:1111111111111111111111#relay\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"OpenPayloadRelayService\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"serviceEndpoint\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://relay.example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"did:openpayload:1111111111111111111111#cache\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"OpenPayloadCacheService\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"serviceEndpoint\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://cache.example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"did:openpayload:1111111111111111111111#keys-1\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`202`}),` means the Directory accepted the registration for processing. It does not confirm final settlement.\nPoll `,_jsx(_components.a,{href:`/api-reference/directory/dids/registration-status`,children:`Get registration status`}),` until the state is `,_jsx(_components.code,{children:`confirmed`}),`.`]})}),`\n`,_jsx(Card,{title:`Understand the complete document`,icon:`file-code`,href:`/concepts/complete-did-document`,children:_jsx(_components.p,{children:`Learn how each key and service entry participates in encryption, Relay delivery, and Cache retrieval.`})}),`\n`,_jsx(Heading,{level:`2`,id:`straight-to-the-point`,children:`Straight to the point`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`POST`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` /register-did`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Content-Type`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` application/json`})]}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Prepare: `,_jsx(_components.code,{children:`POST /register-did/prepare`}),` with unsigned public registration input`]}),`\n`,_jsxs(_components.li,{children:[`Signed bytes: binary hex-decoded `,_jsx(_components.code,{children:`payload_to_sign`}),` from preparation`]}),`\n`,_jsxs(_components.li,{children:[`Submit: returned `,_jsx(_components.code,{children:`request`}),` plus Base64 signature, unchanged before expiry`]}),`\n`,_jsx(_components.li,{children:`Signature: Ed25519, Base64 encoded`}),`\n`,_jsx(_components.li,{children:`Private key: never submitted`}),`\n`,_jsxs(_components.li,{children:[`Confirmation: poll `,_jsx(_components.code,{children:`GET /registration-status/{did}`})]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Register a DID","description":"Submit a new public DID record.","api":"POST /register-did","playground":"none","href":"/api-reference/directory/dids/register"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Request","slug":"request","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Straight to the point","slug":"straight-to-the-point","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"Request","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"46\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://directory.example.com/register-did\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --data\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"did\": \"did:openpayload:1111111111111111111111\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"timestamp\": \"v2:0:\u0026#x3C;future-epoch-milliseconds-from-preparation>\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"signature\": \"\u0026#x3C;signature>\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"root_pubkey\": \"z\u0026#x3C;ed25519-public-key>\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"did_document\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"id\": \"did:openpayload:1111111111111111111111\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"verificationMethod\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"id\": \"did:openpayload:1111111111111111111111#keys-1\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"type\": \"Ed25519VerificationKey2020\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"controller\": \"did:openpayload:1111111111111111111111\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"publicKeyMultibase\": \"z\u0026#x3C;ed25519-public-key>\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"authentication\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"did:openpayload:1111111111111111111111#keys-1\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"keyAgreement\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"id\": \"did:openpayload:1111111111111111111111#x25519-1\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"type\": \"X25519KeyAgreementKey2020\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"controller\": \"did:openpayload:1111111111111111111111\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"publicKeyMultibase\": \"z\u0026#x3C;x25519-public-key>\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"service\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"id\": \"did:openpayload:1111111111111111111111#relay\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"type\": \"OpenPayloadRelayService\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"serviceEndpoint\": [\"https://relay.example.com\"]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"id\": \"did:openpayload:1111111111111111111111#cache\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"type\": \"OpenPayloadCacheService\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"serviceEndpoint\": [\"https://cache.example.com\"],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"authorization\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"did:openpayload:1111111111111111111111#keys-1\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">}'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"202 Response","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"43\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did registration pending\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"registration_status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"pending\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"tx_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u0026#x3C;transaction-id>\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"did\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did:openpayload:1111111111111111111111\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"did_document\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did:openpayload:1111111111111111111111\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"verificationMethod\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did:openpayload:1111111111111111111111#keys-1\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Ed25519VerificationKey2020\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"controller\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did:openpayload:1111111111111111111111\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"publicKeyMultibase\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"z\u0026#x3C;ed25519-public-key>\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"authentication\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"did:openpayload:1111111111111111111111#keys-1\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"keyAgreement\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did:openpayload:1111111111111111111111#x25519-1\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"X25519KeyAgreementKey2020\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"controller\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did:openpayload:1111111111111111111111\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"publicKeyMultibase\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"z\u0026#x3C;x25519-public-key>\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"service\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did:openpayload:1111111111111111111111#relay\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"OpenPayloadRelayService\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"serviceEndpoint\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://relay.example.com\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"did:openpayload:1111111111111111111111#cache\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"OpenPayloadCacheService\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"serviceEndpoint\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://cache.example.com\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"authorization\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"did:openpayload:1111111111111111111111#keys-1\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Register a DID","path":"/register-did","method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"did":[{"type":"string","description":"The canonical `did:\u003cplatform>:\u003cBase58Address>` identifier. The platform must contain 1–32 lowercase ASCII letters or digits. The address must contain 16–96 Bitcoin Base58 characters. The identifier must exactly match `did_document.id` .","required":true}],"timestamp":[{"type":"string","description":"The returned `v2:0:\u003cvalid-until-epoch-milliseconds>` signing token. It must be unexpired and no more than one hour ahead; copy it unchanged from preparation.","required":true}],"signature":[{"type":"string","description":"Base64 Ed25519 signature over the decoded binary `payload_to_sign` bytes.","required":true}],"did_document":[{"type":"object","properties":{},"description":"The public DID document.","required":true}],"root_pubkey":[{"type":"string","description":"The root Ed25519 public key. If omitted, the Directory selects a supported Ed25519 verification method controlled by this DID. Supply it explicitly for documents containing only application-specific key suites."}],"alias":[{"type":"string","description":"An optional lowercase public alias. It cannot contain `@` or `#` ."}]}}],"examples":{"example":{"value":{"did":"\u003cstring>","timestamp":"\u003cstring>","signature":"\u003cstring>","did_document":{},"root_pubkey":"\u003cstring>","alias":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"status":[{"type":"string","description":"A human-readable registration status.","required":true}],"registration_status":[{"type":"string","description":"The public registration state.","required":true}],"tx_id":[{"type":"string","description":"The submitted transaction identifier.","required":true}],"did":[{"type":"string","description":"The submitted DID.","required":true}],"did_document":[{"type":"object","properties":{},"description":"The submitted public DID document.","required":true}]}}],"examples":{"example":{"value":{"status":"\u003cstring>","registration_status":"\u003cstring>","tx_id":"\u003cstring>","did":"\u003cstring>","did_document":{}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"mandolare-llc","siteName":"OpenPayload Developer Network","title":"Register a DID - OpenPayload Developer Network","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T01:59:56.589Z","originalFileLocation":"api-reference/directory/dids/register.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=\"Submit a new public DID record.\">\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=\"Register a DID - OpenPayload Developer Network\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submit a new public DID record.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenPayload Developer Network\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openpayload.io/api-reference/directory/dids/register\">\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=DIDs\u0026amp;title=Register+a+DID\u0026amp;description=Submit+a+new+public+DID+record.\u0026amp;theme=e4ecf45cb997513f4d4cee95\u0026amp;signature=2bc65176ca829c79b9a40e0c37e001216d76e2595813cb8e67623a93da50034d\">\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=\"Register a DID - OpenPayload Developer Network\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submit a new public DID record.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mandolare-llc.mintlify.site/_mintlify/api/og/v2?division=DIDs\u0026amp;title=Register+a+DID\u0026amp;description=Submit+a+new+public+DID+record.\u0026amp;theme=e4ecf45cb997513f4d4cee95\u0026amp;signature=2bc65176ca829c79b9a40e0c37e001216d76e2595813cb8e67623a93da50034d\">\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/api-reference/directory/dids/register\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/directory/dids/register.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/api-reference/directory/dids/register#webpage\",\"url\":\"https://docs.openpayload.io/api-reference/directory/dids/register\",\"name\":\"Register a DID\",\"description\":\"Submit a new public DID record.\",\"dateModified\":\"2026-10-05T01:59:56.589Z\",\"isPartOf\":{\"@id\":\"https://docs.openpayload.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.openpayload.io/api-reference/directory/dids/register#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.openpayload.io/api-reference/directory/dids/register#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Directory API\",\"item\":\"https://docs.openpayload.io/openpayload-directory-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"DIDs\",\"item\":\"https://docs.openpayload.io/api-reference/directory/dids/resolve\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Register a DID\",\"item\":\"https://docs.openpayload.io/api-reference/directory/dids/register\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.openpayload.io/api-reference/directory/dids/register#apireference\",\"headline\":\"Register a DID\",\"name\":\"Register a DID\",\"description\":\"Submit a new public DID record.\",\"url\":\"https://docs.openpayload.io/api-reference/directory/dids/register\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openpayload.io/api-reference/directory/dids/register#webpage\"},\"dateModified\":\"2026-10-05T01:59:56.589Z\",\"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":"/api-reference/directory/dids/register.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","href":"/concepts/application-registry"},{"title":"What these APIs expose","href":"/concepts/public-api-boundary"},{"title":"Authorize a Directory update","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","description":"Look up the OpenPayload DID currently associated with a public 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","description":"Confirm a DID registration against the chain","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":"Register a DID - OpenPayload Developer Network","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff"],"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","OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js"]}