MdocVerifiedPresentation

data class MdocVerifiedPresentation(val documentSignerCertChain: X509CertChain, val issuerSignedClaims: List<MdocClaim>, val deviceSignedClaims: List<MdocClaim>, val zkpUsed: Boolean, val validFrom: Instant?, val validUntil: Instant?, val signedAt: Instant?, val expectedUpdate: Instant?, val docType: String, val transactionResponses: Map<String, Map<String, DataItem>>?, val vpTokenIdentifier: String?, val transactionData: List<TransactionData<*>>, val revocationStatus: RevocationStatus? = null, val zkSystemSpecId: String? = null, val docRequestIds: List<Int>? = null, val keyBound: Boolean = true) : VerifiedPresentation

A verified presentation of an ISO mdoc credential.

Note that producing this presentation does not check X.509 CRL/OCSP revocation on documentSignerCertChain or MSO revocation via revocationStatus; the caller is expected to verify issuer trust, certificate revocation, and revocationStatus (e.g., via RevocationStatus.check) separately when required.

Constructors

Link copied to clipboard
constructor(documentSignerCertChain: X509CertChain, issuerSignedClaims: List<MdocClaim>, deviceSignedClaims: List<MdocClaim>, zkpUsed: Boolean, validFrom: Instant?, validUntil: Instant?, signedAt: Instant?, expectedUpdate: Instant?, docType: String, transactionResponses: Map<String, Map<String, DataItem>>?, vpTokenIdentifier: String?, transactionData: List<TransactionData<*>>, revocationStatus: RevocationStatus? = null, zkSystemSpecId: String? = null, docRequestIds: List<Int>? = null, keyBound: Boolean = true)

Properties

Link copied to clipboard
open override val deviceSignedClaims: List<MdocClaim>

the claims signed by the device.

Link copied to clipboard
open override val docRequestIds: List<Int>?

optional list of DocRequest indices in DeviceRequest.docRequests that this presentation responds to when ISO/IEC 18013-5 is in use, or null if not specified.

Link copied to clipboard

the ISO mdoc document type, e.g. org.iso.18013.5.1.mDL.

Link copied to clipboard

the certificate chain of the document signer key or null if not known.

Link copied to clipboard
open override val expectedUpdate: Instant?

the point in time an update is expected, if any.

Link copied to clipboard
open override val issuerSignedClaims: List<MdocClaim>

the claims signed by the issuer.

Link copied to clipboard
open override val keyBound: Boolean

true if the presentation was cryptographically bound to a key (or verified via a Zero-Knowledge Proof), false if keyless.

Link copied to clipboard

the revocation status, if present.

Link copied to clipboard
open override val signedAt: Instant?

the point in time this was signed.

Link copied to clipboard
open override val transactionData: List<TransactionData<*>>

transaction data that were sent in the presentation request, acknowledged in the response (with the acknowledgement verified).

Link copied to clipboard

response to transaction data associated with the presented credential as a map keyed by TransactionType.identifier, and with the value is a map with an entry for each item in the transaction response data, including "transaction_data_hash".

Link copied to clipboard
open override val validFrom: Instant?

the point in time this presentation is valid from.

Link copied to clipboard
open override val validUntil: Instant?

the point in time this presentation is valid until.

Link copied to clipboard
open override val vpTokenIdentifier: String?

identifier for this document in OpenID4VP response, only set when OpenID4VP is in use

Link copied to clipboard
open override val zkpUsed: Boolean

if true, a Zero-Knowledge Proof was used to verify the credential.

Link copied to clipboard

the ZK system spec identifier used when zkpUsed is true, or null.