openid-data-classes/at.asitplus.openid/ClaimDescription

ClaimDescription

@Serializable
data class ClaimDescription(val path: List<String>, val mandatory: Boolean? = null, val display: Set<DisplayProperties>? = null)(source)

Constructors

Link copied to clipboard
constructor(path: List<String>, mandatory: Boolean? = null, display: Set<DisplayProperties>? = null)

Properties

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

OID4VCI: OPTIONAL. Array of objects, where each object contains display properties of a certain claim in the Credential for a certain language.

Link copied to clipboard
@SerialName(value = "mandatory")
val mandatory: Boolean? = null

OID4VCI: OPTIONAL. Boolean which, when set to true, indicates that the Credential Issuer will always include this claim in the issued Credential. If set to false, the claim is not included in the issued Credential if the wallet did not request the inclusion of the claim, and/or if the Credential Issuer chose to not include the claim. If the mandatory parameter is omitted, the default value is false.

Link copied to clipboard
@SerialName(value = "path")
val path: List<String>

OID4VCI: REQUIRED. The value MUST be a non-empty array representing a claims path pointer that specifies the path to a claim within the credential, as defined in Appendix C.