Skip to main content

ICredentialStatusVerifier interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This interface defines a plugin that can check the status of a Verifiable Credential.

This is used for the discovery of information about the current status of a verifiable credential, such as whether it is suspended or revoked. The precise contents of the credential status information is determined by the specific credentialStatus type definition, and varies depending on factors such as whether it is simple to implement or if it is privacy-enhancing.

The result provided by implementations of this plugin depend on whether the implementation of the StatusMethod is available.

Signature:

export interface ICredentialStatusVerifier extends IPluginMethodMap

Extends: IPluginMethodMap

Methods

MethodDescription
checkCredentialStatus(args, context)(BETA) Checks the status of a Verifiable Credential.