Skip to main content

Portal-Managed Recovery (default)

When using Portal-Managed Backups, you can simply call the portal.recoverWallet() function passing an empty string for the cipherText parameter. Portal will then fetch the cipherText from our backend and complete the recovery process.
WARNING: To recover a wallet with the Portal SDK, your device must be configured to use passcode authentication. Please note that if you disable your passcode authentication after executing the recover function, you will need to run the recover function again.

Self-Managed Recovery

By default, Portal manages storing both the encrypted client backup share and the custodian backup share for you. If you prefer to store and manage the backup shares in your own infrastructure instead of using Portal-Managed Backups, see our Self-Managed Backups guide. Before recovering, you will need to retrieve the encrypted client backup share from your API. You will then provide the encrypted client backup share to portal.recoverWallet. Here’s an example of how that might look in your code:
WARNING: To recover a wallet with the Portal SDK, your device must be configured to use passcode authentication. Please note that if you disable your passcode authentication after executing the recover function, you will need to run the recover function again.

Passkey Recovery

To recover a wallet that was backed up with a passkey:

Custom Domain Passkeys Recovery

If you configured a custom domain for passkeys (see Custom Domain Passkeys), use the following recovery flow:

Google Drive Recovery

To recover a wallet backed up to Google Drive, initialize Portal with a gdrive configuration that looks where the backup was written. Once the SDK is ready, call recoverWallet with BackupMethods.gdrive from a user action, such as a button click:
Google sign-in opens in a pop-up window that browsers can block. See Google sign-in and sessions.
  • Backups in the user-visible folder were made on the web with the default option or a Web SDK earlier than 4.2.0, by your React Native app, or by your iOS or Android app with its user-visible folder option. Use 'gdriveFolder' (the default) or 'appDataFolderWithFallback'.
  • Backups made with the app data folder, on the web or by your iOS or Android app, are only found with 'appDataFolder' or 'appDataFolderWithFallback'.
To recover backups made by your other apps, in either location, use OAuth clients from the same Google Cloud project on every platform, and have the user choose the same Google account. See Share backups across platforms. If the SDK finds no backup file where the configured backupOption looks, recovery fails with [GDriveStorage] File could not be found., even if the backup exists in another location. If it finds an older user-visible file instead, left from before the user backed up in the app data folder, recovery fails with Failed to decrypt (error code 407). See Change the backup location for existing users.

Firebase Auth recovery

Firebase recovery uses the same TBS-backed encryption key flow as backup. Call configureFirebaseStorage with the same getToken implementation you use for backup, and ensure the user is signed in to Firebase before calling recoverWallet. The tab examples below assume a configured portal instance (same pattern as other recovery snippets in this guide).
See Back up a wallet — Firebase Auth backup for setup prerequisites and the Firebase Auth Backup resource.

Progress Callbacks

You can learn how to handle the progress callbacks for portal.recoverWallet here.

Next steps

Amazing! Your users can now have multiple backups and can easily recover their wallet. Next let’s dive into handling sessions across multiple devices for your users.