Cordova TouchID Plugin
Also works with Face ID on iPhone X 🚀
Scan the fingerprint of your user with the TouchID sensor (iPhone 5S).
- Compatible with Cordova Plugman.
- Minimum iOS version is 8 (error callbacks will be gracefully invoked on lower versions).
- Requires a fingerprint scanner, so an iPhone 5S or newer is required.
Distorted a bit because I created it back when Apple had not yet released the SDK and they're not a fan of developers posting screenshots of unreleased features.
Automatically (CLI / Plugman)
$ cordova plugin add cordova-plugin-touch-id $ cordova prepare
The latest, from the master repo:
$ cordova plugin add https://github.com/EddyVerbruggen/cordova-plugin-touch-id $ cordova prepare
TouchID.js is brought in automatically. There is no need to change or add anything in your html.
1. Add the following xml to your
config.xml in the root directory of your
You'll need to add the
Security.framework to your project.
Click your project, Build Phases, Link Binary With Libraries, search for and add the frameworks.
2. Grab a copy of TouchID.js, add it to your project and reference it in
3. Download the source files and copy them to your project.
iOS: Copy the two
.h and two
.m files to
First you'll want to check whether or not the user has a configured fingerprint scanner. You can use this to show a 'log in with your fingerprint' button next to a username/password login form.
If the onSuccess handler was called, you can scan the fingerprint.
There are two options:
The first method will offer a fallback option called 'enter passcode' which shows the default passcode UI when pressed.
The second method will offer a fallback option called 'enter password' (not passcode) which allows you to provide your own password dialog.
The errorhandler of the method above can receive an error code of
-2 which means the user pressed the 'enter password' fallback.
This will render a button labelled 'Enter password' in case the fingerprint is not recognized. If you want to provide your own label ('Enter PIN' perhaps), you can use awkwardly named function (added in version 3.1.0):
You can copy-paste these lines of code for a quick test:
Touch ID available?Scan fingerprint
Since iOS9 it's possible to check whether or not the list of enrolled fingerprints changed since the last time you checked it. It's recommended you add this check so you can counter hacker attacks to your app. See this article for more details.
So instead of checking the fingerprint after
isAvailable add another check.
true you probably want to re-authenticate your user
before accepting valid fingerprints again.
Face ID Support
Since iOS 11, LocalAuthentication also supports Face ID for biometrics. This is a drop-in replacement for Touch ID and any existing apps using Touch ID will work identically on devices that use Face ID.
Since plugin version 3.3.0 the success callback of
the type of biometric ID, which is either
You can use this to display "Face ID" or "Touch ID" as appropriate in your app.
If you want to alter the usage description in the consent popup, then override the
default empty adds an empty
NSFaceIDUsageDescription. To do so, pass the following variable when installing the plugin:
cordova plugin add cordova-plugin-touch-id --variable FACEID_USAGE_DESCRIPTION="For easy authentication"