Interface Credential

A Credential object describes a credential, similar to a passport, which is an issuable identity verifier that can be used as a prerequisite for other transactions

interface Credential {
    CredentialType: string;
    Expiration?: number;
    Flags: number | CredentialFlags;
    index: string;
    Issuer: string;
    IssuerNode: string;
    LedgerEntryType: "Credential";
    PreviousTxnID: string;
    PreviousTxnLgrSeq: number;
    Subject: string;
    SubjectNode: string;
    URI?: string;
}

Hierarchy

  • BaseLedgerEntry
  • HasPreviousTxnID
    • Credential

Properties

CredentialType Expiration? Flags index Issuer IssuerNode LedgerEntryType PreviousTxnID PreviousTxnLgrSeq Subject SubjectNode URI?

Properties

CredentialType

CredentialType: string

A hex-encoded value to identify the type of credential from the issuer.

OptionalExpiration

Expiration?: number

Credential expiration.

Flags

Flags: number | CredentialFlags

A bit-map of boolean flags

index

index: string

Issuer

Issuer: string

The issuer of the credential.

IssuerNode

IssuerNode: string

A hint indicating which page of the issuer's owner directory links to this object, in case the directory consists of multiple pages.

LedgerEntryType

LedgerEntryType: "Credential"

PreviousTxnID

PreviousTxnID: string

The identifying hash of the transaction that most recently modified this object.

PreviousTxnLgrSeq

PreviousTxnLgrSeq: number

The index of the ledger that contains the transaction that most recently modified this object.

Subject

Subject: string

The account that the credential is for.

SubjectNode

SubjectNode: string

A hint indicating which page of the subject's owner directory links to this object, in case the directory consists of multiple pages.

OptionalURI

URI?: string

Additional data about the credential (such as a link to the VC document).

Settings

Member Visibility

On This Page

Properties