Face Capture - Selphi

Version 2.3.X.

Introduction

Face Capture is performed with the Selphi Plugin.

This component is responsible for capturing a selfie of the user and subsequently extracting the most important facial features. Its main processes are:

• Internal camera and permission management.

• Assistant in the user's face capture processes.

• Generation of templates with the user's facial features and image.

---

Dependencies

React Native:

npm install @facephi/sdk-selphi-react-native@<Version>

Android - Gradle:

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

iOS - CocoaPods:

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

Available methods

This component contains several methods that perform different functionalities:

Method	Description
selphi	Main Facial Recognition controller

Selphi method

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

Face Capture launch:

export function selphi(config: SelphiConfiguration): Promise<SelphiResult> {
  return SdkSelphi.selphi(config);
}

Basic configuration

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

The basic configuration required for it is as follows:

export interface SelphiConfiguration {
  debug?: boolean;
  fullscreen?: boolean;
  cropPercent?: number;
  stabilizationMode?: boolean;
  templateRawOptimized?: boolean;
  resourcesPath?: string;
  enableGenerateTemplateRaw?: boolean;
  livenessMode?: SdkLivenessMode;
  showResultAfterCapture?: boolean;
  cameraFlashEnabled?: boolean;
  translationsContent?: string;
  viewsContent?: string;
  showTutorial?: boolean;
  cameraId?: number;
  videoFilename?: string;
  params?: any;
  qrMode?: boolean;
  showDiagnostic?: boolean;
  logImages?: boolean;
  compressFormat?: SdkCompressFormat;
  jpgQuality?: number;
  showPreviousTip?: boolean;
  vibrationEnabled?: boolean;
  extractionDuration?: SdkExtractionDuration;
  cameraPreferred?: SelphiCamera;
  moveSuccessfulAttempts?: number;
  moveFailedAttempts?: number;
}

Advanced component configuration

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

Selphi Configuration

---

Receiving the result

The launch will return the information in SelphiResult format. A distinction can be made between a successful launch and an unsuccessful one:

export interface SelphiResult {
  finishStatus?: number;
  errorType?: string;
  finishStatusDescription?: string;
  errorMessage?: string;
  bestImage?: string;
  bestImageCropped?: string;
  bestImageTemplateRaw?: string;
  qrData?: string;
  templateRaw?: string;
  images?: string[];
  livenessDiagnostic?: string;
}

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

Selphi Result

Component customization

In addition to the changes that can be made at the SDK level (which are explained in the document Advanced settings), this specific component allows its own Customization.

Selphi - Component Customization