uqudosdk-react-native 2.7.4 → 3.0.1

package/CHANGELOG.md

@@ -1,3 +1,40 @@
+## 3.0.1
+
+* Important improvement in the id photo tampering detection during document scanning to identify any alterations to the ID photo.
+* Reduced the level of sensitivity for detecting glares during document scanning.
+* Small improvement during scanning to identify printed copies. As per our previous release, the SDK will not reject scans of printed documents but will provide a score indicating the likelihood of a printed copy under the verification object in the SDK result.
+* Included a new obfuscation type called "FILLED_WHITE" within the facial recognition configuration, which completely substitutes the background with a white color.
+* Introduced a new configuration option called "disableTamperingRejection", directing the SDK not to dismiss the scan upon detecting tampering, specifically for ID photo tampering detection.
+* Deprecated the configuration option called "enrollFace" within the facial recognition configuration, as it is related to the "Account Recovery Flow" deprecated in version 3.0.0. It is planned for removal in a future release.
+* Android: upgraded the camera library to the latest stable version that fixes an important bug that could affect the scan on Samsung A24 devices.
+* iOS: Addressed an issue on iPhone 14 and iPhone 15 base version where the camera failed to focus when documents were in close proximity.
+* iOS: Refactored the implementation to identify whether the device has been rooted.
+
+## 3.0.0
+
+* Introduced a new verification object result within the SDK, including all details pertinent to the verification process. This feature supports your business logic by easily identifying potential issues. Refer to https://docs.uqudo.com/docs/kyc/uqudo-sdk/sdk-result/data-structure/verification-object for comprehensive information.
+* Added Data Consistency Check within the verification object, supporting your business logic by highlighting inconsistencies throughout the entire KYC journey, including optical scanning, NFC, and lookup stages.
+* Added source detection during document scanning to ensure that users display physical documents, eliminating screens and printed copies. In this release, the SDK will not reject scans of printed documents but will provide a score indicating the likelihood of a printed copy under the verification object in the SDK result. Please note that low-light conditions may affect the result, potentially increasing the score for printed copies and leading to false positives. We are committed to improving this aspect in future releases, refining quality check procedures to ensure optimal image quality. Eventually, printed documents above a certain score will be rejected directly from the SDK, similar to how screens are handled.
+* Added an option to permit scanning of non-physical documents (where the SDK won't reject scans upon detecting a screen). The SDK result includes a score indicating whether the document was scanned from a screen, as described in the verification object above.
+* Added ID photo tampering detection during document scanning to identify any alterations to the ID photo. The SDK will reject scans above a certain score and provide an appropriate message. Score information is returned in the SDK result within the verification object.
+* Enhanced identification of low-light conditions during document scanning by introducing stricter criteria. Suboptimal lighting can affect document recognition, particularly for non-physical documents.
+* Improved scanning capabilities for Turkish IDs.
+* Added NFC support for the latest version of the QAT ID for residents.
+* Added NFC support for IRQ ID.
+* Added support for passport chip authentication during NFC reading.
+* Implemented countermeasures for NFC replay attacks on documents lacking authentication mechanisms.
+* Addressed an issue on iPhone 14 Pro/Pro Max and iPhone 15 Pro/Pro Max where the camera failed to focus when documents were in close proximity.
+* Resolved an issue where a specific version of the QAT ID's back side for citizens was not being recognized.
+* In the Lookup Flow, removed NGA virtual NIN in favor of the actual NIN (National Identification Number) written on the document, as the virtual NIN service has been suspended by the Nigerian government.
+* Overall enhancements to the scanning process to improve scan quality.
+* Backported the latest changes from SDK version 2.7.4.
+* For Android application development, targeting SDK 34 is now mandatory.
+* Deprecated the enableUpload feature in the SDK, planned for removal in a future release.
+* Deprecated the forceReadingIfSupported function in the ReadingConfiguration builder and made it the default behavior, eliminating the option to skip the reading step (NFC) unless the device lacks NFC support. The forceReading option remains available for those wishing to restrict usage to devices with NFC support only.
+* Deprecated the forceReadingTimeout function in the ReadingConfiguration, making it a no-op operation.
+* Deprecated the Account Recovery Flow feature in the SDK, planned for removal in a future release. Use Face Session Flow instead.
+* Various minor bug fixes and improvements.
+
 ## 2.7.4
 
 * Added compatibility for applications designed to target targetSdk version 34 on the Android platform

package/android/build.gradle

@@ -1,7 +1,7 @@
-def DEFAULT_COMPILE_SDK_VERSION = 33
+def DEFAULT_COMPILE_SDK_VERSION = 34
 def DEFAULT_BUILD_TOOLS_VERSION = '30.0.3'
 def DEFAULT_MIN_SDK_VERSION = 21
-def DEFAULT_TARGET_SDK_VERSION = 33
+def DEFAULT_TARGET_SDK_VERSION = 34
 
 def safeExtGet(prop, fallback) {
     rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
@@ -33,5 +33,5 @@ android {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'io.uqudo.sdk:Uqudo:2.7.4'
+    implementation 'io.uqudo.sdk:Uqudo:3.0.1'
 }

package/android/src/main/java/io/sdk/uqudoid/UqudoIdModule.java

@@ -39,6 +39,7 @@ import io.uqudo.sdk.core.builder.BackgroundCheckConfigurationBuilder;
 import io.uqudo.sdk.core.builder.FacialRecognitionConfigurationBuilder;
 import io.uqudo.sdk.core.builder.ReadingConfigurationBuilder;
 import io.uqudo.sdk.core.domain.model.BackgroundCheckType;
+import io.uqudo.sdk.core.domain.model.ObfuscationType;
 import io.uqudo.sdk.core.domain.model.Document;
 import io.uqudo.sdk.core.domain.model.DocumentType;
 import java.text.SimpleDateFormat;
@@ -126,6 +127,12 @@ public class UqudoIdModule extends ReactContextBaseJavaModule implements Activit
                 if (json.has("sessionId")) {
                     enrollment.setSessionId(json.getString("sessionId"));
                 }
+                if(json.has("isAllowNonPhysicalDocuments")){
+                    enrollment.allowNonPhysicalDocuments();
+                }
+                if (json.has("isDisableTamperingRejection")) {
+                    enrollment.disableTamperingRejection();
+                }
                 if (json.has("userIdentifier")) {
                     enrollment.setUserIdentifier(UUID.fromString(json.getString("userIdentifier")));
                 }
@@ -150,6 +157,15 @@ public class UqudoIdModule extends ReactContextBaseJavaModule implements Activit
                     if (faceObject.has("allowClosedEyes") && faceObject.getBoolean("allowClosedEyes")) {
                         faceBuilder.allowClosedEyes();
                     }
+                    if (faceObject.has("obfuscationType")){
+                        if (faceObject.getString("obfuscationType").equals("FILLED")){
+                            faceBuilder.enableAuditTrailImageObfuscation(ObfuscationType.FILLED);
+                        } else if (faceObject.getString("obfuscationType").equals("BLURRED")){
+                            faceBuilder.enableAuditTrailImageObfuscation(ObfuscationType.BLURRED);
+                        } else if (faceObject.getString("obfuscationType").equals("FILLED_WHITE")){
+                            faceBuilder.enableAuditTrailImageObfuscation(ObfuscationType.FILLED_WHITE);
+                        }
+                    }
                     enrollment.enableFacialRecognition(faceBuilder.build());
                 }
                 if (json.has("lookupConfiguration")) {
@@ -338,6 +354,15 @@ public class UqudoIdModule extends ReactContextBaseJavaModule implements Activit
                 if (json.has("isReturnDataForIncompleteSession") && json.getBoolean("isReturnDataForIncompleteSession")) {
                     faceSession.returnDataForIncompleteSession();
                 }
+                if (json.has("obfuscationType")){
+                    if (json.getString("obfuscationType").equals("FILLED")){
+                        faceSession.enableAuditTrailImageObfuscation(ObfuscationType.FILLED);
+                    } else if (json.getString("obfuscationType").equals("BLURRED")){
+                        faceSession.enableAuditTrailImageObfuscation(ObfuscationType.BLURRED);
+                    } else if (json.getString("obfuscationType").equals("FILLED_WHITE")){
+                        faceSession.enableAuditTrailImageObfuscation(ObfuscationType.FILLED_WHITE);
+                    }
+                }
                 Intent intent = faceSession.build(context);
                 if (json.has("appearanceMode")) {
                     if ("LIGHT".equals(json.getString("appearanceMode"))) {
@@ -397,6 +422,15 @@ public class UqudoIdModule extends ReactContextBaseJavaModule implements Activit
                     if (faceObject.has("allowClosedEyes") && faceObject.getBoolean("allowClosedEyes")) {
                         faceBuilder.allowClosedEyes();
                     }
+                    if (faceObject.has("obfuscationType")){
+                        if (faceObject.getString("obfuscationType").equals("FILLED")){
+                            faceBuilder.enableAuditTrailImageObfuscation(ObfuscationType.FILLED);
+                        } else if (faceObject.getString("obfuscationType").equals("BLURRED")){
+                            faceBuilder.enableAuditTrailImageObfuscation(ObfuscationType.BLURRED);
+                        } else if (faceObject.getString("obfuscationType").equals("FILLED_WHITE")){
+                            faceBuilder.enableAuditTrailImageObfuscation(ObfuscationType.FILLED_WHITE);
+                        }
+                    }
                     lookupBuilder.enableFacialRecognition(faceBuilder.build());
                 }
                 if (json.has("backgroundCheckConfiguration")) {

package/ios/UqudoId.m

@@ -58,6 +58,12 @@ RCT_EXPORT_METHOD(enroll:(NSString *)enrollObj resolver:(RCTPromiseResolveBlock)
                 if (json[@"isReturnDataForIncompleteSession"]) {
                     enrollmentBuilder.returnDataForIncompleteSession = [[json valueForKey:@"isReturnDataForIncompleteSession"] boolValue];
                 }
+                if(json[@"isAllowNonPhysicalDocuments"]){
+                    enrollmentBuilder.allowNonPhysicalDocuments = [[json valueForKey:@"isAllowNonPhysicalDocuments"] boolValue];
+                }
+                if (json[@"isDisableTamperingRejection"]) {
+                    enrollmentBuilder.disableTamperingRejection = [[json valueForKey:@"isDisableTamperingRejection"] boolValue];
+                }
                 if (facialRecognitionSpecification) {
                     // Enable help page for face recognition
                     UQFacialRecognitionConfig *config = [[UQFacialRecognitionConfig alloc] init];
@@ -84,6 +90,15 @@ RCT_EXPORT_METHOD(enroll:(NSString *)enrollObj resolver:(RCTPromiseResolveBlock)
                     if (facialRecognitionSpecification[@"allowClosedEyes"]) {
                         config.allowClosedEyes = [[facialRecognitionSpecification valueForKey:@"allowClosedEyes"] boolValue];
                     }
+                    if (facialRecognitionSpecification[@"obfuscationType"]) {
+                        if ([facialRecognitionSpecification[@"obfuscationType"]  isEqualToString:@"BLURRED"]) {
+                            config.obfuscationType = BLURRED;
+                        } else if ([facialRecognitionSpecification[@"obfuscationType"]  isEqualToString:@"FILLED"]) {
+                            config.obfuscationType = FILLED;
+                        } else if ([facialRecognitionSpecification[@"obfuscationType"]  isEqualToString:@"FILLED_WHITE"]) {
+                            config.obfuscationType = FILLED_WHITE;
+                        }
+                    }
                     enrollmentBuilder.facialRecognitionConfig = config;
                 }
 
@@ -355,6 +370,16 @@ RCT_EXPORT_METHOD(faceSession:(NSString *)configuration resolver:(RCTPromiseReso
                 if (json[@"isReturnDataForIncompleteSession"]) {
                     faceSessionBuilder.returnDataForIncompleteSession = [[json valueForKey:@"isReturnDataForIncompleteSession"] boolValue];
                 }
+                if (json[@"obfuscationType"]) {
+                    if ([json[@"obfuscationType"]  isEqualToString:@"BLURRED"]) {
+                        [faceSessionBuilder enableAuditTrailImageObfuscation:BLURRED];
+                    } else if ([json[@"obfuscationType"]  isEqualToString:@"FILLED"]) {
+                        [faceSessionBuilder enableAuditTrailImageObfuscation:FILLED];
+                    } else if ([json[@"obfuscationType"]  isEqualToString:@"FILLED_WHITE"]) {
+                        [faceSessionBuilder enableAuditTrailImageObfuscation:FILLED_WHITE];
+                    }
+                }
+                
                 builderController.delegate = self;
                 UIViewController *rootViewController = [UIApplication sharedApplication].delegate.window.rootViewController;
                 builderController.appViewController = rootViewController;
@@ -459,6 +484,15 @@ RCT_EXPORT_METHOD(lookup:(NSString *)lookupObj resolver:(RCTPromiseResolveBlock)
                     if (facialRecognitionSpecification[@"allowClosedEyes"]) {
                         config.allowClosedEyes = [[facialRecognitionSpecification valueForKey:@"allowClosedEyes"] boolValue];
                     }
+                    if (facialRecognitionSpecification[@"obfuscationType"]) {
+                        if ([facialRecognitionSpecification[@"obfuscationType"]  isEqualToString:@"BLURRED"]) {
+                            config.obfuscationType = BLURRED;
+                        } else if ([facialRecognitionSpecification[@"obfuscationType"]  isEqualToString:@"FILLED"]) {
+                            config.obfuscationType = FILLED;
+                        } else if ([facialRecognitionSpecification[@"obfuscationType"]  isEqualToString:@"FILLED_WHITE"]) {
+                            config.obfuscationType = FILLED_WHITE;
+                        }
+                    }
                     lookupBuilder.facialRecognitionConfig = config;
 
                 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "uqudosdk-react-native",
   "title": "React Native UqudoId",
-  "version": "2.7.4",
+  "version": "3.0.1",
   "description": "Uqudo SDK react native module",
   "main": "index.js",
   "author": {

package/uqudoBuilder/uqudo.js

@@ -131,10 +131,18 @@ export const AppearanceMode = Object.freeze(
     }
 );
 
+export const ObfuscationType = Object.freeze(
+    {
+        FILLED: 'FILLED',
+        BLURRED: 'BLURRED',
+        FILLED_WHITE: 'FILLED_WHITE'
+    }
+);
+
 export class Enrollment {
     constructor(documentList, authorizationToken, nonce,
         isRootedDeviceAllowed, isSecuredWindowsDisabled, facialRecognitionSpecification,
-        backgroundCheckConfiguration, lookupConfiguration, sessionId, userIdentifier, isReturnDataForIncompleteSession, appearanceMode) {
+        backgroundCheckConfiguration, lookupConfiguration, sessionId, userIdentifier, isReturnDataForIncompleteSession, appearanceMode,isAllowNonPhysicalDocuments,isDisableTamperingRejection) {
         this.documentList = documentList;
         this.authorizationToken = authorizationToken;
         this.nonce = nonce;
@@ -147,6 +155,8 @@ export class Enrollment {
         this.userIdentifier = userIdentifier;
         this.isReturnDataForIncompleteSession = isReturnDataForIncompleteSession;
         this.appearanceMode = appearanceMode;
+        this.isAllowNonPhysicalDocuments = isAllowNonPhysicalDocuments;
+        this.isDisableTamperingRejection = isDisableTamperingRejection;
     }
 }
 
@@ -160,6 +170,14 @@ export class EnrollmentBuilder {
         this.nonce = nonce;
         return this;
     }
+    allowNonPhysicalDocuments() {
+        this.isAllowNonPhysicalDocuments = true;
+        return this;
+    }
+    disableTamperingRejection() {
+        this.isDisableTamperingRejection = true;
+        return this;
+    }
 
     setSessionId(sessionId) {
         this.sessionId = sessionId;
@@ -230,7 +248,7 @@ export class EnrollmentBuilder {
         return new Enrollment(this.documentList, this.authorizationToken, this.nonce,
             this.isRootedDeviceAllowed, this.isSecuredWindowsDisabled, this.facialRecognitionSpecification,
             this.backgroundCheckConfiguration, this.lookupConfiguration, this.sessionId, this.userIdentifier, this.isReturnDataForIncompleteSession,
-            this.appearanceMode);
+            this.appearanceMode,this.isAllowNonPhysicalDocuments,this.isDisableTamperingRejection);
     }
 }
 
@@ -269,8 +287,14 @@ export class FacialRecognitionConfigurationBuilder {
                 return this;
             },
 
+            
+            enableAuditTrailImageObfuscation: function (obfuscationType) {
+                this.obfuscationType = obfuscationType;
+                return this;
+            },
+
             build: function () {
-                return new FacialRecognitionConfiguration(this.enrollFace, this.scanMinimumMatchLevel, this.readMinimumMatchLevel, this.lookupMinimumMatchLevel, this.maxAttempts,this.isAllowClosedEyes);
+                return new FacialRecognitionConfiguration(this.enrollFace, this.scanMinimumMatchLevel, this.readMinimumMatchLevel, this.lookupMinimumMatchLevel, this.maxAttempts,this.isAllowClosedEyes,this.obfuscationType);
             }
         };
     }
@@ -278,13 +302,14 @@ export class FacialRecognitionConfigurationBuilder {
 
 
 export class FacialRecognitionConfiguration {
-    constructor(enrollFace, scanMinimumMatchLevel, readMinimumMatchLevel, lookupMinimumMatchLevel, maxAttempts,isAllowClosedEyes) {
+    constructor(enrollFace, scanMinimumMatchLevel, readMinimumMatchLevel, lookupMinimumMatchLevel, maxAttempts,isAllowClosedEyes,obfuscationType) {
         this.enrollFace = enrollFace;
         this.scanMinimumMatchLevel = scanMinimumMatchLevel;
         this.readMinimumMatchLevel = readMinimumMatchLevel;
         this.lookupMinimumMatchLevel = lookupMinimumMatchLevel;
         this.maxAttempts = maxAttempts;
         this.allowClosedEyes = isAllowClosedEyes;
+        this.obfuscationType = obfuscationType;
     }
 }
 
@@ -633,17 +658,22 @@ export class FaceSessionBuilder {
                 this.appearanceMode = appearanceMode;
                 return this;
             },
+            
+            enableAuditTrailImageObfuscation: function (obfuscationType) {
+                this.obfuscationType = obfuscationType;
+                return this;
+            },
 
 
             build: function () {
-                return new FaceSessionConfiguration(this.authorizationToken, this.sessionId, this.nonce, this.isRootedDeviceAllowed, this.isSecuredWindowsDisabled, this.minimumMatchLevel, this.maxAttempts, this.isReturnDataForIncompleteSession, this.appearanceMode,this.isAllowClosedEyes);
+                return new FaceSessionConfiguration(this.authorizationToken, this.sessionId, this.nonce, this.isRootedDeviceAllowed, this.isSecuredWindowsDisabled, this.minimumMatchLevel, this.maxAttempts, this.isReturnDataForIncompleteSession, this.appearanceMode,this.isAllowClosedEyes,this.obfuscationType);
             }
         }
     }
 }
 
 export class FaceSessionConfiguration {
-    constructor(token, sessionId, nonce, isRootedDeviceAllowed, isSecuredWindowsDisabled, minimumMatchLevel,maxAttempts,isReturnDataForIncompleteSession,appearanceMode,isAllowClosedEyes) {
+    constructor(token, sessionId, nonce, isRootedDeviceAllowed, isSecuredWindowsDisabled, minimumMatchLevel,maxAttempts,isReturnDataForIncompleteSession,appearanceMode,isAllowClosedEyes,obfuscationType) {
         this.token = token;
         this.sessionId = sessionId;
         this.nonce = nonce;
@@ -654,6 +684,7 @@ export class FaceSessionConfiguration {
         this.isReturnDataForIncompleteSession = isReturnDataForIncompleteSession;
         this.appearanceMode = appearanceMode;
         this.allowClosedEyes = isAllowClosedEyes;
+        this.obfuscationType = obfuscationType;
     }
 }
 

package/uqudosdk-react-native.podspec

@@ -13,5 +13,5 @@ Pod::Spec.new do |s|
   s.source = { :http => 'https://uqudo.com' }
   s.header_dir = 'UqudoSDK'
   s.dependency 'React'
-  s.dependency 'UqudoSDK', '2.7.4'
+  s.dependency 'UqudoSDK', '3.0.1'
 end