Video ID - VideoID

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

• Internal management of cameras, microphone, and permissions.

• Connection with the services.

• OCR reading and document capture.

Dependencies

Flutter:

dependencies:
  fphi_sdkmobile_videoid:
    hosted:
      name: fphi_sdkmobile_videoid
      url: https://facephicorp.jfrog.io/artifactory/api/pub/pub-pro-fphi/
    version: ^<Version>

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:

class VideoIdConfiguration
{
  PreferredCamera mPreferredCamera;
  VideoMode mMode;
  String? mUrl;
  String? mApiKey;
  String? mTenantId;
  String? mSpeechText;
  List<String>? mDocumentFilter;
  List<String>? mCountryFilter;
  bool mShowTutorial;
  bool? mShowDiagnostic;
  bool? mAutoFaceDetection;
  bool? mDebug;
  bool? mVibrationEnabled;
  int mSectionTime;
  int? mSectionTimeout;
  int? mTimeoutServerConnection;
  int? mTimeoutFaceDetection;
  int? mMaxRetries;
}

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:

class VideoIdResult
{
  final SdkFinishStatus finishStatus;
  final String finishStatusDescription;
  final String errorDiagnostic;
  final String? errorMessage;
  final dynamic ocrMap;
  final String? faceImage;
  final String? faceImageTokenized;
  final double? matchingSidesScore;
  final String? speechText;
  final String? documentType;
  final dynamic personalData;
  final dynamic frontDocumentData;
  final dynamic backDocumentData;
  final dynamic ocrDiagnostic;
}

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

Video ID Result