SdJwtTypeMetadataClaimInformation

@Serializable
data class SdJwtTypeMetadataClaimInformation(val path: SdJwtTypeMetadataClaimInformationPath, val display: SdJwtTypeMetadataClaimInformationDisplayMetadataList? = null, val isMandatory: Boolean? = null, val selectiveDisclosureConstraints: SelectiveDisclosureConstraints? = null, val svgId: SvgContentPlaceholder? = null)(source)

4.6. Claim Metadata

The claims property is an array of objects that provides per-claim metadata. Each object identifies which claim or set of claims in the credential is being described (path), and can specify how that claim is presented to end users (display), whether it is required to be included by the Issuer (mandatory), whether it is selectively disclosable (sd), and, for SVG rendering, which placeholder refers to it (svg_id).

The array MAY contain an object for each claim that is supported by the type. Each object contains the following properties:

path: An array indicating the claim or claims that are being addressed, as described below. This property is REQUIRED.
display: An array containing display information for the claim or claims that are being addressed, as described in Section 4.6.2. This property is OPTIONAL.
mandatory: A boolean indicating that the claim must be present in the issued credential. This property is OPTIONAL.
 If omitted, the default value is false. See Section 4.6.3 for details.
sd: A string indicating whether the claim is selectively disclosable, as described in Section 4.6.4. This property is OPTIONAL.
svg_id: A string defining the ID of the claim for reference in the SVG template, as described in Section 4.5.1.2.2.
 The ID MUST be unique within the type metadata.
 It MUST consist of only alphanumeric characters and underscores and MUST NOT start with a digit. This property is OPTIONAL.

Constructors

Link copied to clipboard
constructor(path: SdJwtTypeMetadataClaimInformationPath, display: SdJwtTypeMetadataClaimInformationDisplayMetadataList? = null, isMandatory: Boolean? = null, selectiveDisclosureConstraints: SelectiveDisclosureConstraints? = null, svgId: SvgContentPlaceholder? = null)

Types

Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
@SerialName(value = "mandatory")
val isMandatory: Boolean?
Link copied to clipboard
@SerialName(value = "path")
val path: SdJwtTypeMetadataClaimInformationPath
Link copied to clipboard
Link copied to clipboard
@SerialName(value = "svg_id")
val svgId: SvgContentPlaceholder?

Functions

Link copied to clipboard

Considering this to be the claim information of the parent type, these are the semantics for inheritance.