Adding the SDK to your project

To add our SDK to your own application, you should add it to the build process of your application. Currently we only support doing this using Gradle.
Adding the SDK to your gradle build file consist of two steps:

Adding the repository

To add the repository to your project, open the settings.gradle file in your application.
Edit the repositories part of your settings.gradle, so that it contains the following:

                
maven {
    credentials {
        username 'ExampleUsername'
        password 'ExamplePassword'
    }
    url "https://custom-ocr.klippa.com/sdk/android/maven"
}
maven { url "https://jitpack.io" }
                
            

We add jitpack.io because some of our dependencies are hosted there. If your settings.gradle already contains jitpack.io, don't add it.
The full repositories section of your settings.gradle might look like this now:

                
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    repositories {
        google()
        mavenCentral()
        maven {
            credentials {
                username 'ExampleUsername'
                password 'ExamplePassword'
            }
            url "https://custom-ocr.klippa.com/sdk/android/maven"
        }
        maven { url "https://jitpack.io" }
    }
}
                
            

Adding the dependency

Edit the dependencies part of your build.gradle, so that it contains the following:

                
implementation 'com.klippa:identity_verification:0.7.5'
                
            

The full dependencies section of your build.gradle might look like this now:

                
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'androidx.appcompat:appcompat:1.1.0'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'androidx.test.ext:junit:1.1.0'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1'
    implementation 'com.klippa:identity_verification:0.7.5'
}
                
            

When you build your app now, it should download our library as dependency, and with that all dependencies of our library.

Creating sessions

Before you can start using the identity verification you need to generate a session token in your backend. You can then start the session using your newly generated token. Once the session has been completed you can collect the files and data read by the OCR.

Starting the identity verification

To start the identity verification, import our package:

                        
// Add to the top of your file
import com.klippa.identity_verification.modules.base.IdentitySession;
                        
                    

                        
// Add to the top of your file
import com.klippa.identity_verification.modules.base.IdentitySession
                        
                    

Then start the session from your own Activity

                        
public class MainActivity extends AppCompatActivity {

    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // @todo: get a session token from the API through your backend here.
        IdentitySession identitySession = new IdentitySession("{your-session-token}");

        yourButton.setOnClickListener(buttonView ->
            startIdentitySession.launch(identitySession)
        );

    }

    private final ActivityResultLauncher startIdentitySession = registerForActivityResult(new StartIdentitySession(),
        sessionResultCode -> {
            // switch over the `sessionResultCode` and handle accordingly.
        }
    );

}
                        
                    

                        
class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // @todo: get a session token from the API through your backend here.
        val identitySession = IdentitySession("{your-session-token}")


        yourButton.setOnClickListener {
            startIdentitySession.launch(identitySession)
        }
    }

    private val startIdentitySession = registerForActivityResult(StartIdentitySession()) { sessionCode ->
        // switch over the `sessionCode` and handle accordingly.
    }
}
                        
                    

Session Codes

When the SDK is finished it will return a IdentitySessionResultCode. The current session codes are:

Note: It's also possible to get a message from each IdentitySessionResultCode by calling message() on the sessionCode

• FINISHED
• CONTACT_SUPPORT_PRESSED
• INSUFFICIENT_PERMISSIONS
• INVALID_SESSION_TOKEN
• USER_CANCELED
• NO_INTERNET_CONNECTION
• DEVICE_DOES_NOT_SUPPORT_NFC
• DEVICE_NFC_DISABLED
• TAKING_PHOTO_FAILED
• INCORRECT_SESSION_SETUP
• UNKNOWN_ERROR

Customizing the session

The SDK has a few customizing settings, the following methods are available:

Colors

Add or edit the file android/app/src/main/res/values/colors.xml, add the following:

                    
<color name="kiv_text_color">#FF0000</color>
<color name="kiv_background_color">#000000</color>
<color name="kiv_button_success_color">#4CAF50</color>
<color name="kiv_accent_color">#E91E63</color>
<color name="kiv_button_error_color">#673AB7</color>
<color name="kiv_button_other_color">#333333</color>
<color name="kiv_progress_bar_background_color">#00FFFF</color>
<color name="kiv_progress_bar_foreground_color">#9C27B0</color>
<color name="kiv_camera_success_background_color">#BBAC27</color>
                    
                

Fonts

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
                    
                

Language

We currently support English, Dutch, German, French and Spanish.
Note: It's currently not possible to change the strings.

                        
identitySession.language = IdentityBuilder.KIVLanguage.English;
                        
                    

                        
identitySession.language = IdentityBuilder.KIVLanguage.English
                        
                    

Retry Threshold

To configure how often a user can attempt a task before the contact support button is shown to the user.

                        
identitySession.retryThreshold = 1;
                        
                    

                        
identitySession.retryThreshold = 1
                        
                    

Intro/Success screens

To configure whether to show intro/success screens, add the following to the session:

                        
identitySession.hasIntroScreen = true;
identitySession.hasSuccessScreen = true;
                        
                    

                        
identitySession.hasIntroScreen = true
identitySession.hasSuccessScreen = true
                        
                    

Auto capture

The ability to automatically take a photo of the document when it passes all checks.

                        
identitySession.enableAutoCapture = true;
                        
                    

                        
identitySession.enableAutoCapture = true
                        
                    

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.

                        
// Default value:
List<String> includeList = new ArrayList<>(Arrays.asList(
    "DateOfExpiry",
    "DateOfIssue",
    "DocumentNumber",
    "DocumentSubtype",
    "DocumentType",
    "Face",
    "Gender",
    "GivenNames",
    "Height",
    "IssuingCountry",
    "IssuingInstitution",
    "Nationality",
    "PersonalNumber",
    "PlaceOfBirth",
    "Residency",
    "Signature",
    "Surname"
));
identitySession.includeList = includeList;

// Default value (empty):
identitySession.excludeList = new ArrayList<>();
                        
                    

                        
// Default value:
identitySession.includeList = mutableListOf(
    "DateOfBirth",
    "DateOfIssue",
    "DocumentNumber",
    "DocumentSubtype",
    "DocumentType",
    "Face",
    "Gender",
    "GivenNames",
    "Height",
    "IssuingCountry",
    "IssuingInstitution",
    "Nationality",
    "PersonalNumber",
    "PlaceOfBirth",
    "Residency",
    "Signature",
    "Surname"
)

// Default value (empty):
identitySession.excludeList = mutableListOf()
                        
                    

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.

                        
// Default value:
List<String> validationIncludeList = new ArrayList<>(Arrays.asList(
    "DetectFace",
    "CompareFace",
    "DetectSignature",
    "CompareSignature",
    "CheckRequiredField",
    "MatchSidesFront",
    "MatchSidesBack",
    "FieldValidation",
    "MatchVizMrz",
    "MrzChecksum"
));
identitySession.kivValidationIncludeList = validationIncludeList;

// Default value (empty):
identitySession.kivValidationExcludeList = new ArrayList<>();
                        
                    

                        
identitySession.kivValidationIncludeList = listOf(
    "DetectFace",
    "CompareFace",
    "DetectSignature",
    "CompareSignature",
    "CheckRequiredField",
    "MatchSidesFront",
    "MatchSidesBack",
    "FieldValidation",
    "MatchVizMrz",
    "MrzChecksum"
)

// Default value (empty):
identitySession.kivValidationExcludeList = mutableListOf()
                        
                    

APK size / APK splitting

Because our SDK includes OpenCV, which includes native code which in turn generates a native library (.so file) for every architecture, the APK size can increase quite a bit by using our SDK.
To minimize the impact of the SDK on your app size, you can enable APK splitting in your build.grade, like this:

                
android {
    // Other options
    splits {
       abi {
           enable true
           universalApk false
           reset()
           include 'arm64-v8a', 'armeabi-v7a', 'x86', 'x86_64'
       }
    }
    // Other options
}
                
            

In our example app (which contains not much more than the SDK), this resulted in the following APK files:

• arm64-v8a.apk: 28MB
• armeabi-v7a.apk: 15.2MB
• x86_64.apk: 29.1MB
• x86.apk: 28.4MB

While creating a single APK file creates a file that is 100.8MB, since most phones are ARM, on average APK splitting will result in a 45MB smaller APK, in those cases the SDK will add between 47-61MB to the APK size.

Please note that all APK files should be signed and uploaded to the Play Store to get a release that works on all devices.

JavaDoc

The JavaDoc of the latest version is available for download here.

Versions

The following versions are available:

Changelog