Offer

@Serializable
data class Offer(val credentialIssuer: String, val issuerName: String? = null, val issuerLogo: Logo? = null, val grant: Offer.Grant, val txCode: Offer.TxCode? = null, val credentials: List<Offer.Credential>)(source)

What a Credential Offer offers.

Constructors

Link copied to clipboard
constructor(credentialIssuer: String, issuerName: String? = null, issuerLogo: Logo? = null, grant: Offer.Grant, txCode: Offer.TxCode? = null, credentials: List<Offer.Credential>)

Types

Link copied to clipboard
@Serializable
data class Credential(val configurationID: String, val format: String, val vct: String? = null, val doctype: String? = null, val name: String? = null, val description: String? = null, val logo: Logo? = null, val backgroundColor: String? = null, val textColor: String? = null)

One offered credential.

Link copied to clipboard
@Serializable
enum Grant : Enum<Offer.Grant>

How the holder is authorized.

Link copied to clipboard
@Serializable
data class TxCode(val inputMode: String? = null, val length: Int? = null, val description: String? = null)

The PIN a pre-authorized code offer asks for, as the issuer describes it.

Properties

Link copied to clipboard
@SerialName(value = "credential_issuer")
val credentialIssuer: String

The issuer's identifier, an https URL.

Link copied to clipboard

The offered credentials.

Link copied to clipboard

The grant the offer names.

Link copied to clipboard
@SerialName(value = "issuer_logo")
val issuerLogo: Logo?

The issuer's logo.

Link copied to clipboard
@SerialName(value = "issuer_name")
val issuerName: String?

The issuer's name, in the holder's language.

Link copied to clipboard
@SerialName(value = "tx_code")
val txCode: Offer.TxCode?

The PIN to ask the holder for, for a pre-authorized code offer.