v10.0.0 release

onfido · Jul 27, 2023 · 12b48e5 · 12b48e5
1 parent 95ed115
commit 12b48e5
Show file tree

Hide file tree

Showing 25 changed files with 347 additions and 360 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,28 +1,56 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [10.0.0] - 2023-07-12
+
+### Changed:
+
+- Public: Updated underlying Onfido native SDKs versions:
+  - iOS 29.1.x (up from 29.0.x)
+  - Android 19.0.x (up from 18.0.x)
+- Public: Added Proof of Address configuration
+
+### Fixed:
+
+- Fixed Motion fallback configuration for iOS
+
+## [9.0.0] - 2023-06-26
+
 ### Changed:
-- Public: Added support for Fallback as motionFallbackOptions - MOTION:
+
+- Public: Changed how to setup fallbacks for Motion
 
 ### Added:
 
-- Public: Added support for Fallback Option OnfidoFaceCaptureOptions - MOTION:
 - Public: Added support for RecordingAudio Option as RecordAudio - MOTION:
 - Public: Allow Selfie/Video step configuration
 
+## [8.3.0] - 2023-05-02
+
+### Added:
+
+- Public: Added support for Fallback Option OnfidoFaceCaptureOptions - MOTION:
+
+### Fixed:
+
+- Public: Fixed the Workflow result handling crash
+
 ## [8.2.0] - 2023-04-12
 
 ### Changed:
+
 - Public: Updated underlying Onfido native SDKs versions:
   - iOS 28.3.x (up from 28.1.x)
   - Android 16.3.x (up from 16.1.x)
 
 ## [8.1.0] - 2023-03-06
 
 ### Changed:
+
 - Public: Updated underlying Onfido native SDKs versions:
   - iOS 28.1.0 (up from 28.0.0)
   - Android 16.1.0 (up from 16.0.1)
@@ -32,20 +60,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [8.0.0] - 2023-02-28
 
 ### Changed:
+
 - Public: Updated underlying Onfido native SDKs versions:
   - iOS 28.0.0 (up from 27.4.0)
   - Android 16.0.1 (up from 15.4.0)
 
 ## [7.4.0] - 2023-02-13
 
 ### Changed:
+
 - Public: Updated underlying Onfido native SDKs versions:
   - iOS 27.4.0 (up from 27.3.0)
   - Android 15.4.0 (up from 15.3.0)
 
 ## [7.3.0] - 2023-01-12
 
 ### Changed:
+
 - Public: Updated underlying Onfido native SDKs versions:
   - iOS 27.3.0 (up from 27.2.0)
   - Android 15.3.0 (up from 15.1.0)
@@ -58,13 +89,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Public: Added RTL languages support
 
 ### Changed:
+
 - Public: Update underlying Onfido native SDK versions:
   - iOS 27.2.0 (up from 27.0.0)
   - Android 15.1.0 (up from 14.0.0)
 
 ### Fixed:
 
-- Public: Remove NFC dependencies from the SDK. They should be added in your app when utilizing NFC. 
+- Public: Remove NFC dependencies from the SDK. They should be added in your app when utilizing NFC.
 
 ## [7.1.0] - 2022-12-07
 
@@ -76,6 +108,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [7.0.1] - 2022-11-28
 
 ### Changed:
+
 - Public: Update underlying Onfido native SDK versions:
   - iOS 27.0.0 (up from 26.1.1)
   - Android 14.0.0 (up from 13.0.0)
@@ -85,6 +118,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [6.1.0] - 2022-11-07
 
 ### Changed:
+
 - Public: Update underlying Onfido native SDK versions:
   - iOS 26.1.1 (up from 26.0.1)
 - Public: Start supporting Typescript
@@ -93,6 +127,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [6.0.0] - 2022-09-13
 
 ### Changed:
+
 - Public: Update underlying Onfido native SDK versions:
   - Android 13.0.0 (up from 12.2.0)
   - iOS 26.0.1 (up from 25.1.0)
@@ -102,6 +137,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [5.4.0] - 2022-06-22
 
 ### Changed:
+
 - Public:
 - Public: Update underlying Onfido native SDK versions:
   - Android 12.2.0 (up from 11.5.0)
@@ -110,26 +146,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [5.3.0] - 2022-05-02
 
 ### Changed:
+
 - Public: Update underlying Onfido native SDK versions:
   - Android 11.5.0 (up from 11.4.1)
   - iOS 24.6.0 (up from 24.5.0)
 
 ## [5.2.0] - 2022-04-18
 
 ### Changed:
+
 - Public: Updated underlying Onfido native SDKs versions:
   - Android 11.4.1 (up from 11.3.0)
   - iOS 24.5.0 (up from 24.3.0)
 
 ## [5.1.0] - 2022-03-18
 
 ### Changed:
+
 - Public: Upgraded to React v17.0.1 and React Native v0.64.3
 - Public: Updating Country Code list to match iOS SDK
 
 ## [5.0.0] - 2022-02-18
 
 ### Changed:
+
 - Public: Updated underlying Onfido iOS SDK to version 24.3.0 (up from 23.1.0).
   For more information visit the [Onfido iOS SDK releases on Github](https://github.com/onfido/onfido-ios-sdk/releases)
   NOTE: This version of SDK will only support building your app with Xcode 13 due to lack of backward compatibility introduced by Apple with Xcode 13.
@@ -146,60 +186,67 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [4.0.0] - 2022-01-13
 
 ### Changed:
+
 - Public: Upgraded the Gradle version of the Onfido's React Native SDK to v7.0.2
 - Public: Upgraded the Android Gradle Plugin to v7.0.4
 
-
 ## [3.0.0] - 2021-12-22
 
 ### Changed:
+
 - Public: Updated underlying Onfido iOS SDK to version 23.1.0 (up from 22.3.0). For more information visit the [Onfido iOS SDK releases on Github](https://github.com/onfido/onfido-ios-sdk/releases) NOTE: This version of SDK will only support building your app with Xcode 13 due to lack of backward compatibility introduced by Apple with Xcode 13.
 - Public: Updated underlying Onfido Android SDK to version 10.3.2 (up from 10.1.0). For more information visit the [Onfido Android SDK releases on Github](https://github.com/onfido/onfido-android-sdk/releases)
 
-
 ## [2.2.1] - 2022-01-25
 
 ### Changed:
 
 - Public: Removed the final screen from being always shown at the end of the flow steps on Android
 
-
 ## [2.2.0] - 2021-09-15
 
 ### Changed:
+
 - Public: Updated underlying Onfido iOS SDK to version 22.3.0 (up from 21.4.0). For more information visit the [Onfido iOS SDK releases on Github](https://github.com/onfido/onfido-ios-sdk/releases)
 - Public: Updated underlying Onfido Android SDK to version 10.1.0 (up from 9.3.1). For more information visit the [Onfido Android SDK releases on Github](https://github.com/onfido/onfido-android-sdk/releases)
 
 ### Fixed:
+
 - Public: Fixed script that added Onfido bintray link to users' `android/app/build.gradle` to now add `mavenCentral()` instead, if not already present.
 - Public: Fixed sample Localizable file to match newest iOS string keys.
 
-##  [2.1.1] - 2021-07-27
+## [2.1.1] - 2021-07-27
 
 ### Changed:
+
 - Public: Updated React peer dependency to include up to versions 17.0.x
 
 ## [2.1.0] - 2021-07-19
 
 ### Changed:
+
 - Public: Updated error messages to propagate more info from underlying native SDKs.
 
 ## [2.0.0] - 2021-06-11
 
 ### Added:
+
 - Public: Added support for enabling the user consent screen for iOS and Android.
 
 ### Changed:
+
 - Public: Updated underlying Onfido iOS SDK to version 21.4.0 (up from 20.1.0). For more information visit the [Onfido iOS SDK releases on Github](https://github.com/onfido/onfido-ios-sdk/releases)
 - Public: Updated underlying Onfido Android SDK to version 9.3.1 (up from 9.0.0). For more information visit the [Onfido Android SDK releases on Github](https://github.com/onfido/onfido-android-sdk/releases)
 
 ## [1.3.4] - 2021-05-18
 
 ### Added:
+
 - Public: Updated README with troubleshooting information and okhttp3 resolution guide.
 - Public: Updated error responses to be more descriptive.
 
 ### Fixed:
+
 - Public: Apply okhttp3 fix to SampleApp.
 - Public: Add fix for XCode 12.5 to SampleApp Podfile.
 - Public: Fix an iOS bug where the Onfido flow isn't presented to user if the rootViewController is not at the top of the view hierarchy.
@@ -208,42 +255,51 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [1.3.3] - 2021-02-26
 
 ### Added:
+
 - Public: Added support for hide logo and cobranding enterprise features
 
 ## [1.3.2] - 2020-09-29
 
 ### Fixed:
+
 - UI: Fixed iOS crash problem on Xcode12 simulator
 
 ## [1.3.1] - 2020-09-02
 
 ### Fixed:
+
 - UI: Fixed iOS custom appearance problem on real device
 
 ## [1.3.0] - 2020-08-04
 
 ### Changed:
+
 - Public: Upgraded android SDK version to 7.2.0
 
 ## [1.2.2] - 2020-07-16
 
 ### Fixed:
+
 - Public: Added fix in Github Repository filter
 
 ## [1.2.0] - 2020-07-07
 
 ### Added:
+
 - Public: Added custom localisation support for ios
 
 ### Changed:
+
 - Public: Upgraded iOS SDK version
 
 ## [1.0.1] - 2020-04-16
 
 ### Fixed:
+
 - Public: Added fix for bug where npm install in SampleApp is deleting files in SampleApp directory.
 
 ## [1.0.0] - 2020-04-15
 
 ### Added:
+
 - Public: MVP release of React Native SDK.
diff --git a/README.md b/README.md
@@ -18,7 +18,6 @@
       - [Kotlin](#kotlin)
     - [4.4 Update your iOS configuration files](#44-update-your-ios-configuration-files)
       - [Enabling NFC extraction](#enabling-nfc-extraction)
-        - [Pre-requisites](#pre-requisites)
 - [Usage](#usage)
   - [User data](#user-data)
   - [1. Creating the SDK configuration](#1-creating-the-sdk-configuration)
@@ -33,7 +32,6 @@
   - [2. Creating a check](#2-creating-a-check)
 - [Theme Customization](#theme-customization)
   - [Android](#android-1)
-    - [Customizing Dimensions](#customizing-dimensions)
   - [iOS](#ios-1)
 - [Going live](#going-live)
 - [More Information](#more-information)
@@ -166,6 +164,12 @@ android {
 
 </br>
 
+##### Enabling NFC extraction
+
+With version 10.0.0 of the Onfido React Native SDK, NFC is enabled by default and offered to customer when both the document and the device support NFC.
+
+For more information on how to configure NFC and the list of supported documents, please refer to the [NFC for Document Report](https://developers.onfido.com/guide/document-report-nfc) guide.
+
 
 NFC dependencies are not included in the SDK to avoid increasing the SDK size when the NFC feature is disabled. To use the NFC feature, you need to include the following dependencies (with the specified versions) in your build script:
 
@@ -200,7 +204,7 @@ You also need to add the following Proguard rules to your `proguard-rules.pro` f
 #### 4.3  Custom Android Application Class
 **Note**: You can skip this step if you don't have any custom application class.
 
-⚠️ As of version 9.0.0, Onfido SDK runs in a separate process on Android. This means that when the Onfido SDK is started, a new application instance will be created. To prevent re-running any initialization code that you have in your custom Application class, you can use the following `isOnfidoProcess` function and return from the `onCreate` method as shown below:
+⚠️ After the release of version 9.0.0, Onfido RN SDK runs in a separate process. This means that when the Onfido SDK started, a new application instance will be created. To prevent reinitializing you have in the Android application class, you can use the `isOnfidoProcess` extension function and return from `onCreate` as shown below:
 
 This will prevent initialization-related crashes such as: [`FirebaseApp is not initialized in this process`](https://github.com/firebase/firebase-android-sdk/issues/4693)
 
@@ -266,15 +270,10 @@ cd ..
 
 ##### Enabling NFC extraction
 
-Recent passports, national identity cards and residence permits contain a chip that can be accessed using Near Field Communication (NFC).
-The Onfido SDKs provide a set of screens and functionalities to extract this information, verify its authenticity and provide the results as part of a Document report.
-With version [8.4.0] of the Onfido React Native SDK, NFC is enabled by default and offered to customer when both the document and the device support NFC.
+With version 10.0.0 of the Onfido React Native SDK, NFC is enabled by default and offered to customer when both the document and the device support NFC.
 
 For more information on how to configure NFC and the list of supported documents, please refer to the [NFC for Document Report](https://developers.onfido.com/guide/document-report-nfc) guide.
 
-###### Pre-requisites
-
-
 This feature requires Near Field Communication Tag Reading capability in your app target. If you haven't added it before, please follow the steps in Apple's documentation.
 
 
@@ -285,7 +284,6 @@ You're required to have the following key in your application's Info.plist file:
 <string>Required to read ePassports</string>
 ```
 
-
 You have to include the entries below in your app target's Info.plist file to be able to read NFC tags properly.
 
 ```xml
@@ -429,9 +427,8 @@ config = {
     },
     captureFace: {
       type: OnfidoCaptureType.VIDEO
-    },
-  },
-  enableNFC: true
+    }
+  }
 }
 ```
 
@@ -441,14 +438,14 @@ config = {
 * **`flowSteps`**: Required.  This object is used to toggle individual screens on and off and set configurations inside the screens.
 * **`welcome`**: Optional.  This toggles the welcome screen on or off.  If omitted, this screen does not appear in the flow.
   * Valid values: `true`, `false`
+* **`proofOfAddress`**: Optional. This toggles the proof of address screen on or off. If omitted, this screen does not appear in the flow.
+  * Valid values: `true`, `false`
 * **`captureDocument`**: Optional. This object contains configuration for the capture document screen. If docType and countryCode are not specified, a screen will appear allowing the user to choose these values.  If omitted, this screen does not appear in the flow.
 * **`docType`**: Required if countryCode is specified.
   * Valid values in `OnfidoDocumentType`: `PASSPORT`, `DRIVING_LICENCE`, `NATIONAL_IDENTITY_CARD`, `RESIDENCE_PERMIT`, `RESIDENCE_PERMIT`, `VISA`, `WORK_PERMIT`, `GENERIC`.
     **Note**: `GENERIC` document type doesn't offer an optimised capture experience for a desired document type.
 * **`countryCode`**: Required if docType is specified.
   * Valid values in `OnfidoCountryCode`: Any ISO 3166-1 alpha-3 code. For example: `OnfidoCountryCode.USA`.
-* **`enableNFC`**: Optional. This toggles the ePassport NFC extraction feature. If omitted, this feature is not enabled in the flow. There is also application configuration changes needed to use this feature. To do that please follow [Onfido Developer Hub](#https://developers.onfido.com/guide/document-report-nfc#enable-nfc-in-the-onfido-sdks)
-  * Valid values: `true`, `false`.
 * **`captureFace`**: Optional.  This object object containing options for capture face screen.  If omitted, this screen does not appear in the flow.
 * **`type`**: Required if captureFace is specified.
   * Valid values in `OnfidoCaptureType`: `PHOTO`, `VIDEO`, `MOTION`.
@@ -691,8 +688,6 @@ You can customize the SDK by adding a `colors.json` file to your xcode project a
   "onfidoPrimaryColor": "#FF0000",
   "onfidoPrimaryButtonTextColor": "#FFFFFF",
   "onfidoPrimaryButtonColorPressed": "#FFA500",
-  "onfidoAndroidStatusBarColor": "#A52A2A",
-  "onfidoAndroidToolBarColor": "#800080",
   "onfidoIosSupportDarkMode": true,
   "secondaryTitleColor": "#FF0000",
   "secondaryBackgroundPressedColor": "#FF0000",

diff --git a/SampleApp/backend-server-example.js b/SampleApp/backend-server-example.js
@@ -92,7 +92,7 @@ const createSdkToken = async (applicant, applicationId) => {
       applicant_id: sdkRequestBody.applicant_id,
     };
     const workflowRunIdResponse = await fetch(
-      'https://api.onfido.com/v4/workflow_runs',
+      'https://api.onfido.com/v3.5/workflow_runs',
       {
         method: 'POST',
         headers: {