vck/at.asitplus.wallet.eupidsdjwt/EuPidCredentialSdJwt

EuPidCredentialSdJwt

@Serializable

data class EuPidCredentialSdJwt(val familyName: String, val givenName: String, val birthDate: LocalDate, val familyNameBirth: String? = null, val givenNameBirth: String? = null, val placeOfBirth: PlaceOfBirthSdJwt, val address: AddressSdJwt? = null, val sex: IsoIec5218Gender? = null, val nationalities: Set<String>? = null, val issuanceDate: LocalDateOrInstant? = null, val expiryDate: LocalDateOrInstant, val issuingAuthority: String, val documentNumber: String? = null, val issuingCountry: String, val issuingJurisdiction: String? = null, val personalAdministrativeNumber: String? = null, val portrait: ByteArray? = null, val email: String? = null, val phoneNumber: String? = null, val trustAnchor: String? = null)(source)

PID scheme according to PID Rulebook from 2025-10-02.

Constructors

constructor(familyName: String, givenName: String, birthDate: LocalDate, familyNameBirth: String? = null, givenNameBirth: String? = null, placeOfBirth: PlaceOfBirthSdJwt, address: AddressSdJwt? = null, sex: IsoIec5218Gender? = null, nationalities: Set<String>? = null, issuanceDate: LocalDateOrInstant? = null, expiryDate: LocalDateOrInstant, issuingAuthority: String, documentNumber: String? = null, issuingCountry: String, issuingJurisdiction: String? = null, personalAdministrativeNumber: String? = null, portrait: ByteArray? = null, email: String? = null, phoneNumber: String? = null, trustAnchor: String? = null)

Properties

address

@SerialName(value = "address")

val address: AddressSdJwt?

Address.

birthDate

@SerialName(value = "birthdate")

@Serializable(with = LocalDateIso8601Serializer::class)

val birthDate: LocalDate

Day, month, and year on which the user to whom the person identification data relates was born.

documentNumber

@SerialName(value = "document_number")

val documentNumber: String?

A number for the PID, assigned by the PID Provider.

@SerialName(value = "email")

val email: String?

Electronic mail address of the user to whom the person identification data relates, in conformance with RFC 5322.

expiryDate

@SerialName(value = "date_of_expiry")

val expiryDate: LocalDateOrInstant

Date (and if possible time) when the person identification data will expire.

familyName

@SerialName(value = "family_name")

val familyName: String

Current last name(s) or surname(s) of the user to whom the person identification data relates.

familyNameBirth

@SerialName(value = "birth_family_name")

val familyNameBirth: String?

Last name(s) or surname(s) of the User to whom the person identification data relates at the time of birth.

givenName

@SerialName(value = "given_name")

val givenName: String

Current first name(s), including middle name(s), of the PID User.

givenNameBirth

@SerialName(value = "birth_given_name")

val givenNameBirth: String?

First name(s), including middle name(s), of the User to whom the person identification data relates at the time of birth.

issuanceDate

@SerialName(value = "date_of_issuance")

val issuanceDate: LocalDateOrInstant?

Date (and if possible time) when the person identification data was issued and/or the administrative validity period of the person identification data began.

issuingAuthority

@SerialName(value = "issuing_authority")

val issuingAuthority: String

Name of the administrative authority that has issued this PID instance, or the ISO 3166 Alpha-2 country code of the respective Member State if there is no separate authority authorized to issue PIDs.

issuingCountry

@SerialName(value = "issuing_country")

val issuingCountry: String

Alpha-2 country code, as defined in ISO 3166-1, of the PID Provider's country or territory.

issuingJurisdiction

@SerialName(value = "issuing_jurisdiction")

val issuingJurisdiction: String?

Country subdivision code of the jurisdiction that issued the PID, as defined in ISO 3166-2:2020, Clause 8. The first part of the code SHALL be the same as the value for issuingCountry.

nationalities

@SerialName(value = "nationalities")

val nationalities: Set<String>?

Array of Alpha-2 country code as specified in ISO 3166-1, representing the nationality of the PID User.

personalAdministrativeNumber

@SerialName(value = "personal_administrative_number")

val personalAdministrativeNumber: String?

A value assigned to the natural person that is unique among all personal administrative numbers issued by the provider of person identification data. Where Member States opt to include this attribute, they shall describe in their electronic identification schemes under which the person identification data is issued, the policy that they apply to the values of this attribute, including, where applicable, specific conditions for the processing of this value.

phoneNumber

@SerialName(value = "phone_number")

val phoneNumber: String?

Mobile telephone number of the User to whom the person identification data relates, starting with the '+' symbol as the international code prefix and the country code, followed by numbers only.

placeOfBirth

@SerialName(value = "place_of_birth")

val placeOfBirth: PlaceOfBirthSdJwt

Place of birth.

portrait

@SerialName(value = "picture")

val portrait: ByteArray?

Facial image of the wallet user compliant with ISO 19794-5 or ISO 39794 specifications.

sex

@SerialName(value = "sex")

val sex: IsoIec5218Gender?

See IsoIec5218Gender.

trustAnchor

@SerialName(value = "trust_anchor")

val trustAnchor: String?

This attribute indicates at least the URL at which a machine-readable version of the trust anchor to be used for verifying the PID can be found or looked up

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String