SupportedCredentialFormat

@Serializable
data class SupportedCredentialFormat(source)

OID4VCI: Object that describes specifics of the Credential that the Credential Issuer supports issuance of. This object contains a list of name/value pairs, where each name is a unique identifier of the supported Credential being described. This identifier is used in the Credential Offer to communicate to the Wallet which Credential is being offered.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@SerialName(value = "credential_definition")
val credentialDefinition: SupportedCredentialFormatDefinition? = null

OID4VCI: W3C VC: REQUIRED.

Link copied to clipboard
@SerialName(value = "display")
val display: Set<DisplayProperties>? = null

OID4VCI: OPTIONAL. Array of objects, where each object contains the display properties of the supported Credential for a certain language. Below is a non-exhaustive list of parameters that MAY be included.

Link copied to clipboard
@SerialName(value = "doctype")
val docType: String? = null

OID4VCI: ISO mDL: REQUIRED. String identifying the Credential type, as defined in (ISO.18013-5).

Link copied to clipboard
@SerialName(value = "format")
val format: CredentialFormatEnum

OID4VCI: REQUIRED. A JSON string identifying the format of this credential, e.g. jwt_vc_json or ldp_vc. Depending on the format value, the object contains further elements defining the type and (optionally) particular claims the credential MAY contain, and information how to display the credential.

Link copied to clipboard
@SerialName(value = "order")
val order: Set<String>? = null

OID4VCI: ISO mDL: OPTIONAL. W3C VC: OPTIONAL.

Link copied to clipboard
@SerialName(value = "scope")
val scope: String? = null

OID4VCI: OPTIONAL. A JSON string identifying the scope value that this Credential Issuer supports for this particular Credential. The value can be the same across multiple credential_configurations_supported objects. The Authorization Server MUST be able to uniquely identify the Credential Issuer based on the scope value. The Wallet can use this value in the Authorization Request. Scope values in this Credential Issuer metadata MAY duplicate those in the scopes_supported parameter of the Authorization Server.

Link copied to clipboard
@SerialName(value = "vct")
val sdJwtVcType: String? = null

OID4VCI: IETF SD-JWT VC: REQUIRED. String designating the type of a Credential, as defined in (I-D.ietf-oauth-sd-jwt-vc).

Link copied to clipboard
@SerialName(value = "cryptographic_binding_methods_supported")
val supportedBindingMethods: Set<String>? = null

OID4VCI: OPTIONAL. Array of case-sensitive strings that identify how the Credential is bound to the identifier of the End-User who possesses the Credential as defined in Section 7.1. Support for keys in JWK format (RFC7517) is indicated by the value jwk. Support for keys expressed as a COSE Key object (RFC8152) (for example, used in ISO.18013-5) is indicated by the value cose_key. When Cryptographic Binding Method is a DID, valid values MUST be a did: prefix followed by a method-name using a syntax as defined in Section 3.1 of DID-Core, but without a : and method-specific-id. For example, support for the DID method with a method-name "example" would be represented by did:example.

Link copied to clipboard
@SerialName(value = "proof_types_supported")
val supportedProofTypes: Map<String, CredentialRequestProofSupported>? = null

OID4VCI: OPTIONAL. Object that describes specifics of the key proof(s) that the Credential Issuer supports. This object contains a list of name/value pairs, where each name is a unique identifier of the supported proof type(s).

Link copied to clipboard
@SerialName(value = "credential_signing_alg_values_supported")
val supportedSigningAlgorithms: Set<String>? = null

OID4VCI: OPTIONAL. Array of case sensitive strings that identify the algorithms that the Issuer uses to sign the issued Credential. Algorithm names used are determined by the Credential format and are defined in Appendix A.