Function requestMobileCredentials

Parameters

• options: RequestMobileCredentialsOptions

  An object containing the following properties:

  • request: An array of MobileCredentialRequest objects that specify the credential queries to be sent to the wallet for filtering and matching credentials stored in the wallet.
  • applicationId: The Android verifier application ID that has been registered with the MATTR VII Platform and configured for use with this integration.
  • walletProviderId: Optional wallet provider ID registered with the MATTR VII Platform, used to target a specific wallet that supports OpenID4VP. When set, forces using an OpenID4VP session.
  • challenge: A string representing the challenge to be sent to the server. This is typically a unique identifier or token generated for the verification process.

  ---

  Android behavior:

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

  Creates a DC API session when all of the following conditions are met:

  1. dcApiConfiguration is enabled in the MATTR VII Verifier application configuration
  2. The end user's device supports the Android API level >= Android P (API 28)
  3. walletProviderId is not provided (i.e., walletProviderId is undefined)
  4. request.length == 1

  When any of the conditions are not met, the SDK automatically falls back to create an OpenID4VP session. If no openid4vpConfiguration is defined for the Verifier application, the session would fail.

  NOTE: To receive OpenID4VP results you must declare the SDK callback activity in your app AndroidManifest.xml.

  <activity
      android:name="global.mattr.mobilecredential.verifier.a2apresentation.callback.Openid4VpCallbackActivity"
      android:exported="true">
    <intent-filter>
      <action android:name="android.intent.action.VIEW" />
      <category android:name="android.intent.category.DEFAULT" />
      <category android:name="android.intent.category.BROWSABLE" />
      <!-- Match the openid4vpConfiguration you configured in the MATTR VII Verifier application -->
      <data
          android:scheme="com.example.verifier"
          android:host="openid4vp" />
    </intent-filter>
  </activity>
  Copy

  NOTE: DC API support in the Holder SDK is currently offered as a tech preview. This feature is experimental and relies on Google’s Digital Credentials Manager (DCM) API, which is also in an early stage. As such, functionality may be limited, may not work in all scenarios, and could change or break without prior notice.

  ---

  iOS behavior:

  Initialize an online presentation flow. This method requires a deep link handler to be registered in the app's event handling flow, such as in AppDelegate, SceneDelegate, or onOpenURL.

  Details: https://api-reference-sdk.mattr.global/mobile-credential-verifier-ios/latest/documentation/mobilecredentialverifiersdk/mobilecredentialverifier/handledeeplink(_:)#discussion

  See handleDeepLink for more details.