Document Reader SDK 5.7

Document Reader SDK version 5.7 is available for immediate download and can be obtained from the links below:

It is also available for download using our Regula Downloads Manager tool.

Please review the release notes and change list since 5.6 prior to installing this release:

  • OCR
    • Significantly improved recognition quality for Arabic, Western European, Chinese and Japanese.
    • Implemented correct reading for Arabic and Persian numbers (correct Unicode symbols in output values).
    • Improved reading of perforated document numbers in different countries (new fonts supported).
    • Fixed issue with not returning required fields on timeout. Now they are returned anyway, with empty values if the fields were not read.
  • MRZ
    • Updated parsers:
      • Belarus passport,
      • Comoros ID card,
      • Dominican Republic ID card,
      • Jordan ID card,
      • Russian visa,
      • Serbian ID card,
      • Switzerland DL,
      • Thailand passport.
    • Barcode
      • Added new parsers:
        • Belgium ID card,
        • Costa Rica Child ID card,
        • ECOWAS Id card,
        • India AADHAAR ID card,
        • Viet Nam ID card.
      • Improved processing time for 1D, 2D codes.
      • Fixed issue with CODE128 wrong treated checksums in rare cases.
    • Text data parsing and validation
      • Added parsing and conversion of the Japanese calendar dates into Gregorian and creation of additional fields of the same type as original with LCID equal to 0.
      • Added parsing and conversion of the Islamic calendar dates into Gregorian and creation of additional fields of the same type as original with LCID equal to 0.
      • Added capability to shift the expiry date when calculating the document expiration status. Set the “processParam.shiftExpiryDate” parameter for shifting the date of expiry into the future or past for the number of months specified. This is useful, for example, in some cases when the document might be still valid for some period after the original expiration date to prevent negative validity status for such documents. Shifting the date to the past will set negative validity for the documents that are about to expire in the specified number of months.
      • Added transliteration from Arabic letters to Latin according to ICAO and creation of additional fields of the same type as original with LCID equal to 0.
      • Added transliteration from Arabic and Persian numbers to ASCII numbers and creation of additional fields of the same type as original with LCID equal to 0.
      • Added parsing of data from DG11 in eDL of the Netherlands and extraction of the BSN number as a separate field.
      • Fixed issue with Vietnamese character uppercase conversion and further validation.
    • Image QA
      • Fixed issue with glare detection on the whole portrait area instead of the face area.
    • Authenticity
      • Fixed issue with element coordinates in output for image patterns check.
      • Fixed issue with UV dull paper check parameters for different documents in one series.
      • Fixed issue with hologram detection in some documents.
    • Added capability to guarantee that output image will contain correct MRZ on it in series process mode (on mobile, for example). Set the “processParam.forceReadMrzBeforeLocate” Boolean flag to True to enable this logic. False by default.
    • Added capability to provide in “processParam” JSON parameters “config” object, that may contain specific settings on a per-document basis. Currently, it is possible to disable some of the authenticity checks for the listed document IDs.
    • Added a new eVisualFieldType enum member:
      • ft_Alt_Date_Of_Expiry.
    • Fixed issue with the processing of some PDF files that led to incorrect results.
    • Fixed issue with incorrect DPI detection in some rare cases.
    • Fixed issue with the expectance of additional pages for two-sided documents when both sides are already scanned.
    • Fixed issue with non-zero page index for one-page document results.
    • Fixed issue with random page indexes on multiple pages processing.
    • Fixed issue with no logs present in response when enabled in request (introduced in 5.6).
    • Fixed issue with rare crashes when processing specific images (very small images).
    • Code quality improved with lots of small issues fixed.
    • Documentation updated.


  • Implemented sending of IS certificate as part of the TA_Signature request.
  • Improved the algorithm of building certificate chains for the TA process, where multiple certificates from different chains are stored in one folder.
  • Fixed issue with TCC communication that led to exception on connection.

Desktop API

  • Fixed issue with the date format in BSI TR-03135 transaction log generation.

Hardware support

  • Fixed issue with some documents not detected in video detection mode on 5MP cameras.
  • Fixed issue with Regula devices enumeration on Linux.

Mobile API

  • Added restart of the process on the camera switch during the scanning process.
  • Added restart of the process on the camera orientation change during the scanning process. The orientation cannot be changed after the processing of at least one page is completed.
  • Added the ability to receive events about the connection to the RFID chip and errors in the process of reading the chip.
  • iOS
    • Implemented delivery of SDK in “.xcframework”
    • Added the RGLCameraViewControllerActionProcessWhiteFlashLight event notifying that the flash was turned on forcibly.
    • All @import native libraries have been replaced with #import.
  • Android
    • Added the ability to provide the database as a binary file during SDK initialization.
    • Fixed a crash on devices that do not have Google Play Services.
    • Removed android.permission.INTERNET from framework manifest. Now, if necessary, this permission should be set at the application level.

WebService API

  • Demo site
    • Added capability to download result images with a proper name and extension by left-clicking the mouse on them.
    • Added compressed log handling.
    • Added CSP headers.
    • Image quality requirements are now opened in a new tab.
    • Page content has been changed a bit.
    • Fixed auto scroll behavior for the output section on mobile devices.
    • Fixed incorrect “alreadyCropped” parameter processing on sample image request after the request.json drag-n-drop request.
    • Fixed incorrect .json formatting in .zip archive with Cyrillic symbols in the document.
    • Fixed document type/name fields for the CreditCard scenario.
    • Fixed scenario changing behavior when loading request.json with a different scenario.
    • Fixed issue when an image provided by URL was not processed after changing the scenario.
    • Fixed incorrect order of result columns.
    • Fixed visibility of cross-check validation statuses.
    • Fixed partial response in the request.json file.
    • OcrFree and RusStamp scenarios removed from the list of scenarios.
  • Fixed issue with the wrong format of transaction UUID for old-style API calls.
  • Open API specification updated on GitHub.
  • Clients and packages updated.

Installation packages

  • Windows Desktop API
    • New driver package version 1.8.16 with the Regula camera driver version included.


  • Fixed issue with the license for bank card reading functionality only.


  • ICAO PKD master list version 178 included in the RFID SDK component.


  • Fixed issues in multiple document templates for better quality results.
  • 248 countries and territories / 9647 documents included.
  • 215 new documents added.
  • For details, see Supported documents list.
Was this article helpful?
0 out of 0 found this helpful



Article is closed for comments.

Articles in this section

See more