Releases: microblink/blinkid-react-native
v7.7.0
- Updated to Android SDK v7.7.1 and iOS SDK v7.7.0
What's New
- Barcode extraction is marked as optional on documents where barcode detecton has bad performance (Cuba ID and Passport, Philippines DL, Haiti ID, Sudan ID, Egypt ID, Ecuador Passport, Ghana Passport, Iraq Passport, Nicaragua Passport, Pakistan Passport)
Bug fixes
- In situations where some fields on different sides of a document have values in multiple alphabets it could happen that while merging results we overwrite them and keep only one alphabet. With this version this is fixed and both alphabets are returned.
New documents support
- Angola - Identity Card
- Antigua And Barbuda - Paper Passport
- Barbados - Paper Passport
- Belize - Paper Passport
- Benin - Driver's License
- Benin - Polycarbonate Passport
- Bermuda - Paper Passport
- Bermuda - Polycarbonate Passport
- Bhutan - Paper Passport
- Botswana - Paper Passport
- Brazil, Acre - Identity Card
- Brazil, Espirito Santo - Identity Card
- Brazil, Mato Grosso Do Sul - Identity Card
- Brazil, Paraiba - Identity Card
- Brazil, Piaui - Identity Card
- Brazil, Rio Grande Do Norte - Identity Card
- Brazil, Tocantins - Identity Card
- Central African Republic - Paper Passport
- Chad - Paper Passport
- Chad - Polycarbonate Passport
- Congo - Paper Passport
- Democratic Republic Of The Congo - Paper Passport
- Djibouti - Paper Passport
- Djibouti - Polycarbonate Passport
- Equatorial Guinea - Paper Passport
- Equatorial Guinea - Polycarbonate Passport
- Eswatini - Identity Card
- Ethiopia - Paper Passport
- Federated States Of Micronesia - Paper Passport
- Gabon - Paper Passport
- Gabon - Polycarbonate Passport
- Ghana - Polycarbonate Passport
- Ghana - Social Security Card
- Guinea - Driver's License
- Guinea Bissau - Paper Passport
- Guinea Bissau - Polycarbonate Passport
- India, Odisha - Driver's License
- India, Uttarakhand - Driver's License
- Ireland - Proof Of Age Card
- Laos - Paper Passport
- Lesotho - Paper Passport
- Liberia - Driver's License
- Liberia - Social Security Card
- Madagascar - Paper Passport
- Malawi - Driver's License
- Mauritania - Identity Card
- Mauritania - Polycarbonate Passport
- Mexico - Social Security Card
- Mongolia - Paper Passport
- Mongolia - Polycarbonate Passport
- Namibia - Paper Passport
- Niger - Paper Passport
- Nigeria - Nin Card
- Papua New Guinea - Paper Passport
- Philippines - eID
- Philippines - MySSS Card
- Puerto Rico - Identity Card
- Saint Thomas And Prince - Paper Passport
- Saint Vincent And The Grenadines - Paper Passport
- Seychelles - Paper Passport
- Seychelles - Polycarbonate Passport
- South Sudan - Polycarbonate Passport
- Taiwan - Paper Passport
- Togo - Gendarmerie ID
- Togo - Military ID
- Togo - Police ID
- Togo - Residence Permit
- Togo - Voter ID
- Tonga - Paper Passport
- Yemen - Paper Passport
- Ghana - Health Insurance Card
New document versions for supported documents
- Afghanistan - Identity Card
- Cameroon - Identity Card
- Chile - Driver's License
- Colombia - Alien ID
- Costa Rica - Identity Card
- Malaysia - Driver's License
- Moldova - Identity Card
- Netherlands - Driver's License
- Panama - Driver's License
- South Korea - Driver's License
- South Korea - Identity Card
- Sweden - Driver's License
- UK - Polycarbonate Passport
- USA - Veteran ID
- USA, Alaska - Identity Card
- USA, California - Driver's License
- USA, California - Identity Card
- USA, North Carolina - Driver's License
- USA, Texas - Driver's License
- USA, Texas - Identity Card
- USA, Texas - Weapon Permit
- Vietnam - Driver's License
- Zimbabwe - Identity Card
New segments supported on documents
- Greece, Estonia, Finland, Hungary, Ireland, Latvia, Lithuania, Norway, Romania, Slovenia, Croatia, Slovakia, Poland, Malta, Austria, Luxembourg, Netherlands, Bulgaria, Portugal, Cyprus, Sweden, Czechia, Belgium, Germany, Italy, Spain, Switzerland, Denmark - Residence Permit: remarks, residencePermitType
- Belgium, Minors ID: added parentsInfo vector
- Nicaragua, Passport: barcode
- USA, Social Security Card: workRestriction
- China, Identity Card: permanentExpiry (Chinese)
Minor API changes
-
Added new items to enums:
- new
FieldTypeenum values:EffectiveDate,ParentsLastName,ParentsLastName2,ParentsFirstName2,WorkRestriction,ParentsFirstName,SocialSecurityStatus,LegalStatus,HusbandName,ChinPermanentExpiry - new
DocumentTypeenum values:NinCard,MysssCard,GendarmerieId,PoliceId - new
Countryenum value:SaintThomasAndPrince - new
Regionenum values:Acre,EspiritoSanto,MatoGrossoDoSul,Paraiba,Piaui,RioGrandeDoNorte,Tocantins,Odisha,Uttarakhand
- new
-
Added member results to
BlinkIdScanningResultandVizResulteffectiveDatehusbandNamelegalStatussocialSecurityStatusworkRestrictionparentsInfo(new class)
v7.6.2
What's New
- Added backward compatibility with React Native’s old architecture.
- The SDK now works seamlessly with both the New Architecture (TurboModules) and the legacy Native Module implementation.
- Improved error handling.
- Errors now include clearer context and more actionable messages for easier debugging.
v7.6.1
- Updated to Android SDK v7.6.1 and iOS SDK v7.6.2
What's New
- For some documents document type was returned as None, which was causing confusion. To prevent this, we are filling in document type from the barcode in case customers are using BarcodeId mode.
- The fix is applied to all the AAMVA types, plus some others (Argentina, Canada, Colombia, Nigeria, Panama, Paraguay, SouthAfrica)
v7.6.0
- Updated to Android SDK v7.6.0 and iOS SDK v7.6.0
What's New
- Added two new methods in
BlinkidReactNative:loadBlinkIdSdk&unloadBlinkIdSdkloadBlinkIdSdk- Initializes and loads the BlinkID SDK if it is not already loaded. This method can be called in advance to preload the SDK before starting a scanning session. Doing so reduces loading time for theperformScanandperformDirectApiScanmethods since all resources will already be available and the license verified.unloadBlinkIdSdk- Terminates the BlinkID SDK and releases all associated resources. This method safely shuts down the SDK instance and frees any allocated memory. If the parameterdeleteCachedResourcesis set totrue, the method performs a complete cleanup, including deletion of all downloaded and cached SDK resources from the device.
- You can now configure the SDK to load resources locally instead of downloading them. Set
downloadResourcesto false, and provide the local resource path usingresourceLocalFolder(Android) andbundleIdentifier(iOS). - Added support for capturing the back of US and India passports that feature a barcode
- Prevent parsing of two-line MRZ in TD1 format unless it's explicitly allowed. This will prevent false positive MRZ extraction on documents where the last line of the MRZ is covered or not fully visible
New Documents Support
- Angola - Paper Passport
- Bahrain - Polycarbonate Passport
- Burkina Faso - Polycarbonate Passport
- Cameroon - Driver's License
- Canada, Manitoba - Metis Federation Card
- East Timor - Polycarbonate Passport
- El Salvador - Paper Passport
- Eritrea - Paper Passport
- France - Adr Certificate
- Germany - Adr Certificate
- Ghana - Voter ID
- India, Telangana - Driver's License
- Ivory Coast - Paper Passport
- Japan - Polycarbonate Passport
- Liberia - Paper Passport
- Liberia - Voter ID
- Malawi - Identity Card
- Malawi - Paper Passport
- Maldives - Polycarbonate Passport
- Mali - Paper Passport
- Mauritius - Paper Passport
- Oman - Vehicle Registration
- Paraguay - Polycarbonate Passport
- Rwanda - Driver's License
- Senegal - Driver's License
- Sierra Leone - Paper Passport
- Somalia - Paper Passport
- Switzerland - Adr Certificate
- Togo - Driver's License
- Togo - Paper Passport
- USA, Maryland - Medical Marijuana ID
- Vietnam - Paper Passport
New Document Versions for Supported Documents
- Chile - Polycarbonate Passport
- India - Paper Passport
- Moldova - Identity Card
- Pakistan - Identity Card
- Peru - Identity Card
- Romania - Identity Card
- Slovakia - Identity Card
- USA, California - Driver's License
- USA, California - Identity Card
- USA, New Hampshire - Identity Card
- USA, Georgia - Medical Marijuana ID
- USA, Pennsylvania - Medical Marijuana ID
- USA, South Carolina - Driver's License
- USA, South Carolina - Identity Card
- USA, Texas - Driver's License
- USA, Texas - Identity Card
New Segments Supported on Documents
- Switzerland, Residence Permit -
dateOfEntry - Hungary, Identity Card -
maidenName,nationality,sexOrGender,documentNumber,dateOfBirth - Greece, Identity Card -
fathersName(Latin and Greek),mothersName(Latin and Greek),personalIdNumber,issuingAuthority(Greek),municipalityOfRegistration(Greek) - Mexico, Voter ID -
sectionCode,stateCode,municipalityCode,localityCode - Mexico, Consular Voter ID -
stateCode,stateName
Renamed segments
- Hungary - Identity Card -
additionalNameInformation->mothersName
New languages
- Added 33 new languages (see full list here)
Breaking changes
- Renamed the
bundleURLtobundleIdentifierinBlinkIdSdkSettings. - Renamed
BlinkIdUiSettingstoBlinkIdScanningUxSettings.
Native platform changes
iOS
- The SDK was built with Xcode 26
Android
- Updated Kotlin to
v2.0.21in theblinkid-corelibrary. Theblinkid-uxandmicroblink-uxlibraries already used Kotlinv2.1.20. - Target SDK updated to API Level 36
Bugfixes
- Fixed issues with React Native v0.8 compatibility.
- Users are no longer forced to scan back sides of Alien and Refugee passports
- Fixed the issue with Togo ID where document number from VIZ was overriden by a wrong value from MRZ
Other changes
- Changed default
tiltDetectionLevelfromOfftoMid
v7.5.0
- Updated to Android SDK v7.5.0 and iOS SDK v7.5.0
What's New
- We introduced event tracking across the SDK lifecycle, giving you deeper insights into user journeys, success rates, and drop-off points during scanning sessions. These enhanced analytics make it easier to identify optimization opportunities and ensure the best possible user experience.
- Updated detection analysis logic in case of photo mode
- Added new
parsedresult member to the BarcodeResult which indicates whether the raw barcode data was successfully parsed - Barcode recognition is now allowed on all document classes; unparsable barcodes will be returned as raw data
v7.4.0
- Updated to Android SDK v7.4.0 and iOS SDK v7.4.0
What's new
- Improved extraction for Canada/Nunavut ID and DL by introducing error correction for "1" and "I" characters which look the same in the font used on a document
New Documents Support
- Canada, Newfoundland And Labrador - Identity Card
- Canada, Northwest Territories - Driver's License
- Canada, Northwest Territories - Identity Card
- Canada, Prince Edward Island - Identity Card
- Canada, Yukon - Identity Card
- Canada, Nunavut - Driver's License
- Canada, Nunavut - Identity Card
- Liberia - Identity Card
- Mali - Identity Card
- UK - Military ID
New Document Versions for Supported Documents
- Bahrain - Identity Card
- Canada, Yukon - Driver's License
- Canada - Weapon Permit
- Chile - Alien ID
- Chile - Identity Card
- Finland - Driver's License
- Indonesia - Driver's License
- Kosovo - Identity Card
- Latvia - Polycarbonate Passport
- Mexico, Chiapas - Driver's License
- Mexico, Ciudad de Mexico - Driver's License
- Mexico, Durango - Driver's License
- Mexico, Jalisco - Driver's License
- Sri Lanka - Driver's License
- USA, Alaska - Driver's License
- USA, New Hampshire - Driver's License
- European Union - Health Insurance Card
New Beta Documents Support
- Canada - Non Card Tribal ID
- Dominica - Paper Passport
- Dominica - Polycarbonate Passport
- UAE - Diplomatic ID
- USA, Georgia - Medical Marijuana ID
New Document Versions for Beta-Supported Documents
- Egypt - Driver's License
- Mexico, Quintana Roo - Driver's License
- Philippines - Postal ID
- Vietnam - Identity Card
New Segments Supported on Documents
- European Union, Health Insurance Card -
countryCode - Italy, Identity Card -
documentOptionalAdditionalNumber - France, Identity Card -
additionalNameInformation - UK, Asylum Request -
residencePermitType,remarks - UK, Residence Permit -
residencePermitType,remarks,certificateNumber,nationalInsuranceNumber
Bug fixes
- Fixed issue with incorrect
DriverLicenseDetailedInfoserialization
v7.2.0
The version 7 release of the BlinkID SDK.
-
Updated to Android SDK v7.2.1 and iOS SDK v7.2.2
-
For more information about the inital version 7 release, see the release notes for the native SDKs for Android and iOS.
-
The plugin was built and tested with React Native v0.79.0
Breaking changes
-
Starting with BlinkID v7, the NPM package has been renamed and moved from
blinkid-react-nativeto@microblink/blinkid-react-nativeto improve organization and maintainability.- The old package
blinkid-react-nativeis now deprecated and will no longer receive updates. To continue using the latest BlinkID features and improvements, please install the new package:
npm install @microblink/blinkid-react-native
- The old package
-
BlinkID v7 is now fully written in TypeScript for improved type safety and developer experience.
-
The plugin now requires:
- iOS version 16.0 and above.
- Android API version 24 and above.
-
Method
scanWithCamerahas been renamed toperformScan. -
Method
scanWithDirectApihas been renamed toperformDirectApiScan. -
Many of the older settings have been renamed to be more intuitive, for more information see the blinkIdSettings.ts and types.ts files, and the native documentation for Android and iOS.
-
See section Version 7 plugin usage for more details about how to use each method, and how to handle the scanned results.
Version 7 plugin usage
The performScan method
The performScan method launches the BlinkID scanning process with the default UX properties.
It takes the following parameters:
- BlinkID SDK settings
- BlinkID session settings
- The optional BlinkID UI settings
- The optional ClassFilter object for filtering documents.
BlinkID SDK Settings - BlinkIdSdkSettings: the class that contains all of the available SDK settings. It contains settings for the license key, and how the models, that the SDK needs for the scanning process, should be obtained.
BlinkID Session Settings - BlinkIdSessionSettings: the class that contains various settings for the scanning session. It contains the settings for the ScanningMode and BlinkIdScanningSettings, which define various parameters that control the scanning process.
BlinkID UI Settings - BlinkIdUiSettings: the class that allows customization of various aspects of the UI used during the scanning process.
The optional ClassFilter class - ClassFilter: the class which controls which documents will be accepted or reject for information extraction during the scanning session.
- The implementation of the
performScanmethod can be viewed here in the index.tsx file.
The performDirectApiScanning method
The performDirectApiScan method launches the BlinkID scanning process inteded for information extraction from static images.
It takes the following parameters:
- BlinkID SDK settings
- BlinkID session settings
- First image string in the Base64 format
- The optional second image string in the Base64 format
BlinkID SDK Settings - BlinkIdSdkSettings: the class that contains all of the available SDK settings. It contains settings for the license key, and how the models, that the SDK needs for the scanning process, should be obtained.
BlinkID Session Settings - BlinkIdSessionSettings: the class that contains various settings for the scanning session. It contains the settings for the [ScanningMode] and [BlinkIdScanningSettings], which define various parameters that control the scanning process.
The first image Base64 string - string: image that represents one side of the document. If the document contains two sides and the ScanningMode is set to automatic, this should contain the image of the front side of the document. In case the ScanningMode is set to single, it can be either the front or the back side of the document. If the document contains only one side (for example, various passports), the SDK will automatically detect it, and will not look for the other side.
The optional second image Base64 string - string: needed if the information from back side of the document is required and the ScanningMode is set to automatic.
- The implementation of the
performDirectApiScanmethod can be viewed here in the index.tsx file. - All of the mentioned settings can be found in the blinkIdSettings.ts file.
BlinkID result
-
Both methods return the
BlinkIdScanningResultobject, which contains the results of scanning a document, including the extracted data and images from the document. -
All of the available results can be viewed in blinkIdResult.ts and types.ts.
Implementation guide
v6.13.1
v6.13.0
- Updated the plugin to Android SDK v6.13.0 and iOS SDK v6.13.0
New features
- ClassFilter
ClassFilterrepresents the document filter used to determine which documents will be processed.- Document information (Country, Region, Type) is evaluated with the content set in the filter, and their inclusion or exclusion depends on the defined rules.
- The recognition results of the excluded documents will not be returned.
- If using the standard BlinkID Overlay, an alert will be displayed that the document will not be scanned.
- Modifying the
includeClassesproperty will set the filter to scan only the set document classes. Other document classes will be rejected. - Modifying the
excludeClassesproperty will set the filter to reject only the set document classes. Other document classes will be accepted.- By defult, all of the document classes are accepted.
Expanded document coverage
- All of the new documents & document versions can also be found in the release notes for native Android and iOS SDKs.
Bug fixes
- NY ID/DL: Added logic to expose the Enhanced document subtype, allowing customers to distinguish between regular and enhanced versions.
- Bolivia & Namibia ID: Resolved data match inconsistencies that were causing data match failures.
- Romanian ID: Multi side scan no longer expects blank back card of old IDs, even with skipUnsupportedBack set to false.
- Fixed backImageAnalysisResult.cardRotation not being correctly populated when scanning the wrong side of a document.
- [iOS-specific] Fixed document flip animation on the
BlinkIdOverlay
v6.12.0
- Updated the plugin to Android SDK v6.12.0 and iOS SDK v6.12.0
New features
- Beta Feature: Second Page Passport Scanning
- Added support for scanning and extracting data from the second page of passports for select countries - Slovenia, Ireland, and New Zealand.
- When BlinkID detects one of these passports, a UI message will guide the user to the second page.
- By default, this feature is disabled but can be enabled via the
BlinkIdMultiSideRecognizer.scanPassportDataPageOnlysetting - if set tofalse, it will be required to scan the second page of certain passports. This feature is in beta, and your feedback is appreciated.
- USA Green Card - Enabled Data Match for the
Document Numberfield, matching values from the VIZ (Visual Inspection Zone) and MRZ to further enhance extraction reliability.
Bug fixes
- Spain ID: Fixed an issue with indefinite expiry dates, ensuring consistent values between the MRZ and Visual Inspection Zone (VIZ).
- Bulgaria ID: Improved parsing for indefinite expiry dates in the MRZ for better accuracy.
- Netherlands ID & Norway Passport: Resolved issues with the
Personal ID numberfield that were causing the data match feature to fail. - Chinese Passport: Enhanced reliability of extracted data with additional logic for the
Document Numberfield. - German ID & Luxembourg ID: Adjusted name extraction logic to resolve issues with name separation, ensuring more consistent results.