OpenID4VCIClaimDescription

data class OpenID4VCIClaimDescription(val path: JsonArray, val display: List<OpenID4VCIClaimDisplay>)

Describes a claim in a credential, as provided by the issuer of the credential.

This corresponds to a claims description object in the claims array of a credential configuration in OpenID4VCI issuer metadata, see Appendix B.2 of OpenID for Verifiable Credential Issuance 1.0.

Constructors

Link copied to clipboard
constructor(path: JsonArray, display: List<OpenID4VCIClaimDisplay>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

the display properties of the claim, typically one per language.

Link copied to clipboard
val path: JsonArray

the claims path pointer identifying the claim. For ISO mdoc credentials this is the namespace followed by the data element name, for SD-JWT VC credentials it is the path to the claim. Each element is a string, a non-negative integer or null.

Functions

Link copied to clipboard
fun getDisplayName(locales: List<String>): String?

Gets the display name of the claim in the language which best matches locales.