Introduction

The Verifiable Credentials Client SDK is a powerful tool for managing verifiable credentials. It simplifies several key processes, making it easier to work with these credentials.

You can download the SDK from here.

The SDK assists with the following processes:

• Verification: The SDK provides a straightforward method to verify any given credential.

• Presentation: By inputting a user’s wallet address, the SDK allows you to retrieve all credentials issued to that address. It also provides a filtering option for easy navigation through the credentials.

• Decryption: In case of encrypted credentials, the SDK enables you to decrypt a credential for a specific user interacting with the lit protocol.

Generate a client-side-api-key from the Crossmint console: Go to the Developers -> API Keys tab, click on New API Key in the Client-side keys section, and select the scopes credentials.read and credentials.decrypt.

import { CrossmintAPI } from "@crossmint/verifiable-credentials";

CrossmintAPI.init("<api_key>");

​

SDK Reference Table of Contents

​

Classes

• ContractMetadataService
• CredentialService
• CrossmintDecrypt
• CrossmintMetamaskDecrypt
• Lit
• WalletAuthService

​

Interfaces

• Collection
• CredentialFilter
• CredentialMetadata
• CredentialsCollection
• EncryptedVerifiableCredential
• VCNFT
• VerifiableCredential
• VerifiableCredentialEncryption

​

Type Aliases

• ChainRPCConfig
• VCChain
• VerifiableCredentialType

​

Variables

• VCChain
• crossmintAPI
• crossmintRetrievalProcedure
• ipfsRetrievalProcedure

​

Functions

• getCredentialNFTFromLocator
• getCredentialNfts
• isCredentialType
• isEncryptedVerifiableCredential
• isVcChain
• isVerifiableCredential
• verifyCredential

​

Enumerations

• VerifiableCredentialEncryptionType