How to implement fingerprint biometric authentication in your Android App? – complete source code

In this video it shows the steps to develop a fingerprint authentication Android App in Android Studio.

It creates a simple layout to trigger the authentication. And shows the success or failure of authentication using a text view and image view.

We will be glad to hear about any suggestions, queries or appreciations at: programmerworld1990@gmail.com

Images to show the fingerprints shown in this tutorial are placed below and can be downloaded to be used in your App development:

The results of the App tested on the real phone is shown below: 

Complete Source Code:

Source code:

package com.example.myfingerprintauthenticationapp;

import android.hardware.fingerprint.FingerprintManager;
import android.os.Bundle;
import android.view.View;
import android.widget.ImageView;
import android.widget.TextView;

import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {

private TextView textView;
private ImageView imageView;
private FingerprintManager fingerprintManager;
private FingerprintManager.AuthenticationCallback authenticationCallback;

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);

textView = findViewById(R.id.textView);
imageView = findViewById(R.id.imageView);
imageView.setImageResource(R.drawable.image1);
fingerprintManager = (FingerprintManager) getSystemService(FINGERPRINT_SERVICE);

authenticationCallback = new FingerprintManager.AuthenticationCallback() {
@Override
public void onAuthenticationError(int errorCode, CharSequence errString) {
textView.setText(“ERROR”);
imageView.setImageResource(R.drawable.image2);
super.onAuthenticationError(errorCode, errString);
}

@Override
public void onAuthenticationHelp(int helpCode, CharSequence helpString) {
textView.setText(“HELP”);
imageView.setImageResource(R.drawable.image1);
super.onAuthenticationHelp(helpCode, helpString);
}

@Override
public void onAuthenticationSucceeded(FingerprintManager.AuthenticationResult result) {
textView.setText(“SUCCESS”);
imageView.setImageResource(R.drawable.image3);
super.onAuthenticationSucceeded(result);
}

@Override
public void onAuthenticationFailed() {
textView.setText(“FAILED”);
imageView.setImageResource(R.drawable.image2);
super.onAuthenticationFailed();
}
};
}

public void scanButton(View view){
fingerprintManager.authenticate(null, null, 0, authenticationCallback, null);
}
}

Manifest File:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.myfingerprintauthenticationapp">

    <uses-permission android:name="android.permission.USE_FINGERPRINT" />
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

Gradle File:

apply plugin: 'com.android.application'

android {
    compileSdkVersion 29
    buildToolsVersion "29.0.2"
    defaultConfig {
        applicationId "com.example.myfingerprintauthenticationapp"
        minSdkVersion 26
        targetSdkVersion 29
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'androidx.appcompat:appcompat:1.1.0'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
}

Resource File:

<resources>
    <string name="app_name">My FingerPrintAuthentication App</string>
    <string name="result_display">Result Display ...</string>
    <string name="scan">Scan</string>
    <string name="todo">TODO</string>
</resources>

Layout XML File:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/textView"
        android:layout_width="212dp"
        android:layout_height="90dp"
        android:text="@string/result_display"
        android:textAlignment="center"
        android:textSize="24sp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.289" />

    <Button
        android:id="@+id/button"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginStart="158dp"
        android:layout_marginTop="64dp"
        android:onClick="scanButton"
        android:text="@string/scan"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <ImageView
        android:id="@+id/imageView"
        android:layout_width="217dp"
        android:layout_height="266dp"
        android:layout_marginStart="95dp"
        android:layout_marginTop="31dp"
        android:contentDescription="@string/todo"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/textView"
        tools:srcCompat="@drawable/image1" />

</androidx.constraintlayout.widget.ConstraintLayout>