Type alias VerifiableCredentialCreateOptions

VerifiableCredentialCreateOptions: {
    credentialSchema?: CredentialSchema;
    credentialStatus?: StatusList2021Entry;
    data: any;
    evidence?: any[];
    expirationDate?: string;
    issuanceDate?: string;
    issuer: string;
    subject: string;
    type?: string | string[];
}

Options for creating a verifiable credential.

Type declaration

  • Optional credentialSchema?: CredentialSchema

    The credential schema of the credential

  • Optional credentialStatus?: StatusList2021Entry

    The credential status lookup information.

  • data: any

    The credential data, as a generic type any.

  • Optional evidence?: any[]

    The evidence of the credential, as an array of any.

  • Optional expirationDate?: string

    The expiration date of the credential, as a string.

  • Optional issuanceDate?: string

    The issuance date of the credential, as a string.

  • issuer: string

    The issuer URI of the credential, as a string.

  • subject: string

    The subject URI of the credential, as a string.

  • Optional type?: string | string[]

    The type of the credential, can be a string or an array of strings.

Param: type

Optional. The type of the credential, can be a string or an array of strings.

Param: issuer

The issuer URI of the credential, as a string.

Param: subject

The subject URI of the credential, as a string.

Param: data

The credential data, as a generic type any.

Param: issuanceDate

Optional. The issuance date of the credential, as a string. Defaults to the current date if not specified.

Param: expirationDate

Optional. The expiration date of the credential, as a string.

Param: credentialStatus

Optional. The credential status lookup information to see if credential is revoked.

Param: credentialSchema

Optional. The credential schema of the credential.

Param: evidence

Optional. Evidence can be included by an issuer to provide the verifier with additional supporting information in a verifiable credential.