Reference Documentation
Welcome to the Hyperledger Identus reference documentation. This section provides comprehensive technical references, API specifications, and architectural decision records to support your development with Identus.
What You'll Find Here
📚 SDKs
Detailed API documentation for Identus SDKs across multiple platforms:
- TypeScript SDK - Full TypeScript SDK reference with plugins for AnonCreds, DIDComm, DIF, OEA, and OIDC
- Swift SDK - Native iOS SDK documentation
- Kotlin Multiplatform SDK - Cross-platform Kotlin SDK reference
🔌 Cloud Agent API
OpenAPI specification and interactive documentation for the Identus Cloud Agent API. The Cloud Agent facilitates:
- DID (Decentralized Identifiers) management
- Verifiable credential issuance and verification
- Secure DIDComm messaging
- Connection management
- Multi-tenancy support
📋 Specifications
A comprehensive overview of supported standards and protocols across the Identus platform, including:
- W3C DID and Verifiable Credentials specifications
- DIDComm v2 protocols
- AnonCreds support
- OpenID for Verifiable Credentials
- Status and support tracking for all implemented specifications
🔗 PRISM DID Method
The official PRISM DID Method specification, detailing the did:prism method implementation for Cardano-based decentralized identifiers.
🏗️ Architectural Decision Records (ADRs)
Documentation of key architectural decisions made during the development of Hyperledger Identus. ADRs provide:
- Context - The circumstances and forces at play when decisions were made
- Decision - The architectural choice and its rationale
- Consequences - Expected outcomes and trade-offs
ADRs help developers understand the "why" behind technical choices and maintain consistency across the platform.
Quick Links
Contributing
Found an issue or want to improve the documentation? Contributions are welcome! Visit our GitHub repository to get involved.