Web5 SDK Documentation/web5.sdk.credentials/VerifiableCredential

VerifiableCredential

VerifiableCredential represents a digitally verifiable credential according to the W3C Verifiable Credentials Data Model.

It provides functionalities to sign, verify, and create credentials, offering a concise API to work with JWT representations of verifiable credentials and ensuring that the signatures and claims within those JWTs can be validated.

Types

Companion

object Companion

Properties

credentialSchema

val credentialSchema: CredentialSchema?

evidence

val evidence: List<Any>?

val issuer: String

val subject: String

val type: String

val vcDataModel: <Error class: unknown class>

The VcDataModel instance representing the core data model of a verifiable credential.

Functions

getFieldByJsonPath

fun getFieldByJsonPath(path: String): String?

Retrieves a field from a verifiable credential by its JSON path.

sign

fun sign(did: BearerDid, assertionMethodId: String? = null): String

Sign a verifiable credential using a specified decentralized identifier (did) with the private key that pairs with the public key identified by assertionMethodId.

toString

open override fun toString(): String

Converts the current object to its JSON representation.