Documentation
DocumentationAPI Referenceincode.com
Start typing to search…

Changelog

9.6.1 (Oct 23rd 2025)

  • Fixed compatibility issue for new React Native architectures

Working with Android SDK 5.40.1 and iOS SDK 5.37.0

9.6.0 (Sep 23rd 2025)

  • Added support for the Face Authentication module that performs a selfie scan to authenticate the user as part of the flow or a workflow.
  • Introduced setFaceAuthenticationHint method to provide a face authentication hint.
  • Introduced setUXConfig method for UX customizations in V2 IdScan and SelfieScan modules.
  • Introduced setQuantityStrings method used to localize plural texts on Android.

Working with Android SDK 5.40.1 and iOS SDK 5.37.0

9.5.0 (Aug 4th 2025)

Working with Android SDK 5.39.0 and iOS SDK 5.36.0

9.4.0 (Jun 27th 2025)

  • Added questions param to VideoSelfie module. It takes an array of objects with questions and answers to show during Video selfie when SDK is in captureOnly mode.
  • Improved error handling in case of missing Activity on Android. Replaced RuntimeException with a standardized error code IncodeSdkInitError.ACTIVITY_NOT_PRESENT.

Working with Android SDK 5.38.0 and iOS SDK 5.35.0

9.3.0 (May 15th 2025)

  • RN SDK Android minSdkVersion bumped from 21 to 23
  • Added clientExperimentId optional parameter to the initialize method. Used to enroll customer to experimental features like ID V2.
  • Added new parameter mergeSessionRecordings for OnboardingSessionConfig object. Indicates whether the session recordings from the ID capture and Face capture will be compiled into a single video . It requires RN SDK -vc variant (ie. 9.3.0-vc)
  • Added addNFCScan module, available exclusively in the NFC version of the RN SDK variant (9.3.0-nfc). For running this variant on Android add com.incode.sdk:nfc:1.3.5 dependency in build.gradle.
  • Added new optional parameter matchType to addFaceMatch module. Possible values are: idSelfie, nfcSelfie, nfc3Way.
  • Added new externalCustomerId parameter to the OnboardingSessionConfiguration. This identifier links the onboarding session to an entity in an external system not part of the Incode Omni Platform. It could represent a prospect Id or a customer Id from the client's database, providing a bridge between the Incode session and the client's internal user management systems.
  • Added new ReactNative SDK variant nfc, so now ReactNative SDK is delivered in multiple variants:
    9.3.0: Standard variant 9.3.0-vc: Includes streaming 9.3.0-nfc: Includes NFC 9.3.0-e2ee: Includes end-to-end encryption
  • Fixed crash on Android when calling startFlow with a null moduleId.
  • brightnessThreshold parameter is now deprecated in SelfieScan module and startFaceLogin method.

Working with Android SDK 5.36.1 and iOS SDK 5.34.1

9.2.0 (Mar 21st 2025)

  • Added new parameter voiceConsentFR for VideoSelfie module. It requires RN SDK -l variant (ie. 9.2.0-l) and an additional com.incode.sdk:model-face-recognition:3.2.0 Android dependency added to the build.gradle
  • Added disableVirtualEnvironmentDetection optional parameter to the initialize method. Used to disable virtual environment detection on Android.
  • Fixed crash when running Id capture in capture only mode on Android.
  • Added Theme Customization via setTheme method for Android that accepts JSON in order to change theme on both platforms. On Android, this method currently supports customization exclusively for the ID Scan V2 feature.
  • Fixed the issue of Android returning error unknown when camera permission is denied by the user. Error code permissionsDenied is now returned.

Working with Android SDK 5.34.0 and iOS SDK 5.33.0

9.1.0 (Jan 27th 2025)

  • Added new ID capture experience designed to reduce drop-offs, increase completion rates, and enhance the quality of captured photos. This feature is currently available in opt-in mode, controlled via a feature flag. To opt in, please contact the Customer Support team. It requires an additional com.incode.sdk:camera:1.1.0 Android dependency added to the build.gradle
  • Updated IncodeSdkFlowError. Added jailbreakDetected to IncodeSdkFlowErrorCode.

Working with Android SDK 5.33.0 and iOS SDK 5.32.0

9.0.0 (Oct 18th 2024)

  • Android dependency 'com.incode.sdk:core-light:x.y.z' is no longer added by the integrator, but is part of the React Native SDK.
  • iOS integration requires Podfile update and SSH acccess being setup on the machine.
  • Added support for video streaming via new parameter streamFrames for IDScan, IDScanFront, IDScanBack and SelfieScan modules. It requires RN SDK -vc variant (ie. 9.0.0-vc) and an additional com.incode.sdk:video-streaming:1.5.5 Android dependency added to the build.gradle
  • Fixed on Android java.lang.IllegalArgumentException: No enum constant crash

Working with Android SDK 5.31.1 and iOS SDK 5.30.1

8.1.0 (Aug 30th 2024)

  • The requirement for a minimum supported React Native version of 0.74 has been removed. You can now use this library with earlier versions of React Native, as long as they meet other necessary dependencies.

Using Android SDK 5.30.0, core-light 2.6.4 and iOS SDK 5.29.0-s

8.0.0 (Aug 9th 2024)

  • Added fix for iOS where sessions with VS module would fail the scoring
  • Removed unneccessary log statements
  • Document scan step is removed from VideoSelfie module, so showDocumentScan parameter is now deprecated.

Using Android SDK 5.29.0, core-light 2.6.4 and iOS SDK 5.29.0-s

7.1.0 (June 26th 2024)

  • Added otpVerification parameter to Email module
  • Added new parameters lensesCheck, brightnessThreshold, logAuthenticationEnabled to startFaceLogin
  • Fixed waitForTutorials not being applied in tutorials for face login on Android
  • Added Name, CURP, OCREdit, eKYB and eKYC modules

Using Android SDK 5.28.0, core-light 2.6.3 and iOS SDK 5.28.0-s

7.0.0 (June 11th 2024)

  • Updated IncodeSdkFlowError. Added simulatorDetected, rootDetected, hookDetected, badEnvDetected, virtualEnvDetected to IncodeSdkFlowErrorCode.
  • Renamed IncodeSdkError to IncodeSdkInitError. IncodeSdkError is still available for compatibility. Removed rootDetected, hookDetected from IncodeSdkInitErrorCode.
  • Fixed a crash within ID Scan module on iOS when expo SDK is used
  • Fixed ID Doucment chooser screen not shown if idType param isn't specified on iOS platform.

Using Android SDK 5.27.0, core-light 2.6.3 and iOS SDK 5.28.0-s

6.4.0 (April 24th 2024)

  • Added enableFrontShownAsBackCheck, enableBackShownAsFrontCheck, showAutoCaptureRetakeScreen , enableRotationOnRetakeScreen,
    autocaptureUxMode , showIDOverlay parameters to IDScan module.
  • initialize method on Android platform now always runs on the main thread
  • Added faceMaskCheck and brightnessThreshold parameters to the SelfieScan module.
  • Added GlobalWatchlist, CustomWatchlist, and Aes modules
  • startOnboarding, startWorkflow, startFlow, startFlowFromDeeplink and startOnboardingSection promises when rejected now return a typed error IncodeSdkFlowError. IncodeSdkFlowErrorCode lists all possible values.

Using Android SDK 5.26.0, core-light 2.6.3 and iOS SDK 5.27.1-s

6.3.0 (March 11th 2024)

  • Added isBackgroundExecuted parameter to GovernmentValidation module.
  • Replaced outdated com.google.android.play:core:1.10.3 Android dependency with com.google.android.play:feature-delivery:2.1.0 and com.google.android.play:core-common:2.0.3 to avoid compilation issues.
  • Added new module Antifraud module.
  • Added new API method startFlow to support start or resume an onboarding session based on the provided session configuration and starting module.
  • Added new API method startFlowFromDeepLink to support resume an onboarding session based on the provided deep link URL.
  • Fixed crash on Android emulator after onIdFrontCompleted is called.
  • Fixed crash on Android when non-API key approach is used.

Using Android SDK 5.24.0, core-light 2.6.2 and iOS SDK 5.25.0-s

6.2.0 (Jan 20th 2024)

  • Added new API method startWorkflow to support run workflows
  • Added support for End-to-End Encryption (E2EE). For full integration guide please check here

Using Android SDK 5.23.0, core-light 2.6.2 and iOS SDK 5.24.1-s

6.1.0 (Jan 5th 2024)

  • Added new optional parameters to the initialize method, please check the full list of params here
  • Added failReason, issueName, issueYear and countryCode to the IdScanFrontCompleteEvent. IdValidationStatus values are now same on Android/iOS platforms.
  • Added dynamic localization and updating strings in runtime with new API method setString. Please check here for more details.
  • Added fix to support monorepo application architectures

Using Android SDK 5.20.0, core-light 2.6.1 and iOS SDK 5.21.0-s

6.0.0-nvc (Nov 6th 2023)

  • Changed package installation method to use npmjs
  • Added support for Expo SDK

5.7.0-nvc (Oct 13th 2023)

  • Added optional sslPinningConfig to the initialize method.

5.6.1-nvc (Sep 1st 2023)

  • Breaking change due to Android core-light dependency that needs to be updated to a version '2.5.1'. Please check here for more details.
  • Fixed a crash on Android platform in case app gets killed by the OS during the flow and then restarted

Using Android SDK 5.17.2, core-light 2.5.1 and iOS SDK 5.17.0-s

5.6.0-nvc (August 11th 2023)

  • Fixed bug in Video Selfie module that is not respecting 0 questions on Android devices
  • Added otpVerification parameter to Phone module
  • Added showUserExists parameter to FaceMatch module

Using Android SDK 5.17.0 and iOS SDK 5.17.0-s

5.5.0-nvc (July 4th 2023)

  • Fixed exception when using face match module on the Android emulator
  • Added optional sectionTag param to the startOnboardingSection metho
  • Added onEvents callback to onboarding flow. It is used to track all the user steps in their flow and integrate this metrics as a part of Analytics systems.
  • Added MLConsent module:
{
 module: 'MLConsent',
 type: gdpr' | 'us' .
}
  • Added setLocalizationLanguage method used for runtime localization. Please check here for more details.

Using Android SDK 5.17.0 and iOS SDK 5.17.0-s

5.4.0-nvc (Apr 13th 2023)

  • Breaking change: RN SDK Android minSdkVersion bumped from 17 to 21
    compileSdkVersion should be set to 33 targetSdkVersion should be set to 33.
  • Fixed NPE on Android devices that don't provide recordSessionConfig in the flow

Using 5.16.0 Android and 5.15.0-s iOS

5.3.1-nvc (Mar 13th 2023)

  • Added feature to record ID and Selfie captures by specifying optional recordSessionConfig parameter to the startOnboarding or startOnboardingSection method:
    • Set recordSession to true
    • Set forcePermissions, true if you wish to abort the session in case user denies permissons, false otherwise
  • Fixed PhoneStepCompleteEvent and EmailCompleteEvent not being public

5.3.0-nvc (Feb 10th 2023)

  • Mandatory update of Android core-light dependency to 2.5.0

  • Removed Android kotlin dependency

  • Removed GMS dependencies to avoid issues with Huawei devices

  • Fixed Android crash when Video Selfie module configured with voiceConsentQuestionsCount 0

  • Using 5.15.0 Android and 5.12.0-s iOS

5.2.3-nvc (Dec 22nd 2022)

  • Signature module callback result now includes png base64 image field

5.2.2-nvc (Nov 23rd 2022)

  • Fixed duplicated symbols for SSZipArchive on iOS that were re-introduced in 5.x SDK versions

  • Using 5.10.0 Android and 5.8.1rn-s iOS

5.2.1-nvc (Oct 26th 2022)

  • Fixed chosenIdType not being present inside IdScanFrontCompleteEvent response

  • Breaking change due to Android dependency that needs to be updated. Please check here for more details.

  • Using 5.10.0 Android and 5.8.1-s iOS

5.2.0-nvc (Sep 29th 2022)

  • Aadded cameraFacing param to the Selfie module and cameraFacingConfig to the Video Selfie module, so that back camera can be used instead of the front during image capture.

  • ID Back tutorial second subtitle support for 2 or more lines

  • Using 5.7.0 Android and 5.6.0 iOS

5.1.2-nvc (Sep 7th 2022)

  • Fix for missing callbacks on iOS.

5.1.1-nvc (Aug 10th 2022)

  • Fix for labels being cut-off when using custom fonts. Set additionalTextHeight param in json provided to setTheme method.
  • Using 5.4.0 Android SDK and 5.4.0 iOS SDK

5.1.0-nvc (July 26th 2022)

  • Removed customerToken from startFaceLogin method, now only customerUUID is needed for preforming 1:1 Face Login

  • Added faceМаskCheck parameter to startFaceLogin -> enabling this check will prevent users from logging in with face mask on.

  • Fix for Android TextInput fields crash when RN ^0.67.4 dependency is used.

  • Fixed setupOnboardingSession not returning any data on iOS. Now it returns interviewId and token.

  • onSessionCreated promise now returning interviewId and token.

  • Fixed startOnboarding promise on Android returning as soon as onboarding is started

  • Using 5.3.0 Android SDK and 5.3.0 iOS SDK

5.0.0-nvc (June 28th 2022)

  • startOnboarding and startOnboardingSection parameter name config renamed to flowConfig. Please check here for more details.

  • Added setupOnboardingSession that replaces creatingNewOnboardingSession and setOnboardingSession. Please check here for more details.

  • startFaceLogin now does both 1:1 and 1:N Face Login. 1:N Face Login is performed if no parameters are provided, and 1:1 if customerToken and customerUUID are set.

  • startFaceLogin method result FaceLoginResult now includes image with base64 representation of user's selfie, and for 1:N additional fields - customerUUID, interviewId, interviewToken, token and transactionId.

  • Unified response for UserScore module for Android and iOS, by removing extra jsonData structure from Android's result.

  • Fixed Android 'Need Help' button disappearing on second time retake of Id

  • Fixed Android Exit confirmation alert not being customizable

  • Using 5.2.0 Android SDK and 5.2.0 iOS SDK

4.7.0-nvc (June 6th 2022)

  • Added Email module
  • Added showRetakeScreen param to the IdScan module, a configuration which will enable/disable retake screen after manual capture.
  • Added option to verify secondary ID document - IdScan and FaceMatch now have idCategory param to specify primary or secondary ID used for verification
  • Added showCloseButton method, by specifying true user will be able to abort the onboarding flow by pressing 'X' button on the top right.

Using 4.12.4 Android SDK and 4.8.1rn iOS SDK

4.6.0-nvc (May 18th 2022)

  • Added title, description and descriptionMaxLines params to the Signature module
  • Signature module now uses proper colors from the theme on iOS
  • Fixed duplicated symbols for SSZipArchive on iOS
  • Fixed labels being cut-off when using custom fonts on iOS
  • Downgraded to Kotlin 1.4.2 on Android to avoid kotlin.Unit compile issues

Using 4.12.2 AndroidSDK and 4.8.0rn iOS SDK

4.5.0-nvc (Apr 29th 2022)

  • Optimized Android install size
  • Added IncodeSdk.deleteUserLocalData method that clears currently stored onboarding session data on Android
  • Added option to use lighter Android SDK by specifying ’implementation ‘com.incode.sdk:core-light-reduced:2.2.0’ dependency
  • Fixed IncodeSdk.approve method result callback on Android
  • Fixed OnboardingFlowConfig cast issues on Android
  • Fixed customization of tutorial videos on iOS

Using 4.12.0 Android SDK and 4.7.3rn iOS SDK

4.4.1-nvc (Apr 27th 2022)

  • Fixed ID Uploading/Processing screen to use specified background color instead of being always white
  • Using 4.11.0 Android SDK and 4.7.2rn iOS SDK

4.4.0-nvc (April 18th 2022)

  • Enabled Passport autocapture by default
  • Added enableIdSummaryScreen parameter to the ProcessId module. Specifying false means no summary screen will be shown to the user once he fail to capture ID multiple times. Defaults to true.
  • Breaking change for parsing UserScore module results: UserScoreCompleteEvent now returns raw JSON result that contains full user score via result.extendedUserScoreJsonData field.

Using 4.10.0 Android SDK and 4.7.2rn iOS SDK.

4.3.0-nvc (April 6th 2022)

  • Added waitForTutorials param to the initialize method. Specifying false means that the users can see and press continue button on all video tutorial screens without waiting for the video to complete.

Using 4.9.0 Android SDK and 4.6.0 iOS SDK.

4.2.0-nvc (April 5th 2022)

  • Enabled full customization on iOS platform via setTheme method.
  • Added option to choose between horizontal and vertical layout orientation of the Common Issues screen during Id capture
  • Added lensesCheck parameter to SelfieScan module, so that the validation if the user is wearing glasses or not during SelfieScan can be disabled. Default is true.

Using 4.9.0 Android SDK and 4.6.0 iOS SDK.

4.1.1-nvc (March 28th 2022)

  • Fixed Android issues with optional parameters when React Native 0.61.2 dependency is used

  • Fixed Android crash when Camera permissions are denied

    Using 4.7.2 Android SDK

4.1.0-nvc (March 16th 2022)

  • Added setTheme method that's used for customizing the theme on iOS devices.
  • Fixed issue with bad face match confidence on Android in case selfie isn't taken properly
  • Fixed issue with startOnboardingSection method not always being run on main thread

4.0.1-nvc (March 11th 2022)

  • Fixed issue with overriding session flow configuration when providing existing interviewId to the startOnboarding method on Android devices.
  • Fixed issue with running ID scan on Android emulator
  • Using 4.6.1 Android SDK

4.0.0-nvc (March 10th 2022)

  • Breaking change -> Refactored onboarding session parameters to be part of a new OnboardingSessionConfig object , so that startOnboarding, createOnboardingSession, and setOnboardingSession can be configured with the same session parameters by specifying them inside OnboardingSessionConfig.
  • Added setOnboardingSession method that can be used for resuming an already existing onboarding session.
  • key is now optional inside initialize method, so the SDK can be used by specfying token as a session parameter inside setOnboardingSession method.
  • Using 4.6.0 Android SDK, 4.4.1-rnoptimized iOS SDK

3.2.1-nvc (March 3rd 2022)

  • Using 4.5.0 Android SDK to resolve Video Selfie upload issues on Android platform

3.2.0-nvc

  • Fixed iOS build issues due to bad paths in .podspec and missing linker flags
  • Added IdScanFront, IdScanBack and ProcessId modules that can be used for more flexibility comparing to regular IdScan module. This change requires mandatory changes in receiving results during ID validation, please follow the guide here
  • Added otherDocument3 document type that can be used in DocumentScan module

3.1.1-nvc

  • Added multiple document scan types besides proof of address - addressStatement, paymentProof, medicalDoc, otherDocument1, otherDocument2.
    You can specify these as type parameter when adding DocumentScan module.
  • ODR download now returns error INSUFFICIENT_STORAGE which happens if the device runs out of storage during the download.

3.1.0-nvc

  • Added Dynamic Resource Delivery feature that enables you to download SDK resources in runtime, thus having smaller SDK size and impact on your app's download size on the App Store/Play store.
    More details here
  • BREAKING CHANGE: In order to keep using regular Non-Dynamic Delivery version of the React Native SDK for the Android platform, please refer to the MIGRATION_GUIDE.
  • ID validation now shows 'Processing Id' animation during ID processing after the scan.
  • Document scan new UX with a possibility for the user to upload a pdf or image besides doing the camera capture.
  • Switched to using iOS static frameworks to reduce the SDK size
  • Reduced Android framework size
  • Using 4.3.0-rnoptimized Android SDK and 4.1.0-s iOS SDK

3.0.6-nvc and 3.0.6-nvc-pod

  • Added IncodeSdk.faceMatch API method that does face match between photo from the ID and Selfie silently in the background.

Using 3.6.0 Android SDK
Using 3.2.0 iOS SDK

3.0.5-nvc

  • Optimized RN SDK impact size for iOS platform by putting in optimized version of the opencv2.framework

3.0.4-nvc and 3.0.4-nvc-pod React Native SDK without video conference

This version of the React Native SDK doesn't have video conference module available, and consequently has smaller size.

Additionaly for Android please remove this line from your projects build.gradle:
maven { url 'https://tokbox.bintray.com/maven' }

For cocoapods version please add these lines to your projects Podfile:

source 'https://github.com/CocoaPods/Specs.git'
source '[email protected]:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'

3.0.2

  • DocumentScan module now has showDocumentProviderScreen parameter, using which you can skip the providers screen and go straight to the document capture.
  • DocumentScanCompleteEvent now has image inside the result - it is png base64 representation of the captured image during Document scan.

3.0.1

  • Fixed a crash for Android devices when IncodeSdk.startOnboarding isn't being called on a main thread.

3.0.0

  • iOS Frameworks used by React Native SDK are now bundled inside, so these lines are no longer needed and can be removed from your Podfile:
source 'https://github.com/CocoaPods/Specs.git'
source '[email protected]:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
  • Added capture only SDK mode, to enable it provide sdkMode parameter to the IncodeSdk.initialize method:
IncodeSdk.initialize({
      apiConfig: {
        key: 'YOUR_API_KEY',
        url: 'YOUR_API_URL',
        regionCode: 'ALL',
      },
      sdkMode: 'captureOnly',
    })
  • Added UserConsent module:
{
 module: 'UserConsent',
 title: 'Consent Title',
 content: 'Consent content for the user to confirm',
}

2.1.0

  • Fixed app crash during Passport scan if issueDate isn't read on Android devices
  • Restructured IdScanCompleteEvent:
    • data: the basic IdScanOcrData object, containing most important data
    • ocrData: the String object, raw JSON containing full OCR data ie. exteriorNumber, interiorNumber, typeOfId, documentFrontSubtype
    • images - containing images taken during ID capture, optional, cause on simulator the images won't be captured and returned.
    • images.front - IncdImage object, containing pngBase64 of the captured front ID
    • images.back - IncdImage object, containing pngBase64 of the captured back ID
    • status: the IdValidationStatus object, carrying statuses for the front side of the ID and the back side.

2.0.2

  • Made Video Selfie module more flexible, these are the new parameters:
	  /** default: `true` */
      showTutorial?: boolean;
      /** default: 'selfieMatch' */
      selfieScanMode?: 'selfieMatch' | 'faceMatch';
      /** default: 'false' */
      selfieLivenessCheck?: boolean;
      /** default: 'true' */
      showIdScan?: boolean;
      /** default: 'true' */
      showDocumentScan?: boolean;
      /** default: 'true' */
      showVoiceConsent?: boolean;
      /** default: 3 */
      voiceConsentQuestionsCount?: number;

2.0.1

  • Added configurationId param for the startOnboarding method. Use this to specify flow configuration created from dashboard

2.0.0

  • Changed iOS setup to use different source for fetching iOS frameworks. Add these to the top of your Podfile and run pod install:
source 'https://github.com/CocoaPods/Specs.git'
source '[email protected]:Incode-Technologies-Example-Repos/IncdDistributionPodspecs.git'
  • Introduced new method for Face Login called startFaceLogin. Old way by using SelfieScan module and loginOptions is now removed.
  • Added posibility to resume existing session by specifying interviewId for startOnboarding method
  • Fixed crashes when used on Android simulator during ID and Selfie scans

1.0.11

  • Fixed false positive hook detection issues

1.0.10

  • Replaced disableEnvironmentChecks parameter with disableHookCheck for initialize method to disable check if device is hooked.

1.0.9

  • Fixed opentok dependency resolving issues

1.0.8

  • Improved error handling for initialize method by adding specific error codes and messages for these scenarios:

Incd::EmulatorDetected - “Emulator detected, emulators aren't supported in non test mode!”

Incd::RootDetected - “Root access detected, rooted devices aren't supported in non test mode!”

Incd::HookDetected - “Hooking framework detected, devices with hooking frameworks aren't supported in non test mode!”

Incd::TestModeDetected - “Please disable test mode before deploying to a real device!”

1.0.7

  • Fixed faulty reports of spoof attempt during Face login on Android devices

1.0.6

  • Fixed 'Face login not enabled during SDK init!' error during Face login flow on Android devices
  • Added disableEnvironmentChecks parameter for initialize method to disable checks if device is rooted/hooked or emulator.

1.0.2

  • ID Scan now showing options for the user to choose between ID or Passport
  • ID Scan now shows passport screen if the idType is set to passport

Updated 14 days ago