Video ID - VideoID

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

Dependencies

Capacitor:

npm install @facephi/sdk-videoid-capacitor@<Version>
npm run build
npx cap sync

Android - Gradle:

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

iOS - CocoaPods:

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

Method startVideoIdComponent

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.

Component Launch:

Future<Map> startVideoIdComponent({required VideoIdConfiguration widgetConfigurationJSON})
{
  return FphiSdkmobileVideoidPlatform.instance.startVideoIdComponent(
      widgetConfigurationJSON: widgetConfigurationJSON
  );
}

Basic configuration

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

The basic configuration needed for this 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.

Result reception

The launch will return the information in the format VideoIdResult. It being possible to distinguish between a successful launch and an unsuccessful one:

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