API Reference

This section provides detailed documentation of the core classes, constructors, methods, and options available in the DID Connect SDK. Understanding these components is key to building robust and secure authentication flows for your application.
The SDK is primarily composed of two main classes that work together to handle the entire DID Connect workflow:
WalletAuthenticator: The low-level engine that handles the creation, signing, and verification of cryptographic messages exchanged between your application and the user's DID Wallet.
WalletHandlers: A high-level utility for Express.js servers that sets up the necessary API endpoints and manages the session state, simplifying the integration process.
Explore the detailed documentation for each class to understand their full capabilities.
WalletAuthenticator
The core class for creating and verifying authentication requests and responses. It manages cryptographic operations, claim generation, and communication with the DID Wallet.
WalletHandlers
A convenience class for integrating DID Connect into an Express.js or similar web server framework. It automates the setup of required API endpoints and manages the session lifecycle.
We recommend starting with the WalletAuthenticator documentation to grasp the fundamental concepts of the protocol before moving on to the WalletHandlers for web integration.

Overview

Getting Started

Guides

Claims Reference

API Reference

Examples

API Reference

WalletAuthenticator

WalletHandlers

Encryption Key Claim

WalletAuthenticator