| description | layout | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Dive into cheqd's product and identity functionality |
|
cheqd is a purpose-built network for decentralised identity. This documentation site provides technical and product information for all identity features & functionality on the cheqd network.
cheqd maintains an array of packages with varying levels of integration complexity to allow its partners and customers to have a variety of ways of plugging into cheqd's identity functionality. Via these different packages, customers and partners can issue and verify Verifiable Credentials, create cheqd DIDs, DID-Linked Resources, Status Lists and Schemas with different levels of integration effort and flexibility.
There are three core ways of integrating and building with cheqd:
| Credential Service (SaaS) | Low complexity | Customers can easily integrate cheqd's identity functionality into their existing applications through hitting simple REST APIs using Credential Service. | credential-service-image.png | get-started |
| Software Development Kits (SDKs) | Moderate complexity | To have greater flexibility, customers can build identity solutions through a set of SDKs to meet different technical stacks and requirements. | SDKs-image.png | understanding-sdks.md |
| Direct integration with ledger code (cheqd SDK) | High complexity | For full customisability and flexibility, the cheqd SDK plugs directly into cheqd Network and is responsible for communicating with the core ledger code. | cheqd-sdk-image.png | advanced.md |
cheqd's identity functionality is fully standards compliant, ensuring interoperability and no vendor lock-in. cheqd's tooling and different product offerings offer a variety of building blocks for any Trusted Data Market.
| Issue Credentials and Presentations | Fully W3C VC Data Model conformant Verifiable Credentials for establishing trust and demonstrating decentralised reputation. Supporting JSON, JSON-LD and AnonCreds. | credentials |
| Charge for Credentials | Setup encrypted Status Lists and other Resources with Payment Conditions to unlock, allowing issuers to set a price for verifying a Credential Status. | payments |
| Create Decentralised Identifiers (DIDs) | Fully W3C DID Core conformant Digital identifiers for establishing a root of trust in a given ecosystem. Utilising cheqd's DID method (did:cheqd). | dids |
| Create Status Lists on-ledger | Sophisticated and first-of-its-kind cryptographically verifiable on-ledger files for establishing Trust and Reputability in a Verifiable Credential, utilising DID-Linked Resources. | status-lists |
| Create DID-Linked Resources | Digital resources, leveraging the cryptographic verifiability of DIDs and patterns of DID Core to anchor schemas, trust registries, status lists and more. | did-linked-resources |
If you want to utilise cheqd DIDs or DID-Linked Resources within applications without a specific cheqd integration, you can incorporate a Universal Registrar or Universal Resolver driver to support did:cheqd alongside other commonly adopted DID methods.
| DID Registrar (and Universal Registrar Driver) | Low complexity | Simple setup for building cheqd DIDs into existing applications using REST APIs, building into the Universal Registrar. | did-registrar |
| DID Resolver (and Universal Resolver Driver) | Low complexity | Service for resolving cheqd DIDs and DID URLs. Feature complete with query-based DID URL dereferencing. Full integration and driver within the Universal Resolver. | did-resolver |
Credential Service is the easiest route to get started with cheqd's identity functionality, or for testing with very low integration effort. Using simple REST APIs, it is possible to integrate Credential Service in a few lines of code, or issue Credentials within a few clicks.
Under the hood, Credential Service utilises the Veramo SDK cheqd Plugin, providing the most feature complete set of functionality and tooling.
| 🟢 Get started with Credential Service | Click here to start your journey with Credential Service, create your account and begin issuing Credentials. | get-started |
If you'd rather build a deeper integration using a Software Development Kit (SDK) or lower level package, we've created a simple diagram to show how our packages are structured below.
One of cheqd's primary motives is to make itself accessible to the widest set of identity applications possible. To accomplish this, cheqd has built a flexible set of packages and tooling to accommodate its identity capabilities into a broad set of external SDKs and applications.
These can be represented through the visual below:
.png)
cheqd SDK packages diagram
The cheqd Community Slack is our primary chat channel for the open-source community, software developers, and node operators.
Please reach out to us there for discussions, help, and feedback on the project.
