Document Capture - SelphID

Document capture is performed with the SelphID Plugin.

This component is responsible for capturing identity documents and analyzing the data obtained. Its main processes are:

• Internal camera and permission management.

• Assistant in the processes of capturing the front and back of the document.

• Extraction of the information contained in the document.

• Obtaining the images of the front and back of the document, as well as other images included in the document: user face, user signature,...

• High level of configuration: different countries, languages, document types...

---

Dependencies

React:

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

Android - Gradle:

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

iOS - CocoaPods:

pod 'FPHISDKSelphIDComponent', '~> $version'

Available methods

This component contains several methods that execute different functionalities:

Method	Description
launchSelphID	Main document capture controller

selphid 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 selphid(config: SelphidConfiguration): Promise<SelphidResult> {
  return SdkSelphid.selphid(config);
}

Basic configuration

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

The basic configuration required for it is as follows:

 export interface SelphidConfiguration {
  debug?: boolean;
  fullscreen?: boolean;
  tokenImageQuality?: number;
  timeout?: SdkTimeout;
  showResultAfterCapture?: boolean;
  showTutorial?: boolean;
  tutorialOnly?: boolean;
  scanMode?: SdkScanMode;
  specificData?: string;
  documentType?: SdkDocumentType;
  videoFilename?: string;
  documentModels?: string;
  generateRawImages?: boolean;
  translationsContent?: string;
  viewsContent?: string;
  cameraId?: number;
  params?: any;
  resourcesPath?: string;
  tokenPrevCaptureData?: string;
  wizardMode?: boolean;
  documentSide?: SdkDocumentSide;
  showDiagnostic?: boolean;
  compressFormat?: SdkCompressFormat;
  jpgQuality?: number;
  showPreviousTip?: boolean;
  vibrationEnabled?: boolean;
}

Advanced component configuration

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

SelphID Configuration

---

Receiving the result

The launch will return the information in SelphidResult. Being able to distinguish between a successful and an unsuccessful launch:

export interface SelphidResult 
{
    finishStatus: number;
    finishStatusDescription: string;
    errorType: string;
    errorMessage?: string;
    frontDocumentImage?: string;
    backDocumentImage?: string;
    faceImage?: string;
    signatureImage?: string;
    fingerprintImage?: string;
    documentData?: string;
    tokenFrontDocument?: string;
    tokenBackDocument?: string;
    tokenFaceImage?: string;
    tokenOCR?: string;
    documentCaptured?: string;
    captureProgress: number;
    matchingSidesScore: number;
    rawFrontDocument?: string;
    rawBackDocument?: string;
    tokenRawFrontDocument?: string;
    tokenRawBackDocument?: string;
    lastActionBeforeCapture?: string;
}

Advanced component configuration

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

SelphID 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.

SelphID - Component Customization