waltid-openid4vc-wallet-mobile/id.walt.wallet2.mobile

Package-level declarations

Types

object AndroidDigitalCredentialCreateProvider

Android framework boundary for official holder CREATE_CREDENTIAL request and response handling.

AndroidDigitalCredentialCreateProviderInput

data class AndroidDigitalCredentialCreateProviderInput(val request: AndroidDigitalCredentialCreateRequest, val providerRequest: ProviderCreateCredentialRequest)

Verified Android Credential Manager create input after caller and protocol extraction.

AndroidDigitalCredentialCreateRequest

data class AndroidDigitalCredentialCreateRequest(val protocol: String, val offerJson: String, val verifiedOrigin: String)

Android CREATE_CREDENTIAL OpenID4VCI request after Credential Manager extraction.

AndroidDigitalCredentialCreateResponse

data class AndroidDigitalCredentialCreateResponse(val protocol: String = MobileWalletDigitalCredentialProtocols.OPENID4VCI_V1, val dataJson: String = "{}")

Android CREATE_CREDENTIAL acknowledgement returned to Credential Manager after OpenID4VCI completes.

AndroidDigitalCredentialProvider

object AndroidDigitalCredentialProvider

Android framework boundary for official holder Activity request and response handling.

AndroidDigitalCredentialProviderInput

data class AndroidDigitalCredentialProviderInput(val request: MobileWalletDigitalCredentialRequest, val providerRequest: ProviderGetCredentialRequest)

Verified Android Credential Manager input after caller and selected-entry extraction.

AndroidDigitalCredentialRegistry

class AndroidDigitalCredentialRegistry(context: Context) : MobileWalletCredentialRegistry

Android Credential Manager metadata registry adapter.

AndroidMobileWalletNfcConfiguration

data class AndroidMobileWalletNfcConfiguration(val serviceClass: Class<out AndroidMdocHostApduService>)

App-owned Android HCE service used for mdoc NFC engagement and retrieval.

IosIdentityDocumentProjectionRecord

@Serializable

data class IosIdentityDocumentProjectionRecord(val documentIdentifier: String, val documentType: String)

One mdoc credential projected into Apple's IdentityDocumentServices registration model.

IosIdentityDocumentProjectionResult

sealed interface IosIdentityDocumentProjectionResult

Outcome of reading the shared projection, with "absent" and "unreadable" kept apart.

IosIdentityDocumentProjectionState

@Serializable

data class IosIdentityDocumentProjectionState(val walletId: String, val registrations: List<IosIdentityDocumentProjectionRecord>)

Desired IdentityDocumentServices registration state of the one wallet that owns this App Group.

IosIdentityDocumentRegistrationStatus

enum IosIdentityDocumentRegistrationStatus : Enum<IosIdentityDocumentRegistrationStatus>

Runtime authorization state of Apple's IdentityDocumentServices provider registration.

IosIdentityDocumentRegistry

class IosIdentityDocumentRegistry(appGroupIdentifier: String?, walletId: String) : MobileWalletCredentialRegistry

App-to-extension desired-state bridge for Apple's IdentityDocumentServices registration store.

MobileWallet

class MobileWallet

Android and iOS facade for the walt.id wallet SDK.

MobileWalletAnnexCDocumentRequest

data class MobileWalletAnnexCDocumentRequest(val docType: String, val namespaces: Map<String, List<String>>)

Requested mdoc document and namespace elements.

MobileWalletAnnexCParsedRequest

data class MobileWalletAnnexCParsedRequest(val documents: List<MobileWalletAnnexCDocumentRequest>)

Parsed request shape Apple exposes before the user grants access to the raw Annex C request.

MobileWalletAnnexCPreview

data class MobileWalletAnnexCPreview(val requestId: String, val verifiedOrigin: String, val parsedRequest: MobileWalletAnnexCParsedRequest, val credentialOptions: List<MobileWalletPresentationCredentialOption>, val readerAuthentication: MobileWalletReaderAuthentication, val readerTrust: ReaderTrustDecision?)

Consent preview for an ISO 18013-7 Annex C presentation.

MobileWalletAnnexCRequest

data class MobileWalletAnnexCRequest(val parsedRequest: MobileWalletAnnexCParsedRequest, val verifiedOrigin: String, val selectedRegistryEntryIds: List<String> = emptyList(), val deviceRequestBase64Url: String? = null, val encryptionInfoBase64Url: String? = null)

Two-phase Annex C input. Android supplies raw fields immediately; Apple may defer them.

MobileWalletAnnexCSubmission

data class MobileWalletAnnexCSubmission(val requestId: String, val verifiedOrigin: String, val deviceRequestBase64Url: String, val encryptionInfoBase64Url: String, val selectedCredentialOptions: List<MobileWalletPresentationCredentialSelection>)

Raw post-consent Annex C data required to sign and encrypt a response.

MobileWalletClientIdScheme

enum MobileWalletClientIdScheme : Enum<MobileWalletClientIdScheme>

Client identifier scheme established while authenticating an OpenID4VP request.

MobileWalletConfig

data class MobileWalletConfig(val walletId: String = "default", val attestationConfig: WalletAttestationConfig? = null, val persistence: MobileWalletPersistence = MobileWalletPersistence(), val onEvent: suspend (MobileWalletEvent) -> Unit = {}, val preferredLocales: List<String> = emptyList(), val transactionDataProfiles: List<MobileWalletTransactionDataProfile> = emptyList(), val paymentCredentialIssuers: List<PaymentCredentialIssuer> = emptyList(), val credentialIssuerMetadataTrustResolver: CredentialIssuerMetadataTrustResolver? = null, val credentialRegistry: MobileWalletCredentialRegistry = UnavailableMobileWalletCredentialRegistry, val readerTrustEvaluator: ReaderTrustEvaluator = MdocReaderAuthenticationTrustEvaluator, val crossProcessAccess: MobileWalletCrossProcessAccess? = null, val onDigitalCredentialRegistryChanged: suspend () -> Unit = {}, val defaultKeyUseAuthorizationPolicy: KeyUseAuthorizationPolicy = KeyUseAuthorizationPolicy.BiometricCurrentSet, val keyUseAuthorizationPrompt: KeyUseAuthorizationPrompt = KeyUseAuthorizationPrompt(), val signingIdentity: SigningIdentityConfiguration = id.walt.wallet2.mobile.identity.SigningIdentityConfiguration())

Configuration for creating a MobileWallet.

MobileWalletCredential

data class MobileWalletCredential(val id: String, val format: String, val issuer: String?, val subject: String?, val label: String?, val addedAt: String?, val credentialDataJson: String, val metadataJson: String? = null)

Credential entry suitable for mobile UI lists and detail display.

MobileWalletCredentialHolders

sealed interface MobileWalletCredentialHolders

Holder-key choice for one accepted configuration or dataset.

MobileWalletCredentialOffer

sealed interface MobileWalletCredentialOffer

Credential offer input for MobileWalletIssuanceRequest.

MobileWalletCredentialRegistrationResult

data class MobileWalletCredentialRegistrationResult(val available: Boolean, val registeredEntryCount: Int, val reason: String? = null)

Outcome of synchronizing the platform registry with the current wallet credential metadata.

MobileWalletCredentialRegistry

interface MobileWalletCredentialRegistry

Platform adapter for metadata-only registration. Android framework types never cross this boundary.

MobileWalletCredentialRegistryField

data class MobileWalletCredentialRegistryField(val path: List<String>, val valueJson: String, val selectivelyDisclosable: Boolean)

One matcher-visible field. Values are individual decoded claims, never the raw credential payload.

MobileWalletCredentialRegistryRecord

data class MobileWalletCredentialRegistryRecord(val registryEntryId: String, val credentialId: String, val format: MobileWalletDigitalCredentialFormat, val type: String, val fields: List<MobileWalletCredentialRegistryField>, val displayName: String, val subtitle: String = "", val iconPng: ByteArray? = null, val cardArtImageUris: List<String> = emptyList(), val cardArtBackgroundColor: String? = null, val cardArtFallbackPng: ByteArray? = null)

Matcher-visible credential metadata supplied to a platform credential registry.

MobileWalletCredentialSelection

data class MobileWalletCredentialSelection(val credentialConfigurationId: String, val holders: MobileWalletCredentialHolders, val credentialIdentifier: String? = null)

Accepted configuration/dataset and its holder-key choice.

MobileWalletCrossProcessAccess

data class MobileWalletCrossProcessAccess(val appGroupIdentifier: String, val keychainAccessGroup: String)

Cross-process wallet access required by native document-provider extensions.

MobileWalletDatabaseKey

sealed interface MobileWalletDatabaseKey

Selects who owns the encrypted wallet database key.

MobileWalletDigitalCredentialCapabilities

data class MobileWalletDigitalCredentialCapabilities(val platform: String, val platformAvailable: Boolean, val minimumOsVersion: String, val registrationAvailable: Boolean, val capabilities: List<MobileWalletDigitalCredentialCapability>)

Truthful platform capability snapshot, including runtime and registration availability.

MobileWalletDigitalCredentialCapability

data class MobileWalletDigitalCredentialCapability(val protocol: String, val credentialFormats: List<MobileWalletDigitalCredentialFormat>, val requestProtection: List<MobileWalletDigitalCredentialRequestProtection>, val responseProtection: List<MobileWalletDigitalCredentialResponseProtection>, val supported: Boolean, val unsupportedReason: String? = null)

Runtime support for one protocol/format/protection combination.

MobileWalletDigitalCredentialFormat

enum MobileWalletDigitalCredentialFormat : Enum<MobileWalletDigitalCredentialFormat>

Credential formats exposed through the platform Digital Credentials integration.

MobileWalletDigitalCredentialPreview

data class MobileWalletDigitalCredentialPreview(val requestId: String, val protocol: String, val verifiedOrigin: String, val request: MobileWalletDigitalCredentialRequestInfo, val credentialOptions: List<MobileWalletPresentationCredentialOption>, val credentialRequirements: List<MobileWalletPresentationCredentialRequirement>, val readerAuthentication: MobileWalletReaderAuthentication, val readerTrust: ReaderTrustDecision?)

Consent preview retained by the SDK until MobileWallet.submitDigitalCredentialPresentation.

MobileWalletDigitalCredentialProtocols

object MobileWalletDigitalCredentialProtocols

Protocol identifiers understood by platform Digital Credentials APIs.

MobileWalletDigitalCredentialRequest

data class MobileWalletDigitalCredentialRequest(val protocol: String, val dataJson: String, val verifiedOrigin: String, val selectedRegistryEntryIds: List<String> = emptyList())

Platform-neutral request passed by Android Credential Manager or an Apple provider extension.

MobileWalletDigitalCredentialRequestInfo

data class MobileWalletDigitalCredentialRequestInfo(val clientId: String?, val verifierMetadata: MobileWalletVerifierMetadata?, val nonce: String, val responseMode: String?, val transactionData: List<MobileWalletTransactionDataItem> = emptyList())

Verifier and transaction metadata extracted from an OpenID4VP request received through a Digital Credentials API.

MobileWalletDigitalCredentialRequestProtection

enum MobileWalletDigitalCredentialRequestProtection : Enum<MobileWalletDigitalCredentialRequestProtection>

Authentication applied to a Digital Credentials request.

MobileWalletDigitalCredentialResponse

data class MobileWalletDigitalCredentialResponse(val protocol: String, val dataJson: String)

OS-mediated response. dataJson is returned to the platform and is never direct-posted over HTTP.

MobileWalletDigitalCredentialResponseProtection

enum MobileWalletDigitalCredentialResponseProtection : Enum<MobileWalletDigitalCredentialResponseProtection>

Protection applied to the response returned to the requesting platform.

MobileWalletEvent

enum MobileWalletEvent : Enum<MobileWalletEvent>

Observable mobile wallet session event.

MobileWalletEventPhase

enum MobileWalletEventPhase : Enum<MobileWalletEventPhase>

High-level protocol flow that emitted a MobileWalletEvent.

MobileWalletEventStatus

enum MobileWalletEventStatus : Enum<MobileWalletEventStatus>

Progress state represented by a MobileWalletEvent.

MobileWalletFactory

actual class MobileWalletFactory

Android MobileWallet factory backed by Android KeyStore and an app-private SQLDelight database.

expect class MobileWalletFactory

Platform factory that wires MobileWallet to Android or iOS storage and key infrastructure.

actual class MobileWalletFactory

iOS MobileWallet factory backed by Keychain/Secure Enclave managed keys, the Crypto2 software-key fallback, and a native SQLDelight database.

MobileWalletHolderBinding

data class MobileWalletHolderBinding(val keyId: String, val did: String? = null)

One credential instance, backed by an existing platform wallet key.

MobileWalletIssuanceRequest

data class MobileWalletIssuanceRequest(val offer: MobileWalletCredentialOffer, val clientId: String = "eudiw-abca", val redirectUri: String = "openid://", val keyId: String? = null, val did: String? = null, val keyPolicy: SigningIdentityKeyPolicy = id.walt.wallet2.mobile.identity.SigningIdentityKeyPolicy.GeneralPurpose)

App-facing input for starting an OpenID4VCI issuance session.

MobileWalletKeyType

enum MobileWalletKeyType : Enum<MobileWalletKeyType>

Key algorithms supported by the mobile wallet bootstrap flow.

MobileWalletMetadataDisplay

data class MobileWalletMetadataDisplay(val name: String?, val locale: String?, val logoUri: String?, val logoAltText: String?, @ObjCName(name = "descriptionText") val description: String? = null, val backgroundColor: String? = null, val backgroundImageUri: String? = null, val textColor: String? = null)

Localized display metadata normalized from issuer, credential, or verifier protocol metadata.

MobileWalletPersistence

data class MobileWalletPersistence(val databaseKey: MobileWalletDatabaseKey = MobileWalletDatabaseKey.Managed, val credentialStore: WalletCredentialStore? = null, val didStore: WalletDidStore? = null)

Wallet-local persistence configuration.

MobileWalletPresentationCredentialOption

data class MobileWalletPresentationCredentialOption(val queryId: String, val credentialId: String, val multiple: Boolean = false, val format: String, val issuer: String?, val subject: String?, val label: String?, val credentialDataJson: String, val disclosures: List<MobileWalletPresentationDisclosure> = emptyList(), val metadataJson: String? = null)

A wallet credential that satisfies one DCQL credential query in the presentation request.

MobileWalletPresentationCredentialRequirement

data class MobileWalletPresentationCredentialRequirement(val options: List<List<String>>)

A required presentation credential-query combination.

MobileWalletPresentationCredentialSelection

data class MobileWalletPresentationCredentialSelection(val queryId: String, val credentialId: String)

User-selected presentation credential option.

MobileWalletPresentationDisclosure

data class MobileWalletPresentationDisclosure(val path: String, val name: String?, val valueJson: String, val displayValue: String?, val selectivelyDisclosable: Boolean, val required: Boolean = !selectivelyDisclosable, val selectable: Boolean = selectivelyDisclosable && !required, val requested: Boolean = true)

Claim or selective-disclosure value that may be shared for a matched credential.

MobileWalletPresentationDisclosureSelection

data class MobileWalletPresentationDisclosureSelection(val queryId: String, val credentialId: String, val path: String)

User-selected selectively disclosable claim for a selected presentation credential option.

MobileWalletPresentationErrorCode

enum MobileWalletPresentationErrorCode : Enum<MobileWalletPresentationErrorCode>

OAuth 2.0 and OpenID4VP 1.0 authorization error codes supported by the wallet.

MobileWalletPresentationPreview

data class MobileWalletPresentationPreview(val previewHandle: MobileWalletPresentationPreviewHandle, val request: MobileWalletPresentationRequestInfo, val credentialOptions: List<MobileWalletPresentationCredentialOption>, val credentialRequirements: List<MobileWalletPresentationCredentialRequirement> = emptyList())

Preview of an OpenID4VP presentation request before the wallet submits a VP token.

MobileWalletPresentationPreviewHandle

data class MobileWalletPresentationPreviewHandle(val value: String)

Opaque presentation preview handle. It is valid only for the wallet that created it.

MobileWalletPresentationPreviewResult

sealed interface MobileWalletPresentationPreviewResult

Result of resolving and validating an OpenID4VP request for presentation preview.

MobileWalletPresentationRequestContext

data class MobileWalletPresentationRequestContext(val clientId: String, val verifierMetadata: MobileWalletVerifierMetadata?, val requestAuthentication: MobileWalletRequestAuthentication, val responseUri: String?, val state: String?, val nonce: String?, val responseEncryption: MobileWalletResponseEncryption)

Partial request context retained when an OpenID4VP request is invalid.

MobileWalletPresentationRequestInfo

data class MobileWalletPresentationRequestInfo(val clientId: String, val verifierMetadata: MobileWalletVerifierMetadata?, val requestAuthentication: MobileWalletRequestAuthentication, val responseUri: String?, val state: String?, val nonce: String, val responseEncryption: MobileWalletResponseEncryption, val transactionData: List<MobileWalletTransactionDataItem> = emptyList(), val responseMode: String? = null)

Verifier and transaction metadata extracted from a presentation request.

MobileWalletPresentationResult

sealed interface MobileWalletPresentationResult

Result of answering an OpenID4VP presentation request.

MobileWalletReaderAuthentication

enum MobileWalletReaderAuthentication : Enum<MobileWalletReaderAuthentication>

Reader authentication state of a presentation request.

MobileWalletRequestAuthentication

sealed interface MobileWalletRequestAuthentication

Authentication established for an OpenID4VP Authorization Request or Request Object.

MobileWalletResponseEncryption

sealed interface MobileWalletResponseEncryption

Response-encryption state selected for an OpenID4VP presentation request.

MobileWalletStaleRegistryEntryException

class MobileWalletStaleRegistryEntryException(val registryEntryId: String) : IllegalArgumentException

Selected platform registry entry no longer maps to a current wallet credential.

MobileWalletTransactionDataItem

data class MobileWalletTransactionDataItem(val type: String, val displayName: String, val credentialQueryIds: List<String>, val supportedFields: List<String>, val rawJson: String, val detailsJson: String)

Decoded transaction_data item attached to a presentation request.

MobileWalletTransactionDataProfile

data class MobileWalletTransactionDataProfile(val type: String, val displayName: String = type, val fields: List<String> = emptyList())

Transaction data profile accepted by the mobile wallet.

MobileWalletVerifierMetadata

data class MobileWalletVerifierMetadata(val display: MobileWalletMetadataDisplay?, val clientUri: String?, val policyUri: String?, val termsOfServiceUri: String?)

Typed OpenID4VP verifier metadata needed by mobile presentation-review interfaces.

ProximityAction

sealed interface ProximityAction

User or host action accepted by a proximity session.

ProximityActionResult

sealed interface ProximityActionResult

Deterministic result of dispatching an action.

ProximityActionType

enum ProximityActionType : Enum<ProximityActionType>

Action kinds used for state-derived UI affordances without constructing an action payload.

ProximityApplicationAuthorization

data class ProximityApplicationAuthorization(val profileId: String, val displayTitle: String, val details: List<ProximityApplicationAuthorizationDetail>, val compatibleCredentialIds: Set<String>, val deviceSignedElements: List<ProximityDeviceSignedElement> = emptyList(), val resultBindingDigestBase64Url: String)

Validated output of one recognized, versioned wallet application profile.

ProximityApplicationAuthorizationDetail

data class ProximityApplicationAuthorizationDetail(val id: String, val label: String, val value: String)

One locally validated, display-safe application authorization value.

ProximityApplicationCredential

data class ProximityApplicationCredential(val credentialId: String, val docType: String, val label: String?)

One candidate made available to an application-profile adapter.

ProximityApplicationDocumentRequest

data class ProximityApplicationDocumentRequest(val requestIndex: Int, val docType: String, val requestedElements: List<ProximityRequestedElement>)

Dependency-free parsed request facts supplied to application-profile adapters.

ProximityApplicationProfile

interface ProximityApplicationProfile

Versioned wallet-owned interpreter for application-specific request data.

ProximityApplicationProfileInput

data class ProximityApplicationProfileInput(val deviceRequestBase64Url: String, val credentials: List<ProximityApplicationCredential>, val requestedDocuments: List<ProximityApplicationDocumentRequest>, val readerAuthentication: List<ProximityReaderAuthentication>)

Exact request and compatible candidates supplied to a versioned application profile.

ProximityApplicationProfileRegistry

class ProximityApplicationProfileRegistry(profiles: List<ProximityApplicationProfile>)

Ordered registry requiring at most one profile to recognize a request.

ProximityApplicationProfileResult

sealed interface ProximityApplicationProfileResult

Result of asking one application profile to recognize and validate the exact request.

ProximityApproval

sealed interface ProximityApproval

How the holder approves data release. Transport selection remains independent.

ProximityApprovalTiming

enum ProximityApprovalTiming : Enum<ProximityApprovalTiming>

Timing of the holder's deliberate approval for a locally completed response.

ProximityBleBearerPolicy

enum ProximityBleBearerPolicy : Enum<ProximityBleBearerPolicy>

Bearer selection policy kept separate from the app-visible session state.

ProximityBleConfiguration

data class ProximityBleConfiguration(val roles: ProximityBleRoles = ProximityBleRoles.Dual, val bearerPolicy: ProximityBleBearerPolicy = ProximityBleBearerPolicy.PreferL2cap)

Complete BLE bearer configuration; it cannot exist unless BLE retrieval is selected.

ProximityBleRoles

enum ProximityBleRoles : Enum<ProximityBleRoles>

BLE roles a holder may prepare for one in-person presentation.

ProximityCapabilities

data class ProximityCapabilities(val profile: ProximityProfile, val session: ProximitySessionConfiguration, val qrEngagement: ProximityTransportCapability, val nfcEngagement: ProximityTransportCapability, val bluetoothLowEnergy: ProximityTransportCapability, val nfcRetrieval: ProximityTransportCapability, val nfcV2Retrieval: ProximityTransportCapability, val wifiAwareRetrieval: ProximityTransportCapability)

Side-effect-free prerequisite snapshot. No radio resource or session material has been created.

ProximityCertificateRevocationResult

sealed interface ProximityCertificateRevocationResult

Result returned by an application-owned certificate-revocation source.

ProximityConfiguration

data class ProximityConfiguration(val profile: ProximityProfile = ProximityProfile.Iso180135Edition2Dis2026, val session: ProximitySessionConfiguration = ProximitySessionConfiguration.Qr(), val readerPolicy: ProximityReaderPolicy = ProximityReaderPolicy.AllowAnonymousOrUntrusted, val deviceAuthenticationPolicy: ProximityDeviceAuthenticationPolicy = ProximityDeviceAuthenticationPolicy.SignatureOnly, val readerTrustEvaluator: ProximityReaderTrustEvaluator = UnconfiguredProximityReaderTrustEvaluator, val credentialStatusEvaluator: ProximityCredentialStatusEvaluator = UnconfiguredProximityCredentialStatusEvaluator, val applicationProfiles: ProximityApplicationProfileRegistry = ProximityApplicationProfileRegistry.Empty, val maximumMessageBytes: Int, val approval: ProximityApproval = ProximityApproval.AskEachTime)

Immutable configuration for one single-use proximity session.

ProximityConfiguredReaderTrustEvaluator

class ProximityConfiguredReaderTrustEvaluator : ProximityReaderTrustEvaluator

Shared standards-profile, path, revocation, RICAL, and product-trust evaluator.

ProximityConnectedRoute

data class ProximityConnectedRoute(val engagement: ProximityEngagementMethod, val transport: ProximityTransport)

Actual connected route, independent of the methods configured or advertised.

ProximityCredentialOption

data class ProximityCredentialOption(val credentialId: String, val label: String?, val issuer: String?, val validUntil: Instant, val deviceAuthentication: ProximityDeviceAuthenticationMethod, val requestedElements: List<ProximityRequestedElement>)

Eligible wallet credential projected without raw credential or key material.

ProximityCredentialStatus

enum ProximityCredentialStatus : Enum<ProximityCredentialStatus>

Current status of a credential at the explicit application status boundary.

ProximityCredentialStatusEvaluator

fun interface ProximityCredentialStatusEvaluator

Explicit, optionally network-backed status boundary. The SDK itself performs no hidden lookup.

ProximityCredentialStatusInput

data class ProximityCredentialStatusInput(val credentialId: String, val docType: String, val issuer: String?, val validFrom: Instant, val validUntil: Instant)

Metadata-only status input; raw credential values are not handed to network providers.

ProximityCrlFetcher

fun interface ProximityCrlFetcher

Application-owned transport for explicit CRL distribution-point requests.

ProximityCrlFetchResult

sealed interface ProximityCrlFetchResult

A complete DER CRL retrieved by the application's network/cache policy.

ProximityCrlRevocationEvaluator

class ProximityCrlRevocationEvaluator : ProximityReaderRevocationEvaluator

Reader-certificate CRL evaluator for ProximityReaderRevocationPolicy.Check.

ProximityCrlScope

enum ProximityCrlScope : Enum<ProximityCrlScope>

Certificates whose CRL status the hosting application requires.

ProximityDeviceAuthenticationMethod

enum ProximityDeviceAuthenticationMethod : Enum<ProximityDeviceAuthenticationMethod>

Holder authentication frozen for a reviewed document response.

ProximityDeviceAuthenticationPolicy

enum ProximityDeviceAuthenticationPolicy : Enum<ProximityDeviceAuthenticationPolicy>

Explicit allowlist and preference applied before an immutable review is constructed.

ProximityDeviceSignedElement

data class ProximityDeviceSignedElement(val credentialId: String, val namespace: String, val elementIdentifier: String, val valueCborBase64Url: String)

Generic device-signed value proposed by a recognized application profile.

ProximityDocumentReview

data class ProximityDocumentReview(val requestIndex: Int, val docType: String, val credentialOptions: List<ProximityCredentialOption>, val requiredElements: Set<ProximityElementReference> = emptySet())

One satisfiable document request in an immutable review snapshot.

ProximityDocumentSubmission

data class ProximityDocumentSubmission(val requestIndex: Int, val credentialId: String, val disclosedElements: Set<ProximityElementReference>)

Credential and disclosure choice for exactly one reviewed document request.

ProximityElementReference

data class ProximityElementReference(val namespace: String, val elementIdentifier: String)

Dependency-free namespace and element identifier.

ProximityEngagement

sealed interface ProximityEngagement

Prepared engagement presented by the host UI.

ProximityEngagementMethod

enum ProximityEngagementMethod : Enum<ProximityEngagementMethod>

Engagement that actually won the reader connection.

ProximityError

data class ProximityError(val category: ProximityErrorCategory, val code: String, val message: String, val recovery: ProximityRecovery)

Stable, non-sensitive failure exposed by the Wallet SDK.

ProximityErrorCategory

enum ProximityErrorCategory : Enum<ProximityErrorCategory>

Layer-stable error category; raw dependency and platform exceptions are never exposed.

ProximityHolderAuthorization

data class ProximityHolderAuthorization(val reviewId: ProximityReviewId, val exchange: Int, val requests: List<ProximityHolderAuthorizationRequest>)

Exact holder-key authorization context for a frozen approved submission.

ProximityHolderAuthorizationRequest

data class ProximityHolderAuthorizationRequest(val requestIndex: Int, val credentialId: String, val deviceAuthentication: ProximityDeviceAuthenticationMethod)

One protected-key operation required by a frozen approved document response.

ProximityHostActionResult

enum ProximityHostActionResult : Enum<ProximityHostActionResult>

Privacy-safe outcome of a system surface performed by the host application.

ProximityNfcHandover

enum ProximityNfcHandover : Enum<ProximityNfcHandover>

Conventional NFC Forum handover selection; provisional NFCv2 has its own session variant.

ProximityNfcRetrievalConfiguration

data class ProximityNfcRetrievalConfiguration(val maximumCommandDataLength: Int, val maximumResponseDataLength: Int)

Complete conventional NFC retrieval length contract.

ProximityPreparationResult

sealed interface ProximityPreparationResult

Result of an explicit holder decision made before connection.

ProximityPreparedSharing

class ProximityPreparedSharing

Opaque one-use approval. Hosts may display or cancel it, but cannot construct or expand its scope.

ProximityProfile

enum ProximityProfile : Enum<ProximityProfile>

Versioned mdoc interoperability boundary selected for one proximity session.

ProximityPurposeHint

data class ProximityPurposeHint(val type: String, val code: Int, val readerAsserted: Boolean = true)

Reader-asserted purpose hint associated with the selected use case.

ProximityReaderAuthentication

data class ProximityReaderAuthentication(val scope: ProximityReaderAuthenticationScope, val authenticationIndex: Int = 0, val outcome: ProximityReaderAuthenticationOutcome)

Display-safe reader authentication and trust fact for holder consent.

ProximityReaderAuthenticationOutcome

sealed interface ProximityReaderAuthenticationOutcome

Authentication result whose trust payload exists only after successful verification.

ProximityReaderAuthenticationScope

sealed interface ProximityReaderAuthenticationScope

Scope covered by one reader-authentication statement.

ProximityReaderAuthenticationSummary

enum ProximityReaderAuthenticationSummary : Enum<ProximityReaderAuthenticationSummary>

Scope-aware summary for the reviewed documents; raw statement evidence remains available.

ProximityReaderAuthenticationValidity

enum ProximityReaderAuthenticationValidity : Enum<ProximityReaderAuthenticationValidity>

Cryptographic validity of reader authentication, kept separate from trust.

ProximityReaderCertificatePathState

enum ProximityReaderCertificatePathState : Enum<ProximityReaderCertificatePathState>

Result of validating the reader certificate path against explicitly configured trust material.

ProximityReaderEvidence

data class ProximityReaderEvidence(val scope: ProximityReaderAuthenticationScope, val authenticationIndex: Int = 0, val certificateChainDerBase64Url: List<String>)

Exact verified reader evidence supplied to an application-owned trust policy.

ProximityReaderPolicy

enum ProximityReaderPolicy : Enum<ProximityReaderPolicy>

Policy applied after reader authentication and trust facts have been evaluated.

ProximityReaderRevocationEvaluator

fun interface ProximityReaderRevocationEvaluator

Explicit application boundary for OCSP, CRL, or another reader-certificate status source.

ProximityReaderRevocationPolicy

sealed interface ProximityReaderRevocationPolicy

Revocation behavior selected for reader trust.

ProximityReaderRevocationState

enum ProximityReaderRevocationState : Enum<ProximityReaderRevocationState>

Reader-certificate revocation fact, kept independent from path validity and product trust.

ProximityReaderTrustAnchor

data class ProximityReaderTrustAnchor(val certificateDerBase64Url: String, val displayName: String? = null)

Explicit application-provisioned Reader CA certificate and optional display label.

ProximityReaderTrustAnchorPreview

data class ProximityReaderTrustAnchorPreview(val displayName: String, val subject: String, val issuer: String, val sha256Fingerprint: String, val validFrom: Instant, val validUntil: Instant, val profile: String = "X.509 CA certificate")

Display-safe preview of an imported Reader CA.

ProximityReaderTrustConfiguration

data class ProximityReaderTrustConfiguration(val trustAnchors: List<ProximityReaderTrustAnchor> = emptyList(), val ricalProviders: List<ProximityRicalConfiguration> = emptyList(), val revocationPolicy: ProximityReaderRevocationPolicy = ProximityReaderRevocationPolicy.NotChecked, val requiredIacaIssuerCertificateDerBase64Url: String? = null)

Immutable shared reader-trust policy.

ProximityReaderTrustDecision

data class ProximityReaderTrustDecision(val state: ProximityReaderTrustState, val certificatePath: ProximityReaderCertificatePathState = ProximityReaderCertificatePathState.NotEvaluated, val revocation: ProximityReaderRevocationState = ProximityReaderRevocationState.NotChecked, val rical: ProximityRicalState = ProximityRicalState.NotEvaluated, val displayName: String? = null, val reason: String? = null)

Trust decision supplied by the hosting wallet application.

ProximityReaderTrustEvaluator

fun interface ProximityReaderTrustEvaluator

Explicit trust boundary for verified reader certificate evidence.

ProximityReaderTrustImportKind

enum ProximityReaderTrustImportKind : Enum<ProximityReaderTrustImportKind>

Kind of public reader-trust material represented by an import preview.

ProximityReaderTrustImportPreview

data class ProximityReaderTrustImportPreview(val kind: ProximityReaderTrustImportKind, val sourceName: String, val readerAuthorities: List<ProximityReaderTrustAnchorPreview>, val ricalProviders: List<ProximityRicalPreview>, val resultingSettings: ProximityReaderTrustSettings)

Import review which must be explicitly confirmed before its settings are persisted.

ProximityReaderTrustSettings

data class ProximityReaderTrustSettings(val readerPolicy: ProximityReaderPolicy = ProximityReaderPolicy.AllowAnonymousOrUntrusted, val trustAnchors: List<ProximityStoredReaderTrustAnchor> = emptyList(), val ricalProviders: List<ProximityStoredRicalProvider> = emptyList())

Complete holder-owned Reader Authentication settings snapshot.

ProximityReaderTrustSettingsCodec

object ProximityReaderTrustSettingsCodec

Strict codec and importer for holder-owned Reader Authentication settings.

ProximityReaderTrustState

enum ProximityReaderTrustState : Enum<ProximityReaderTrustState>

Trust outcome after valid reader authentication.

ProximityRecovery

enum ProximityRecovery : Enum<ProximityRecovery>

Recovery action supported by the phase that reported a failure.

ProximityRemediationAction

enum ProximityRemediationAction : Enum<ProximityRemediationAction>

Normalized host remediation suggested by a side-effect-free prerequisite check.

ProximityRequestedElement

data class ProximityRequestedElement(val namespace: String, val elementIdentifier: String, val intentToRetain: Boolean, val satisfiesRequestedElements: List<ProximityElementReference> = emptyList())

One requested or alternative data element shown during consent.

ProximityRetrievalOptions

data class ProximityRetrievalOptions(val bluetoothLowEnergy: ProximityBleConfiguration? = ProximityBleConfiguration(), val nfc: ProximityNfcRetrievalConfiguration? = null, val wifiAware: Boolean = false)

Nonempty conventional retrieval plan used by QR or NFC handover.

ProximityReview

data class ProximityReview(val reviewId: ProximityReviewId, val exchange: Int, val documents: List<ProximityDocumentReview>, val readerAuthentication: List<ProximityReaderAuthentication>, val useCases: List<ProximityUseCase>, val applicationAuthorizations: List<ProximityApplicationAuthorization>)

Immutable holder-consent snapshot bound to one exchange and exact request.

ProximityReviewId

data class ProximityReviewId(val value: String)

Opaque identity issued by the wallet for one consent review.

ProximityReviewReason

enum ProximityReviewReason : Enum<ProximityReviewReason>

Why a request needs a fresh review.

ProximityRicalConfiguration

data class ProximityRicalConfiguration(val providerId: String, val acceptedTypes: Set<String>, val providerTrustAnchors: List<ProximityRicalProviderTrustAnchor>, val acceptedSignerCertificatePolicyOids: Set<String>, val signerRevocationPolicy: ProximityRicalSignerRevocationPolicy = ProximityRicalSignerRevocationPolicy.NotChecked, val establishReaderTrust: Boolean = false, val provider: ProximityRicalProvider, val constraintEvaluator: ProximityRicalConstraintEvaluator? = null)

Immutable policy for one explicitly configured RICAL provider.

ProximityRicalConstraintEvaluator

fun interface ProximityRicalConstraintEvaluator

Application-owned evaluator for ecosystem-specific RICAL trust-constraint semantics.

ProximityRicalPreview

data class ProximityRicalPreview(val providerId: String, val providerName: String, val type: String, val issuedAt: Instant, val nextUpdate: Instant?, val validUntil: Instant?, val establishesReaderTrust: Boolean)

Display-safe preview of a validated static RICAL provider.

ProximityRicalProvider

fun interface ProximityRicalProvider

Supplies the latest application-selected RICAL without an implicit SDK network request.

ProximityRicalProviderResult

sealed interface ProximityRicalProviderResult

Exact active RICAL supplied by an application-owned provider boundary.

ProximityRicalProviderTrustAnchor

data class ProximityRicalProviderTrustAnchor(val certificateDerBase64Url: String)

Explicit application-provisioned root for one RICAL provider.

ProximityRicalSignerEvidence

data class ProximityRicalSignerEvidence(val providerId: String, val certificateChainDerBase64Url: List<String>)

Exact RICAL signer evidence passed to an application-owned revocation source.

ProximityRicalSignerRevocationEvaluator

fun interface ProximityRicalSignerRevocationEvaluator

Explicit application boundary for RICAL-signer OCSP, CRL, or another status source.

ProximityRicalSignerRevocationPolicy

sealed interface ProximityRicalSignerRevocationPolicy

Revocation behavior selected for one RICAL provider's signer certificate.

ProximityRicalState

enum ProximityRicalState : Enum<ProximityRicalState>

Optional RICAL evidence fact. A match never establishes product trust by itself.

ProximityRicalTrustConstraint

data class ProximityRicalTrustConstraint(val valuesCborBase64Url: Map<String, String>)

One RICAL trust constraint, with each value CBOR-encoded as unpadded Base64URL.

ProximityRuntimeObservation

sealed interface ProximityRuntimeObservation

Runtime evidence is independent of whether the host selected a method.

ProximitySession

interface ProximitySession

Single-use, wallet-owned proximity presentation session.

ProximitySessionConfiguration

sealed interface ProximitySessionConfiguration

Owns engagement and compatible retrieval together for one single-use session.

ProximitySharingPlan

class ProximitySharingPlan

A wallet-verified request that can be approved before a new connection. This is not permission to share.

ProximitySharingReceipt

class ProximitySharingReceipt

Display-only receipt. Its data is not an authorization token and cannot be replayed.

ProximityState

sealed interface ProximityState

Public Wallet SDK session state; each variant carries only data valid for that phase.

ProximityStoredReaderTrustAnchor

data class ProximityStoredReaderTrustAnchor(val certificateDerBase64Url: String, val displayName: String)

Persisted Reader CA trust material selected by the holder.

ProximityStoredRicalProvider

data class ProximityStoredRicalProvider(val providerId: String, val acceptedTypes: Set<String>, val providerTrustAnchorsDerBase64Url: List<String>, val acceptedSignerCertificatePolicyOids: Set<String>, val establishReaderTrust: Boolean, val signedRicalBase64Url: String)

Persisted, already validated static qualification RICAL provider.

ProximitySubmission

data class ProximitySubmission(val documents: List<ProximityDocumentSubmission>, val continueAfterResponse: Boolean = false)

Complete holder choice for the current review; it is rebound and revalidated before response generation.

ProximityTransport

enum ProximityTransport : Enum<ProximityTransport>

Bearer actually carrying the connected session.

ProximityTransportCapability

data class ProximityTransportCapability(val implemented: Boolean, val profilePermitted: Boolean, val runtime: ProximityRuntimeObservation, val selected: Boolean)

One transport's independent support dimensions.

ProximityUseCase

data class ProximityUseCase(val index: Int, val mandatory: Boolean, val documentRequestIndices: List<Int>, val purposeHints: List<ProximityPurposeHint>)

Selected edition-2 use case projected for review.

UnavailableMobileWalletCredentialRegistry

object UnavailableMobileWalletCredentialRegistry : MobileWalletCredentialRegistry

Registry used when the current platform or application has no registration integration.

UnconfiguredProximityCredentialStatusEvaluator

object UnconfiguredProximityCredentialStatusEvaluator : ProximityCredentialStatusEvaluator

Default status policy relies on the locally verified MSO validity interval only.

UnconfiguredProximityReaderTrustEvaluator

object UnconfiguredProximityReaderTrustEvaluator : ProximityReaderTrustEvaluator

Default policy: validity is reported, but no reader certificate becomes trusted implicitly.

WalletAttestationConfig

data class WalletAttestationConfig(val baseUrl: String, val attesterPath: String, val bearerToken: String = "", val hostHeader: String = "")

OAuth 2.0 client-attestation configuration used during mobile issuance.

Properties

legalActions

val ProximityState.legalActions: Set<ProximityActionType>

Legal host actions derived exclusively from the current session state.