Sunbird RC
v1.0.0
v1.0.0
  • Learn
    • Introduction
    • Sunbird RC Overview
      • Why do we need Sunbird RC?
      • Core Capabilities
      • Core Registry Verbs
      • Workflows
      • What Sunbird RC is and what it's not? (WIP)
      • Possibilities
      • Demo Links
    • Technical Overview
      • High level architecture
      • Technical Specification Draft
      • Tech Stack and Requirements
    • Adopters
    • Roadmap
  • Use
    • Getting started
      • Pre-requisites
      • Installation Guide
        • Registry CLI
          • Setup A Registry Instance
        • Manual installation through docker-compose
        • Production setup through Helm
    • Developer's Guide
      • Configurations
        • Frontend Configurations
        • Frontend - Proxy configuration
        • Audit Configuration
        • Notifications Configuration
        • View Templates Configuration
      • Schema Setup
        • Introduction To Schemas
        • Creating Your Own Schemas
        • Schema Configuration
        • Create Schemas With Custom Password
      • Setup the Backend
      • Setup the Frontend
      • Backup and Restore
        • PostgreSQL
          • SQL Dump
          • File System Level Backup
          • Continuous Archiving and Point-in-Time Recovery (PITR)
        • Cassandra
          • Snapshot-based backup method
          • Incremental backup method
          • Data Restore
      • Generic Identity And Access Management
      • Metrics
      • Custom Keycloak Build
      • Custom QR Code design
      • VC Verification Module
    • Integrations
      • SSO with existing systems
      • Digilocker Meripehchaan SSO
      • Digilocker Integration
    • Release Notes
      • Latest Release - v1.0.0
    • Admin Portal
      • Login
      • Get Started
        • Create Schema
        • Attestation Workflows (WIP)
        • VC Template
          • Custom VC Template (WIP)
        • Ownership (WIP)
        • Publish (WIP)
      • Dashboard
  • API Reference
    • Registry
      • Using The APIs
      • 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
      • Revoke a Credential
      • 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
    • Metrics APIs
      • Get Count
      • Get Aggregates
    • Other APIs
      • Sign API
      • Verify API
      • Swagger JSON API
      • Health API
  • Reference Solutions for Functional Registries
    • Education
      • Education Ecosystem
        • Installation
      • Education Registries
        • Installation
    • Health Registries
      • Organ Registries
        • Frontend Setup
        • Backend Setup
        • User Guide
      • Health Facility Registry
    • Govt to Person (G2P)
  • Reference Solution for Digital Credentials
    • Certificate Issuance
      • Installation(WIP)
      • User Guide
    • Vaccination Platform
    • Unified Learners Passport (ULP)
      • ULP Capabilities
      • Example Scenario
      • Technical Components (WIP)
      • Demo/Sandbox Links (WIP)
      • Installation Guide (WIP)
        • Frontend Setup
        • Installation through docker-compose
        • Dummy records setup for refrence
    • eLocker
      • High Level Diagram
      • Installation (WIP)
        • Frontend Setup E-locker
      • User Guide
    • Skills & Work Credentials
  • Links
    • Source Code
    • Releases & Changelogs
    • Website
    • Roadmap
    • Reference links
    • Design
  • Community
    • Discussion Forum
    • Contributors
    • Contributing
    • Contribution Guidebook
    • Code of Conduct
    • Community Events
    • Status By Track
  • HELP
    • Roadmap
    • FAQs
    • Glossary
    • Guide to Electronic Registries and Verifiable Credentials
      • 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
      • Leveraging Existing data stores
    • External Open Source Software Attributions
Powered by GitBook

Copyright (c) 2023 EkStep Foundation under MIT License

On this page
Edit on GitHub
  1. Learn

Sunbird RC Overview

PreviousIntroductionNextWhy do we need Sunbird RC?

Last updated 10 months ago

What is Sunbird RC?

Video on "What is Sunbird RC?"

To understand Sunbird RC, listen to Dr Pramod Varma, CTO of EkStep foundation

Sunbird RC (Registry and Credentials) is a "low code" framework to enable organizations to rapidly build next generation electronic registries and verifiable credentials. Sunbird RC uses a set of configurations to rapidly build out registries, automatically generate CRUD (create/ read/ update/ delete) APIs without any coding, enable registry searches and access via open APIs, issue and manage verifiable credentials, manage user consent flows if required, manage attestation and verification flows, etc.

One of the most significant advantages of Sunbird RC is its privacy-preserving feature. Sunbird RC uses advanced cryptographic methods, such as digital signatures and encryption, to protect personally identifiable information (PII) and other sensitive data from unauthorized access or disclosure. This is critical in today's data-driven world, where data privacy and security are of paramount importance.

Another significant benefit of the Sunbird RC is its modular and configurable design. This feature allows implementers to tailor the platform to their specific needs and requirements, enabling them to use the platform efficiently and effectively. Sunbird RC also supports multiple languages and multi-cloud environments, making it easy to deploy and facilitate rapid roll-out.

Sunbird RC also offers observability features that allow users to monitor the health and performance of the system. Basic telemetry and analytics are provided, enabling users to detect any issues or anomalies through audit and logs.

Sunbird RC is designed to handle large volumes of data and concurrent users, with the ability to sync and update data asynchronously, ensuring that the platform can scale as the data grows. See the Sunbird RC in action page for examples of where and how Sunbird RC is currently used.

Features of Sunbird RC

1. Master Data Store: Use the registry as a master data store of actors (people, entities or things)

  • Vocabulary creation and modelling

  • Employ flexible schema to define entity attributes and validations using JSON, JSON-LD

  • Attach rules for data validation, lifecycle operations and relationships

2. Data operations: Issue data into, as well as read data from Registry

  • Secure API driven CRUD operations

  • Data operations via secure, open APIs for data publishing and access, data discovery and search

  • Key-value pair driven search, attribute search

3. Data protection: Encryption and data security

  • Data encryption and masking

  • Support for custom encryption services - open end points to replace the bundled in encryption services with services of the adopters choice

  • Audit trails and logging

4. Single source of truth: Employing the registry as a single source of truth for reliable data

  • Digital signatures for trust worthiness and non-repudiation

  • Open end points to replace the bundled in encryption services with services of the adopters choice

5. Business led Database choice: Ability to make a business led choice of database to the registry

  • Support for multiple databases employing out-of-the-box adapters for multiple DB support - including graphs DBs(Neo4j), RDBMS(Postgres)

Sunbird RC is listed as a global Digital Public Good (DPG) within the . Sunbird RC is the core engine within , a globally recognized DPG for vaccination and health credentialing. Sunbird RC is also part of India's massively adopted school education platform used at population scale.

This is an independently usable digital building block and is part of overall open-source initiative. Similar to various projects under Sunbird, this is also open sourced under MIT license and you are free to adopt for your purposes. We strongly encourage you to contribute back, participate in the community to help improve this project.

to learn more about electronic registries and verifiable credentials

Use the GitHub or to participate in the community and help improve. For feature requests and issues, use the . We also encourage you to help fix documentation and code by doing pull requests on the appropriate repos here.

“Copyright © 2021 EkStep Foundation. This work is licensed under a unless otherwise noted.”

Digital Public Good Alliance (DPGA) registry
DIVOC
DIKSHA
Sunbird
Click here
discussions board
use this invite to join Discord community channel
issue tracker
Creative Commons Attribution (CC-BY-4.0) International License
What is Sunbird RC? by Dr Pramod Varma