Skip to content

Document Reader SDK 7.5 — December 16, 2024

IMPORTANT changes

  • Added full support for DTC-VC and DTC-PC. Learn more about DTC in simple terms here.
  • Added support for the new DG2 data format in accordance with ISO/IEC 39794-5.
  • Significantly improved document detection performance.
  • Significantly improved Document Liveness check performance.
  • Added new functionality for barcode format and photo embedding checks.
  • Added capability to seamlessly switch from a computer to a mobile device by scanning QR code for the web component.

Info

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

Core SDK

Document Detection and Crop

Improved neural network (NN) for precise and fast detection of multiple documents on any background. The NN is almost perfectly balanced in size, precision, and speed with different brews for mobile and server. This significantly improved processing time on mobile devices and recognition quality on servers. Faster processing also makes the Document Liveness checking session easier and more efficient.

Document Type Recognition

Implemented an additional step to resolve ambiguities between different series of the same document that differ only in IR/UV security features, based on the date of issue. Example: Latest Germany ePassports.

OCR

  • Improved NN for the Vietnamese alphabet.
  • Implemented correct recognition of single-line text in multiple languages.
  • Updated and added new fonts for perforated field reading in multiple countries.
  • Optimized recognition speed for very long fields.
  • Fixed resource initialization issues.

MRZ

  • New parsers:
    • China: HK/Macao Visit Permit.
  • Updated parsers:
    • China: HK/Macao ID Card.
  • Other
    • Improved reading of MRZ printed with non-standard fonts.
    • Fixed validity calculation for fields with incorrectly recognized characters replaced with the question mark (?)

Barcode

  • Added new parsers:
    • Belize DL
    • Burundi DL
    • Ecuador DL
    • El Salvador ID Card
    • Finland Child ID Card
    • Ghana Consular ID Card
    • Honduras Residence Card
    • Kenya Diplomatic ID Card
    • Kosovo ID Card
    • Lebanon Visa
    • Palau ID Card
    • Philippines ID Card
    • Puerto Rico ID Card
    • Saint Kitts and Nevis ID Card
    • Sudan DL
    • Tanzania Voter Card
    • Thailand Work Permit
    • Togo ID Card
    • Turkey Residence Permit
    • Turkmenistan ePassport
    • Zimbabwe DL
  • Updated parsers:
    • Canada DL
    • AAMVA
    • France ID Card
    • Greece Visa
    • ICAO IDB
    • Kenya ID Card
    • Mexico DL
    • South Africa DL
    • Visa VDS
  • Other
    • Improved reading of damaged QR codes.
    • Fixed issue with returning results for all codes in a document template, not only for those that were detected/read.
    • Fixed issue with merging detection/recognition results from external sources (for example, iOS) with native results inside the core.
    • Fixed issue with returning all barcodes as graphic fields.

Text Data Parsing and Validation

  • Added functionality to return the longest names from other sources (Visual, Barcode, RFID) in the Text results field if MRZ contains shortened or cropped names. This feature works when the procParam.selectLongestNames parameter is set to true. It is disabled by default.
  • Added capability to extract specific text from a text recognized field value and return only this part in the results if it is present in the recognized field value.
  • Added capability to compare parts of a date to other date fields. For example, "SEP 83" to "1983-09-24".
  • Fixed issue with the XXX nationality code for further conversion.
  • Fixed issue with parsing a visa type from MRZ.
  • Fixed issues with Mexico and Singapore personal number validation.
  • Fixed issue with SPECIMEN status detection.
  • Fixed issue with country code conversion from ALPHA2 to ALPHA3 for Somaliland.
  • Fixed issue with DS certificate date conversion for LAO DPR.

Authenticity

  • Document Liveness check
    • Added a new check for black-and-white copies, determining if the image is black and white or contains color information. This check, previously available in image quality checks, now affects document liveness status.
    • Added restrictions for input image quality for the check to be performed. The image resolution should be at least 200 PPI, the document image should not be cropped at the edges (background must be present), and each document page should be in a separate image.
    • Added new diagnoses signaling a timeout during a liveness assessment session in mobile capture, leading to check failure.
    • Added the capability to perform portrait comparison between the main document portrait and the ghost portrait in dynamic elements, like MLI.
    • Improved detection of digitally manipulated images.
    • Updated the neural network (NN) for electronic device replay checks with greater accuracy.
    • Fixed logic for checking result calculation: if some sub-checks were set to perform but were not executed, the overall check status will also indicate "not performed."
    • Fixed issue with processing the Document Liveness check when no document was detected, which led to incorrect licensed transaction registration.
  • Image Patterns check
    • Updated NN for checking the contact chip type.
    • Fixed issue with returning an incorrect reference image for OVI elements when only a visible image was available for processing.
    • Fixed issue where OVI element pattern checks were not performed when only a visible image was available for processing.
  • Photo Embedding check
    • Added a head position check for the document’s main portrait based on the document template.
    • Updated NN for portrait replacement checks.
  • IR B900 check
    • Fixed issue with no check results when scanning documents on readers in certain cases.
  • Barcode Format check
    • Added verification of barcode digital signatures for French ID cards according to "Spécifications Techniques des Codes à Barres 2D-DOC" version 3.3.4.
    • Introduced an additional check for barcode digital replacement in images.
    • Implemented the processParam.strictBarcodeDigitalSignatureCheck option to enable/disable strict barcode data digital signature verification, requiring a complete valid certificate chain to be present, not only validating the signature.
    • Added strict validation of ICAO IDB format data contents according to the specific document template.
    • Fixed issue with incorrect source certificates for digital signature validation used in cases when multiple sources were available.
  • OCR Security Text check
    • Fixed issue where no check results were reported if text was not recognized in UV at all.

Image QA

  • Introduced a new Boolean parameter processParam.strictImageQuality that will replace the deprecated processParam.respectImageQuality. When enabled, image QA status affects the overall status. Disabled by default.
  • Added capability to specify "glaresCheck" in processParam.imageQa.expectedPass for signaling that the glare check result should affect the image QA status.
  • Fixed issue with perspective angle check for flat documents in rare cases where they were rotated to some degree.

Enums

  • Added new eRPRM_DeviceTypes enum members:

    • RPRM_DeviceType_DeskoIcon
    • RPRM_DeviceType_XperixRealPass
    • RPRM_DeviceType_WiseCube_wsdef
    • RPRM_DeviceType_AccessIs

  • Added new eVisualFieldType enum members:

    • ft_DTC_Version
    • ft_DTC_ID
    • ft_DTC_DateOfExpiry
    • ft_EF_CardAccess

  • Added new eCheckDiagnose enum members:

    • chd_FieldPosCorrector_IncorrectHeadPosition
    • chd_NoCertificateForDigitalSignatureCheck
    • chd_DocLiveness_BlackAndWhiteCopyDetected

  • Added new eRPRM_SecurityFeatureType enum members:

    • SecurityFeatureType_HeadPositionCheck
    • SecurityFeatureType_Liveness_BlackAndWhiteCopyCheck

Other

  • Added the new "DTC" scenario to parse and validate only DTC-VC data as input.
  • Added functionality to return DTC-VC data if processParam.generateDTCVC is enabled.
  • Added functionality for quick reprocessing of transaction data when previous processing results are provided as an input. This is useful in different scenarios when, for example, images and chip data are supplied for processing at different moments in time; or reprocessing is needed to run face comparison of the document portrait with live photo that is obtained later; or PKD content has been updated and there is a need to repeat Passive Authentication check over chip data.
  • Implemented the possibility of calling the finalizePackage command multiple times, allowing gathered data to be sent for reprocessing as soon as available.
  • Added the capability to enable or disable face comparison for portraits from barcodes against other portraits in a document, based on its template. For some barcode portraits, comparison does not make sense due to their low resolution.
  • Added the parameter processParam.backendProcessing.timeoutConnection to set the connection timeout for backend communication.
  • Improved the general processing flow timing performance due to the updated algorithm.
  • Improved the "MrzOrLocate" scenario results by returning cropped portraits and performing image QA.
  • Extended the list of scenarios eligible for working in the processParam.doublePageSpread mode to include "Locate", "MrzOrLocate", "MrzAndLocate", "BarcodeAndLocate".
  • Fixed issue when recognized pages were not reported in the results when there were more than two pages in the input in some cases.
  • Fixed issue with reprocessing multiple pages of a document scanned on a reader device, where the second page lost its designation as obtained from a device.
  • Fixed issue with the FullAuth scenario running with Document Liveness checks enabled on mobile in multi-page mode, which led to incomplete results for the second page.
  • Fixed issue with unnecessary image hash calculations in processing series.
  • Fixed issue with infinite page scanning in multipage mode when processParam.doublePageSpread was enabled.
  • Fixed issue with logging levels on mobile platforms.
  • Fixed memory leaks.
  • Implemented multiple optimizations to improve performance.

Core RFID SDK

  • Added full support for handling DTC-VC according to the ICAO Technical Report. DTC-VC can now be created from ePassport data after successful reading and reprocessed and verified by passing DTC-VC data as input.
  • Added full support for handling DTC-PC according to ICAO Technical Reports.
  • Added support for the new DG2 data format according to ISO/IEC 39794-5, "Information technology - Extensible biometric data interchange formats — Part 5: Face image data", and the ICAO Application Profile for eMRTDs.
  • Implemented the capability to pass EF.CardAccess contents into a scenario for processing in the "CardAccess" key in Base64 encoding.
  • Implemented support for the PEM format for IS private keys.
  • Implemented the capability to retrieve parsed DG data during a reading session immediately after they are read and parsed. Upon receiving an RFID_Notification_Session_FileDataUpdated notification, the active session can be checked for the corresponding data group data.
  • Disabled strict MRZ ICAO conformity validation for DG1 when parsing by default. It can now be enabled by passing the "MrzStrictCheck" amendment in the scenario.
  • Fixed issue with the overall RFID status when reading finished with a communication error.
  • Fixed issue with parsing IS private key values that may lead to failed TA.
  • Fixed issue with incorrect parsing of certificates in PEM format.
  • Fixed issue with validating certificates with a validity date after 2038.
  • Fixed issue with potential race between disabling and enabling the antenna field when manual detection was used.
  • Fixed issue where a "69 87" response did not lead to an SM request.
  • Fixed issue with parsing master lists in ldif format where specific attributes are encoded in Base64. Since version 280 of ICAO master list includes master lists with such attributes, that will lead to issues when used with previous SDK versions. It is highly recommended to update to the latest SDK version.

Structs

  • Added a new struct TRF_DTC_Info

Enums

  • Added new eRFID_NotificationCodes enum members:

    • RFID_Notification_Session_Open
    • RFID_Notification_Session_Close
    • RFID_Notification_Session_FileDataUpdated

  • Added new eRFID_ResultType enum member:

    • RFID_ResultType_RFID_DTC_VC

  • Added new eRFID_DataGroupTypeTag enum members:

    • RFDGT_DG17
    • RFDGT_DG18
    • RFDGT_DG22
    • RFDGT_DG23
    • RFDGT_DG24

  • Added new eCBEFF_EyeColor enum member:

    • eyeHazel

  • Added new eCBEFF_HairColor enum member:

    • hairColoured

  • Added new eCBEFF_FormatTypes enum members:

    • ftypXBDIF_Finger_CCVB
    • ftypXBDIF_Finger_CCCRE
    • ftypXBDIF_Finger_Minutiae
    • ftypXBDIF_Finger_MinutiaeXML
    • ftypXBDIF_Finger_Image
    • ftypXBDIF_Finger_ImageXML
    • ftypXBDIF_Face_Image
    • ftypXBDIF_Face_ImageXML
    • ftypXBDIF_Iris_Image
    • ftypXBDIF_Iris_ImageXML

  • Added new eOutputFormat enum member:

    • ofFile_Binary

  • Added new eLDS_ParsingErrorCodes enum members:

    • errLDS_ASN_DTC_SignerInfo_IncorrectData
    • errLDS_ASN_DTC_SignerInfo_Certificate_IncorrectData
    • errLDS_ASN_DTC_SignerInfo_DigestAlg_IncorrectData
    • errLDS_ASN_DTC_SignerInfo_SignedAttrs_IncorrectData
    • errLDS_ASN_DTC_SignerInfo_SignAlg_IncorrectData
    • errLDS_ASN_DTC_SignerInfo_Signature_IncorrectData
    • errLDS_ASN_DTC_SecurityInfo_IncorrectData
    • errLDS_ASN_DTC_ContentInfo_IncorrectData

  • Added new eLDS_ParsingNotificationCodes enum members:

    • ntfLDS_Biometrics_BDB_Data_Incorrect
    • ntfLDS_Biometrics_RB_Data_Incorrect
    • ntfLDS_Biometrics_RB_Item_Incorrect
    • ntfLDS_Biometrics_RB_Item_Missing
    • ntfLDS_Biometrics_RB_Item_Unexpected
    • ntfLDS_Biometrics_RB_RID_Incorrect
    • ntfLDS_Biometrics_RB_ImageR_Incorrect
    • ntfLDS_Biometrics_RB_Image_Item_Incorrect
    • ntfLDS_Biometrics_RB_Image_Item_Missing
    • ntfLDS_Biometrics_RB_Image_Item_Unexpected
    • ntfLDS_Biometrics_RB_Image_Info_Item_Incorrect
    • ntfLDS_Biometrics_RB_Image_Info_Item_Missing
    • ntfLDS_Biometrics_RB_Image_Info_Item_Unexpected
    • ntfLDS_Biometrics_RB_Image_Info_Format_Incorrect
    • ntfLDS_Biometrics_RB_Image_Info_Format_Unsupported
    • ntfLDS_Biometrics_RB_Image_Info_Kind_Incorrect
    • ntfLDS_Biometrics_RB_Image_Info_Kind_Unsupported
    • ntfLDS_Biometrics_RB_Image_Info_PostAPB_Incorrect
    • ntfLDS_Biometrics_RB_Image_Info_LossyTA_Incorrect
    • ntfLDS_Biometrics_RB_Image_Info_LossyTA_Unsupported
    • ntfLDS_Biometrics_RB_Image_Info_Cam2Subj_Unsupported
    • ntfLDS_Biometrics_RB_Image_Info_SensDiag_Unsupported
    • ntfLDS_Biometrics_RB_Image_Info_LensF_Unsupported
    • ntfLDS_Biometrics_RB_Image_Info_ImSize_Incorrect
    • ntfLDS_Biometrics_RB_Image_Info_ImSize_Unsupported
    • ntfLDS_Biometrics_RB_Image_Info_ImMeas_Incorrect
    • ntfLDS_Biometrics_RB_Image_Info_Color_Incorrect
    • ntfLDS_Biometrics_RB_Image_Info_Color_Unsupported
    • ntfLDS_Biometrics_RB_Image_Info_ColorMap_Incorrect
    • ntfLDS_Biometrics_RB_Image_Capt_Item_Incorrect
    • ntfLDS_Biometrics_RB_Image_Capt_Item_Unexpected
    • ntfLDS_Biometrics_RB_Image_Capt_Spectral_Unsupported
    • ntfLDS_Biometrics_RB_Image_Capt_TechCode_Incorrect
    • ntfLDS_Biometrics_RB_Image_Capt_TechCode_Unsupported
    • ntfLDS_Biometrics_RB_Date_Item_Incorrect
    • ntfLDS_Biometrics_RB_Date_Item_Missing
    • ntfLDS_Biometrics_RB_Date_Item_Unexpected
    • ntfLDS_Biometrics_RB_Date_Incorrect
    • ntfLDS_Biometrics_RB_Quality_Item_Incorrect
    • ntfLDS_Biometrics_RB_Quality_Item_Missing
    • ntfLDS_Biometrics_RB_Quality_Item_Unexpected
    • ntfLDS_Biometrics_RB_Quality_AlgID_Item_Incorrect
    • ntfLDS_Biometrics_RB_Quality_SoE_Item_Incorrect
    • ntfLDS_Biometrics_RB_Quality_Score_Item_Incorrect
    • ntfLDS_Biometrics_RB_Quality_Error_Item_Incorrect
    • ntfLDS_Biometrics_RB_Quality_Error_Item_Unsupported
    • ntfLDS_Biometrics_RB_PAD_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_Item_Unexpected
    • ntfLDS_Biometrics_RB_PAD_Decision_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_Decision_Item_Unsupported
    • ntfLDS_Biometrics_RB_PAD_Score_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_Score_RegID_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_SoE_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_SoE_Score_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_SoE_Error_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_SoE_Error_Item_Unsupported
    • ntfLDS_Biometrics_RB_PAD_ExtData_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_ExtData_Type_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_Context_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_Context_Item_Unsupported
    • ntfLDS_Biometrics_RB_PAD_SLevel_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_SLevel_Item_Unsupported
    • ntfLDS_Biometrics_RB_PAD_RiskLevel_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_Criteria_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_Criteria_Item_Unsupported
    • ntfLDS_Biometrics_RB_PAD_Date_Item_Incorrect
    • ntfLDS_Biometrics_RB_PAD_Date_Item_Missing
    • ntfLDS_Biometrics_RB_PAD_Date_Item_Unexpected
    • ntfLDS_Biometrics_RB_PAD_Date_Incorrect
    • ntfLDS_Biometrics_RB_SessionID_Incorrect
    • ntfLDS_Biometrics_RB_Derived_Incorrect
    • ntfLDS_Biometrics_RB_Device_Incorrect
    • ntfLDS_Biometrics_RB_Device_Item_Unexpected
    • ntfLDS_Biometrics_RB_Device_ModelID_Item_Incorrect
    • ntfLDS_Biometrics_RB_Device_CertID_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Item_Unexpected
    • ntfLDS_Biometrics_RB_Metadata_Gender_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Gender_Item_Unsupported
    • ntfLDS_Biometrics_RB_Metadata_Eye_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Eye_Item_Unsupported
    • ntfLDS_Biometrics_RB_Metadata_Hair_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Hair_Item_Unsupported
    • ntfLDS_Biometrics_RB_Metadata_Height_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Props_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Props_Item_Unexpected
    • ntfLDS_Biometrics_RB_Metadata_Express_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Express_Item_Unexpected
    • ntfLDS_Biometrics_RB_Metadata_Pose_Item_Incorrect
    • ntfLDS_Biometrics_RB_Metadata_Pose_Item_Unexpected
    • ntfLDS_Biometrics_RB_LandMark_Item_Incorrect
    • ntfLDS_Biometrics_RB_LandMark_Item_Missing
    • ntfLDS_Biometrics_RB_LandMark_Item_Unexpected
    • ntfLDS_Biometrics_RB_LandMark_Kind_Item_Incorrect
    • ntfLDS_Biometrics_RB_LandMark_Mpeg4_Item_Incorrect
    • ntfLDS_Biometrics_RB_LandMark_Mpeg4_Item_Unsupported
    • ntfLDS_Biometrics_RB_LandMark_AntrL_Item_Incorrect
    • ntfLDS_Biometrics_RB_LandMark_Coord_Item_Incorrect
    • ntfLDS_DTC_ContentInfo_Version_Incorrect

  • Added new eRFID_AccessControl_ProcedureType enum member:

    • acptDTCInfo

  • Added new eRFID_Application_Type enum members:

    • at_LDS2_TravelRecords
    • at_LDS2_VisaRecords
    • at_LDS2_AddBiometrics
    • at_eDTC_PC

  • Added new eRFID_DataFile_Type enum members:

    • dftDTC_DG17
    • dftDTC_DG18
    • dftDTC_DG22
    • dftDTC_DG23
    • dftDTC_DG24
    • dftDIR
    • dftDTC_Info

  • Added new eRFID_CertificateType enum member:

    • ctDTCS

Desktop API

  • Fixed issue with sending MRZ to nonexistent serial port, that lead to significant delay when scanning document on the reader.
  • Fixed issue with loading database after license expiration.
  • Fixed issue with loading database when database loading is disabled.

Hardware Support

  • Added native support for 3rd party document readers for Windows:
    • Desco Icon
    • Xperix RealPass-N
    • ARH OSMOND-R
    • WiseCube WiseScan410
    • WiseCube WiseScan600
    • WiseCube WIS-1000
  • Updated support for Thales SDK version 3.9.2.39 (x64) Windows/Linux for AT9000 MK2/ AT10k devices.
  • Updated support for Desko Penta devices: now RFID antenna can be used in manual detection mode and scanning can be cancelled when a document is removed during scan.
  • Fixed issue with glare in axial light that was introduced in 7.4 for Regula 70x4M-5A/70x7/7028M devices.

RFID Firmware

  • IMPORTANT! New firmware version 22.14 is included. It is recommended to update your 21.x or 22.x firmware series Regula RFID devices to this new version.
  • Processing of USB OUT packets has been moved to the main loop.
  • Fixed issue where reading/writing EEPROM data caused CPU failure.
  • Fixed issue where RFID chip detection may not have started in certain cases.
  • Fixed issue with disappearing RFID USB device in certain cases.
  • Fixed issue of starting manual detection on forensic devices.

Mobile API

  • Added DTC-VC and DTC-PC support.
  • Added possibility to customize the background mask color.
  • Added strictImageQuality property, and respectImageQuality marked as deprecated.
  • Added strictBarcodeDigitalSignatureCheck property.
  • Added possibility to adjust the delay before the start and after the end of the multipage animation.
  • Added possibility to pass the CardAccess data to start the DTC-PC processing.
  • Added possibility to finish the backend transaction using the EndBackendTransaction method.
  • Added selectLongestNames property.
  • Updated logic of returning the value to isRFIDAvailableForUse and isAuthenticatorAvailableForUse, and added the isAuthenticatorRFIDAvailableForUse.
  • Changed the default profiler type for the RFID chip processing to LDS and PKI Maintenance, v2.0, May 21, 2014.
  • Added mrzStrictCheck property.
  • Front camera won't be available for use in the FullAuth scenario.
  • Updated the copyright label ("powered by Regula").
  • Added Uzbek localization support.
  • Removed Chinese Traditional localization support.
  • Updated package dependencies to the latest version to fix security issues.
  • Updated sample projects on GitHub.

Android

  • Added NFC reading timeout, use setTagTimeout in the RfidConfig class.
  • Added smooth autorotation of the camera.
  • Fixed RFID UI issue in the RTL interfaces.
  • Fixed issue in the database download progress.
  • Fixed issue with the setParameters method failure that caused exception.
  • Fixed issue with incorrect notification code that was returned during the RFID chip processing.

iOS

  • Updated the minimum supported iOS version from 11 to 12.
  • Added Swift Package Manager support for iOS native projects.
  • Updated return value for getTextFieldValueByType method. The value with Latin LCID now takes the priority.
  • Added etalonResultType field in the OCRSecurityTextCheck class.
  • Extended IdentResult to have IR visibility results.
  • Some improvements in the RFID chip processing.
  • Some fixes regarding the addition of PKD certificates.
  • Some fixes regarding the database download method.
  • Fixed issue with backend processing transaction creation.
  • Fixed issue with processing of multiple pages in the Online processing mode.
  • Fixed multipage animation that might be displayed after closing the camera in the child presence mode.

Hybrid

  • Fixed issue in onlineProcessingConfig.
  • Fixed conflicts with the external MAUI library.

Document Reader Application

  • Added functionality to save/load ePassport application data in DTC-VC format. Now together with RFID_Session.dat there will be saved DTC_VC.dat file after RFID reading if the results' saving is enabled.
  • Added functionality to pass EF.CardAccess contents obtained from ICAO IDB barcode into RFID module.
  • Fixed issue with display of the main portrait in case many sources are available. Order of appearance (subject to availability): RFID, Visual, Barcode.
  • Fixed issue with updating database when FTP port is disabled.
  • Fixed issue with displaying area of barcode on the image from which text and graphic fields were obtained via parsing its data.
  • Fixed issue with "Show result LED" setting not switching off LED after disabled.

COM API

  • Added new property RFIDDTCDataGroups for setting/getting of OR combination of eRFID_DataGroups enumeration elements that used as a list of data groups to read from DTC-PC application.
  • Added new property ProcessHandle for specifying current client process ID (read/write, integer). When set, COM can control all client processes activity when sending events. In case client process was killed this will allow COM to remove dormant handle from the active clients list.
  • Added new property RFIDCardAccess for providing EF.CardAccess contents from barcode into RFID module for DTC-PC reading (read/write, variant). This property value is cleared on starting a new scan.
  • Added new method GetRFIDDGValue for obtaining data group value immediately after it was got from the chip while chip reading is still in progress. It can be useful for getting DG2 data while DG3 is still being read for some time. This can allow saving time on further DG2 processing (like search/match). If not using this method, one should have to wait until the whole reading process is finished before getting any DG data. Should be called when theRFID_Notification_Session_FileDataUpdated notification is received.
  • Added new method RefreshTACertStore. This method allows you to tell the COM server to refresh the internal EAC certificates storage. Folder specified by RFIDEACPKDFolder property would be re-read and certificates stored in it added to internal storage.
  • Updated HealthCheck method response data with RFID antenna parameters data in rfid_data_version parameter.

Web Component

  • New features:

    • Seamlessly switch from a computer to a mobile device by scanning a QR code, allowing users to process documents on their phone and then return to the computer to view the results or continue the user journey.
    • New design of the start, success, and error screens.
    • The ability to show/hide buttons on the start screen.
    • The ability to configure bitrate for video record.
    • The ability to customize the background image within the camera border.
    • Display the correct message if HTTPS is not used.
    • Configure the presence of the mirror button (to turn it on / off), use the mirrorButton property.
    • Predefine the desired mirror type (mirror or no mirror), use the mirrorType property.
    • Turned off by default the mirror button.
    • Updated the camera launch.
    • Updated work with the package resources that are hosted on your own server—WASM files—by configuring via workerPath property.
    • Added the copyright label on the camera ("powered by Regula").
    • Added copyright property to turn on / off the "powered by Regula" label. regulaLogo property is now deprecated, use copyright instead.
    • Added timeoutConnection property that allows to configure the timeout for backend transaction creation and package finalization.
    • Added cameraFrameHorizontalPositionMultiplier property that allows to change the horizontal position of the camera frame (only applies to the landscape orientation).

  • Resolved issues:

    • Camera UI updates for small mobile devices and for right-to-left (RTL) interfaces.
    • Selecting the correct iPhone camera when it's connected to the computer in Safari while working on the computer.
    • Changed frame positioning while using the cameraFrameLandscapeAspectRatio property.
    • Removed --main-color, --hover-color, --active-color customization properties, use CSS part elements instead. See the Migration Guide for more details.
    • Updated package dependencies to the latest version to fix security issues.
    • Added API Reference documentation.

UI Components

  • New features:

    • document-reader-recipes package is migrated to the document-reader-typings package. From now on, document-reader-recipes won't longer be supported and marked as deprecated.
    • Popovers to the Security checks and RFID results that describe what every check means.
    • Raw barcode data in the Response tab.
    • Horizontal scrollbar in the Logs tab.
    • Display the barcode portrait in the top section if there are no other portraits.
    • Display round corners in the magnifier to match the original image.
    • Display values of required text fields as dash instead of blank if they are empty.
    • Display date of birth in the Summary section.
    • Display the diagnose for authenticity checks for all cases, except the success checks.

  • Resolved issues

    • Incorrect display of the images in the portrait comparison section in Safari.
    • Incorrect preview of the fingerprint images in the Response tab.
    • Incorrect display of some result.json files.
    • Incorrect display of data groups of some documents with the eDL application type.
    • Incorrect display of the status of IR transparency check in some cases while the raw response contained another one.
    • Incorrect logs decoding in some cases.
    • Updated package dependencies to the latest version to fix security issues.

  • Added the sample project on GitHub. that demonstrates how to use the ui-components package.

Web Service API

  • /api/ping endpoint is deprecated, use /api/healthz instead. However, it will remain available until the major version change.
  • /api/readiness endpoint is deprecated, use /api/readyz instead. However, it will remain available until the major version change.
  • Video of the document processing is saved on Storage during the Server-Side Verification after the package is received from the Mobile SDK / Web Component.
  • Removed the deprecated endpoint /webapi.
  • Added the ability to augment a package for reprocessing, for example, when there is already a package on Storage, but without RFID data, and you need to add it there.
  • Added license_valid_hours metric to Prometheus to get information about the remaining license validity.
  • Added possibility to specify one or more names (service names) by which to connect to the Oracle database. Previously it was implemented only for Windows, now supports Docker and Ubuntu as well.
  • Added Core error logging.

  • Added support for MongoDB, see details on the Database Configuration page.

  • Helm charts:

    • Added the ability to set a custom port value.
    • Added predefined RBAC rules.

  • Clients:

    • Updated interface of the getTransactionsByTag method.
    • Updated TransactionInfo scheme.
    • Added format property to the ImageData scheme.
    • Added the imageUrls property that allows to pass the URLs to the images for processing.
    • Fixed issue with the package reprocessing, when there is nothing, but the RFID data.
    • Fixed issue with keys update for the RFID reprocessing, when finalize called two times.
    • Updated the config.yaml.example file to correspond with best practices for configuration.

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

    • Java

      • Decreased JDK version from 11 to 8.
      • Updated version of the org.threeten:threetenbp dependency.

    • C#

      • Added portrait comparison results.
      • Added percentage value to portrait comparison results.
      • Fixed issue with CheckLiveness property.
      • Removed the outdated dependency - DotNetZip package.

    • Python

      • Added percent_value to the init function of the AuthenticityCheckResultItem class.
      • Added possibility to pass custom headers.

    • JS

      • Added TransactionInfo results to the top level of the response.

    • Demo Website

      • New features:
        • Seamlessly switch from a computer to a mobile device by scanning a QR code, allowing users to process documents on their phone and then return to the computer to view the results.
        • The list of supported image files to upload as a popover in the Document image section.
        • Tooltips to the action buttons, such as Download results, request, response, etc.
        • Close the camera start screen by clicking outside the modal area.
        • New appearance of the Document Templates Database and What Sets Regula Document Reader SDK Apart pages.
        • New appearance of the settings dialog.
        • New scenario "DTC" added.
      • Resolved issues:
        • Some supported image files might not be uploaded.
        • Auto-scroll to the processing results page.
        • Let's Talk Business page might not appear in Safari.
        • Incorrect cursor position when typing in the Custom params text area.

  • Open API specification is updated on GitHub.

  • Clients and packages are updated.
  • Other bug fixes and improvements.

Licensing

  • Added licensing for the new "DTC" scenario. It will require the same capabilities as for reading the RFID.
  • Implemented passing through client library licensing service response with exact error reasons instead of generic error.
  • Fixed issue with processing document with RFID session lead to multiple registered licensing transactions.
  • Fixed issue with multiple reprocessing of the same document images lead to reaching reprocessing limit for session tag on licensing service and subsequent processing error.
  • Fixed issue for licensing of RFID reading with mobile license without optical scanning for access key.
  • Resources usage optimization.

Installation Packages

  • Windows

    • New driver version 10.5.10.23 included in Regula Reader Drivers package 1.8.27
    • New 3rd party adapter libraries added to corresponding component in SDK installer.

  • Linux

    • Redesigned the installation packages to no longer use the /tmp and /var/tmp directories. From now on, the web service will be installed in /opt/regula/document-reader-webapi/

  • Docker

    • Updated the base image to the latest version.

PKD

  • ICAO PKD master list version 293 included.
  • ICAO Health master list version 9 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, 14685 documents.
  • Added 447 new documents.

For details, see the Supported documents list.