Sorcha Documentation
Comprehensive documentation for the Sorcha decentralised register platform.
Current Status: 100% MVD (Minimum Viable Deployment) | Detailed Status Report
Documentation by Audience
System Administrators
Deploy, configure, scale, and manage a Sorcha instance.
- System Admin Guide — Complete operations manual (prerequisites, installation, configuration, scaling, monitoring, troubleshooting)
Organization Administrators
Integrate your organization with a running Sorcha instance.
- Organization Integration Guide — Step-by-step with curl and C# examples
End Users
Set up your account using passkeys or social login.
- Public User Setup Guide — Registration, wallet linking, and self-service
Developers
Build on the Sorcha platform.
- API Documentation — Interactive Scalar API explorer at
http://localhost/openapi(when running locally) - Getting Started — Development environment setup
- Guides — Feature-specific integration guides
- Reference — Architecture, status, and specifications
AI Agents and Integrators
Machine-readable surfaces for AI agents, AI coding assistants, and integrators picking up the platform without prior context.
- Architecture — Entry-point overview: services, data flows, the discovery surface
- OpenID4VC / HAIP Integration — How Sorcha issues to and verifies from HAIP-conformant holder wallets
- Applicability — The four near-term regulatory-pull domains, each with a worked example
- Security Model — Selective disclosure, post-quantum posture, and honest gaps
- Quickstart — Agent-runnable setup against a clean Docker host
- MCP Server — Connecting an AI agent via the Model Context Protocol
llms-full.txt— Long-form machine-readable summarySTANDARDS.md(repo root) — Single source of truth for every standard the platform implementsllms.txt(repo root) — One-screen factual summary, llmstxt.org-conformingGET /.well-known/openapi.json+GET /.well-known/openapi.yaml— Aggregated OpenAPI 3.1 surfaceGET /.well-known/mcp.json— MCP server manifest
Getting Started
Setup guides, first-run configuration, and prerequisites.
| Guide | Description |
|---|---|
| Getting Started | Prerequisites, first run, service overview |
| Docker Quick Start | Start all services with Docker Compose |
| Docker Development Workflow | Rebuild, hot reload, and debug with Docker |
| First Run Setup | Bootstrap credentials and initial configuration |
| Bootstrap Credentials | Default credentials for development environments |
| Port Configuration | Complete port assignments for Docker, Aspire, and individual services |
| Infrastructure Setup | PostgreSQL, MongoDB, Redis deployment and configuration |
| Blueprint Quick Start | Create your first blueprint in 5 minutes |
| NuGet Setup | Package management and private feed configuration |
Guides
How-to guides for specific tasks, integrations, and workflows.
Authentication & Security
| Guide | Description |
|---|---|
| Authentication Setup | JWT Bearer configuration, delegation tokens, policies |
| JWT Configuration | Token lifetimes, signing keys, service-to-service auth |
Blueprints
| Guide | Description |
|---|---|
| Blueprint Format | JSON/YAML blueprint specification |
| Blueprint Architecture | 4-step execution pipeline: validate, calculate, route, disclose |
| JSON-LD Quick Reference | JSON-LD context usage in Sorcha models |
| JSON-LD Implementation | JSON-LD integration status and patterns |
| JSON-e Templates | Template language for dynamic payload generation |
| JSON Logic Guide | Conditional routing and calculation expressions |
Integration & Serialization
| Guide | Description |
|---|---|
| Integration Guide | SDK patterns, wallet integration, SignalR examples |
| Payload Serialization | Transaction serialization, Base64url encoding, hash computation |
Testing
| Guide | Description |
|---|---|
| Testing Guide | Test strategy, naming conventions, coverage targets |
| Peer Integration Tests | Peer Service integration test suite |
Deployment
| Guide | Description |
|---|---|
| Deployment | Production deployment guide |
| Azure Quick Start | Deploy to Azure Container Apps |
| Azure Database Setup | Azure PostgreSQL and MongoDB setup |
| Azure Custom Domain | Custom domain and SSL configuration |
Development
| Guide | Description |
|---|---|
| Claude Code Guidelines | AI-assisted development conventions |
| Troubleshooting | Common issues and solutions |
Reference
Architecture, API documentation, and technical specifications.
| Document | Description |
|---|---|
| API Documentation | Complete REST API reference for all services |
| Architecture Overview | High-level system architecture and service interactions |
| Project Structure | Solution layout and project organization |
| Development Status | Overall platform completion and recent updates |
| Security Requirements | Component placement rules, crypto isolation, threat model |
| OpenAPI Decisions | Scalar UI configuration and OpenAPI decisions |
Data & Transactions
| Document | Description |
|---|---|
| Blockchain Transaction Format | JSON-LD transaction model and DID URI addressing |
| Transaction Submission Flow | End-to-end transaction lifecycle |
| Data Persistence | Storage architecture: PostgreSQL, MongoDB, Redis |
Cryptography & Wallets
| Document | Description |
|---|---|
| Wallet Encryption | Key management and encryption provider architecture |
| Cryptography & Quantum Analysis | Post-quantum cryptography, ZK proofs, algorithm analysis |
Service Reference
| Document | Description |
|---|---|
| Validator Design | Validator Service architecture and design |
| Validator Quick Reference | Validator Service API cheat sheet |
| Architecture Decisions | ADRs (Architecture Decision Records) |
| Service Status Reports | Per-service detailed status |
AI Blueprint Design
| Document | Description |
|---|---|
| Blueprint Examples | Example blueprints for AI assistants |
| Blueprint Builder Prompt | System prompt for AI-powered blueprint design |
Archive
Historical implementation plans, session summaries, and completion reports are preserved in archive/.