SUMMARY.md

Table of contents

Learn

• Introduction
• Verifiable Credentials
  • What issues will Verifiable Credentials address?
  • What are the key roles in Verifiable Credentials?
  • What are the components of Verifiable Credentials?
  • What are the benefits of Verifiable Credentials?
  • Digital Credentials vs Verifiable Credentials
  • QR code vs Verifiable QR code
  • Use Cases
• Electronic Registries
  • Evolution of Electronic Registries
  • What issues will Electronic Registries address?
  • Benefits of Electronic Registries
  • Registry vs Database
  • Design Principles
  • Use Cases
• Sunbird RC Overview
  • Core Registry Verbs
  • Why do we need Sunbird RC?
  • What Sunbird RC is and what it's not? (WIP)
  • Core Capabilities
  • Technical Specification Draft
  • Workflows
  • High level architecture
  • Sunbird RC in action
    • Implementations
    • Possibilities
• Roadmap

Use

• Technical Requirements
• Schema Configuration
• Setup the Backend
• Setup the Frontend
• Leveraging Existing data stores
• SSO with existing systems
  • Digilocker Meripehchaan SSO

Developer Documentation

• Installation Guide
• Setup A Registry Instance
• Introduction To Schemas
• Creating Your Own Schemas
• Using The APIs
• Admin Portal
  • Login
  • Get Started
    • Create Schema
    • Attestation Workflows (WIP)
    • VC Template
      • Custom VC Template (WIP)
    • Ownership (WIP)
    • Publish (WIP)
  • Dashboard
• Configuration
• Developer Setup
• VC Verification Module
• Audit Configuration
• Custom Keycloak Build
• Metrics

API Reference

• Registry
  • Create An Entity
  • Invite An Entity
  • Generate token
  • Generate admin token
  • Get An Entity
  • Get An Entity By Id
  • Update An Entity
  • Create A Property Of An Entity
  • Update A Property Of An Entity
  • Delete An Entity
• Schema
  • Create Schema
  • Get Schema
  • Update Schema
  • Delete Schema
  • Publish A Schema
• Attestation API
  • Raise An Attestation
  • Get Attestation Certificate
• Claims API
  • Get All Claims
  • Get Claim by ID
  • Attest A Claim
• Discovery API
  • Search An Entity
• File Storage API
  • Upload A File
  • Get Uploaded File
  • Delete A File/ Multiple Files
• Bulk Issuance API
  • Get Sample Template
  • Upload CSV
  • Get all uploaded Files
  • Download a Report File
• Other APIs
  • Sign API
  • Verify API
  • Swagger JSON API
  • Health API

Reference Solutions

• Education
  • Education Ecosystem
    • Setup
  • Education Registries
    • Installation
• Organ Registries
• Certificate Issuance
  • Portal User Guide
• ELocker
• Vaccination Platform
• Skills & Work Credentials

Links

• Source Code
• Releases & Changelogs
• Website
• Roadmap
• Reference links
• Design

Community

• Discussion Forum
• Contributing
• Contribution Guidebook
• Code of Conduct
• Community Events
• Status By Track

HELP

• FAQs
• Glossary