Fingerprint Capture - Phingers

This plugin is responsible for capturing the user's fingerprints and subsequently extracting the fingerprint templates.

Its main features are as follows:

• Two operating modes: extraction of the four fingers of the hand (except the thumb), or extraction of only the thumb.

• Internal camera management.

• Permission management.

• Built-in liveness detection.

• Assistant in fingerprint capture processes.

• Generation of templates with fingerprint characteristics, images, and scores.

Dependencies

Capacitor:

npm install @facephi/sdk-phingers-capacitor@<Version>
npm run build
npx cap sync

Android - Gradle:

implementation "com.facephi.androidsdk:phingers_tf_component:$version"

iOS - CocoaPods:

s.dependency 'FPHISDKPhingersTFComponent', '~> $version'

startPhingers Method

Once the SDK has been started and a new operation has been created, the component can be launched. Any of its controllers can be used to execute its functionality.

Launching the fingerprint reader:

startPhingers(configuration: PhingersConfiguration): Promise<PhingersResult>;

Basic configuration

To launch the current component, an object PhingersConfiguration must be created, which will be the configuration of the component controller.

The basic configuration needed for this is as follows:

export interface PhingersConfiguration 
{
  fingersFilter?: FingersFilter;
  reticleOrientation: ReticleOrientation;
  fingerSelectorHandOrientation?: PhingerSelectorHandOrientation;
  fingerSelectorOptions?: string[];
  showEllipses?: boolean;
  useLiveness?: boolean;
  showTutorial?: boolean;
  extractionTimeout?: number;
  vibration?: boolean;
  showDiagnostic?: boolean;
  threshold?: number;
  showPreviousTip?: boolean;
  showPreviousFingerSelector?: boolean;
}

Phingers Configuration

Advanced component configuration

Below are all the fields that are part of this class.

Result reception

The launch will return the information in the format PhingersResult. It being possible to distinguish between a successful launch and an unsuccessful one:

export interface PhingersResult 
{
  finishStatus: number;
  finishStatusDescription?: string;
  errorType: string;
  errorMessage?: string;
  fingers?: any;
  slapImages?: any;
}

Below are all the fields that are part of this class.

Phingers Result