Document Capture - SelphID

Version 2.3.X

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 management of cameras and permissions.

• Assistant in the capture processes for the front and back of the document.

• Extraction of the information contained in the document.

• Obtaining images of the back and front 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

Cordova:

cordova plugin add @facephi/sdk-selphid-cordova@<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

Method launchSelphID

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 Face Capture:

exports.launchSelphID = function (cfg) {
    return new Promise((resolve, reject) => {
        var config = [];
        try {
            config = [{ config_id: cfg }];
        } catch (e) {
            console.log(e);
        }

        exec(resolve, reject, 'SdkSelphid', 'launchSelphID', config);
    });
};

Basic configuration

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

The basic configuration needed for this is as follows:

export interface SelphIDConfiguration 
{
    wizardMode?: boolean;
    documentSide: SelphIDDocumentSide;
    resourcesPath: string;
    debug?: boolean;
    showResultAfterCapture?: boolean;
    showTutorial?: boolean;
    tutorialOnly?: boolean;
    scanMode?: SelphIDScanMode;
    specificData?: string;
    fullscreen?: number;
    tokenImageQuality?: number;
    documentType?: SelphIDDocumentType;
    timeout?: SelphIDTimeout;
    tokenPrevCaptureData?: string;
    generateRawImages?: boolean;
    imageQuality?: number;
    compressFormat?: SelphIDCompressFormat;
    documentModels?: string;
    params?: any;
    showDiagnostic?: boolean;
    cameraId?: number;
    translationsContent?: string;
    viewsContent?: string;
    showPreviousTip?: boolean;
    vibrationEnabled?: boolean;
}

Advanced component configuration

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

SelphID Configuration

---

Result reception

The launch will return the information in SelphIDResult format. It can be distinguished between a successful launch and an unsuccessful one:

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 SDK level (which are explained in the document of Advanced settings), this specific component allows its own Customization.

SelphID - Component Customization