Skip to content
No description, website, or topics provided.
Java Swift TypeScript Ruby Objective-C JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
android
ios
src
.gitignore
.npmignore
.travis.yml
CapacitorBiometricAuth.podspec
README.md
azure-pipelines.yml
package-lock.json
package.json
rollup.config.js
tsconfig.json

README.md

Capacitor Biometric Auth

NPM Downloads Build Status

Installation

  • npm i capacitor-biometric-auth
  • yarn add capacitor-biometric-auth

Usage

import { Plugins } from "@capacitor/core";

const { BiometricAuth } = Plugins;

const available = await BiometricAuth.isAvailable()

if (available.has) {
  const authResult = await BiometricAuth.verify({...})
  if (authResult.verified) {
    // success authentication
  } else {
    // fail authentication
  }
} else {
  // biometric not available
}

Methods

verify(options)

Open biometric popup

option values decription
reason any string Popup label
const result = await BiometricAuth.verify({reason: "Message ..."})

result

{
  verified: true // true if biometric auth was succes or false otherwise,
  status: {} // an object with errors matching biometric auth fails (on if verified === false)
}

status

error description
10 The user failed to provide valid credentials
11 Authentication was cancelled by application
12 The context is invalid
13 Not interactive
14 Passcode is not set on the device
15 Authentication was cancelled by the system
16 The user did cancel
17 The user chose to use the fallback

isAvailable()

Checks if biometric is enabled

const result = await BiometricAuth.isAvailable()

result

{
  has: true, // true if has biometric auth enabled, false otherwise
  status: {...} // an object with errors
}

status

error description
1 Biometric not available
2 Authentication could not continue because the user has been locked out of biometric authentication, due to failing authentication too many times.
3 Authentication could not start because the user has not enrolled in biometric authentication.
You can’t perform that action at this time.