# Sunbird RC ## RC Knowledge Base - [Welcome Aboard!](https://rc.sunbird.org/learn/welcome-aboard.md) - [Overview](https://rc.sunbird.org/learn/readme.md): Build live, reusable and trustworthy registries and verifiable credentials — with configuration, not code. - [Why do we need Sunbird RC?](https://rc.sunbird.org/learn/readme/why-do-we-need-sunbird-rc.md): Stand up trusted registries and verifiable credentials quickly — for any domain, at national scale. - [Core Capabilities](https://rc.sunbird.org/learn/readme/core-capabilities.md): What Sunbird RC can do out of the box — registries, verifiable credentials, verification and wallet interoperability. - [Workflows](https://rc.sunbird.org/learn/readme/workflows.md): How users, issuers, holders and verifiers move through Sunbird RC — from onboarding to verification. - [What Sunbird RC is and what it's not?](https://rc.sunbird.org/learn/readme/what-sunbird-rc-is-and-what-its-not-wip.md): Where Sunbird RC fits — and what you'll still need to build or bring yourself. - [Possibilities](https://rc.sunbird.org/learn/readme/possibilities.md): Ideas for what you can build with Sunbird RC across education, healthcare, government and employment. - [Adopters](https://rc.sunbird.org/learn/adopters.md): Sunbird RC has been leveraged to develop the following solutions: - [Getting started](https://rc.sunbird.org/use/getting-started.md) - [Pre-requisites](https://rc.sunbird.org/use/getting-started/developer-setup.md) - [Installation](https://rc.sunbird.org/use/getting-started/installation.md) - [Registry CLI](https://rc.sunbird.org/use/getting-started/installation/registry-cli.md) - [Docker Compose Setup](https://rc.sunbird.org/use/getting-started/installation/docker-compose-setup.md) - [Helm Setup](https://rc.sunbird.org/use/getting-started/installation/helm-setup.md) - [Credentialling Services setup (Dev / Docker / Helm)](https://rc.sunbird.org/use/getting-started/installation/credentialling-services-setup-dev-docker-helm.md) - [Developer Guide](https://rc.sunbird.org/use/developer-guide.md) - [Working with Source Code](https://rc.sunbird.org/use/developer-guide/working-with-source-code.md) - [Environment Variable Reference](https://rc.sunbird.org/use/developer-guide/environment-variable-reference.md) - [Configuration Reference](https://rc.sunbird.org/use/developer-guide/configuration-reference.md) - [Schema Setup](https://rc.sunbird.org/use/developer-guide/schema-setup.md) - [Introduction To Schemas](https://rc.sunbird.org/use/developer-guide/schema-setup/introduction-to-schemas.md) - [Creating Your Own Schemas](https://rc.sunbird.org/use/developer-guide/schema-setup/creating-your-own-schemas.md) - [Schema Configuration](https://rc.sunbird.org/use/developer-guide/schema-setup/schema-configuration.md) - [Create Schemas With Custom Password](https://rc.sunbird.org/use/developer-guide/schema-setup/create-schemas-with-custom-password.md) - [Setup Backend](https://rc.sunbird.org/use/developer-guide/setup-backend.md) - [Setup Frontend](https://rc.sunbird.org/use/developer-guide/setup-frontend.md) - [Backup and Restore](https://rc.sunbird.org/use/developer-guide/backup-and-restore.md) - [PostgreSQL](https://rc.sunbird.org/use/developer-guide/backup-and-restore/postgresql.md) - [Cassandra](https://rc.sunbird.org/use/developer-guide/backup-and-restore/cassandra.md) - [Generic IAM](https://rc.sunbird.org/use/developer-guide/generic-iam.md) - [Metrics](https://rc.sunbird.org/use/developer-guide/metrics.md) - [Custom Keycloak Build](https://rc.sunbird.org/use/developer-guide/custom-keycloak-build.md) - [~Custom QR Code design~](https://rc.sunbird.org/use/developer-guide/custom-qr-code-design.md) - [VC Verification Module](https://rc.sunbird.org/use/developer-guide/vc-verification-module.md) - [Integrations](https://rc.sunbird.org/use/integrations.md) - [SSO with existing systems](https://rc.sunbird.org/use/integrations/sso-with-existing-systems.md) - [Digilocker Meripehchaan SSO](https://rc.sunbird.org/use/integrations/digilocker-meripehchaan-sso.md) - [Digilocker Integration](https://rc.sunbird.org/use/integrations/digilocker-integration.md) - [Wallet Integration](https://rc.sunbird.org/use/integrations/wallet-integration.md) - [Connectors](https://rc.sunbird.org/use/connectors.md): Checkout the connectors here: - [~G2P Connect~](https://rc.sunbird.org/use/connectors/g2p-connect.md) - [OpenID for Verifiable Credentials (OID4VCI)](https://rc.sunbird.org/use/connectors/openid-for-verifiable-credentials-oid4vci.md) - [Releases](https://rc.sunbird.org/use/releases.md) - [Registry](https://rc.sunbird.org/use/releases/registry.md) - [v2.0.3](https://rc.sunbird.org/use/releases/registry/v2.0.3.md) - [v1.0.0](https://rc.sunbird.org/use/releases/registry/v1.0.0.md) - [Credentialling](https://rc.sunbird.org/use/releases/credentialing.md) - [v2.1.0 — Latest release](https://rc.sunbird.org/use/releases/credentialing/v2.1.0-latest-release.md) - [v2.0.3](https://rc.sunbird.org/use/releases/credentialing/v2.0.3.md) - [v2.0.0](https://rc.sunbird.org/use/releases/credentialing/v2.0.0.md) - [Discussion Forum](https://rc.sunbird.org/engage/discussions.md): We have multiple channels available for the community to discuss use cases, as for support from fellow community members & discuss existing features as well as brainstorm about new ones. - [Contributing](https://rc.sunbird.org/engage/contributing.md) - [Contribution Guidebook](https://rc.sunbird.org/engage/contribution-guidebook.md) - [Code of Conduct](https://rc.sunbird.org/engage/code-of-conduct.md) - [Roadmap](https://rc.sunbird.org/help/roadmap.md) - [FAQs](https://rc.sunbird.org/help/faqs.md) - [Glossary](https://rc.sunbird.org/help/terminology.md) - [Guide to Electronic Registries and Verifiable Credentials](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials.md) - [Verifiable Credentials](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials.md) - [What issues will Verifiable Credentials address?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-issues-will-verifiable-credentials-address.md) - [What are the key roles in Verifiable Credentials?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-key-roles-in-verifiable-credentials.md) - [What are the components of Verifiable Credentials?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-components-of-verifiable-credentials.md) - [What are the benefits of Verifiable Credentials?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-benefits-of-verifiable-credentials.md) - [Digital Credentials vs Verifiable Credentials](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/digital-credentials-vs-verifiable-credentials.md) - [QR code vs Verifiable QR code](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/qr-code-vs-verifiable-qr-code.md) - [Use Cases](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/use-cases.md) - [Electronic Registries](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries.md) - [Evolution of Electronic Registries](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/evolution-electronic-registries.md) - [What issues will Electronic Registries address?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/what-issues-will-electronic-registries-address.md) - [Benefits of Electronic Registries](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/benefits-of-electronic-registries.md) - [Registry vs Database](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/registry-vs-database.md) - [Design Principles](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/design-principles.md) - [Use Cases](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/use-cases.md) - [Leveraging Existing data stores](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/leveraging-existing-data-stores-directories.md): leverage existing trustworthy sources of data to accelerate registry implementation - [External Open Source Software Attributions](https://rc.sunbird.org/help/external-open-source-software-attributions.md) ## Registry - [High-Level architecture](https://rc.sunbird.org/registry/technical-overview/high-level-architecture.md): The microservices that make up the Sunbird RC registry, and what each one does. - [Technical Specification Draft](https://rc.sunbird.org/registry/technical-overview/technical-specification-draft.md): Terminology, schemas, configuration, attestation, enrolment, discovery and consent for the Sunbird RC registry. - [Tech Stack and Requirements](https://rc.sunbird.org/registry/technical-overview/infrastructure-requirements.md): Software versions and infrastructure needed to run the Sunbird RC registry. - [Schema](https://rc.sunbird.org/registry/api-reference/schema.md) - [Create Schema](https://rc.sunbird.org/registry/api-reference/schema/create-schema.md) - [Get Schema](https://rc.sunbird.org/registry/api-reference/schema/get-schema.md) - [Update Schema](https://rc.sunbird.org/registry/api-reference/schema/update-schema.md) - [Delete Schema](https://rc.sunbird.org/registry/api-reference/schema/delete-schema.md) - [Publish A Schema](https://rc.sunbird.org/registry/api-reference/schema/publish-a-schema.md) - [Registry](https://rc.sunbird.org/registry/api-reference/registry.md) - [Using The APIs](https://rc.sunbird.org/registry/api-reference/registry/using-the-apis.md) - [Create An Entity](https://rc.sunbird.org/registry/api-reference/registry/create-an-entity.md): To create an entity, we need to make the following HTTP request - [Invite An Entity](https://rc.sunbird.org/registry/api-reference/registry/invite-an-entity.md): To invite an entity, we need to make the following HTTP request - [Generate token](https://rc.sunbird.org/registry/api-reference/registry/authenticating-as-an-entity.md) - [Generate admin token](https://rc.sunbird.org/registry/api-reference/registry/generate-admin-token.md) - [Get An Entity](https://rc.sunbird.org/registry/api-reference/registry/get-an-entity.md): To get an entity created by the owner, we need to make the following HTTP request - [Get An Entity By Id](https://rc.sunbird.org/registry/api-reference/registry/get-an-entity-by-id.md): To get an entity, we need to make the following HTTP request - [Update An Entity](https://rc.sunbird.org/registry/api-reference/registry/update-an-entity.md): To update an entity, we need to make the following HTTP request - [Create A Property Of An Entity](https://rc.sunbird.org/registry/api-reference/registry/create-a-property-of-an-entity.md): To add property to an existing entity, we need to make the following HTTP request - [Update A Property Of An Entity](https://rc.sunbird.org/registry/api-reference/registry/update-a-property-of-an-entity.md): To update the property of an existing entity, we need to make the following HTTP request - [Revoke a Credential](https://rc.sunbird.org/registry/api-reference/registry/create-a-property-of-an-entity-1.md): To revoke an existing VC (Verifiable Credential) or an entity, we need to make the following HTTP request - [Delete An Entity](https://rc.sunbird.org/registry/api-reference/registry/delete-an-entity.md): To soft delete an entity, we need to make the following HTTP request - [Attestation API](https://rc.sunbird.org/registry/api-reference/attestation-api.md) - [Raise An Attestation](https://rc.sunbird.org/registry/api-reference/attestation-api/raise-an-attestation.md) - [Get Attestation Certificate](https://rc.sunbird.org/registry/api-reference/attestation-api/get-attestation-certificate.md) - [Claims API](https://rc.sunbird.org/registry/api-reference/claims-api.md) - [Get All Claims](https://rc.sunbird.org/registry/api-reference/claims-api/get-all-claims.md) - [Get Claim by ID](https://rc.sunbird.org/registry/api-reference/claims-api/get-claim-by-id.md) - [Attest A Claim](https://rc.sunbird.org/registry/api-reference/claims-api/attest-a-claim.md) - [Discovery API](https://rc.sunbird.org/registry/api-reference/discovery-api.md) - [Search An Entity](https://rc.sunbird.org/registry/api-reference/discovery-api/search-an-entity.md) - [File Storage API](https://rc.sunbird.org/registry/api-reference/file-storage-api.md) - [Upload A File](https://rc.sunbird.org/registry/api-reference/file-storage-api/upload-a-file.md) - [Get Uploaded File](https://rc.sunbird.org/registry/api-reference/file-storage-api/get-uploaded-file.md) - [Delete A File/ Multiple Files](https://rc.sunbird.org/registry/api-reference/file-storage-api/delete-a-file-multiple-files.md) - [Metrics APIs](https://rc.sunbird.org/registry/api-reference/metrics-apis.md) - [Get Count](https://rc.sunbird.org/registry/api-reference/metrics-apis/get-count.md) - [Get Aggregates](https://rc.sunbird.org/registry/api-reference/metrics-apis/get-aggregates.md) - [Other APIs](https://rc.sunbird.org/registry/api-reference/other-apis.md) - [Sign API](https://rc.sunbird.org/registry/api-reference/other-apis/sign-api.md) - [Verify API](https://rc.sunbird.org/registry/api-reference/other-apis/verify-api.md) - [Swagger JSON API](https://rc.sunbird.org/registry/api-reference/other-apis/swagger-json-api.md) - [Health API](https://rc.sunbird.org/registry/api-reference/other-apis/health-api.md) ## Credentials - [High-Level Architecture](https://rc.sunbird.org/credentials/technical-overview/high-level-architecture.md): The microservices behind Sunbird RC credentialling, and how identity, schema, issuance and verification flows work. - [Technical Specification Draft](https://rc.sunbird.org/credentials/technical-overview/technical-specification-draft.md): Data models, schemas, issuance, verification, revocation, DIDs and wallet protocols for Sunbird RC credentialling. - [Tech Stack and Requirements](https://rc.sunbird.org/credentials/technical-overview/tech-stack-and-requirements.md): Software versions needed to run Sunbird RC credentialling services. - [Identity Service APIs](https://rc.sunbird.org/credentials/api-reference/identity-service-apis.md) - [Credential Schema APIs](https://rc.sunbird.org/credentials/api-reference/credential-schema-apis.md) - [OID4VC Service API](https://rc.sunbird.org/credentials/api-reference/oid4vc-service-api.md) - [Credential Issuance APIs](https://rc.sunbird.org/credentials/api-reference/credential-issuance-apis.md) - [Other APIs](https://rc.sunbird.org/credentials/api-reference/other-apis.md) - [Sign API](https://rc.sunbird.org/credentials/api-reference/other-apis/sign-api.md) - [Verify API](https://rc.sunbird.org/credentials/api-reference/other-apis/verify-api.md) - [Swagger JSON API](https://rc.sunbird.org/credentials/api-reference/other-apis/swagger-json-api.md) - [Health API](https://rc.sunbird.org/credentials/api-reference/other-apis/health-api.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://rc.sunbird.org/learn/welcome-aboard.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.