Migrate from Ionic Identity Vault
Copy a setup prompt with the install steps and the full markdown guide for this plugin.
Native Biometric provides a complete replacement for the secure credential-vault part of Ionic Identity Vault. It does more than prompt for biometrics: it saves, checks, retrieves, and deletes credentials with native Keychain or Keystore protection. With biometric access control enabled, protected reads require Face ID, Touch ID, or Android biometrics before your app receives the credential.
Use Native Biometric directly for tokens and credential-vault flows. Your app decides when to request a protected read to apply its timeout and lifecycle policy. If you also need a broad encrypted database for data beyond credentials, add Fast SQL or Data Storage SQLite; that is optional for a credential-vault migration.
Automatic timeout locks and background privacy screens are application-layer policy, so preserve or recreate them in your app. Custom-passcode and memory-only vault modes are not supported by Native Biometric; use a separate application storage and encryption design if you need them.
Capgo replacements at a glance
Section titled “Capgo replacements at a glance”| Ionic enterprise plugin | Capgo replacement | Migration guide |
|---|---|---|
| Secure Storage | @capgo/capacitor-fast-sql or @capgo/capacitor-data-storage-sqlite | Secure Storage migration |
| Auth Connect | @capgo/capacitor-social-login | Auth Connect migration |
| Identity Vault credential-vault flows | @capgo/capacitor-native-biometric — direct replacement | You are here |
What Native Biometric covers
Section titled “What Native Biometric covers”- Secure credential vault: save, retrieve, check, and delete credentials for a server or account.
- Biometric-gated unlock:
getSecureCredentialsshows the native biometric prompt before protected credentials can be read. - App-controlled lock policy: call the protected read when the app resumes, after a timeout, or before a sensitive action.
- Separate identity prompt:
verifyIdentitysupports device-passcode fallback on iOS; protected credential reads remain biometric-only. - Access-control choices: choose whether biometric enrollment changes invalidate protected credentials.
Migration steps
Section titled “Migration steps”- Install Native Biometric and sync native code.
npm install @capgo/capacitor-native-biometricnpx cap sync- Save the access and refresh tokens or other credentials with biometric access control enabled.
- Use
getSecureCredentialsto unlock protected credentials when the app resumes, after an inactivity timeout, or before a sensitive action. - Keep timeout and privacy-screen behavior in your app layer. Custom-passcode and memory-only modes are unsupported by Native Biometric; use a separate application storage and encryption design if required.
- Use
isCredentialsSavedanddeleteCredentialsfor onboarding, locked-state, and logout flows. - Migrate stored secrets on first launch by reading from Identity Vault and writing them with Native Biometric.
- Remove Ionic Identity Vault from your dependencies and native configuration.
Next steps
Section titled “Next steps”Keep going from Migrate from Ionic Identity Vault
Section titled “Keep going from Migrate from Ionic Identity Vault”If you are using Migrate from Ionic Identity Vault to plan security and compliance, connect it with Encryption for the implementation detail in Encryption, Compliance for the implementation detail in Compliance, Capgo Security Scanner for the product workflow in Capgo Security Scanner, Capgo Security for the product workflow in Capgo Security, and Capgo Trust Center for the product workflow in Capgo Trust Center.