mDocs Holder SDK/global.mattr.mobilecredential.holder.issuance.dto

Package-level declarations

Types

@Serializable

data class Claim(val name: String, val namespace: String)

Represents a claim available in an OfferedCredential.

@Serializable

data class DiscoveredCredentialOffer(val issuer: String, val credentials: List<OfferedCredential>, val transactionCode: TransactionCode? = null)

You can display the data from this object to the user to get their consent for credentials retrieval. It is recommended to do this before downloading and saving the credentials using the retrieveCredentials function.

MobileCredentialRequest

@Serializable

data class MobileCredentialRequest( val docType: DocType, val namespaces: NameSpaces, val verifierAuthenticationResult: VerifierAuthenticationResult? = null)

Represents a request for presentation of mobile credentials.

OfferedCredential

@Serializable

data class OfferedCredential(val doctype: String, val claims: List<Claim>, val name: String?, scope: String)

Represents an offered credential available for retrieval.

RequestParameters

@Serializable

data class RequestParameters(val loginHint: String?, val prompt: String?)

Represents UI hints for request authentication.

RetrieveCredentialError

@Serializable(with = RetrieveCredentialError.Companion::class)

enum RetrieveCredentialError : Enum<RetrieveCredentialError>

RetrieveCredentialResult

@Serializable

data class RetrieveCredentialResult(val docType: String, val credentialId: String?, val error: RetrieveCredentialError?)

Represents a result of a mobile credential retrieval over OpenID4VCI.

VerifierAuthenticationFailureType

@Serializable(with = VerifierAuthenticationFailureTypeSerializer::class)

enum VerifierAuthenticationFailureType : Enum<VerifierAuthenticationFailureType>

VerifierAuthenticationResult

@Serializable(with = VerifierAuthenticationResultSerializer::class)

sealed class VerifierAuthenticationResult

Represents the result of verifier authentication as per ISO 18013-5 section 9.1.4.

VerifierInfo

@Serializable

data class VerifierInfo(val commonName: String, val trustedVerifierCertificateId: String)

Contains details about the trusted root certificate that was used to successfully complete verifier authentication.