Skip to main content

Getting Started with UbID Docs

UbID is a decentralized identity ecosystem designed to support secure digital identity, verifiable credentials, encrypted user-controlled vaults, credential issuance, credential verification, and secure recovery mechanisms.

This documentation site provides technical and functional guidance for the main UbID components:

  • Issuer: the component responsible for issuing verifiable credentials.
  • Holder / Vault: the user-controlled application that stores credentials, encrypted keys, local identity data, and recovery material.
  • Verifier: the component responsible for validating credentials and presentations.
  • Recovery Cloud / Gateway: the recovery infrastructure used to protect account continuity without exposing private keys.
  • Trust and cryptographic infrastructure: the technical layer supporting encryption, holder binding, passkeys, biometrics, SD-JWT VC, OpenID4VCI, OpenID4VP, and future DIDComm interoperability.

Documentation goals​

The goal of this documentation is to provide a clear technical reference for developers, integrators, auditors, and institutional stakeholders who need to understand or implement UbID components.

This documentation should help readers:

  • Understand the UbID architecture.
  • Deploy and configure issuer and verifier services.
  • Understand the holder/vault model.
  • Review credential formats and protocols.
  • Understand recovery patterns.
  • Review security and cryptographic design decisions.
  • Follow implementation and contribution standards.

Local development​

This documentation is built with Docusaurus.

Install dependencies:

yarn install