Skip to main content

Change Log

Version 5.2.0

Added 1 to N login

Added Auto-capture timeout setting for Capture Only mode

Exit dialog customizations

Fixed issue with disappearing Need Help button

Version 5.1.0

Added MinVideoLengthRequired config to allow videos shorter than 30 seconds in VideoSelfie module

All fixes and updates from 4.12.4

Version 5.0.0

Introduced new way to configure flows and setup onboarding sessions. Please refer to the Migration Guide

Video Selfie module now works in capture only mode

Introduced new way to initialize the SDK without the API URL and API KEY in capture only mode. Please refer to the guide here

Removed automated licence check from capture only mode to avoid network calls

Improved logic for handling location permission requests on Android 12 and above

Refactoring and bug fixes

Version 4.12.4

Fixed issue with Continue button not appearing in Tutorials on some devices

Fixed issue where the Back ID scan gets skipped in Second ID module

Fixed issues with Video Selfie ID scan

Fixed issue with Conference on Android 12 & 13

Version 4.12.3

Improved Video Selfie ID scan

Version 4.12.2

Fixed image distortion problem with back-camera on model SMA135

Updated okhttp3 logging interceptor

Version 4.12.1

Changed default value of waitForTutorial to false

Added customizable signature ink color

Migrating Geolocation and some base files to Kotlin

Updated third party libraries

Version welcome 4.12.0 & core-light 2.2.0

Introduced download and install time optimizations

Version 4.11.1

Added null checks for data repository access at OnLifecycleEvents

Version 4.11.0

Updated compile sdk version

Removed TensorFlow dependency and related files

Refactored Phone Number Module into Kotlin

Fixed document scan upload error when used local image

Version 4.10.2


Fixed ID Uploading/Processing screen to use @color/onboard_sdk_BackgroundWindow background color instead of hard-coded white

Version 4.10.0

Handling of IDProcess result

Changed blur threshold default value to 0.75

Added logic for removing duplicated ProcessId module

Fix for back id tutorial condition

Fix for broken attach-flows logic

Added raw JSON for UserScore into the UserScoreResult

Migrated some modules and UI elements to Kotlin

Updated HBRecorder dependency to latest version (Fixes issues with Android 12)

Version 4.9.0

Added ability to customize Selfie Scan circle outline color

Added ability to display Need Help screens in vertical mode

Fixed Need Help screens to use proper background color (onboard_sdk_BackgroundWindow)

Fixed code for parsing getLibraries API response

Fixed Xamarin bindings

Version 4.8.0

Added secondary text for Scan ID title

Added customizable thresholds for ID Glare and Blurriness checks (Added setIdGlareThreshold and setIdBlurThreshold methods to OnboardingConfigBuilderV2)

Added ability to customize Selfie Scan screen background color

Version 4.7.2

Fixed crash when pressing back after denying Camera permission

Fixed NaN when parsing ResponseProcessFace

Fixed unnecessary omni/update call when omni/addFace fails

Version 4.7.1

Added customizable Scan Feedback Text

Added customizable Manual Capture Instructions Text

Version 4.7.0

Added new individual style for Need help manual capture button

Added OnboardingConfigV2.setShowExitConfirmation() to enable configurable exit confirmation dialog

Added screen name to event values on BACKGROUND and USER_CANCELLED events

Added customizable help more subtexts

Added customizable id capture feedback background color

Added continue button string resource per screen

Fixed continue button disabled in Document Scan Tutorial

Version 4.6.1

Fixed bug with running ID scan on emulator which interrupted the flow

Fixed bug in start session which caused new session to be generated even when interviewId is provided.

Version 4.6.0

Added exit confirmation dialog

Added possibility to initialize SDK with Token (No ApiKey Init)

Added option to hide manual capture review photo screen

Fixed OnErrorNotImplementedException in takeCameraPicture() method

Bug fixes

Version 4.5.0

Added onEvent() callback to IOnboardingListenerV2 to track analytic Events locally

Prevent double-clicking buttons

Fixed Video Selfie video not uploaded in some cases

Fixed Video Selfie showing wrong feedback message

Version 4.4.1

Added option to show Close Button on all screens (Default: off)

Enabled customization for Need help

Replaced ID and SELFIE balloon images in FaceMatch module with TextView (Custom fonts are applied automatically now)

Fixed issue with missing back ID scan in certain use cases

Prevent Continue button from being clicked twice on Tutorial screens

Fixed issue with flow interrupting after ID/Passport scan

Fixed issue with rotation of some Documents on Photo Review screen

Fixed issue with Submit button on Captcha screen

Version 4.4.0

Added support for OTHER_DOCUMENT_3 in DocumentScan module

Version 4.3.1

Bug fixes

Version 4.3.0

SDK Version is now sent to the server and it is visible on the Dashboard

Document Scan module updates (allow file upload for all DocumentTypes)

Fixed compile-time error due to missing interface

Fixed onUserCancelled() callback not called in some cases

Removed jCenter repository

Bug fixes

Version 4.2.0

Added non-UI API for processing Labor History

Added non-UI API for processing Payment Proof

Added non-UI API for getting Payment Proof Info

Updated QR Scan module to send raw data to server

Captcha module improvements

Fixed empty values being sent in Captcha module

Fixed issue with feedback messages being too small

Fixed an issue in Signature module where clicking Done multiple times could cause an error

Fixed onOnboardingSessionCreated() callback called on the wrong thread

Fixed IdResults class missing

Fixed SDK config not set properly when using sections API

Bug fixes

Version 4.1.1

Added missing croppedFacePath to IdScanResult

Version 4.1.0

Added non-UI API for ID processing

Captcha module UI updates

Bug fixes

Version 4.0.0

Separated front and back ID scan modules. Check out Migration Guide for details.

Updates to SDK results: nameMatched in FaceMatchResult

VideoSelfie UX updates: White background and increased screen brightness for Selfie step

Refactoring and bug fixes: build process adapted for easier crowd testing distribution, fix for user already exists always shown

Version 3.6.0

Added geolocation(@NonNull Context context, @Nullable String interviewId, GeolocationListener geolocationListener) API which allows running the geolocation module without showing Incode's UI

Version 3.5.0

Added faceMatch(String interviewId, IdCategory idCategory, @NonNull FaceMatchListener faceMatchListener) API which allows doing a face match without showing Incode's UI

Added a static label to the scan ID screen to show which side of the ID is being scanned

Updates to SDK results: Unencrypted Base64 image in SelfieScanResult, ExistingUser and ExistingInterviewId in FaceMatchResult, GovernmentValidationResults in UserScoreResult

Bug fixes

Version 3.4.0

Moved liveness and face recognition models into standalone libraries - Make sure to check the Migration Guide

Added possibility to use on-device liveness while enrolling face

Face detection improvements

Bug fixes

Version 3.3.1

Added support for OTHER_DOCUMENT_1 and OTHER_DOCUMENT_2 in DocumentScan module

Added support for usage of Selfie in VideoSelfie from Dashboard flow

Added sending device fingerprint within setOnboardingSession()

Added getFrontIdBase64() and getBackIdBase64() to IdValidationResult

Added ability to disable emulator and root detection for debugging purposes

Added setExternalId(String externalId) method to OnboardingConfigV2

Updated UserConsent module

Added ID processing to VideoSelfie module

Fixed missing SelfieMode enum

UI improvements

Bug fixes

Version 3.3.0

Medical card scanning and validation

Selfie resolution step-up in order to get better liveness results

Doing face recognition between the selfie taken in video selfie and the enrolled face template even if liveness failed for the selfie taken in video selfie

Bug fixes

Version 3.2.1

Fixed crash in Conference module

Bug fixes

Version 3.2.0

Increased targetSdkVersion and compileSdkVersion from 29 to 30

Added setInterviewId(String interviewId) method to OnboardingConfigV2.OnboardingConfigBuilderV2

Added ability to start Onboarding SDK for an existing interviewId (which can be set in OnboardingConfigV2)

Bug fixes

Version 3.1.0

Reffered to executive screen redesign

API refactor: Individual API calls are deprecated, please check Migration Guide and User Guide for migrating to sections API

Updated to Gradle plugin 4.2.0 and Gradle Wrapper 6.9.1

Prevent false positive in hook detector when using Realm in a React Native app

Email module added

Implemented an API to disable a check which detected hooking framework on the device

New ID realtime check introduced - Check if front of the ID is shown as back. Disabled by deafult, can be turned on when initializing ID scan module.

Bug and UI fixes

Version 3.0.0

New customization options - Make sure to check the Migration Guide and Customization Guide

Fix for not sending finish status

Added IncodeWelcome interface to enable easier testing. Check and

Added full frame photo in SelfieScan result

Version 2.10.1

Added detailed event logging for Video Selfie

Fixed /omni/finish-status called multiple times in certain cases

Fixed Video Selfie module sometimes sending one extra selfie scan attempt

Hotfix: Fixed issue with attachFlow endpoint

Bug fixes

Version 2.10.0

Fixed broken Opentok dependency

Modularized VideoSelfie API: Added posibility to turn on/off ID scan, address proof scan, questions and voice consent.

Implemented second ID feature: IDScan and FaceMatch modules can be added to the flow twice and parametrized with second ID category.

Incode styleables and file provider renamed to support internal naming convention and avoid possible duplicate names with other libraries

Version 2.9.0

Made CTA buttons more uniform

Improved customization of CTA buttons

Added customization of "Need Help" button

Added Customer Token to Approve result

Error messages refactor

Face login feature changes:
Face recognition in server mode now sends photo to the server (instead of locally generated template)
API was adapted accordingly: enableFaceLogin() was replaced with enableLocalFaceRecognition()

Portuguese translations

Rebranding INE to government

Added new validation module: governmentOcrValidation

Bug fixes

Version 2.8.0

Added new ID detection model with on device classification, glare and sharpness checks

Added model encryption

Removed unused ExcludedValidationModules API

Implemented restart of the selfie scan if app is sent to background/foreground during the selfie step

Fixed UX and liveness problems in selfie scan on phones with narrow horizontal view angle (e.g. Samsung s9+)

Version 2.7.0

Added CURP validation

Added INE scraping

Bug fixes

Version 2.6.1

Added extendedOcrJsonData field to OCRData

Bug fixes

Version 2.6.0

Changes to IncodeWelcome.startFaceMatch() - Make sure to check the Migration Guide

API update: Possibility to set custom fields in onboarding session

Implemented Face Detection for devices without Google Services support

Bug and crash fixes

Version 2.5.1

Optimized resources in favour of size

API update: Possibility to set customer token for login feature

API update: Added binary face match and liveness results for clarity, simplicity and alignment with iOS

Small UI improvements

Bug and crash fixes

Version 2.5.0

Changes to ApproveListener - Make sure to check the Migration Guide

Replaced Tutorial videos with Lottie animations - Make sure to check the Migration Guide

Updated SDK to allow mocking of Results and Listener classes (for automated testing)

Prevent SDK from running on a real device when Test Mode is enabled

Bug fixes

Version 2.4.2

Added new fields to OCRData

Bug fixes

Version 2.4.1

Moved network security configuration to app level

Bug fixes

Version 2.4.0

Capture Only mode

Moved 'queueName' parameter from Conference module to OnboardingConfigV2

Bug fixes

Version 2.3.5

OMNI rebranding

Selfie scan defaults to manual capture if photo is not taken automatically

Help feature in ID scan

Informing the user about the number of ID scan retries

Analytics events updates

Added intro module for educating users about the process and to help with measuring conversion

Added onGeolocationUnavailable() callback

Using server configuration for auto capture timeouts and upload retries

Bug fixes

Version 2.3.4

Added analytics events

Added PDF/Image upload for Proof of Address documents

Implemented a mechanism to inform the server that the onboarding is complete from the client side

Fix for SDK not returning result after unsuccessful processing ID calls

Implemented new UI state after 3rd unsuccessful ID upload

Model download disabled by default. Customers can enable it through SDK.

Bug fixes

Version 2.3.3

Emulator support updates: EMULATOR_DETECTED as Face match module result, added missing OCR data fields

Version 2.3.2

Added setOnboardingSession() API to allow continuing the existing onboarding even after app unnstall

Added dummy OCR data to ID scan and Document scan result in case when emulator is detected

Version 2.3.1

Enabled emulator support in test SDK mode

Version 2.3.0

Sending parsed address from Geolocation module to server

Optional dependency for conference

Dynamic delivery mechanism implemenented for big ML resources

Downloading video selfie random questions from the server

ISO country code for specifying regions instead of a type

Bug fixes

Version 2.2.12

POA capture improvements

ID capture improvements

Selfie capture improvement

Signature API extended to accept tittle and subtitle

Bug fixes

Version 2.2.11

Fix for Canadian passport

Version 2.2.10

Introduced Canada region

Version 2.2.9

Video Selfie 2.0:

-Liveness check

-Proof of Address

-Random questions

-Minimum video length of 30 seconds Bug fixes

Version 2.2.8

Video recording improvements - size optimization and uninterrupted recording

Optional Proof Of Address Statement step in Video Selfie

Video Selfie design updates

Security updates

Bug fixes

Version 2.2.7

Geolocation module implemented

Bug fixes

Version 2.2.6

Video selfie feature implemented

Version 2.2.5

Upgrade mechanism for library download

Version 2.2.4

Bug fixes

Version 2.2.3

Fixed missing classes due to DexGuard config

Version 2.2.2

Fixed Proof of Address scan

Version 2.2.1

Separate address fields as part of the OCR result

Fixed broken signature bug

Version 2.2.0

Added public methods for starting individual SDK modules

Refactoring - moved and renamed SDK interface classes Please refer to for details

Version 2.1.6

Added more user information to OCRData

Version 2.1.5

Improved ID capture photo quality

ID capture design improvements

ID and selfie tutorials design improvements

Selfie feedback messages changes

Conference chat feature implemented

Added setWaitForTutorials() method for IdScan and SelfieScan modules

Bug fixes

Version 2.1.4

Optional captcha verification in retake video conference SDK API

Styles updated: reverted to text color white for base button style

Bug fixes

Version 2.1.3

Retake video-conference with specific token

Captcha module retry/fail mechanism implemented

Bug fixes

Version 2.1.2

Added UI for Approval module

Added option to perform Face Match inside Approval module

Added Legal screen

Refactoring to allow for some upcoming features

Bug fixes

Version 2.1.1

Allowing download-set API to be used in on-premise environment

Passport flow improvements

Version 2.1.0

Capture ID and capture selfie offline APIs. APIs perform capture when local conditions for the capture are met and return photos

Passport scanning and validation flow

Download libraries control exposed through new APIs

Bug fixes

Version 2.0.0

Using new server API

Major SDK refactor to allow more flexibility, easier configuration and support for reorderable components

INE validation feature

QR scan

New tutorials

New bubble animation while processing ID

Result screen updates

App navigation improvement

Report feature

User consent feature

Liveness call encryption

Eyes closed detection

Multiple faces detection

Face angle is 20 by default instead of 15

Fixes for lower end device

Bug fixes

Smartlook screen recording analytics (off by default)

Google forms in the end of the flow

Video recording prototype feature

Contract acceptance feature

Captcha feature

Speech to text prototype feature

Instabug bug reporting

Runtime download of native libraries

Version 1.1.2

Enable/disable logs through setLoggingEnabled method of IncodeWelcome.Builder

Displaying valid interviewer name during video conference

Added more info when sending back results after face scan

Added callbacks through OnboardingListener once signature and proof of address are captured

Version 1.1.1


Version 1.1.0

Introduced core Module which has to be added as a dependency together with welcome module - This change allows Incode Welcome SDK to be used together with Incode Hello SDK

Exposed getUserScore API to fetch results from ID scan, Liveness and Face Recognition checks.

Exposed approve API to approve users either by using Incode's scoring mechanism or explicitly approving them regardless of the scoring mechanism.

Version 1.0.8

Improved ID Scan performance

Improved Selfie capture UX

BugfixesOnboardingListener now has onEstimatedWaitingTime callback which returns estimated waiting time in seconds

Version 1.0.7

OnboardingSessionListener and its onSuccess callback now returns both token and interviewId

OnboardingListener now has onOnboardingSessionCreated callback that returns token and interviewId

VideoConferenceListener now has onEstimatedWaitingTime callback which returns estimated waiting time in seconds

OnboardingListener now has onEstimatedWaitingTime callback which returns estimated waiting time in seconds

Version 1.0.6

Added OCR data inside IdValidationResult.

OnboardingListener now has 2 more callbacks - onIdValidationCompleted and onQueuePositionChanged

VideoConferenceListener now has onQueuePositionChanged callback

Version 1.0.5

Fixed Camera crash on Selfie screen

Address Validation step can now be skipped through OnboardingConfig

Version 1.0.4

Fixed obfuscation issue

Version 1.0.3

Enabled Theme customization

Enabled custom text messages

'How To' ID tutorials are now optional

Extended IncodeWelcome Builder API to specify custom SSL configuration for on-premise servers

Choose if you wish to enable or disable the call when starting the video conference

Version 1.0.2


Bug fixes

initNewOnboardingSession now expects useConference parameter

startIdValidation now expects idAutoCaptureTimeout parameter

Version 1.0.1


Bug fixes

Optimized ID capture for getting better quality ID photos

Enabled relative paths for URL