mDocs Holder SDK/global.mattr.mobilecredential.common.dto

Package-level declarations

Types

CredentialError

@Serializable

data class CredentialError(val docType: DocType, val errorCode: ErrorCode)

Represents an error for a specific credential.

CredentialStatus

enum CredentialStatus : Enum<CredentialStatus>

Represents the revocation status of a credential

IssuerInfo

@Serializable

data class IssuerInfo(val commonName: String, val trustedIssuerCertificateId: String)

Contains information identifying the issuer of a mobile credential.

MobileCredential

@Serializable

data class MobileCredential(val id: String, val deviceKeyId: String, val verificationResult: MobileCredentialVerificationResult? = null, val issuerInfo: IssuerInfo, val docType: String, val validityInfo: MobileCredentialValidity, val statusInfo: StatusInfo, val claims: Map<String, Map<String, MobileCredentialElement>>, val branding: Branding? = null)

Represents an issued mobile credential.

MobileCredentialElement

@Serializable(with = MobileCredentialElement.Serializer::class)

sealed class MobileCredentialElement

Specifies the possible data types for elements or claims in a mobile credential.

MobileCredentialMetaData

@Serializable

data class MobileCredentialMetaData(val id: String, deviceKeyId: String, val issuerInfo: IssuerInfo, val docType: String, val validityInfo: MobileCredentialValidity, val statusInfo: StatusInfo, val claims: Map<String, Set<String>>, val branding: Branding? = null)

Represents an issued mobile credential.

MobileCredentialPresentation

@Serializable

data class MobileCredentialPresentation(val docType: DocType, val validityInfo: MobileCredentialValidity, val claimErrors: Map<NameSpace, Map<DataElementIdentifier, ErrorCode>>?, val claims: Map<NameSpace, Map<DataElementIdentifier, MobileCredentialElement>>?, val branding: Branding?, val issuerInfo: IssuerInfo?, val verificationResult: MobileCredentialVerificationResult, val statusInfo: StatusInfo?)

Represents a mobile credential presentation.

MobileCredentialRequest

@Serializable

data class MobileCredentialRequest(val docType: DocType, val namespaces: NameSpaces)

Represents a mobile credentials presentation request.

MobileCredentialResponse

@Serializable

data class MobileCredentialResponse(val credentials: List<MobileCredentialPresentation>?, val credentialErrors: List<CredentialError>?)

Represents a response to a mobile credentials presentation request.

MobileCredentialStatusCheckFailureType

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

enum MobileCredentialStatusCheckFailureType : Enum<MobileCredentialStatusCheckFailureType>

MobileCredentialValidity

@Serializable

data class MobileCredentialValidity(val validFrom: Instant, val validUntil: Instant)

Represents a mobile credential validity information. Note: The corresponding iOS SDK element is Validity.

MobileCredentialVerificationFailureType

@Serializable(with = MobileCredentialVerificationFailureTypeSerializer::class)

enum MobileCredentialVerificationFailureType : Enum<MobileCredentialVerificationFailureType>

MobileCredentialVerificationResult

@Serializable

data class MobileCredentialVerificationResult(val verified: Boolean, val failureType: MobileCredentialVerificationFailureType? = null)

Represents a mobile credential verification result.

StatusInfo

@Serializable

data class StatusInfo(var status: CredentialStatus, val nextUpdate: Instant? = null, val error: MobileCredentialStatusCheckFailureType? = null)

TrustedCertificate

@Serializable

data class TrustedCertificate(val id: String, val pem: String, val commonName: String, val verificationResult: TrustedCertificateVerificationResult? = null)

Represents a trusted certificate conforming to the IACA profile as per ISO 18013-5.

TrustedCertificateVerificationFailureType

@Serializable(with = TrustedCertificateVerificationFailureTypeSerializer::class)

enum TrustedCertificateVerificationFailureType : Enum<TrustedCertificateVerificationFailureType>

TrustedCertificateVerificationResult

@Serializable

data class TrustedCertificateVerificationResult(val verified: Boolean, val failureType: TrustedCertificateVerificationFailureType? = null)

Represents a trusted certificate verification result.

TrustedIssuerStatusListsCacheInfo

@Serializable

data class TrustedIssuerStatusListsCacheInfo(val nextUpdate: Instant?)

The result type of MobileCredentialVerifier.getTrustedIssuerStatusListsCacheInfo(). To keep the status lists updated, it is recommend to call MobileCredentialVerifier.updateTrustedIssuerStatusLists() before nextUpdate is reached.

UpdateTrustedIssuerStatusListsResult

@Serializable

data class UpdateTrustedIssuerStatusListsResult(val success: Boolean, val nextUpdate: Instant?, val failedLists: Map<String, Set<String>>?)

The result type of MobileCredentialVerifier.updateTrustedIssuerStatusLists(). To keep the status lists updated, it is recommend to call MobileCredentialVerifier.updateTrustedIssuerStatusLists() before nextUpdate is reached.