Document Capture - SelphID

Document capture is performed with the SelphID Component.

Document capture is performed with the SelphID Component.

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

Flutter:

dependencies:
  fphi_sdkmobile_selphid:
    hosted:
      name: fphi_sdkmobile_selphid
      url: https://facephicorp.jfrog.io/artifactory/api/pub/pub-pro-fphi/
    version: ^<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
startSelphIDWidget	Main document capture controller

Method startSelphIDWidget

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.

Face Capture launch:

@override
Future<Map> startSelphIDWidget({required String resourcesPath, required SelphIDConfiguration widgetConfigurationJSON}) async
{
  final Map result = await methodChannel.invokeMethod('selphid', {"resourcesPath": resourcesPath, "widgetConfigurationJSON": widgetConfigurationJSON.toJson()});
  return result;
}

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:

class SelphIDConfiguration{
  bool? mWizardMode;
  bool? mDebug;
  bool? mShowResultAfterCapture;
  bool? mShowTutorial;
  bool? mTutorialOnly;
  bool? mFullscreen;
  bool mGenerateRawImages;
  bool? mShowDiagnostic;
  bool? mShowPreviousTip;
  bool? mVibrationEnabled;
  double mJPGQuality;
  double? mTokenImageQuality;
  String? mSpecificData;
  String? mTranslationsContent;
  String? mViewsContent;
  String? mDocumentModels;
  String? mVideoFilename;
  String? mTokenPreviousCaptureData;
  int? mCameraId;
  dynamic mParams;
  SelphIDScanMode? mScanMode;
  SelphIDDocumentSide? mDocumentSide;
  SelphIDDocumentType? mDocumentType;
  SelphIDTimeout? mTimeout;
  SelphIDCompressFormat mCompressFormat;
}

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 the format SelphIDResult. It being possible to distinguish between a successful launch and an unsuccessful one:

class SelphIDResult
{
  final SdkFinishStatus finishStatus;
  final String finishStatusDescription;
  final String errorDiagnostic;
  final String? errorMessage;
  final String frontDocumentImage;
  final String backDocumentImage;
  final String rawBackDocument;
  final String rawFrontDocument;
  final String fingerprintImage;
  final String faceImage;
  final String signatureImage;
  final String tokenRawBackDocument;
  final String tokenRawFrontDocument;
  final String tokenFrontDocument;
  final String tokenBackDocument;
  final String tokenFaceImage;
  final String documentData;
  final String tokenOCR;
  final String documentCaptured;
  final double matchingSidesScore;
}

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 of Advanced settings), this specific component allows its own Customization.

SelphID - Component Customization