Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fingerprint Capture

Introduction

Fingerprint Capture is performed through the Phingers Component.

This component is responsible for capturing the user's fingerprints (fingerprints) and extracting the associated biometric templates. Its main processes are:

  • Internal camera and permission management.

  • Different extraction modes: full hand (four fingers without thumb), thumb, or individual fingers.

  • Integrated liveness detection.

  • Guided assistance during the capture process.

  • Generation of biometric templates, images, and quality metrics.

Dependency

The specific dependency for the component is:

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

Available controllers

Controller

Description

PhingersTFController

Main fingerprint capture controller

Receiving errors

  • PHG_ACTIVITY_RESULT_ERROR: The activity result is incorrect.

  • PHG_ACTIVITY_RESULT_MSG_ERROR: The activity result message is incorrect.

  • PHG_APPLICATION_CONTEXT_ERROR: The application context is null.

  • PHG_CANCEL_BY_USER: The user has canceled the process.

  • PHG_CANCEL_LAUNCH: General SDK cancellation.

  • PHG_COMPONENT_LICENSE_ERROR: The component license is not valid.

  • PHG_EMPTY_LICENSE: The license string is empty.

  • PHG_FETCH_DATA_ERROR: Error collecting the result.

  • FLOW_ERROR: Error in the flow process.

  • PHG_INITIALIZATION_ERROR: Initialization error.

  • PHG_INTERNAL_ERROR: Internal error.

  • PHG_LOW_QUALITY: Low image quality.

  • PHG_MANAGER_NOT_INITIALIZED: The managers are null or not initialized.

  • PHG_NO_DATA_ERROR: No data has been received from the capture.

  • PHG_OPERATION_NOT_CREATED: There is no operation in progress.

  • PHG_PERMISSION_DENIED: The user has denied the permissions.

  • PHG_AUTOFOCUS_FAILURE: Autofocus failure.

  • PHG_CAMERA_FAILURE: Camera failure.

  • PHG_CAPTURE_FAILURE: Capture failure.

  • PHG_CONFIGURATION_FAILURE: Configuration error.

  • PHG_FINGERPRINT_CAPTURE_FAILURE: Failure in Fingerprint Capture.

  • PHG_FINGERPRINT_TEMPLATE_IO_ERROR: Template IO error.

  • PHG_LICENSING_FAILURE: License failure.

  • PHG_LIVENESS_FAILURE: Error in the liveness check.

  • PHG_NO_FINGERS_DETECTED: No fingerprints have been detected.

  • PHG_UNIQUE_USER_ID_NOT_SPECIFIED: User not specified.

  • PHG_TIMEOUT: Timeout in the process.

  • PHG_FLOW_VIDEO_RECORDING_ERROR: Error in the flow's Video Recording.

  • PHG_FLOW_TRACKING_ERROR: Tracking error in the flow.

  • PHG_TRACKING_STEP_ERROR: Error in the tracking step.

Advanced configuration

The controller uses PhingersConfigurationData to adjust the capture behavior. In addition to the parameters for finger selection, quality, liveness, or help screens, optional fields can be provided for activation and Widget traceability:

  • licenseKey: License key passed to the Phingers TF Widget.

  • product: Product associated with activation or licensing.

  • operationId: Operation identifier sent to the Widget.

The configuration also allows enabling local Video Recording of the capture:

  • videoRecordingEnabled: Enables local recording during capture. By default false.

  • videoRecordingDirectoryPath: Optional destination directory for the generated MP4.

  • videoRecordingFileName: Optional file name.

  • videoRecordingQuality: Quality LOW, MEDIUM or HIGH. By default MEDIUM.

Reception of the correct result - data

If successful, data contains a PhingersResult with the captured fingerprints, images slap when applicable, and the average liveness (livenessScore).

When local recording is enabled and the Widget generates an MP4 file, PhingersResult.recording can return:

  • path: Full path of the generated file.

  • fileName: Video file name.

  • mimeType: File MIME type. By default video/mp4.

  • sizeBytes: File size in bytes, when the Widget reports it.

  • durationMs: Video duration in milliseconds, when the Widget reports it.

Last updated