mDocs Verifier SDK/global.mattr.mobilecredential.verifier/MobileCredentialVerifier

MobileCredentialVerifier

object MobileCredentialVerifier

The entry point for the MobileCredentialVerifier SDK.

Types

Link copied to clipboard
enum SdkState : Enum<MobileCredentialVerifier.SdkState>

Enum class to represent all possible Verifier SDK states.

Properties

Link copied to clipboard
val initialized: Boolean

Functions

Link copied to clipboard
@Blocking
fun addTrustedIssuerCertificates(certificates: List<String>): List<String>

Add a trusted issuer certificate to storage.

Link copied to clipboard
fun createProximityPresentationSession(activity: Activity, qrEncodedDeviceEngagementString: String, listener: ProximityPresentationSessionListener)

Create a proximity-based presentation session with a mDoc holder using device retrieval as per ISO/IEC 18013-5:2021.

Link copied to clipboard
suspend fun deinitialize()

Deinitialize the MobileCredentialVerifier SDK.

Link copied to clipboard
@Blocking
fun deleteTrustedIssuerCertificate(id: String)

Delete a trusted issuer certificate from storage.

Link copied to clipboard
fun deregisterForNfcDeviceEngagement(activity: Activity)

Disables NFC engagement and deregisters any previously registered callbacks.

Link copied to clipboard
suspend fun destroy(context: Context)

Destroys the SDK instance.

Link copied to clipboard
fun getLog(): String?

Retrieve the path to the Verifier SDK log file.

Link copied to clipboard
@Blocking
fun getTrustedIssuerCertificates(): List<TrustedCertificate>

Retrieve all trusted issuer certificates from storage.

Link copied to clipboard
@Blocking
fun getTrustedIssuerStatusListsCacheInfo(): TrustedIssuerStatusListsCacheInfo

Get current revocation status lists cache information without attempting to update any status lists.

Link copied to clipboard
suspend fun initialize(context: Context, platformConfiguration: PlatformConfiguration? = null, loggerConfiguration: Logger.LoggerConfiguration? = null)

Initialize the MobileCredentialVerifier SDK.

Link copied to clipboard
fun isValidDeviceEngagementString(data: String): Boolean

Validates the supplied string is a valid QR code based on device engagement structure (as per section 8.2.2.3 of ISO 18013-5).

Link copied to clipboard
fun registerForNfcDeviceEngagement(activity: Activity, listener: ProximityPresentationSessionListener): Boolean

Registers for NFC-based device engagement and enables it.

Link copied to clipboard
suspend fun requestMobileCredentials(activity: Activity, request: List<MobileCredentialRequest>, applicationId: String, walletProviderId: String? = null, challenge: String? = null): OnlinePresentationSessionResult

Starts a remote app-to-app verification flow using either an OpenID4VP Redirect or Digital Credentials API (DC API) session. Depending on the MATTR VII configured Android Verifier application and request the most appropriate session flow will be initiated.

Link copied to clipboard
suspend fun sendProximityPresentationRequest(request: List<MobileCredentialRequest>, checkStatus: Boolean = true): MobileCredentialResponse

This function uses the requested mDocs to construct and send a presentation request to the holder. This new function, replaces the old ProximityPresentationSession.requestMobileCredentials.

Link copied to clipboard
suspend fun terminateProximityPresentationSession()

Terminate the current session explicitly, send status code sessionTerminated to the holder, and close data transport.

Link copied to clipboard
@Blocking
fun updateTrustedIssuerStatusLists(): UpdateTrustedIssuerStatusListsResult

Update revocation status lists.