Implementation Guide

Authentication

A unique access token should be created upon each SDK entry. In order to generate an access token, please refer to Valify's Authentication Documentation.

Security Warning: For improved security, consider implementing the access token fetching logic outside the Activity. This helps keep sensitive credentials secure and reduces potential exposure within the Activity/Fragment code.

Importing

Import the module’s function in your file using the following line

import 'package:crossplatform_flutter_vidvdockit/crossplatform_flutter_vidvdockit.dart';

Configurations

The plugin builder is separated into two components.

Required Configurations

Initialize the required parameters as follows while adding the required configurations

  final String baseURL = ' '; //put your acctual base url here
  final String bundleKey = ' '; //put your actual bundle key here
  final String accessToken = ' '; //put your actual access token here
  final String document_type = '' //avaliable doc types: passport - egyNID - tunNID -dzaNID; 

Optional Configurations

Initialize the required parameters as follows while adding the desired configurations

final String language = "<insert_language>"; // "en" is set as default
final String capture_mode = "<insert_capture_mode>"; // "automatic" is set as default
final int auto_after_seconds = <int>; // 6 is set as default
final bool review_data = <boolean>; // true is set as default
final bool collect_user_info = <boolean>; // false is set as default
final bool preview_captured_image = <boolean>; // false is set as default
final bool advanced_confidence = <boolean>; // false is set as default
final bool profession_analysis = <boolean>; // false is set as default
final bool document_verification_plus = <boolean>; // false is set as default
final Map<String, dynamic> extras = {}; // default is empty, you either use the extras map or the booleans document_verification_plus, advanced_confidence, profession_analysis
final bool document_liveness = <boolean>; // false is set as default
final String primary_color = "<hex_color_code>"; // default is Valify primary color
final bool disable_logo = <boolean>; // false is set as default
final String custom_logo = "<base_64_image>"; // default is empty
final Map<String, String> headers = {}; // default is empty
final String ssl_certificate = "<ssl_certificate>"; // default is empty

Configurations Breakdown

This section shows the breakdown of all optional builder configurations.

1. Sets the base URL used by the SDK to communicate with your backend APIs.

  final String baseURL = ' '; //put your acctual base url here

2. Sets the access token required for authenticating SDK API requests.

  final String accessToken = ' '; //put your actual access token here

3. Associates the session with your account using a unique bundle key.

  final String bundleKey = ' '; //put your actual bundle key here

4. Specifies the type of document to be captured by the SDK.

Available options:

• passport

• egyNID

• tunNID

• dzaNID

final String document_type = '' //avaliable doc types: passport - egyNID - tunNID -dzaNID; 

1. The following line is where the user interface language is set.

final String language = "<insert_language>"; // ["ar" or "en" or "fn"] 

The currently supported languages are Arabic, English and French

1. If this flag is set to true, the SDK performs additional data validations on the document. These validations are returned in the SDK response as flags, and you must implement your own handling logic based on these flags [Handling Document Verification Plus Flags in Code] , the SDK does not auto-reject or block the transaction.

View Document Verification Plus Breakdown here: [Understanding Document verification plus flag]

final bool document_verification_plus = <boolean>;

1. If this flag is set to true, the SDK detects potential physical or digital manipulation in the National ID. These validations are returned in the SDK response as flags, and you must implement your own handling logic based on these flags [Handling Advanced Confidence Flags in Code] , the SDK does not auto-reject or block the transaction.

View Advanced Confidence Breakdown here: [Understanding Advanced Confidence flag]

final bool advanced_confidence = <boolean>;

1. If the following line is set to true, the captured image will be displayed for the user.

final bool preview_captured_image = <boolean>;

1. If the following line is set to true, the SDK will automatically enable manual capture if it detects that the user is unable to autocapture card.

final bool manual_capture_mode = <boolean>;

1. If the following line is set to true, a screen is added to the user flow that displays the images captured and the OCR result to the user.

final bool review_data = <boolean>;

1. If the following lineis used you, you have the flexibility to control how document images are captured.

final String capture_mode = <String>; //choose from automatic - manual - auto_after

1. If the capture_mode is set to auto_after, this configuration is required to specify the number of seconds before the SDK switches from automatic capture to manual capture mode.

final int auto_after_seconds = <int>; // 6 is set as default

1. The following line is optional and can be used to set your company's branding color to the SDK's user interface.

final String primaryColor = ”<hex_color_code>”;

1. If the following line is set to true, the Valify logo will be hidden from the SDK user interface.

final bool disable_valify_logo = <boolean>;

1. The following line can be used to display a custom logo instead of the default Valify logo. The value should be a base64-encoded image string.

final String custom_logo = "<base_64_image>";

1. The following line is optional and can be used to set any headers that may be required for purposes specific to your application. Any headers set will be sent along with each API call made by the SDK.

final HashMap<String, String> headers = HashMap();

1. The following line is optional and can be used to set an SSL certificate that may be required for purposes specific to your application.

final InputStream sslCertificate = <InputStream>;

1. Adds optional feature flags that enhance the SDK's processing capabilities. These extras allow you to enable advanced functionalities during EGY NID document processing:

• advancedConfidence → Enables Physical manipulation detection

• professionAnalysis → Enables profession categorization

• documentVerificationPlus → Enables document validation

final Map<String, dynamic> extras = {
"advancedConfidence": true,
"professionAnalysis": true,
"documentVerificationPlus": true,
};

1. If the following line is set to true then you need to enable the location permission to your application to use collect user info option

 final bool collect_user_info = <boolean>; 

Parameter Declaration

Declare the SDK parameters with the configuration variables previously created

// Parameter map for SDK initialization
Map<String, dynamic> params = {
  "base_url": baseURL,
  "access_token": accessToken,
  "bundle_key": bundleKey,
  "language": language,
  "capture_mode": capture_mode,
  "auto_after_seconds": auto_after_seconds,
  "review_data": review_data,
  "collect_user_info": collect_user_info,
  "preview_captured_image": preview_captured_image,
  "capture_only_mode": capture_only_mode,
  "advanced_confidence": advanced_confidence,
  "profession_analysis": profession_analysis,
  "document_verification_plus": document_verification_plus,
  "document_liveness": document_liveness,
  "primary_color": primary_color,
  "disable_valify_logo": disable_valify_logo,
  "custom_logo": custom_logo,
  "headers": headers,
  "ssl_certificate": ssl_certificate,
  "extras": extras
};

Start the SDK

To start the DocKit SDK, call the start method with your configuration arguments:

 final result = await VIDVDocKit().start(params);