Set CDCVM method

Overview

The digital card profile defines whether it supports CDCVM.

For a given wallet instance, the first provisioned card that supports CDCVM defines the CDCVM method used by the digital wallet application.

NFC Wallet SDK does not allow cards with different CDCVM methods to co-exist in the same wallet instance.

As described in Handle CDCVM, most NFC Wallet programs use CDCVM.

In this section, you set the CDCVM method based on device capabilities during Tokenization of the first card that supports CDCVM.

Setting the CDCVM method is Required

If the profile supports CDCVM and you do not set the CDCVM method:

• Retrieving the card list fails with DigitalizedCardErrorCodes.CD_CVM_REQUIRED.
• NFC payments fail until you set the CDCVM method.

SDK integration

Check whether CDCVM is supported and set

Use CHVerificationManager to check whether CDCVM is supported and already configured for the current wallet instance:

• CHVerificationManager.isFCDCVMSupported() checks whether CDCVM is supported.
• CHVerificationManager.isFCdCvmSet() checks whether the CDCVM method is already set.
• CHVerificationManager.getDefaultFCdCvm() returns the CDCVM method used by the digital wallet application.

If CDCVM is supported and not set, initialize it as described in Set the CDCVM method.

Handle CD_CVM_REQUIRED when listing cards

If you do not set the CDCVM method and you retrieve the card list using DigitalizedCardManager.getAllCards(), the SDK can return DigitalizedCardErrorCodes.CD_CVM_REQUIRED. In such case initialize CDCVM method it as described in Set the CDCVM method.

DigitalizedCardManager.getAllCards( new AbstractAsyncHandler<String[]> () {
    
    @Override
    public void onComplete(final AsyncResult<String[]> asyncResult) {
        if (asyncResult.isSuccessful()) {
            // Card list retrieved successfully
        }
        else {
            // Card list retrieval failed
            final int errorCode = asyncResult.getErrorCode();
            if (errorCode == DigitalizedCardErrorCodes.CD_CVM_REQUIRED) {
                // Set the CDCVM method here (see next section)
                // ....
            }
        }
    }
    
});

Set the CDCVM method

Use DeviceCVMManager.initialize(...) to set the CDCVM method according to device capabilities:

• Biometric: CHVerificationMethod.BIOMETRICS
• Device credentials (keyguard): CHVerificationMethod.DEVICE_KEYGUARD

After you set the CDCVM method, consider scenarios where the end user changes the device unlock method. See Device unlock method update scenario.

Implementation example

// Check device eligibility for CDCVM
DeviceCVMEligibilityResult result =
        DeviceCVMEligibilityChecker.checkDeviceEligibility(getApplicationContext());

if (result.getBiometricsSupport() == BiometricsSupport.SUPPORTED) {
    // Biometric is supported
    try {
        DeviceCVMManager.INSTANCE.initialize(CHVerificationMethod.BIOMETRICS);
    } catch (DeviceCVMException e) {
        // Handle error
    }
}
else if (result.getDeviceKeyguardSupport() == DeviceKeyguardSupport.SUPPORTED) {
    // If biometrics are not supported, use device keyguard.
    try {
        DeviceCVMManager.INSTANCE.initialize(CHVerificationMethod.DEVICE_KEYGUARD);
    } catch (DeviceCVMException e) {
        // Handle error
    }
}
else {
    // Device does not support CDCVM, or the end user did not enable a secure lock screen.
    // Prompt the end user to enable biometrics or device credentials.
}