Changelog

v2.27.1 (MAY 10, 2024)

Fixes

  • The camera now opens properly for the PDF417 barcode scan
  • The feedback text now is the proper one for the PDF417 barcode scan

v2.27.0 (APR 09, 2024)

Enhancements

  • Added privacy manifest to the frameworks. This is a requirement from the Apple side.

v2.26.0 (DEC 04, 2023)

New features

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

Breaking changes

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

v2.25.2 (OCT 06, 2023)

Fixes

  • Perform some fixes over the facial validation process. Now the API does not wait for the video to be compressed to return the feedback to the developers.

Enhancements

  • Bump the TesseractOCR library
  • Improve the OCR scanning process over some document types

v2.25.1 (JUL 20, 2023)

Fixes

  • Fix minnor issue with the MRZ scanning process

v2.25.0 (JUL 19, 2023)

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.
  • Notify developers when the connectivity has been lost, during a unattended video process.
  • The detection time has been improved. Now, it takes less time to perform a document detection.

Fixes

  • Fix the MRZ scanning mode FORCE_CROPPED_DOCUMENT. Now this method is working properly for every document scanning.

v2.24.0 (Dec 1, 2022)

Enhancements

  • Add new liveness method (MobbScanFaceValidationMode_LIVENESS_VIDEO_PASSIVE). The new method, allow the users to check the liveness without moving the face.
  • Add missing fields to the GTMIDCard document
  • Add support for COLIDCardV4 and PERIDCardV2 documents.

v2.23.1 (Jun 24, 2022)

Enhancements

  • Unattended video processes that are cancelled by identity verification causes are now tracked in server with a more specific cancellation reason (IDENTITY_VERIFICATION_NOT_VALID).

  • Improved sparkles control in document detection.

  • Reduced payload in identity verification requests.

  • Improved detection of back side of documents.

Fixes

  • Sparkles control was never being enabled. Now it enables or not depending on API configuration and it is enabled by default.

  • Liveness verification included in unattended video processes were not being processed properly due to a bug in timestamps records.

v2.23.0 (May 19, 2022)

New features

  • Add support for the new document type SLVIDCardV2.

v2.22.0 (May 5, 2022)

Deprecations

  • The MobbScanAPIMode is no longer used.

Fixes

  • Fix the COLIDCardV3 and PERIDCardV1 PDF417 scanning.
  • Fix a crash, when the developers try to scan a document without calling the startScan method before.
  • Now an iPA can be generated without the MobbFaceUX.xcframework framework.

Breaking changes

  • Remove the offline support for regular document scanning. Now, the offline framework just supports the MRZ scanning flow.

v2.21.0 (February 11, 2022)

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.

  • Default detection views can be customized by setting properties in the ms_theme.plist file.

  • Renewed face detection user interface for unattended video processes.

  • Now the unattended video process includes an OTP step.

  • NFC scanned data is sent to the server enabling reviewing 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.

Breaking changes

  • Drop support for KWTPassport.

v2.20.1 (January 14, 2022)

New features

  • Whenever the unattended video process gets cancelled, the cancellation reason is sent to the server.

v2.20.0 (November 19, 2021)

New features

  • Fully renewed face detection user interface.

Breaking changes

  • Drop support for SMILE liveness face validation mode.

v2.19.4 (November 3, 2021)

New features

  • Add support for ESPIDCardV4 document type.

Enhancements

  • Improve TD2 document detection.
  • Add SLVIDCardV1 fields: spouseName, spouseSurname, fatherName, motherName.
  • Add GTMIDCard fields: cui, munBirth, dptBirth

v2.19.3 (September 13, 2021)

Enhancements

  • Add support for Salvadorian generic ID cards. Now developers can set SLVIDCard as document type and scan SLVIDCardV1 or SLVIDCardCA4 documents in case they do not know the specific type in advance.

v2.19.2 (August 12, 2021)

Enhancements

  • Improve the document face detection algorithm that enables detect and extract user pictures from documents.

Fixes

  • Fix the false positive check algorithm that was keeping Salvadorian passports and Panama ID cards from being detected properly.
  • Properly return images used for face matching check as result of face validation process.
  • Fix the error that was produced sometimes when the connection was lost during the NFC chip reading process.

v2.19.1 (June 24, 2021)

Fixes

  • Remove the agent evidences of an unattended video process anytime the onboarding process finish with a scan error.

v2.19.0 (May 20, 2021)

Enhancements

  • Stop embedding some third-party libraries in the SDK module.
  • Renew demo project by translating from Objective-C to Swift and adding more use cases.

Features

  • Add a timeout for the default unattended video process and allow developers to customize it. Check this section for more info.

Fixes

  • Fix a double callback invocation bug with the NFC process.

v2.18.12 (April 26, 2021)

Fixes

  • Prevent a SDK crash when user cancels the NFC reading process and starts another again.

v2.18.11 (April 22, 2021)

Enhancements

  • Improve the NFC chip reading process:
    • Added a progress bar during reading process
    • Added a vibration at the beginning of the process
    • Fix error reading old passport chips

v2.18.10 (March 30, 2021)

Fixes

  • Set "true" every QA control by default, unless the developer changes it using the MSConfiguration object.

v2.18.9 (March 29, 2021)

Fixes

  • Fix scan process for Spanish documents. Now every field and validation is returned properly from the server scan to the native SDK.

Enhancements

  • Make facial detection orientation sensitive to detectionOrientation property setting.
  • Allow developers to enable / disable the QA controls for the document and face detection processes.

v2.18.8 (March 15, 2021)

Fixes

  • Avoid callback twice in unattended process completion.
  • Allow cancel unattended video process if user asks to.

v2.18.7 (February 16, 2021)

Enhancements

  • Add NFC method allowing passive authentication.

v2.18.6 (February 3, 2021)

Fixes

  • Get rid of wrong double callback on unattended video process end.

v2.18.5 (January 25, 2021)

Fixes

  • Fix the NFC error messages. Now developers can properly customize the messages that are shown when an error occurs during the NFC chips reading process.

v2.18.4 (January 18, 2021)

Fixes

  • All of the components of MobbScan SDK are delivered as xcframeworks now, enabling Xcode12.3 to include them without errors.

Enhancements

  • Adding a Run Script to your application's Build Phases to remove simulator architectures from frameworks is no longer needed.

v2.18.3 (January 11, 2021)

Fixes

  • The video liveness process now works properly with every kind of base url.

v2.18.2 (December 17, 2020)

Fixes

  • Improved brightness checks for back side of MEXIDCard document type.

v2.18.1 (December 9, 2020)

Fixes

  • Back of documents of type MEXIDCardC are now properly detected when starting scan process with generic type MEXIDCard.

v2.18.0 (November 11, 2020)

New features

  • Add the possibility of creating an unattended video onboarding process using your own interfaces. Developers can now create an onboarding process and perform the document and/or the face detection when they desire using their own interfaces. The whole process will be recorded and stored on the server side.
  • Improved facial detection. The face detection engine adds these new checkpoints to assure better quality:
    • Position and distance: the user must place their face within the frame, nor too close neither too far.
    • Occlusion: face shouldn't be total or partially occluded, so users wearing a health mask will be rejected.

v2.17.0 (October 27, 2020)

Enhancements

  • Renewed document detection: the document detector now checks some points in order to assess the quality of the captured image. This means better results and richer feedback exposed to the user.
  • Improve UX for face validation when using video liveness mode: by adding a delay before starting the video recording we make some time to let the user read the instructions.
  • New document type supported: Mexican passport.

v2.16.28 (April 14, 2021)

Enhancements

  • Online support for new document types:
    • MobbScanDocumentType_SLVDrivingLicenseV1
    • MobbScanDocumentType_SLVDrivingLicenseV2

v2.16.27 (October 30, 2020)

Enhancements

  • New supported document types:
    • MobbScanDocumentType_PANIDCardV1,
    • MobbScanDocumentType_PANIDCardV2

Fixes

  • Fix an issue with the facial validation. Users can now perform a document detection flow and perform a facial validation some time later. To do this, the previous scanId must be provided.

v2.16.26 (September 23, 2020)

Fixes

  • Fix flow passport detection + video liveness validation. Now this flow works properly.

v2.16.25 (September 16, 2020)

Fixes

  • Restore properly "PROCESS_CANCELLED" error from default document detection interface. Now it is sent to developers once the view controller has been dismissed.

v2.16.24 (September 11, 2020)

Enhancements

  • Add cancel button to default face detection interface

Fixes

  • Properly return a "PROCESS_CANCELLED" error when the user taps on the cancel button in the default document detection interface

v2.16.23 (September 10, 2020)

Enhancements

  • Allow being notified when facial detection default UI is presented and/or dismissed by setting each properties: MSViewPresented and MSViewDismissed (both being blocks).

v2.16.22 (August 26, 2020)

Fixes

  • Fix error allowing unattended process customization in swift.

v2.16.21 (August 25, 2020)

Enhancements

  • Allow customization for overlay layer in unattended process.

v2.16.20 (August 24, 2020)

Fixes

  • Fix error exporting SLVPassport document header. It was not being exporting properly.

v2.16.19 (August 21, 2020)

Enhancements

  • Add one side document literal for default document detection interface. Now, for those documents that just have on side, default interface will show this customizable string. The documents with just one side are those:

    • MobbScanDocumentType_ROUIDCard
    • MobbScanDocumentType_DEUIDCardV1
    • MobbScanDocumentType_SLVDrivingLicense
    • MobbScanDocumentType_PASSPORT_TD3
    • MobbScanDocumentType_NLDPassport
    • MobbScanDocumentType_SLVPassport

  • Scan both document sides at the same time in unattended process instead of each one separately.

v2.16.18 (August 19, 2020)

Enhancements

  • Allow customization for unattended video process. Now developers can customize unattended process interfaces.
  • Add camera sound on unattended process when a document side has been detected.
  • Add SLVPassport document

v2.16.17 (August 14, 2020)

Fixes

  • Fix crash with video liveness process.
  • Fix error with default document detection interface. There was a bug showing a wrong string for a second.
  • Fix error with liveness interface. Now this interface does not rotate and always keeps portrait orientation.
  • Show back button in unattended process interface. Now this button is shown in every device.

v2.16.16 (July 21, 2020)

Enhancements

  • Improve unattended process aspect. We have implemented a new interface for it.

Fixes

  • Now there are no cuts in unattended process between countdown and face detection.

v2.16.15 (July 15, 2020)

Enhancements

  • Add support for unattended video process with passport documents.
  • Add new object MSDetectionExtraResultData. This object inherits from MobbScanDetectionResultData and is used for get original image (without crop) in a detection process.
  • Add a new init method that uses a configuration object of class MSConfiguration. Now developers can configure MobbScan API using this method following a builder pattern.

v2.16.14 (July 10, 2020)

Fixes

  • Fixed error with urls ended in "/mobbscan" or "/mobbscan-agent" in unattended process. Now, developers can configure the MobbScan api using this kind for urls without problems.

v2.16.13 (July 7, 2020)

Enhancements

  • Improve facial detection: the face detector now checks ambient light to avoid capturing poorly illuminated faces.

Fixes

  • Fixed an error on the face detection default interface, where the interface was not being dismissed properly if it was being loaded from a presented view controller.

  • Fixed an error with the unattended video onboarding process, where the process was not properly lauched if it was loaded from a presented view controller.

v2.16.12 (June 29, 2020)

Fixes

  • Fixed an error with the document detection default interface, where the interface was not being dismissed properly if it was being loaded from a presented view controller.

v2.16.11 (June 26, 2020)

Fixes

  • Fixed facial validation preview setup when device is flat orientated.

v2.16.10 (June 22, 2020)

Fixes

  • Fixed a thread issue that was causing face validation (smile mode) not being started properly.

v2.16.9 (June 19, 2020)

Enhancements

  • Add new fields to SLVIDCardV1document:

    • cityOfIssuance
    • stateOfIssuance

  • Add new document SLVIDCardNIT

Fixes

  • Fix MobbId Antispoofing error propagation. If the facial validation process fails due to no liveness being detected, the API method finishes providing an error that lets developers know the reason (error code MobbScanAPIErrorCode_ANTISPOOFING_ERROR).

v2.16.8 (June 15, 2020)

Fixes

  • Fix image normalization before send to server to be scanned. Portrait images were not being normalized.

v2.16.7 (June 12, 2020)

Fixes

  • Fix error for online MRZ scanning. The images of the scan were not being sent to server after the scan was finished.

Enhancements

  • The method scanMRZForOperation:forScanId:withDetectionResult:andScanResult: has been deprecated, and developers should use this one instead: scanMRZForOperation:forScanId:.

v2.16.6 (June 10, 2020)

Fixes

  • Fix error with mirrored images for face detection. Now, the face detection process returns images that are not mirrored. This increases the score when face matching is performed.

v2.16.5 (June 4, 2020)

Enhancements

  • Add a new method for configuring PDF417 scanning with a timeout, with no result block. Now developers can use this method to configure PDF417 scanning and specify a timeout.

v2.16.4 (June 3, 2020)

Enhancements

  • Creates a default interface for PDF417 scanning. Developers can now use this interface to scan PDF417 barcode for those documents that have one, without creating their own.

v2.16.3 (May 28, 2020)

New features

  • Add new parameters to SLVIDCArdV1 document. These parameters are:
    • knownBy
    • maritalStatus
    • dateOfIssuing
    • cityOfBirth
    • stateOfBirth
    • profession

v2.16.2 (May 25, 2020)

Enhancements

  • Create new method imageForScanId:type:success:failure: in order to fetch images from server. Old method imageForScanId:type: has been deprecated

v2.16.1 (May 21, 2020)

Fixes

  • Fix a bug that made the Passport detection with default view take too long.

v2.16.0 (May 14, 2020)

Enhancements

  • Use xcframework instead of regular framework as distribution system. If developers are using an older version, they can check the migration guide.

New features

  • Add new identity verification process.

v2.15.18 (May 7, 2020)

Enhancements

  • Track the "cancel button tapped" event on the NFC reading process. Now, developers can track every time the user taps on the cancel button while the NFC chip is being read.

v2.15.17 (May 5, 2020)

Fixes

  • Fix MEXIDCard validations paring. Now every MEXIDCard validation is returned properly.

v2.15.16 (April 30, 2020)

Fixes

  • Fix NFC bitcode support. Now developers can generate applications with enabling bitcode
  • Fix NFC reading events. Now every NFC event is thrown properly
  • Fix NFC error tracking. Now developers can properly track any error during NFC reading process

v2.15.15 (April 24, 2020)

New features

  • Add method getClientVersion so integrators can have SDK version information.

Enhancements

  • Add validationBothSidesMatchScore and validationPersonalNumberBothSidesMatch to GTMIDCard.

Fixes

  • Fix default MRZ scanning process. This process was not returing data properly.

v2.15.14 (April 22, 2020)

Enhancements

  • Add parent field for ESPIDCardV3 NFC chips

Fixes

  • Fix error with some NFC chips. Now, when a chip does not contains a datagroup, the process does not stop.
  • Fix i18n in NFC process

v2.15.13 (April 13, 2020)

Fixes

  • Fix error during passport detection when integrator selects the "FORCE_CROPPED_DOCUMENT" option

v2.15.12 (April 9, 2020)

New features

  • Create new detection method, using scanMRZ operation so integrator can decide if passport detection will go back-end or not.

Enhancements

  • Normalize document image before send to scan, in order to send lighter images
  • Set facial detection interface like the one in the Android SDK

Fixes

  • Fix passport cropping before returning to integrator

v2.15.11 (April 6, 2020)

Enhancements

  • Lowers the position of the "cancel" button in the default detection view for iPhone X models

Fixes

  • Fix error when user sets a url that ends with "/mobbscan" or "/mobbscan-agent". Now the SDK sets the url properly.

v2.15.10 (March 25, 2020)

Enhancements

  • Allow customization for texts in NFC process

Fixes

  • Fix native error returning document number in Spanish documents.

v2.15.9 (March 24, 2020)

Fixes

  • Fix a crash that could happen when the native detector method tried to detect certain images
  • Fix falsePositive behaviour with flipped documents

v2.15.8 (March 17, 2020)

Fixes

  • Adding the validationBothSidesMatchScore validation only for ESPIDCard documents to improve the parsing of the JSON

v2.15.7 (March 12, 2020)

Fixes

  • Fix some errors with license verification process

v2.15.6 (March 2, 2020)

Fixes

  • Fix error sending data to server on an online MRZ scanning process

v2.15.5 (February 20, 2020)

Enhancements

  • Allow developers to do an offline detection without including offline frameworks. The SDK will fail and ask for them if developers try to perform an offline scan without them.

v2.15.4 (February 13, 2020)

Fixes

  • Fixed an error with facial validation in iPhone 6.

v2.15.3 (February 7, 2020)

Fixes

  • Fix problem with the liveness detection. Now the liveness detection process uses a new method to get the focus level of captured images.

v2.15.2 (February 5, 2020)

Fixes

  • Agent is now notified when the user cancels a videoconference only if they cancel it before the agent accepts the call.

v2.15.1 (January 31, 2020)

Fixes

  • Fix an error for unattended video

v2.15.0 (January 27, 2020)

Feature

  • Add listener to inform developers of the channel quality during a videoconference

Enhancements

  • Agent is notified when a user cancels a videoconference

v2.14.0 (December 22, 2019)

Feature

  • Added the NFC chip reading feature. MobbScan now includes a plugin (MobbScan_NFC_Plugin) that enables the reading of NFC chips on Passports and Spanish ID cards.

Enhancements

  • Add validationLaserMark validation for ESPIDCard documents
  • Add ITAIDCardV1 document
  • Allow face detection view customization. Developers can now create their own detection view and set it to the MobbScan API so that it can trigger the detection face method and use it instead of the default MobbScan interface.

v2.13.4 (October 18, 2019)

Fixes

  • Return properly detected face images on default facial validation process. Images were returned mirrored provoking some issues.

Enhancements

  • Add visual feedback mechanimsms on default passport detection view. Now the interface showes scanned MRZ data once the SDK gets it and the interface box changes its color when detection is nearly ended.

v2.13.3 (October 11, 2019)

Fixes

  • Fix problems on default passport detection view when developers don't allow all orientations on their projects. Now interface can be launch on all orientations without need the developers allow them.

v2.13.2 (October 2, 2019)

Enhancements

  • Improve passport detection process when developer uses default detection view.

v2.13.1 (October 1, 2019)

Fixes

  • Fix problem scanning EURDrivingLicense document when developer selects ESP document in process.

v2.13.0 (September 30, 2019)

New features

  • Added new mechanism for false positive rejection in ID detection activity. Integrators can activate this mode by setting up setFalsePositiveRejection method. Once enabled, ID detections that do not meet some constraints (headshot or MRZ location for instance) are rejected, preventing unsupported ID processing.

  • Added 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)

  • ESP document type has been added. This document 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.

Enhancements

  • Updates OpenCV version to 3.4.6, achieving a general performance improvement in native operations.

v2.12.0 (May 24, 2019)

Fixes

  • Fix detection document process while a document is being detected. Now the camera flow doesn't stop and keep going if the image is not focused, but it just notify the developer by the usual feedback block with message MobbScanDetectionFeedbackResult_NOT_DETECTED if the frame is too blurry.

New features

  • Create external framework "MobbScan_UnattendedPlugin_iOS" containing the needfull methods for developers to create their own onboarding process with MobbScan functionalities and store the recorded video on back-end server.

  • Add new field "drivingLicenseValidity" to EURDrivingLicense document in order to return de information of the validity of every driving license that are reflected on the document.

Enhancements

  • Allow sending to back-end the extracted data from a MRZ scanning process. Now developers can send to the back-end server the result from an IDDocumentMRZ document scanning process just setting the SDK to ONLINE mode.

  • Add "placeOfBirth" field to IDDocument object. This field will be extracted after an MRZ scan when developer set Api mode in ONLINE mode.

  • Update devices list for clientVersion information.

  • Add a list of validation to ScanOperationMRZ object. Now developers can indicates the API what validations must be checked on the document before exit the MRZ scan process.

  • Extract field "place of birth" from NLD Passport after a MRZ online scanning process.

v2.11.1 (January 29, 2019)

New features

  • Add method "addExtraParameter" in order to add extra data to a validation stores in mobbscan-agent portal

Enhancements

  • Allow configure SDK base url with mobbscan-agent url

Fixes

  • Parse properly both-side validations from server

v2.11.0 (January 16, 2019)

New features

  • Includes support for European driving licenses (EURDrivingLicense)
  • Unattended video recording feature. Document and face detection steps can be called consecutively and in the same flow. The overall process can be recorded in a video file.

Enhancements

  • Updates Twilio framework to last stable version (v2.5.3).

Fixes

  • Remove unnecessary script from MobbCommons framework avoiding distribution error.

v2.10.0 (August 29, 2018)

New features

  • Allows portrait document scanning.
  • Customized PDF417 detection feedback block. PDF417 detection status is received in the same way as regular document detection.
  • Customized MRZ scanning UI. An overlay can be defined by stablishing spatial coordinates.

Enhancements

  • Detection status feedback messages.

v2.9.1 (July 16, 2018)

Fixes

  • PDF417 scanning in online mode.

v2.9.0 (July 6, 2018)

New features

  • New documents: El Salvador residence permit, Guatemala ID card and lite version for Mexican IDs.
  • PDF417 scanning support for El Salvador ID (SLVIDCardV1), Peru ID (PERIDCardV1) and Colombia ID (COLIDCardV3).
  • Integration with MobbID facial verification.
  • Integration with MobbID liveness detection (anti-spoofing).

Enhancements

  • MRZ detection performance.

Fixes

  • Autofocus and blurriness bugs.
← Customize Unattended ProcessAPI Reference →