Changelog MobbScan Android SDK

v2.27.1 (2024-09-23)

Enhancements

• Updated some internal dependencies.

Fixes

• Fixed an exception caused by exceeding the maximum camera preview resolution.

v2.27.0 (2024-04-09)

New features

• OTP is now entered via text during the unattended video flow.
• Adds new quality control parameter: checkDocumentBlurring.

Enhancements

• Enlarged the oval where the face is located during facial recognition.

Fixes

• Fixed some service calls during the unattended video flow.

v2.26.2 (2024-03-26)

Fixes

• Fixed an error that was causing a Null Pointer Exception.

v2.26.1 (2024-01-10)

Fixes

• Fixed document detection issues for ITAIDCard type.

v2.26.0 (2023-11-23)

New features

• Added support for the following document types:
  • PANIDCardV3
  • ITAIDCard
  • ITAIDCardV1
  • ITAIDCardV2
  • ITAIDCardV3

Warning: This update introduces some DEPRECATED METHODS. Please carefully read the Migration Guide.

v2.24.3 (2023-10-03)

Enhancements

• It removes custom fonts and uses only Android system's local fonts.

v2.25.1 (2023-09-27)

Fixes

• It solves an exception when method detectFaceVideoLiveness is called twice.

Enhancements

• MRZ Detector Enhancements: We have made significant improvements to our MRZ detector to provide you with a more accurate and reliable experience. In this version, we have focused on MRZ detection for several countries, including (but not limited to): Bulgaria, France, Albania, Netherlands,...

v2.25.0 (2023-03-14)

Warning: This update introduces some BREAKING CHANGES. Please read the Migration Guide carefully.

Fixes

• The labeling of FRONT and BACK images in the unattended video process has been corrected, as they were previously swapped.

Enhancements

• Add a new method startScan with a scanId. Now the developers can perform a startScan operation in a 3rd party environment, and inject the scanId into the mobile application.
• A new system has been implemented to embed internal libraries, ensuring compatibility with the latest versions of Gradle.
• Several resources that were no longer in use have been eliminated, resulting in a smaller SDK.
• The CameraAPI has been replaced with the Camera2 API in the unattended video process.

New features

• A new functionality has been added during the unattended video process to obtain local video results for specific parts of the process.

v2.24.1 (2023-05-30)

Fixes

• Fixed a bug that was occurring on devices with Android >= 31 and were not using the permission: android.permission.HIGH_SAMPLING_RATE_SENSORS.

Enhancements

• Some libraries are upgraded to prevent security issues in WebRTC.

New features

• Two new objects (VizData and MrzData) are added as attributes of the IDDocument class.

v2.24.0 (2022-11-30)

Fixes

• Solves an issue while detecting an italian document with TD1IDCard document type.
• Adds new fields to GTMIDCard.

Enhancements

• Upgrades Twilio dependency to v7.5.1.
• Adds support for the following document types:
  • COLIDCardV4.
  • PERIDCardE.
  • PERIDCardEV2.
• Adds support for the PDF417 detection of SLVIDCardV2.

New features

• Adds a new facial validation mode: MobbScanFaceValidationMode.LIVENESS_VIDEO_PASSIVE. The new method allows the users to check the liveness without moving the face.

v2.23.1

Fixes

• Fixed a NullPointerException when the unattended video + liveness flow was launched.
• Fixed an issue that appears when a detection flow with liveness was launched.

Enhancements

• Added a new error type to identify issues relating to camera management.
• Some network requests were reduced in size.
• The liveness video file was optimized to take less space.
• DetectorView overlay was adjusted to fit the different document types (TD1, TD2 and TD3).

v2.23.0

New features

• Added support for SLVIDCardV2

Fixes

• Fixes a memory management issue when the PDF417 flow is launched.
• Fixes an issue when face validation is launched in landscape orientation.
• Fixes an issue when the unattended video flow is launched twice.

v2.22.1

New features

• The unattended video process includes two new errors: DOCUMENT_NOT_VALID_ERROR and IDENTITY_VERIFICATION_NOT_VALID_ERROR. These error are launched if the unattended video process is cancelled due to the following reasons:

  • Error in the validation matrix:
    • DOCUMENT_NOT_VALID_ERROR: An error occurs while scanning the document.
    • IDENTITY_VERIFICATION_NOT_VALID_ERROR: An error occurs with the face biometrics.

Fixes

• Fixes an issue when customizing the liveness video: the video is not sent to the server.

v2.22.0

New features

• Now the unattended video process includes an OTP step.
• The following vulnerabilities are patched:
  • EXTERNAL DATA STORAGE [CWE-921]
  • HARDCODED DATA [CWE-200]
  • INFORMATION EXPOSURE [CWE-200]
  • USAGE OF IMPLICIT INTENT [CWE-927]
  • NETWORK SECURITY CONFIGURATION IS NOT PRESENT
  • OBJECT DESERIALIZATION FOUND [CWE-502]

Fixes

• Fixed bugs relative to the PDF417 flow.
• Fixed NullPointerException error while going back in the sample project.

Deprecations

• Deprecated supporting offline scan.

v2.21.1

Fixes

Correction of repeated fields in documents:

• SLVDrivingLicense : duplicate field dateOfIssuing
• GTMIDCard : duplicate field validationBothSidesMatchScore
• SLVIDCardNIT : duplicate field parameter dateOfIssuing

v2.21.0

New features

• Add new document types: CRIIDCard, CRIIDCardV1, CRIIDCardV2, CHLIDCard, COLIDCard, DEUIDCard, PERIDCard, PRT, IDNIDCard, NLDPassport, ESPResidencePermit, ESPResidencePermitV1, ESPResidencePermitV2, ESPResidencePermitV3, TD3Passport and European countries driving licenses.
• Fully renewed face detection user interface in unattended video flow.
• Add face detection with liveness validation mode to the unattended video flow.
• Default detection views can be customized by setting properties in the mobbscan_styles.xml file.
• NFC scanned data is sent to the server enabling you to review the scanned documents in the validations page.

Enhancements

• Improve NLDPassport detection.
• Improve POLIDCard detection.

Deprecations

• NIE document type is deprecated, please use ESPResidencePermitV1 instead.
• ESPIDCardRP document type is deprecated, please use ESPResidencePermitV2 instead.
• NDLPassport document type is deprecated, please use NLDPassport instead.
• PASSPORT_TD3 document type is deprecated, please use TD3Passport instead.

v2.20.1

New features

• cancelReason parameter has been added to the cancelVideo method to to get the reason for cancellation:
  • USER_CANCELLED_ERROR
  • TIMEOUT_ERROR
  • DOCUMENT_NOT_CLASSIFIED_ERROR

Fixes

• Fixes unexpected errors in the frame management of the unattended video functionality that cause a forced shutdown of the application.

v2.20.0

New features

• Fully renewed face detection user interface.
• licenseId parameter has been added to the video start method.

Enhancements

• Drop support for SMILE liveness face validation mode.

• Added validationFaceLaserMarkScore value for El Salvador and Mexico documents:

  • SLVIDCardCA4
  • SLVIDCardV1
  • MEXIDCard
  • MEXIDCardF
  • MEXIDCardE
  • MEXIDCardD
  • MEXIDCardGH

v2.19.9

Fixes

• Fixed a NullPointerException when the scan passport + liveness flow was launched.

v2.19.8

Enhancements

• Improved support for these document types:

  • CHLICardE
  • ESPIDCardV4
  • MEXIDCard
  • MEXIDCardC
  • MEXIDCardF
  • MEXIDCardGH
  • MEXPassport
  • SLVDrivingLicense
  • SLVIDCardCA4
  • SLVIDCardV1

• Adds new fields to SLVIDCardV1 fatherName and motherName.

• Adds new field to control to documents validationRelationshipDates.

• Adds new fields to SLVIDCardCA4 dateOfIssuing and placeOfBirth.

• Improved the document capture quality control for these document types:

  • COLIDCardV3
  • CRIIDCard
  • CRIIDCardV1
  • CRIIDCardV2
  • MEXIDCardC
  • PANIDCard
  • PANIDCardV1
  • PANIDCardV2
  • SLVIDCardNIT
  • TD2IDCard

v2.19.7

Enhancements

• Fixes validationBothSidesMatchScore value for El Salvador documents: DUI (SLVIDCardV1) and resident card (SLVIDCardCA4).

v2.19.6

Enhancements

• Improved the document capture quality control module to avoid cases where the SDK failed to detect the document back side as valid.

v2.19.5

Fixes

• Fixes unexpected errors in the unattended video functionality causing a force close of the application.

v2.19.4

Fixes

• Fixes an NFC module issue: SDK has been updates NFC internal dependencies in order to prevents the unexpected force close of the application.
• Fixes unattended video issue: prevents to invoke the cancel video method after the video was saved.
• Fixes unattended video issue: when the user cancel the process the camera still open and now it properly closed.

v2.19.3

New features

• Fixes a related issue on auto-cancellation of the unattended video process when the maximum allowed timeout occurs.
• licenseId parameter has been added to the video cancellation method in order to check the scanId received corresponds to its licenseId.

v2.19.2

Fixes

• Fixes an issue when the user cancels the unattended video process without successfully finish it.

v2.19.1

Enhancements

• Improved frame capture on video indenty verification process.

v2.19.0

New features

• Added the option to perform the face validation process in landscape mode.
• Added new security checks in the NFC scan.
• Added a new timeout for unattended video process.
• Added a method to remove all data related to cancelled unattended video data.

v2.18.10

New features

• Added the option to perform the face validation process in landscape mode.

v2.18.9

New features

• Added the option to disable or enable specific verifications over face detection.

v2.18.8

Fixes

• Fixed a bug that caused the custom face detector to open the default view.

v2.18.7

Fixes

• Fixed a problem that caused the unattended video process to not save the video in the agent portal.

v2.18.6

Fixes

• Fixed a bug that allowed the detector to return partial document detections.

v2.18.5

New features

• Added the option to disable or enable specific verifications over document detection.

v2.18.4

Fixes

• Fixed a bug that caused the detector to reject the MEXIDCard document in very bright conditions.
• Fixed a bug that returned an incorrect user image in the video liveness process callback.

Enhancements

• Changed the aspect ratio of the detection rectangle in the default activities for Passports.

v2.18.3

Fixes

• Fixed a bug that caused the back of the MEXIDCardC document to not be detected when using the MEXIDCard generic type.

v2.18.2

Enhancements

• Default MRZ and Passport interface now shows the new feedback messages recently added.

Fixes

• Fixed a bug that caused, occasionally, the camera to open after detecting the face in the video liveness process.
• Fixed a bug that caused an animation to not display correctly in the video liveness process.

v2.18.1

New features

• Added the option to show a back arrow icon in the unattended video activity.

Fixes

• Fixed a bug that caused the SDK to not be able to detect documents in horizontal mode.
• Fixed a bug that caused the SLVDriverLicense data to be returned incorrectly.
• Fixed a bug that caused a crash in the Liveness Video process.

v2.18.0

New features

• Added new controls for the face detection process, face within the frame, distance and mouth visible.
• Unattended video activity is now fully configurable.

Fixes

• Fixed a bug that caused, occasionally, the video unattended process to not detect the documents.

v2.17.6

Enhancements

• Now all the documents have a validationIssuingState field.

v2.17.5

New features

• Added new feedback messages for the unattended process.
• Added a new count down timer for the face detection step in the unattended process.
• Added a new method to be able to mirror the camera preview in the unattended process.

Enhancements

• Modified the document detection for better accuracy.

v2.17.4

New features

• Improved the performance of the default face detector. Now it will check the image luminosity, returning feedback when it is not correct. A new process has also been added so as to reduce unfocused and moved images.
• Added support for SLVIDCardNIT.
• Added a new field to the MobbScanDetectionResultData on the IDDocumentDetectionListener with the image of the document uncropped.

Fixes

• Fixed a bug that caused the face images returned by MobbID to be mirrored.
• Removed allowBackup attribute from MobbScan-MobbIDFaceValidator-Android dependency.
• Fixed a bug that caused the error codes from MobbID to not be correctly returned.
• Fixed a bug that caused the SDK to save images when not on debug mode.
• Fixed a bug that caused the camera to not be able to be initialized.

v2.17.3

New features

• Added support for IDNIDCard.

v2.17.2

New features

• Added new fields to SLVIDCardV1.

Fixes

• Fixed problems with isApiInitializationDone when license was invalid.
• Fixed face detection returning mirrored image.
• Fixed a problem that caused the video from the detectVideoLiveness to be deleted before the user could get it.

v2.17.1

New features

• Added support for NFC scanning and the ideo based validation process.

Fixed

• Fixed a bug that caused the LIVENESS_SMILE validation method to not return the result.
• Fixed a bug that caused the error codes from the video based validation to not be properly parsed.
• Fixed a bug that caused the detectVideoLiveness method to not return the result.
• Fixed a bug that caused the app to close when updating to version 2.17 of the MobbScan Android SDK.

v2.17.0

New features

• Added a new detection flow for documents. Now the detection process returns more feedback messages about luminosity, document distance and much more.
• Added a new UI for the video based validation process.
• Added more options on the MobbScanConfiguration class, this new options will help you configure the new detection flow as you like.

Fixed

• Fixed a bug that, occasionally, caused the video based validation process to Force Close

v2.16.27

Fixed

• Fixed a bug that caused the SLVDriverLicense data to be returned incorrectly.

v2.16.26

New features

• Added the ability to pass your own scanId to use in the process.

v2.16.25

Fixed *Fixed a bug that caused the Liveness Video activity to not be able to be configurable.

v2.16.24

New features

• Added the ability to customize the default Liveness Video activity.

v2.16.23

New feature

• Added new MobbScanViewPresented and MobbScanViewDismissed listeners to know when a default MobbScan activity is displayed and removed.

Fixed

• Fixed a bug that caused the app to force close when doing the unattended process.

v2.16.22

Fixed

• Fixed a bug that caused data inconsistency in the unattended process.
• Fixed a bug that caused unnecessary images to be stored.

v2.16.21

New features

• Adds the option to customize the detection rectangle and face border on the unattended video process.
• Adds support for MEXPassport.

Fixes

• Fixes a bug caused the unattended video process to end without result.

v2.16.20

New features

• Adds isOneSideDocument method to check if a document has only one side

Fixes

• Fixes a bug that caused the validation data obtained to not be correct.

v2.16.19

Fixes

• Fixes a bug that caused the detector to be disabled after a document scan in the unattended video process.

v2.16.18

New features

• Adds a new customization method for the unattended video process.

Enhancements

• Changes the face acquisition method in the unattended video process.

Fixes

• Fixes a bug that caused a NullPointerException when returning the app from background.

v2.16.17

New features

• Adds support for SLVPassport

v2.16.16

New features

• Added more customization options for the Unattended video process.

v2.16.15

Fixes

• Fixed a bug that caused the Passport_TD3 to be more difficult to detect.

v2.16.14

New features

• Added a new interface for the Unattended video process.

v2.16.13

Fixes

• Fixed a bug that caused the camera to not be properly initialized.

v2.16.12

Fixes

• Fixed a bug that caused the camera to not be able to be initialized.

v2.16.11

Fixes

• Fixed a bug that caused the SDK to save images when not on debug mode.

v2.16.10

New features

• Added support for SLVIDCardV1
• Added support for SLVIDCardNIT

Fixes

• Fixed a bug that caused the error codes from MobbID to not be correctly returned.

v2.16.9

Enhancements

• Improved the performance of the default face detector. Now it will check the image luminosity, returning feedback when it is not correct. It has also been added a new process in order to reduce unfocused and moved images.

Fixes

• Removed allowBackup attribute from MobbScan-MobbIDFaceValidator-Android dependency.

v2.16.8

Fixes

• Fixed a bug that caused the face images returned by MobbID to be mirrored.

v2.16.7

Fixes

• Fixed a bug that caused the PDF417 detection to not work properly in some cases.

v2.16.6

New features

• Added new fields to SLVIDCardV1.

Fixes

• Fixed problems with isApiInitializationDone when license was invalid.
• Fixed face detection returning mirrored image.

v2.16.5

Fixes

• Fixed MEXIDCardGH parser.

v2.16.4

New features

• Added the option to pass an image of the user's face to the new video based face validation process.

Fixes

• Fixed a bug that caused an exception when using the new video based face validation with a one sided document.
• Fixed a bug that caused an exception when using the neww video based face validation and no MobbScanConfiguration was provided.

v2.16.3

Fixes

• Fixed a bug that caused the document detector to not work in some devices with small screen resolutions.

New features

• Added a new method to scan a document MRZ with a default activity.

v2.16.2

Fixes

• Fixed a bug that caused the face detector to not return the detected image.

v2.16.1

Fixes

• Fixes a bug that ocassionally caused an ANR error when scanning a document with the two images of a document.
• Fixes a bug that caused some validations of MEXIDCard documents to be wrong.

v2.16.0

New features

• Added support for MEXIDCardGH.
• Added new method scanDocument that allows you to perform a scan of the front image (bitmap) and the back image (bitmap).
• Added the option to perform only document detection with default activities.
• Added a new default face detector which replaces the previous one with a new UI design.
• Added the option to customize the colors of the default activities.
• Added a new identity verification process.

Enhancements

• Improved the speed of the face detector.
• Allow detection without having to include offline dependencies.

Fixes

• Fixes a bug that caused the face validation activity to stay open in the background after finishing the process.
• Fixed a bug that caused the documentSide attribute to return null when performing an MRZ detection.
• Fixed detection problems with Nexus 5x.
• Fixed detection problems with Huawei Y5.
• Fixed detection problems for the SLVDrivingLicense document.
• Fixed conflicts with the camerakit external dependency.

v2.15.8

Enhancements

• Added parents information if you scan an ESPIDCardV3 via the NFC chip reader.

Fixes

• Fixed a bug that caused the documentType value to be null when scanning a document with the NFC.
• Returns the first and second surname in its corresponding attribute instead of both values in the surname attribute when scanning a document with via the NFC chip reader.

v2.15.7

Fixes

• Fixed detection problems with SLVDrivingLicense.
• Fixed incompatibility issues with some external dependencies.

v2.15.6

Fixes

• Fixed detection problems with some specific devices causing the image detected to return rotated.

v2.15.5

New features

• Added the option to use MobbScan detector UI just for detection.
• Added support for offline detections without requiring offline resources.

v2.15.4

Enhancements

• The obligation to use AndroidX dependencies if you use MobbID is removed.

## v2.15.3

Enhancements

• Improved the data extraction process for Passport_TD3 document type.
• Improved support for Salvadoran driving license and fixed some bugs related to this document.

v2.15.2

Fixes

• Fixed a bug that caused the app to close, occasionally, when scanning an MRZ.
• Fixed a bug where, in some cases, a document could not be detected.

Enhancements

• Now the field firstSurname and secondSurname are complete on all documents when available.

v2.15.1

Fixes

• Fixes a bug that caused the result of the check verification process to always return an error.

v2.15.0

Enhancements

• Improved the extraction of information from QR Code on supported documents.

New features

• Added listener to check quality status on video conference process.
• Added support for notifications if the user has connection issues during video conference.

v2.14.2

Fixes

• Fixed a bug that caused, occasionally, to not return ValidationNotSpecimen field correctly.

Enhancements

• NFC reader now returns address information and city of birth.

v2.14.1

Fixes

• Fixes a bug that caused the app to close, occasinally, when using the new face acquisiton methods.
• Fixes a bug that caused the app to close when using MobbID without AndroidX. This fix adds support to non AndroidX applications.

v2.14.0

New features

• Adds default activity on unattended mode for all developers to use instead of having to customize one.
• Adds a new face detector with improved focus calculation including default and custom views.
• Adds a document and passport detector using DNN methods, this is now the default detector used.
• Adds support for applications using AndroidX dependencies.

Enhancements

• Improves detected image's focus.
• Removes obligation to include retrofit and support-annotation libraries.
• Added support for the latests versions of gradle (3.5.2).

Fixes

• Fixes a bug that, in some cases, the MRZ detection could not detect the document on FORCE_CROP mode.
• Fixes a bug where MobbScan dependencies could conflict with third party dependencies.

v2.13.5

• Fixes a bug that happened when you try to scan a nfc document with incorrect credentials.

v2.13.4

Fixes

• Fixes a bug that appeared when using custom detector UI and not setting the marginListener.

v2.13.3

Enhancements

• Adds validations list on mrz scan with default activity

v2.13.2

Fixes

• Fixes a bug where the default activity runs as other application.

v2.13.1

Fixes

• Fixes the force crop mode in the default MRZ activity.
• Fixes a problem with validation both sides score.

v2.13.0

New features

• Adds new mechanism for false positive rejection on ID detection activity. Integrators can activate this mode by setting up "setFalsePositiveRejection" parameter. Once enabled, ID detections that do not meet some constraints (headshot or MRZ location for instance) are rejected, preventing unsopported ID processing.
• Adds support for new document types: Israel driving license (ISRDrivingLicense), Cuba ID Card (CUBIDCard), Colombian foreigner ID Card (COLIDCardExt) and all IDs following ICAO TD2 standard (TD2IDCard).
• Adds ESP document type. This documet type can be used generically to indicate a Spanish ID within the following: ESPIDCardV1, ESPIDCardV2, ESPIDCardV3, ESPIDCardRP, NIE, EURDrivingLicense. MobbScan will automatically detect the actual document type and parse ID fields accordingly.
• Data extracted from MRZ scanning mode can be now sent and stored in the back-end by setting SDK to online mode.
• Place of birth field (placeOfBirth) is now returned for Dutch passport (NLDPassport). It can be extracted after MRZ scanning by setting SDK to online mode.
• Orientation can now be blocked to portrait or landscape by means of a setter.
• Adds a default activity for MRZ scanning mode in order to facilitate the integration.
• Adds a new method to send key-value map to MobbScan-Agent.

Enhancements

• Improves passport detection in the default activity.
• Improves performance for MRZ and ID card scanning process.
• Improves Portuguese ID data extraction and validation.

Fixes

• Listeners called previously from background threads can be now managed from UI main thread.
• Fixes exception in face detection activity found in old and low-end devices.
• Fixes undesired looping behaviour due to always forcing Autofocus when an ID is not detected.
• Fixes rotation updated bad behaviour found on some devices.
• Fixes minor bugs found in scanning default activity of MobbScan SDK.
• Fixes inconsistencies found in devices that do not support native face detection.

v2.12.12

Enhancements

• Adds new camera version with force camera orientation.

Fixes

• Fixes a problem that happened when forcing camera orientation on the default activity.

v2.12.11

Fixes

• Fixes a problem with the default scan activity.

v2.12.10

Fixes

• Fixes a problem where the images from camera could be bad oriented.

v2.12.9

New features

• Adds the posibility to fix the orientation of the camera.

v2.12.8

New features

• Adds the posibility to send MRZ scan data to the server with the back image.

Fixes

• Fixes a null pointer exception that could happen using the online MRZ scan.

v2.12.7

Fixes

• Fixes a problem where, in some cases, personal number was returned as null with MRZ scan process.

v2.12.6

Fixes

• Fixes problems with camera orientation calculations.
• Fixes a problem that occured on some devices when touching the screen to focus.
• Fixes a problem where camera did not support facial matching.
• Fixes a problem where some fields from MRZ scan were always returned as NOT_CHECKED.

v2.12.5

Fixes

• Fixes a bug that made smile based Liveness return only 1.

v2.12.4

Fixes

• Fixes both sides validation for Spanish documents.

v2.12.3

Fixes

• Images obtained from the front camera (face matching step) are now lighter.
• Adds a new callback message when a process is cancelled (PROCESS_CANCELLED).

v2.12.2

Fixes

• Fixes document detection issues.

v2.12.1

Fixes

• Fixes unexpected exception with NIE document using OFFLINE mode.

v2.12.0

New features

• Includes support for European driving licenses (EURDrivingLicense).
• Allows customization of data to be extracted and validated in MRZ scanning mode.
• NFC scanning for passports.

Enhancements

• Optimizes camera flow performance.
• Improves document detection for old and low-end devices.

Fixes

• General SDK performance and minor bugs.

v2.11.0

New features

• Enables portrait detection in MRZ scanning mode.

v2.10.0

New features

• Allows PDF417 barcode scanning for El Salvador ID (SLVIDCardV1), Peru ID (PERIDCardV1) and Colombia ID (COLIDCardV3).
• Integration with MobbID facial verification.
• Integration with MobbID liveness detection (anti-spoofing).
• Allows portrait and landscape document detection.

Enhancements

• MRZ real time detection.
• PDF417 barcode detection.
• Focus control and blurriness correction.
• OCR and data validation for all documents.

Fixes

• Memory leaks for Mexico ID cards (MEXIDCard).

v2.9.0

New features

• New documents: El Salvador residence permit, Guatemala ID card and lite version for Mexican IDs.

Enhancements

• MRZ real time detection.