Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperauth.dev/llms.txt

Use this file to discover all available pages before exploring further.

Registers a DID after the identifier has been verified. For non-handle channels, an attestation object must be present and is validated against the ATTESTATION_SIGNING_KEY before the DO call is made.

Request body

FieldTypeRequiredDescription
credentialIdstringYesWebAuthn credential ID
identifierstringYesRegistration identifier (also accepts handle or name)
channelstringYesChannel type
didstringYesDID to register
txHashstringYesTransaction hash of the on-chain registration
blockNumbernumberNoBlock number of the transaction
smartAccountstringNoSmart account address
attestationVerificationAttestationNoRequired for non-handle channels

Response (200)

{ "ok": true, "identifier": "alice", "channel": "handle", "txHash": "0x..." }

Errors

CodeerrorCondition
400"Missing required fields: credentialId, identifier, channel, did, txHash"Field absent
403"attestation_invalid"Attestation signature invalid
403"attestation_mismatch"Attestation identifier/channel does not match request
409"credential_already_registered"Credential ID already in registered_dids