Skip to content

Documentation about identity features and functionality on the cheqd network

License

Notifications You must be signed in to change notification settings

cheqd/product-docs

Repository files navigation

description layout
Dive into cheqd's product and identity functionality
title description tableOfContents outline pagination
visible
true
visible
true
visible
true
visible
true
visible
true

Product Overview

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.

Integrate with cheqd

cheqd maintains an array of products and 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 create cheqd DIDs, DID-Linked Resources, Status Lists, Trust Registries and Schemas, as well as use cheqd's Credential Payments model, with different levels of integration effort and flexibility.

There are three core ways of integrating and building with cheqd:

cheqd StudioLow complexityCustomers can easily integrate cheqd's identity functionality into their existing applications through hitting simple REST APIs using cheqd Studio. credential-service-image.pngstudio
Software Development Kits (SDKs)Moderate complexityTo have greater flexibility, customers can build identity solutions through a set of SDKs to meet different technical stacks and requirements.SDKs-image.pngunderstanding-sdks.md
Direct integration with ledger code (cheqd SDK)High complexityFor 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.pngadvanced.md

What functionality does cheqd offer?

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.

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
Build Trust Registries Create industry-leading trust registries, using chains of Verifiable Accreditations, to secure your identity ecosytem.trust-registries
Charge for CredentialsSetup encrypted Status Lists and other Resources with Payment Conditions to unlock, allowing issuers to set a price for verifying a Credential Status. payments
Issue Credentials and PresentationsFully W3C VC Data Model conformant Verifiable Credentials for establishing trust. Supporting JSON, JSON-LD, SD-JWT and AnonCreds through cheqd APIs and via cheqd's Partners.credentials
Create Status Lists on-ledgerSophisticated 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 ResourcesDigital resources, leveraging the cryptographic verifiability of DIDs and patterns of DID Core to anchor schemas, trust registries, status lists and more. did-linked-resources

Industry Standard DID Support

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 complexitySimple 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 complexityService 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

Get started with cheqd Studio

cheqd Studio 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 cheqd Studio in a few lines of code.

Under the hood, cheqd Studio utilises the Veramo SDK cheqd Plugin, providing the most feature complete set of functionality and tooling.

Get started with cheqd StudioClick here to start your journey with cheqd Studio, create your account and begin using cheqd's underlying functionality.studio

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.

Understanding the structure of cheqd's packages

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:

cheqd packages diagram

Get involved

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.

🙋 Find us elsewhere

Telegram Discord Twitter LinkedIn Slack Medium YouTube