Skip to content

Document Reader SDK 8.1 — June 18, 2025

Warning

This is the major release update, containing significant changes in all modules and components. The backward compatibility is not guaranteed. To transfer your existing Document Reader SDK configuration from the previous version and keep the system performing, follow the Migration Guide for the corresponding software component.

IMPORTANT changes

  • Introduced the redesigned camera UI in the Mobile SDK to improve user experience. The previous UI remains available; however, all future features will only be supported in the new camera UI. For details, see the Customize User Interface pages.
  • Added a new Core type—RFID— for reading only RFID chips without optical processing. For details, see the Mobile RFID Chip Processing page.
  • Added capability to initiate RFID chip processing with just the required MRZ fields—such as document number, date of birth, and date of expiry—instead of the entire MRZ string. This allows starting chip reading without scanning of MRZ in case this information is already available before the reading. Might be useful for authentication with electronic documents that the user should possess. For details, see the RFID Chip Processing Configuration page.
  • Added capability to initiate RFID chip processing with the SHA-1 hash of MRZ information. For details, see the RFID Chip Processing Configuration page.
  • Added Geometry check to Document Liveness that detects changes of document perspective in a capture process. For details, see the Web Service and Mobile SDK configuration parameters.
  • Updated multiple neural networks for authenticity checks.

Core SDK

OCR

  • Updated and added new fonts for perforated field reading in multiple countries.

MRZ

  • Updated parsers:
    • Albania Residence Permit
    • Bahrain ID Card
    • Brazil ID Card
    • Costa Rica Passport
    • Iceland Residence Permit
    • Moldova ID Card
    • PAM Laissez Passer
  • Fixed issue with incorrect validity status being returned for MRZ lines with a missing final check digit.

Barcode

  • Added new parsers:
    • Azerbaijan DL
    • Burkina Faso Consular ID Card
    • Colombia Armed Forces ID Card
    • Colombia Police Card
    • Georgia Seaman's Identity Document
    • Guinea Consular ID Card
    • Guinea Voter Card
    • Honduras Consular ID Card
    • India ID Card
    • India Registration Certificates
    • Kosovo DL
    • Lesotho ID Card
    • Madagascar Registration Certificate
    • Mexico Guerrero DL
    • Mexico Visa
    • Namibia Voter Card
    • Pakistan DL
    • Saint Vincent and the Grenadines ID Card
    • Viet Nam eVisa
    • Western Sahara ID Card
  • Updated parsers:
    • Argentina ID Card
    • Cameroon ID Card
    • Chile ID Card
    • Colombia Residence Permit
    • Ghana Visa
    • India PVC ID Card
    • Mexico DL
    • Mozambique DL
    • Myanmar D
    • Philippines Digital ID Card
    • Russia ID Card
    • USA DL
  • Added digital signature check for Philippines Digital ID Card. See more details in our blog post.
  • Fixed issue with decoding PDF417 barcodes with the 8th level of error correction.
  • Fixed issue with stability of Code 128 barcode recognition.

Text data parsing and validation

  • Added transliteration to Latin of field values in Japanese.
  • Added validation rules for the document discriminator text field for USA documents.
  • Added capability to generate Alpha-2 codes for nationality and issuing state fields (processParam.generateAlpha2Codes).
  • Added logic for SPECIMEN detection for cases when the document type is unknown.
  • Extended logic for SPECIMEN detection.
  • Fixed issue with splitting DL categories into separate text fields that do not contain notes.
  • Fixed issue where the processParam.selectLongestNames property did not prioritize hyphen-containing values as the longest during selection.
  • Fixed transliteration issue for the Issuing authority text field.
  • Fixed validation issue for the Date of insurance expiry text field.
  • Fixed issue with validity for generated text field. Now the validity will be the same as for the original text field.
  • Fixed issue with Date of expiry and Date of issue mapping for non-ICAO Mexico Resident Permits where Date of issue can be presented in Date of expiry position.
  • Fixed issue with comparison between numeric values in barcodes and text values in the visual zone for the same fields in all scenarios.
  • Fixed issue with comparison between RFID and Visual zone data for DG1 fields was not strict.
  • Fixed issue with incorrectly parsing dates in MM/YY format in DL categories.
  • Fixed issue with incorrect date comparison for learners permits, the day of expiry is not the same as the day of birth.
  • Updated parsing of DG11/DG12 field values into correct field types and LCID for documents from multiple countries.

Authenticity

  • Added Geometry check to Document Liveness that detects changes of document perspective by analyzing document edges in the capture process (processParam.authParams.livenessParams.checkGeometry).
  • Updated the neural network (NN) for electronic device replay checks with greater accuracy.
  • Updated the neural network (NN) for portrait replacement checks with greater accuracy.
  • Updated the neural network (NN) for black and white copy check with greater accuracy.
  • Updated the neural network (NN) for document occlusion check with greater accuracy.
  • Updated the neural network (NN) for hologram detection check with greater accuracy.
  • Fixed issue with a hologram detection result that might be positive when processing finished by timeout.
  • Fixed issue with missing Security text results when working in the process series.
  • Fixed issue with missing MLI authenticity results after the server-side reprocessing.

Image QA

  • Refactored code to minimize memory usage.

Enums

Other

  • Added the new scenario — RFID, allowing only RFID chip data to be processed, with no images in the request.
  • Added capability to reprocess a package on the Web Service with greater flexibility: if RFID chip processing was completed on the mobile device and the package includes RFID data, reprocessing on the Web Service can now be performed with or without reprocessing the RFID data. Use the processParam.reprocessRfidSession setting when reprocessing the package on the Web Service. Enabled by default.
  • Added capability to limit the number of pages to be processed from a PDF file—use the processParam.pdfPagesLimit setting.
  • Added the memory limit for logs of 128 MB to reduce the memory consumption.
  • Changed the new line symbol for text data: from ^ to \n in JSON results.
  • Fixed issue with paIgnoreNotificationCodes not working when passed via config.yaml file.
  • Memory usage optimization.

Core RFID SDK

  • Added capability to initiate RFID chip processing with just the required MRZ fields—such as document number, date of birth, and date of expiry—instead of the entire MRZ string.
  • Added capability to initiate RFID chip processing with the SHA-1 hash of MRZ information.
  • Added the FacialBDBList field to the processing results to store biometric facial graphic data for multiple records.
  • Fixed issue where the reading speed was not changed when a document was on the device.
  • Fixed issue with the certificate issuer and subject country codes comparison that affected the PA status if their case was different.

Enums

  • Added new eLDS_ParsingNotificationCodes enum members:
    • ntfLDS_ICAO_Certificate_Issuer_CountryNonUpperCase
    • ntfLDS_ICAO_Certificate_Subject_CountryNonUpperCase

Desktop API

  • Added capability to pass nationality and issuing state Alpha-2 codes to Opera PMS when working with Local Service SDK. To do that, enable the processParam.generateAlpha2Codes property in CustomConfig.
  • Fixed issue with returning value of _CheckResult()—if the requested data exists, returns a pointer to the container with data of the requested type, otherwise NULL value.

Hardware Support

  • Updated integration of RealPass SDK to version 3.2.2.357 to work with Xperix devices.
  • Changed default behavior for threadMode: it will now be disabled by default.
  • Fixed issue with 7028М-13 device calibration.

Mobile API

  • Introduced the new camera UI in the Mobile SDK to improve user experience. The previous UI remains available; however, future features will only be supported in the new camera UI.
  • Deprecated the showScanner() method in DocumentReader. It can still be used to launch scanning with the old UI. Use startScanner() to launch scanning with the new UI.
  • Deprecated the setShowChangeFrameButton() property.
  • The following properties are deprecated and unused in the new camera UI: resultStatus, showResultStatusMessages, resultStatusTextFont, resultStatusTextColor, resultStatusBackgroundColor, resultStatusPositionMultiplier, showChangeFrameButton.
  • Added the ability to initiate RFID chip processing using only required MRZ fields—document number, date of birth, and date of expiry—rather than the entire MRZ string.
  • Added the ability to initiate RFID chip processing with the SHA-1 hash of MRZ data.
  • Introduced a new Core type: RFID, for RFID chip-only processing.
  • Added a new scenario: RFID, for processing RFID data only (no image input required).
  • Added customization options for the activity indicator’s position via activityIndicatorPortraitPositionMultiplier and activityIndicatorLandscapePositionMultiplier.
  • Added customization options for the Skip button in multipage processing, including text, font, text size, and color.
  • The readingBuffer property now accepts values from the RFIDReadingBufferSize enum instead of arbitrary integers.
  • Changed the newline character in result text data from ^ to \n.
  • Updated RFID error codes handling to restart the RFID chip processing.

Android

  • Fixed toolbar button visibility issues on devices with rounded corners.
  • Fixed camera frame centering after switching cameras.

iOS

  • Deprecated the prepareCameraViewController() method in RGLDocReader. You can still use it to get the view controller with the old UI. Use prepareCameraViewControllerForStart() for the new UI.
  • Added ability to configure processParams, functionality, and customization via JSON.
  • Changed the default value of backgroundMaskAlpha in RGLCustomization to 1.0.
  • Updated the cameraViewController property type in RGLFunctionality from RGLDocumentReaderCameraViewController to RGLDocumentReaderBaseCameraViewController.
  • Fixed issue with the RFID animation size in landscape mode.
  • Fixed issue with DTC DG17 value parsing.
  • Fixed issue of an incorrect RFID animation image.

Hybrid

  • Flutter: Fixed compatibility issue with JDK 11.
  • Flutter: Fixed issue with requirement for having the Bluetooth permission for iOS.

COM API

  • Added RFIDAfterOptical property (boolean, read/write) to enable RFID chip processing after optical processing. Requires SeparateOpticalReading to be enabled.
  • Added RFIDDelay (integer, read/write) to configure delay before starting RFID processing.
  • Added OpticalDelay (integer, read/write) to configure delay before starting optical processing.

Document Reader Application

  • Added new baud rates for RFID chip processing that are available for the devices with firmware version 3х.хх: 1695 kbps, 3390 kbps, 6780 kbps.
  • Fixed issue with update notifications.
  • Fixed issue with page numbering in PDF reports.

Web Components

  • Added customization of the background area outside the camera frame via CSS parts.
  • Added position customization for the activity indicator via the activityIndicatorPortraitPositionMultiplier and activityIndicatorLandscapePositionMultiplier settings.
  • Added UI image customization.
  • Fixed issue with camera frame centering when all buttons are turned off.
  • Fixed issue with camera frame positioning when it overlapped the capture button.
  • Fixed issue with the following properties that were not accessible on TypeScript:
    • angleThreshold
    • focusCheck
    • documentPositionIndent
    • brightnessThreshold
  • Fixed typing errors.
  • Removed the following settings: flipFrontIcon, flipBackIcon.
  • Removed the following CSS parts: hint-next-page-front-img, hint-next-page-back-img.
  • Removed the following unused labels: preparingService, documentProcessing, flipDocument.
  • Removed the following deprecations:
    • prepare method and prepareListener field in DocumentReaderService
    • license attribute
    • devLicense, regulaLogo settings
    • processParams.respectImageQuality setting
    • statusBackgroundColor, statusTextColor, backgroundMasAlpha settings
  • Disabled the Picture-in-Picture video mode.

UI Components

  • Added an option to disable image modal opening on click (imageViewer).
  • Added an option to disable automatic scroll to results (scrollToResult).
  • Added capability to customize the initial page and light image to display in the DocumentImages component.
  • Added capability to customize the initial tab, scroll position to display, and data fields to expand in the DocumentTabs component.
  • Fixed issue with the results positioning by width on mobile devices.

Web Service API

  • Added Prometheus metric core_request_queue_time_histogram to monitor request queue time to Core.
  • Changed Oracle DB connection string from oracle+cx_oracle to oracle+oracledb.
  • Updated Python to version 3.11.
  • Updated dependencies to the latest version to fix security breaches.
  • Fixed MongoDB Atlas connection issue.

Clients

  • Updated all models to conform to the raw response structure.
  • Added ability to pass headers in requests for Java Client.
  • Added Health() method that calls the /api/healthz endpoint for health check.
  • Added tenant, env, tag params to the /api/v2/transaction/process endpoint.
  • Fixed out of range issue for int values in Java Client.
  • Fixed issue of a missing raw response in .ProcessAsync().

Demo Website

  • Fixed the auto-scroll issue after page refresh following document processing.
  • Memory usage optimization.
  • Updated dependencies to the latest version to fix security breaches.

Licensing

  • Updated licensing to support RFID-only processing.

Installation Packages

  • Windows
    • Included driver version 10.5.10.24 in Regula Reader Drivers package 1.8.29.

PKD

  • ICAO PKD Master List version 316 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 252 countries and territories, 15446 documents.
  • Added 227 new documents.

For details, see the Supported documents list.