oid4vcwallet/dev.idfoundry.oid4vcwallet/CredentialSummary

CredentialSummary

@Serializable

data class CredentialSummary(val id: String, val credentialIssuer: String, val configurationID: String, val format: String, val vct: String? = null, val doctype: String? = null, val receivedAt: Instant, val holderKeyPresent: Boolean? = null, val display: CredentialDisplay? = null, val validUntil: Instant? = null, val status: CredentialStatus? = null, val copies: Int = 0, val copiesLeft: Int = 0, val refreshable: Boolean = false, val linkable: Boolean = false, val shownToVerifier: Boolean? = null, val linkableHere: Boolean? = null)(source)

A credential the wallet holds, as the app shows it.

Constructors

CredentialSummary

constructor(id: String, credentialIssuer: String, configurationID: String, format: String, vct: String? = null, doctype: String? = null, receivedAt: Instant, holderKeyPresent: Boolean? = null, display: CredentialDisplay? = null, validUntil: Instant? = null, status: CredentialStatus? = null, copies: Int = 0, copiesLeft: Int = 0, refreshable: Boolean = false, linkable: Boolean = false, shownToVerifier: Boolean? = null, linkableHere: Boolean? = null)

Properties

configurationID

@SerialName(value = "configuration_id")

val configurationID: String

The issuer's credential configuration it was issued under.

copies

val copies: Int

How many copies the wallet holds, each bound to its own key, and how many no Verifier has seen. Each presentation uses one of those; once none is left, presentations can be linked.

copiesLeft

@SerialName(value = "copies_left")

val copiesLeft: Int

How many copies no Verifier has seen.

credentialIssuer

@SerialName(value = "credential_issuer")

val credentialIssuer: String

The issuer's identifier, an https URL.

display

val display: CredentialDisplay?

How to show it, from the issuer's metadata when it was received.

doctype

val doctype: String?

An mdoc's document type.

format

val format: String

Its format: dc+sd-jwt or mso_mdoc.

holderKeyPresent

@SerialName(value = "holder_key_present")

val holderKeyPresent: Boolean?

Whether the key store still holds the credential's key: without it (restored to another device, say) it can't be presented. Set in Wallet.credentials and Wallet.credential.

val id: String

The credential's ID in the wallet.

linkable

val linkable: Boolean

Whether a copy has been presented to more than one Verifier, so those Verifiers could link the holder's presentations. Refreshing gives it copies no Verifier has seen.

linkableHere

@SerialName(value = "linkable_here")

val linkableHere: Boolean?

Whether presenting it to the Verifier asking would hand it a copy another Verifier has seen. Set only on a presentation's candidates.

receivedAt

@SerialName(value = "received_at")

@Serializable(with = InstantSerializer::class)

val receivedAt: Instant

When the wallet received it.

refreshable

val refreshable: Boolean

Whether its issuance kept a refresh token (WalletConfiguration.requestRefresh), so Wallet.refreshCredential can replace its copies. The Authorization Server may still refuse (WalletException.Code.reissueRequired).

shownToVerifier

@SerialName(value = "shown_to_verifier")

val shownToVerifier: Boolean?

Set only on a presentation's candidates (Presentation.queries): whether the Verifier asking has been shown this credential before, and whether presenting it now would hand it a copy another Verifier has seen.

status

val status: CredentialStatus?

Its revocation status, as last checked; null before any check.

validUntil

@SerialName(value = "valid_until")

@Serializable(with = InstantSerializer::class)

val validUntil: Instant?

When it expires, if it says.

vct

val vct: String?

An SD-JWT VC's type.

Functions

isExpired

fun isExpired(now: Instant = Instant.now()): Boolean

Whether it has expired by now.