Typescript types for the W3C Verifiable Credentials Data Model, DID Core, cryptosuites, etc.
If you're implementing the Verifiable Credential specification in Typescript, chances are that you're using a type definition for VerifiableCredentials and VerifiablePresentations. Many VC-related projects (Sphereon's Veramo, LEF's LearnCard, Transmute's Verifiable Data) include the type definitions in their monorepos.
We saw a niche for a standalone library that exported just the type definitions, hence this repository.
See W3C Verifiable Credentials Data Model specification.
Inspired by / incorporates elements of other VC Typescript libraries:
- https://github.com/Sphereon-Opensource/veramo (
/packages/core/src/types/vc-data-model.ts) - https://github.com/transmute-industries/verifiable-data (
/packages/vc.js/src/types/) - https://github.com/learningeconomy/LearnCard (
/packages/learn-card-core/src/types/) - Existing type definitions in DCC libraries (in
learner-credential-walletand others)
The version numbers of this npm module are meant to mirror the version numbers of the Verifiable Credentials Data Model specification. Developers are encouraged to specify which VC Data model version they're using. For example, currently, the VC DM 1.1 is the stable version:
"dependencies": {
"@digitalcredentials/vc-data-model": "^1.1.0"
}
However, the VC DM 2.0 Working group is currently developing the second version of the specification (which will likely make breaking changes). So, in the future:
"dependencies": {
"@digitalcredentials/ssi": "^3.0.0"
}
- Node.js 16+ is recommended.
To install via NPM:
npm install @digitalcredentials/ssi
To install locally (for development):
git clone https://github.com/digitalcredentials/ssi.git
cd ssi
npm install
import { IVerifiableCredential, IVerifiablePresentation } from '@digitalcredentials/ssi'
// for example, in an Express route definition:
const vp = req.body.presentation as IVerifiablePresentationIVerifiableCredentialandIVerifiablePresentationIOpenBadgeCredentialV3(for OBv3 VCs)IDidCoreDocumentand its children,IDidDocument_v1_0andIDidDocument_v1_1IKeyPairand its children, such asIVerificationKeyPair2020andIKeyAgreementKeyPair2020ISigner- ... others (see individual exports in
/src)
PRs accepted.
If editing the Readme, please conform to the standard-readme specification.
MIT License © 2022-2025 Digital Credentials Consortium.