Android Fingerprint Auth


This plugin will open a native dialog fragment prompting the user to authenticate using their fingerprint. If the device has a secure lockscreen (pattern, PIN, or password), the user may opt to authenticate using that method as a backup.


ionic cordova plugin add cordova-plugin-android-fingerprint-authnpm install @ionic-native/android-fingerprint-auth
Ionic EE comes with fully supported and maintained plugins from the Ionic Team. Learn More or Contact Us
ionic enterprise register --key=YOURPRODUCTKEYnpm install @ionic-enterprise/android-fingerprint-auth

Supported Platforms

  • Android


import { AndroidFingerprintAuth } from '@ionic-native/android-fingerprint-auth/ngx';

constructor(private androidFingerprintAuth: AndroidFingerprintAuth) { }


  .then((result)=> {
      // it is available

      this.androidFingerprintAuth.encrypt({ clientId: 'myAppName', username: 'myUsername', password: 'myPassword' })
        .then(result => {
           if (result.withFingerprint) {
               console.log('Successfully encrypted credentials.');
               console.log('Encrypted credentials: ' + result.token);
           } else if (result.withBackup) {
             console.log('Successfully authenticated with backup password!');
           } else console.log('Didn\'t authenticate!');
        .catch(error => {
           if (error === this.androidFingerprintAuth.ERRORS.FINGERPRINT_CANCELLED) {
             console.log('Fingerprint authentication cancelled');
           } else console.error(error)

    } else {
      // fingerprint auth isn't available
  .catch(error => console.error(error));