Skip to content

Document Reader SDK 7.6 — March 28, 2025

IMPORTANT changes

  • Significant memory usage optimization and stability improvements in Core SDK.
  • Implemented new security check for Dynaprint® dynamic security elements. Together with other dynamic element checks, such as OVI, holograms, MLI, it extends the capabilities for the Document Liveness verification.
  • From this version, we have raised the C++ dialect support to C++17. This means we will not support older compilers and older Linux versions that do not support C++17. From now on, changed the minimal supported OS versions:
    • Debian 11
    • Ubuntu 20.04
    • RHEL 9
    • macOS 11
    • iOS 13

Info

To properly upgrade to version 7.6, follow the Migration Guide.

Core SDK

Document Detection and Crop

Fixed issue with different processing results when reprocessing on the backend the package collected on mobile than results got on mobile itself.

OCR

Updated default value for processParam.disablePerforationOCR property to true for the Mobile and Web platforms. If reading of perforated fields is required, you have to manually set the value to false.

MRZ

  • Updated parsers:

    • Cote d'Ivoire Residence Permit
    • France DL
    • Guinea ID Card
    • Saint Vincent and the Grenadines ID Card
    • Slovakia ePassport
    • Tajikistan ePassport

  • Updated MRZ validation for some non-standard documents.

Barcode

  • Added new parsers:

    • Canada DL
    • Libya Visa
    • Mexico DL
    • Taiwan eVisa
    • Vietnam ID Card and eVisas

  • Updated parsers:

    • IATA Boarding passes
    • Canada ID Card
    • Chile ID Card
    • Moldova ID Card
    • Philippines ID Card
    • Saudi Arabia DL, ID and Resident Card

  • Added digital signature check for Philippines ID Card. See more details in our blog post.

  • Fixed issue with checking the image focus when reading barcodes even if the processParam.disableFocusingCheck property was enabled.
  • Fixed issue with transliteration of the letter Ä‚ for the Moldova ID Card.
  • Fixed issue with reading PDF417 barcodes with large number of cells (> 930).

Text Data Parsing and Validation

  • Added transliteration from Korean to Latin. Currently enabled for name fields only.
  • Added ft_Nationality_Code field generation based on the ft_Nationality field.
  • Added processParam.strictDLCategoryExpiry property that forces DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than the category expiry date, this might be handy for specific cases.
  • Added splitting Full Name into separate ft_Surname and ft_Given_names fields based on data in other sources.
  • Updated validation logic for the ft_Voter_Key field for Mexico Voter Cards.
  • Updated validation logic for the ft_Weight field for the USA DL when multiple values in different formats are present in the barcode.
  • Expanded the list of special characters that indicate how to separate surnames and given names.
  • Fixed issue with ft_Date_of_Expiry field validity for documents that might have no expiry date.
  • Fixed issue with transliteration of Chinese to Latin.
  • Fixed issue with validation of multiple legitimate variants of field mask in barcode data.
  • Fixed issue that might occur when processing some Indian documents and lead to exception.

Authenticity

  • Implemented new security check for Dynaprint® dynamic security elements. Together with other dynamic element checks, such as OVI, holograms, MLI, it extends the capabilities for Document Liveness verification.
  • Added the checkSecurityText property to the authenticity params (processParam.authParams.checkOcrSecurityText) to have the possibility to enable or disable the Security Text check.
  • Added the checkBlackAndWhiteCopy property to the liveness params (processParam.authParams.livenessParams.checkBlackAndWhiteCopy) to have the possibility to enable or disable the Black and White copy check.
  • Implemented possibility to reprocess the package with images that contain different lights, such as UV and IR, that can be taken using the devices Regula 7310 and 1120.
  • Updated the neural network (NN) for electronic device replay checks with greater accuracy.
  • Updated priorities of params: if both processAuth and authParams are used, then authParams will be effective, overriding the processAuth.
  • Fixed issue with calculating the Document Liveness status when processing multiple pages.
  • Fixed issue with reprocessing the Document Liveness check on the backend for multiple pages in one package.
  • Fixed issue with LetterScreen++ check for the USA passport.
  • Fixed issue with hologram coordinates in Document Liveness results.
  • Fixed issue with the wrong document format for laminated documents that resulted in incorrect Document Liveness results.
  • Fixed issue with checkBarcodeFormat that was always active regardless of the setting (processParam.authParams.checkBarcodeFormat).
  • Fixed issue with returning Area with empty coordinates for authenticity check results. Now if there are no coordinates available, this field will not be returned in results.
  • Fixed issue with the number of pages in the authenticity results after skipping—if only one page was processed, the second one could appear by accident.
  • Fixed issue with Document Liveness data that was present after capture on the Mobile, but missed after reprocessing on the backend.
  • Fixed an issue with checking glares during the hologram detection process that led to incorrect image quality results.
  • Fixed issue with the overall status when the Document Liveness check was not enabled and not available.
  • Fixed issue with removing second page scanning results, when instead of scanning second page on request, still the same first page was presented again. Now all results will remain available in the response.

Image QA

Fixed issue with incorrect glares status in the image quality results when the Document Liveness check was enabled.

Enums

  • Added new eBarCodeResultCodes enum member:

    • bcrc_InvalidResult

  • Added new eCheckDiagnose enum member:

    • chd_DocLiveness_DocumentNotLive

  • Added new eRPRM_SecurityFeatureType enum member:

    • SecurityFeatureType_Liveness_Dynaprint

  • Added new eVisualFieldType enum members:

    • ft_Short_Flight_Number
    • ft_Airline_Code

Other

  • Significant memory usage optimization and stability improvements in Core SDK. Reduced excessive memory allocations that led to memory fragmentation, that might be considered as a memory leak when working for long periods of time with many processings.
  • Added support for the flatten PDF processing.
  • Improved logic of portrait comparison for children. Previously, in the case of a child document, portrait comparison was not performed at all. Now it will, and if portraits match, then the positive result is returned regardless of the age threshold. If portraits do not match, the age threshold is analyzed: if the age exceeds the child threshold, the negative result is returned, otherwise wasNotDone is returned.
  • Implemented the new approach to document detection and cropping via neural networks for 3rd party devices.
  • Fixed issue with depersonalization in case when the document in the request was turned upside down.
  • Fixed issue with bounds image quality check that could occur in the multipage processing.
  • Fixed issue that XML results were not available for RFID in case the processParam.xmlResults was enabled in the request.
  • Fixed issue with some files not accessible in db.dat
  • Fixed issue with the backend reprocessing of data packages from Regula 7310/1120 devices.
  • Fixed issue with calculating the Document Type status in the multipage processing when working with the device Regula 1120.
  • Fixed out of memory issue when reprocessing a package.
  • Code quality was improved with lots of small issues fixed.

Core RFID SDK

  • Added capability to download CRLs (Certificate Revocation Lists) in runtime based on DS certificate extension id-ce-cRLDistributionPoint of the document.
  • Fixed issue of saving DTC data for non-RFID documents from the previous scan of RFID-enabled documents.
  • Fixed issue with a different result of PA_Status for EF.SOD file that was implemented in the version 7.5. Now the previous logic is restored.

Enums

  • Added new eRFID_BaudRate enum members:
    • rfbr_1695
    • rfbr_3390
    • rfbr_6780

Desktop API

  • Added possibility to disable using of mrzproc.dll via enabling the processParameters.noMrzProc parameter setting.
  • Fixed issue with document ejection command effective for the active reader only if several readers are connected at the same time.

Mobile API

  • Added Armenian and Kyrgyz localization support.
  • Minor changes in the RFID animation—now it will be slightly larger.
  • The status field, which is at the level of the authenticity results by the page, is deprecated. Use the overall status of the authenticity results instead.
  • Added possibility to enable/disable loading CRLs in runtime based on document DS certificate.
  • Added the checkSecurityText property to the authenticity params.
  • Added the checkBlackAndWhiteCopy property to the liveness params.
  • Added the checkDynaprint property to the liveness params.
  • The perspectiveAngle property is deprecated, use the expectedPass by passing the angleThreshold instead.
  • Added possibility to set the state of the flashlight before starting the document processing.
  • Added possibility to change the camera frame offset width for landscape orientation.
  • Field sessionLogFolder in the ProcessParam class is now deprecated. Use the DocumentReaderResults.transactionInfo.sessionLogFolder in the processing results instead.
  • The progress indicator is now automatically centered based on the camera frame position.
  • Updated the DTC data groups enumeration.
  • Updated sample projects on GitHub.
  • Fixed the default camera selection on some devices.

Android

  • Added a "vibrate" permission that can be added to apps if you want Regula 7310 devices to start vibrating when the RFID chip processing initiates.
  • Fixed the order of log folders where they are saved, which led to the issue of incorrect return path via the processParams.sessionLogFolder property.
  • Fixed issue when deinitialization was called when SDK was processing a document.
  • Fixed issue with deleting a database that could not be removed if it was partially downloaded.
  • Improved autofocus during the document processing.
  • Improved general stability.

iOS

  • Minimum deployment target version changed from 12.0 to 13.0
  • Server-Side Verification is now supported for apps that use the childViewController UI presentation.
  • Fixed the issue with processing images in PNG format for extPortrait and livePortrait properties.
  • Fixed the issue with camera frame orientation when the orientation was limited but the user used an orientation that was not in the list.
  • Improved general stability.

Hybrid

  • Added HTTP Request Interception for the Online Processing feature.
  • Fixed the issue where the class RNRegulaDocumentReaderModule was not marked as abstract and did not implement an abstract method in React Native.
  • Fixed the issue with acquiring Bluetooth permissions for Android in React Native and Cordova when using the devices Regula 7310 and 1120.

COM API

  • Added new property RFIDLoadCRLFromRemote for enabling/disabling CRLs download in runtime based on document DS certificate (read/write, boolean). Disabled by default.

Web Component

  • Added possibility to adjust the delay before the start and after the end of the multipage animation.
  • Added possibility to limit the maximum file size for upload using the maxImageSize property.
  • Added possibility to limit the maximum file resolution for upload using the maxResolutionSize property.
  • Added Armenian and Kyrgyz localization support.
  • Changed behavior of statusPositionMultiplier property—now the status position is adjusted within the camera view, rather than within the camera frame.
  • Added new properties:
    • strictImageQuality
    • doDetectCan
    • generateDoublePageSpreadImage
    • mrzDetectMode
    • strictBarcodeDigitalSignatureCheck
    • selectLongestNames
  • Fixed issue with infinite backend reprocessing on timeout—processing now completes if the finalizeOnTimeout property is enabled or the finalize method is called.
  • Fixed issue with switching cameras in the Camera Snapshot component.
  • Fixed issue with Capture button in RTL languages.
  • Fixed issue with location changing in the iframe mode.

UI Components

  • Added the demo project on GitHub showing the usage of the ui-components package with Angular.
  • Automatic switching of document images when expanding results by page in Security checks, Image Quality, Document Type tabs.
  • Automatic scrolling to the bottom of the table when it is expanded.
  • Perforated text created by puncturing the document blank now displays in the text results table, if present.
  • Added display of text field data group if there are more than 2 groups of the same field in the RFID chip.

Web Service API

  • Fixed issue with /api/healthz and /api/readyz endpoints responding too long if processing is in progress or licensing service connection is causing a timeout because of network issues. Now they respond immediately.
  • Automatic cleanup for Complete Server-Side Verification data. Find detailed information in the Cleaning Up Data documentation article.
  • Fixed the issue with database migrations. The issue reproduced with MariaDB, MS SQL, Oracle and was related to using the instance_id column without a key length.
  • Fixed the issue with deleting transaction data by tag from storage when using the File System type.
  • Temp folders which are created after SDK update will be deleted.
  • Added possibility to keep application settings and don't reset when updating the SDK on Windows.

  • Updated package dependencies to the latest version to fix security breaches.

  • Clients:

    • Added the doBarcodes property that allows you to limit the types of barcodes to process.
    • Updated the authenticity result data structures for C# client.
    • Added the livenessChecks method for getting Document Liveness results for JS client.

  • Demo Website:

    • Added settings that were added to the SDK.
    • Added scenarios, that are not licensed, but exist in the SDK.
    • The list of available scenarios for the Web Component is now generated dynamically, depending on the license capabilities.

Licensing

Added mechanism for preventing flooding of the licensing service with requests from many devices simultaneously. This might happen in case of the improper SDK integration in mobile applications which have a large user base.

Installation Packages

New driver version 10.5.10.23 included in Regula Reader Drivers package 1.8.28

PKD

ICAO PKD master list version 307 included.

Database

  • Updated multiple document templates to include OVI, MLI, Contact chip, Holograms, Extended MRZ, Extended OCR, Photo embedding type, Patterns checks where appropriate.
  • Includes 251 countries and territories, 15117 documents.
  • Added 432 new documents.

For details, see the Supported documents list.