Support and troubleshooting
About
When problems arise out in the wild, it is important to be able to efficiently debug the problems, both for the App team and Aera. Here are some advice and routines.
UI error visibility
Screenshots from consumers can be very valuable, if they contain the right information. A good approach is to display the exception type and cid in the error provided to the consumer, so Aera can debug issues more easily.
Support cases
Support cases that are created should include the following information (when present, obtainable and relevant).
- The error that occurred, including all mapped fields. Code, externalResponseCode, timestamp and cid are especially valuable to Aera
- The step-by-step to reproduce the error
- The steps you have already taken to try to solve this
- A screenshot or video of the error
- A crash report
Symbolication
The Wallets SDK iOS saves dSYM files per release for easier diagnosing issues from crash reports. If you have a crash report available, provide these in your support cases.
SDK Troubleshooting / Q&A
- The SDK tries to re-onboard my user when I wanted to just open the dashboard or delete the wallet. Why?
- Secure ID has, for some reason, decided that the user can no longer sign with Secure ID successfully, and has returned an error to the Wallets SDK, indicating that signing will never succeed. In this case, the Wallets SDK will handle the error by initiating a re-onboarding. This can happen if the SDK is deleted externally, but present on device, or if the user has changed security settings like biometrics, making Secure ID not trusting the device anymore.
- The following Secure ID errors result in an automatic triggering of re-onboarding via Wallets SDK:
-
Upon opening the wallet: CVD_SIGNATURE_INVALID("68513"), WALLET_NOT_FOUND("68511"), ONBOARDING_EXPIRED("68508"),
SID_SDK_REVOKED("68512"),SDK_REVOKED("1042"),
NOT_INITIALIZED("1013"),
SIGNING_ERROR_KEY_PERM_INVALIDATED("1019"),
APP_PIN_REVOKED("1045"), SIGNING_ERROR_NOT_COMPATIBLE("1020") -
Upon deleting the wallet: CVD_SIGNATURE_INVALID("68513"),
ONBOARDING_EXPIRED("68508"),
SID_SDK_REVOKED("68512"),SDK_REVOKED("1042"),
NOT_INITIALIZED("1013")
-
- The user is locked out of the wallet, can not open or delete it. Signing with Secure ID always fails with the same error.
- In some cases, the automatic re-onboarding from pt. 1 does not happen. In this case, a "sign out" button should be made available for the end-user, triggering "deleteSdk" Wallets SDK Method. This will result in the local Secure ID SDK being deleted on the device, and a new onboarding being triggered on open wallet/delete wallet. DeleteSDK does not delete the wallet, thus functioning as a local "reset" option.
- Deeplinking does not work
- Deeplinking is available during Secure ID onboarding and some payment instrument onboardinbg flows. Deeplinking can work different across OS and Browsers. Please see this troubleshooting guide from Itsme: https://belgianmobileid.github.io/doc/deeplinks-issues/
