multipaz/org.multipaz.documenttype/TransactionType

TransactionType

abstract class TransactionType(val displayName: String, val identifier: String, attributes: List<MdocDataElement>, val kbJwtResponseClaimName: String = identifier, val mdocRequestInfoKeyName: String = identifier, val mdocResponseNamespace: String = identifier)

An object that represents a particular transaction data type.

All transaction types that are expected to be processed or rejected must be registered in a DocumentTypeRepository object. In OpenID4VP unregistered transaction types cause the whole request to be rejected. In ISO/IEC 18013-5:2021, unknown transaction types are not processed, which may or may not fail at verification time.

Parameters

displayName

human-readable transaction name

identifier

unique transaction type identifier, corresponds to the type property in transaction data in OpenID4VP; all TransactionType objects must have distinct identifiers.

attributes

describes attributes that this transaction type can/must contain

kbJwtResponseClaimName

if transaction processing results in any data, it will be inserted in key binding JWT using this claim name; all TransactionType objects must have distinct values.

mdocRequestInfoKeyName

key to use in requestInfo map in ISO/IEC 18013-5:2021 document request to represent this transaction data; all TransactionType objects must have distinct values.

mdocResponseNamespace

namespace to use in deviceSigned namespace map in ISO/IEC 18013-5:2021 response to represent transaction hash and transaction processing results; all TransactionType objects must have distinct values.

Constructors

TransactionType

constructor(displayName: String, identifier: String, attributes: List<MdocDataElement>, kbJwtResponseClaimName: String = identifier, mdocRequestInfoKeyName: String = identifier, mdocResponseNamespace: String = identifier)