klippa_identity_verification_sdk

Description:

klippa identity verification sdk

flutter-klippa-identity-verification-sdk #


SDK usage #
Please be aware you need to have a Klippa Identity Verification OCR API key to use this SDK.
If you would like to use our Identity Verification SDK, please contact us here
Getting started #
Android #
Edit the file android/key.properties, if it doesn't exist yet, create it. Add the SDK credentials:
klippa.identity_verification.sdk.username={your-username}
klippa.identity_verification.sdk.password={your-password}
copied to clipboard
Replace the {your-username} and {your-password} values with the ones provided by Klippa.
iOS #
Edit the file ios/Podfile, add the Klippa CocoaPod:
// Add this to the top of your file:
// Edit the platform to a minimum of 13.0, our SDK doesn't support earlier iOS versions.
platform :ios, '13.0'
ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_USERNAME'] = '{your-username}'
ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_PASSWORD'] = '{your-password}'

// Edit the Runner config to add the pod:
target 'Runner' do
// ... other instructions

// Add this below flutter_install_all_ios_pods
if "#{ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_URL']}" == ""
ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_URL'] = File.read(File.join(File.dirname(File.realpath(__FILE__)), '.symlinks', 'plugins', 'klippa_identity_verification_sdk', 'ios', 'sdk_repo')).strip
end

if "#{ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_VERSION']}" == ""
ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_VERSION'] = File.read(File.join(File.dirname(File.realpath(__FILE__)), '.symlinks', 'plugins', 'klippa_identity_verification_sdk', 'ios', 'sdk_version')).strip
end

pod 'Klippa-Identity-Verification', podspec: "#{ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_URL']}/#{ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_USERNAME']}/#{ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_PASSWORD']}/KlippaIdentityVerification/#{ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_VERSION']}.podspec"
end
copied to clipboard
Replace the {your-username} and {your-password} values with the ones provided by Klippa.
Edit the file ios/{project-name}/Info.plist and add the NSCameraUsageDescription value:
...
<key>NSCameraUsageDescription</key>
<string>Access to your camera is needed to photograph documents.</string>
<key>NSPhotoLibraryAddUsageDescription</key>
<string>Access to your photo library is used to save the images of documents.</string>
...
copied to clipboard
Flutter #
Add klippa_identity_verification_sdk as a dependency in your pubspec.yaml file.
Usage #
import 'package:klippa_identity_verification_sdk/klippa_identity_verification_sdk.dart';

var identityBuilder = IdentityBuilder();
try {
// @todo: get a session token from the API through your backend here.
var sessionResult = await KlippaIdentityVerificationSdk.startSession(identityBuilder, '{insert-session-token-here}');
} on PlatformException catch (e) {
print('Failed to start session: ' + e.toString());
}
copied to clipboard
After returning from the SDK you can use the API to validate the session in your backend.
The reject reason object has a code and a message, the used codes are:

E_ACTIVITY_DOES_NOT_EXIST (Android only)
E_FAILED_TO_SHOW_SESSION (Android only)
E_MISSING_SESSION_TOKEN
E_CANCELED
E_UNKNOWN_ERROR
E_CONTACT_SUPPORT_PRESSED

How to use a specific version of the SDK? #
Android #
Edit the file android/build.gradle, add the following:
allprojects {
// ... other definitions
project.ext {
klippaIdentityVerificationVersion = "{version}"
}
}
copied to clipboard
Replace the {version} value with the version you want to use.
If you want to change the repository:
Edit the file android/key.properties, add the SDK repository URL:
klippa.identity_verification.sdk.url={repository-url}
copied to clipboard
Replace {repository-url} with the URL that you want to use.
iOS #
Edit the file ios/Podfile, add the following line below the username/password if you want to change the version:
ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_VERSION'] = '{version}'
copied to clipboard
Replace {version} with the version that you want to use.
If you want to change the repository:
Edit the file ios/Podfile, add the following line below the username/password if you want to change the URL:
ENV['KLIPPA_IDENTITY_VERIFICATION_SDK_URL'] = '{repository-url}'
copied to clipboard
Replace {repository-url} with the URL that you want to use.
How to change the setup of the SDK: #
Debug #
To display extra debug info, add the following to the builder:
identityBuilder.isDebug = true;
copied to clipboard
Enable Auto Capture #
To configure if the camera should automatically take a photo if the conditions are right.
identityBuilder.enableAutoCapture = true;
copied to clipboard
Intro/Success screens #
To configure whether to show intro/success screens, add the following to the builder:
identityBuilder.hasIntroScreen = true;
identityBuilder.hasSuccessScreen = true;
copied to clipboard
Retry Threshold #
To configure how often a user can attempt a task before the contact support button is shown to the user.
identityBuilder.retryThreshold = 1;
copied to clipboard
Language #
Add the following to the builder:
// We support English, Dutch, Spanish, German and French.
identityBuilder.language = KIVLanguage.Dutch;
copied to clipboard
When no language is given we try to detect the language of the device and use that if we support it.
Include & Exclude lists #
You can edit the include list: The extracted data keys that will be shown to the user after document pictures are processed.
Or the exclude list: The extracted data keys that will be hidden for the user after document pictures are processed.
identityBuilder.verifyIncludeList = [
"DateOfBirth",
"DateOfIssue",
"DateOfExpiry",
"DocumentNumber",
"DocumentSubtype",
"DocumentType",
"Face",
"Gender",
"GivenNames",
"Height",
"IssuingCountry",
"IssuingInstitution",
"Nationality",
"PersonalNumber",
"PlaceOfBirth",
"Residency",
"Signature",
"Surname"
];

identityBuilder.verifyExcludeList = [];
copied to clipboard
Validation Include & Exclude lists #
You can edit the validation include list: the failed validations that are shown to the user Or the validation exclude list: the failed validations that are hidden from the user.
For more information regarding validations check out the API documentation.
identityBuilder.validationIncludeList = [
"DetectFace",
"CompareFace",
"DetectSignature",
"CompareSignature",
"CheckRequiredField",
"MatchSidesFront",
"MatchSidesBack",
"FieldValidation",
"MatchVizMrz",
"MrzChecksum"
]

identityBuilder.validationExcludeList = []
copied to clipboard
How to change the colors of the SDK? #
Android #
Add or edit the file android/app/src/main/res/values/colors.xml, add the following:
<?xml version="1.0" encoding="utf-8"?>
<resources>
<color name="kiv_text_color">#808080</color>
<color name="kiv_background_color">#FFFFFF</color>
<color name="kiv_button_success_color">#00CC00</color>
<color name="kiv_button_error_color">#FF0000</color>
<color name="kiv_button_other_color">#333333</color>
<color name="kiv_progress_bar_background_color">#EBEFEF</color>
<color name="kiv_progress_bar_foreground_color">#00CC00</color>
</resources>
copied to clipboard
You can also replace the fonts by adding the files:

android/app/src/main/res/font/kiv_font.ttf
android/app/src/main/res/font/kiv_font_bold.ttf

iOS #
Use the following properties in the builder:
// Colors:
identityBuilder.colors.textColor = Color.fromARGB(255, 128, 128, 128);
identityBuilder.colors.backgroundColor = Color.fromARGB(255, 255, 255, 255);
identityBuilder.colors.buttonSuccessColor = Color.fromARGB(255, 0, 204, 0);
identityBuilder.colors.buttonErrorColor = Color.fromARGB(255, 255, 0, 0);
identityBuilder.colors.buttonOtherColor = Color.fromARGB(255, 51, 51, 51);
identityBuilder.colors.progressBarBackground = Color.fromARGB(255, 235, 239, 239);
identityBuilder.colors.progressBarForeground = Color.fromARGB(255, 0, 204, 0);

// Fonts:
identityBuilder.fonts.fontName = 'Avenir Next';
identityBuilder.fonts.boldFontName = 'Avenir Next';
copied to clipboard
Important iOS notes #
Older iOS versions do not ship the Swift libraries. To make sure the SDK works on older iOS versions, you can configure the build to embed the Swift libraries using the build setting EMBEDDED_CONTENT_CONTAINS_SWIFT = YES.
We use XCFrameworks, you need CocoaPod version 1.9.0 or higher to be able to use it.
About Klippa #
Klippa is a scale-up from Groningen, The Netherlands and was founded in 2015 by six Dutch IT specialists with the goal to digitize paper processes with modern technologies.
We help clients enhance the effectiveness of their organization by using machine learning and OCR. Since 2015 more than a 1000 happy clients have been served with a variety of the software solutions that Klippa offers. Our passion is to help our clients to digitize paper processes by using smart apps, accounts payable software and data extraction by using OCR.
License #
The MIT License (MIT)