Video ID - VideoID

This component is responsible for recording a user identifying themselves, showing their face and their identity document.

Dependencies

Cordova:

cordova plugin add @facephi/sdk-videoid-cordova@<version>

Android - Gradle:

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

iOS - CocoaPods:

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

Method startVideoIdComponent

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.

Component launch:

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

        exec(resolve, reject, 'SdkVideoId', 'videoId', config);
    });
};

Basic configuration

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

The basic configuration required for it is as follows:

export interface VideoIdConfiguration {
  mode?: VideoMode;
  showTutorial?: boolean;
  autoFaceDetection?: boolean;
  url?: string;
  apiKey?: string;
  tenantId?: string;
  timeoutServerConnection?: number;
  sectionTime?: number;
  vibrationEnabled?: boolean;
  timeoutFaceDetection?: number;
  ocrValidations?: string[];
  countryFilter?: string[];
  documentFilter?: string[];
  sectionTimeout?: number;
  cameraPreferred?: CameraPreferred;
  maxRetries?: number;
  speechText?: string;
  debug?: boolean;
}

Video ID Configuration

Advanced component configuration

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

Receiving the result

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

export interface VideoIdResult {
  finishStatus: number;
  finishStatusDescription?: string;
  errorType: string;
  errorMessage?: string;
  faceImage?: string;
  faceImageTokenized?: string;
  documentFaceImageTokenized?: string;
  matchingSidesScore?: number;
  speechText?: string;
  documentType?: string;
  personalData?: any;
  frontDocumentData?: any;
  backDocumentData?: any;
  ocrMap?: any;
  ocrDiagnostic?: any;
}

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

Video ID Result