In Browser
v7.2.1
Hotfix Release
- Fixed an issue with frame quality estimation that could cause the recognition process to get stuck. This fix significantly improves success rate of document capturing, especially for the desktop cameras
Fixes
- Fixed an issue with frame quality estimation.
v7.2.0
What's new
- Added the ability to filter documents using the
addDocumentClassFilter
method on the BlinkID UX Manager. - Added new user feedback for scanning multi-page passport documents.
- Added message for hand occlusion detection. The setting
skipImagesOccludedByHand
set totrue
by default - Added message for poor lighting conditions detection. The setting
skipImagesWithInadequateLightingConditions
set totrue
by default - Added "Demo" overlay for the demo licenses (non-production)
- Added "Powered by Microblink" overlay option for licenses with this enabled
Bug Fixes
- Fixed data match bug when partial anonymisation is enabled
- Fixed face extraction bug for rotated face images on documents
- Improved face extraction for documents without face image (skipping face image extraction in that case)
- Fixed face extraction bug for Philippines Passport document
- Fixed an issue with filling the ProcessResult during the Barcode Capture step, ensuring only relevant fields are filled
- Fixed bug that forced scanning of the back side of the Germany Residence Permit in passport document
- Fixed bug that caused skipping back side when only signature was present
- Fixed an issue which caused certain feedback messages to be displayed too briefly.
v7.1.0
What's New
New Documents Support
- Austria - Refugee Passport
- Austria - Polycarbonate Refugee Passport
- Burkina Faso - Driver's License
- Burkina Faso - Paper Passport
- Costa Rica - Residence Permit
- Gambia - Paper Passport
- Guinea - Polycarbonate Passport
- Rwanda - Polycarbonate Passport
- South Korea - Polycarbonate Passport
- Tanzania - Polycarbonate Passport
- Uganda - Paper Passport
- Uganda - Polycarbonate Passport
- Zambia - Driver's License
- Zambia - Paper Passport
- USA, Florida - Medical Marijuana ID
- USA, Pennsylvania - - Medical Marijuana ID
New Beta Documents Support
- Benin - Paper Passport
- Burundi - Polycarbonate Passport
- Chad - Identity Card
- Kenya - Driver's License
- Mozambique - Polycarbonate Passport
- Spain - Registration Certificate
- Sudan - Identity Card
- Zimbabwe - Driver's License
- USA, Nevada - Medical Marijuana ID
- USA, New York - Medical Marijuana ID
- USA, Oklahoma - Medical Marijuana ID
New Document Versions for Supported Documents
- Bangladesh - Second data page support on Paper Passport and Polycarbonate Passport
- Kosovo - Paper Passport
- Mexico, Colima - Driver's License
- Mexico, Mexico - Driver's License
- Netherlands - Identity Card
- Netherlands - Polycarbonate Passport
- Romania - Identity Card, Back side scanning
- Romania - Polycarbonate Passport
- Singapore - Employment Pass, Back side scanning
- Slovakia - Polycarbonate Passport
- Syria - Paper Passport
- USA, Wyoming - Driver's License
New Document Versions for Beta-Supported Documents
- Mexico, Guanajuato - Driver's License
- Mexico, Puebla - Driver's License
- Croatia - Health Insurance Card
New Segments Supported on Documents
- Greece
- Identity Cards, Driver's Licenses, Residence Permits and Passports
- expanding support for extracting segments in Greek script
- Saudi Arabia, Identity Card
- expanding support for extracting segments in Arabic script
- Egypt, Driver's Licenses
- expanding support for extracting segments in Arabic script
Affected Packages
- @microblink/blinkid
- @microblink/blinkid-core
- @microblink/blinkid-ux-manager
- @microblink/camera-manager
Installation
npm install @microblink/blinkid@7.1.0
Or with pnpm:
pnpm add @microblink/blinkid@7.1.0
v7.0.1
Hotfix Release
This is a hotfix release that addresses issues with remote licenses.
Fixes
- Fixed issues with remote license handling
Affected Packages
- @microblink/blinkid
- @microblink/blinkid-core
- @microblink/blinkid-ux-manager
- @microblink/camera-manager
Installation
npm install @microblink/blinkid@7.0.1
Or with pnpm:
pnpm add @microblink/blinkid@7.0.1
v7.0.0
We're excited to introduce BlinkID v7, a major upgrade designed to simplify your integration and deliver a simpler ID scanning experience. With BlinkID v7, we're taking a fresh approach to scanning logic by introducing a more straightforward, session-based API for an easier configuration path, all while boosting first-time scan success rate.
Highlights & Integration Improvements
- Unified session-based API: We've moved away from juggling multiple recognizers (e.g., SingleSide, MultiSide) to a single session-based approach, unifying scanning logic under one simplified API. There's no need to switch recognizers anymore.
- Backward compatibility: Existing production keys will continue to work with v7.0. No new license key is required for the upgrade.
- More maintainable codebase: This new architecture sets the stage for easier and faster updates.
Architecture Changes
- New core components: Instead of Recognizer-based architecture, BlinkID uses a streamlined session-based approach.
- Modern TypeScript: Written with modern TypeScript features for improved developer experience.
- Component-based UI: Simplified, customizable UI components for easier integration.
- Simplified flow: More straightforward API with clearer separation of concerns.
Major API Changes
-
New session-based API
- Replaces the recognizer-based approach with a single, streamlined session model for easier scanning logic and better maintainability.
-
Modular SDK structure
- The SDK is now modular:
@microblink/blinkid-core
for scanning logic.@microblink/blinkid-ux-manager
for prebuilt UI components.@microblink/camera-manager
for camera stream handling.@microblink/blinkid
as the all-in-one package.
- The SDK is now modular:
-
Simplified initialization & result handling
-
New SDK initialization method:
import { createBlinkId } from "@microblink/blinkid";
const blinkid = await createBlinkId({
licenseKey: "your-license-key",
}); -
Results are now retrieved through structured session-based callbacks.
-
-
Enhanced UI customization
- UI settings enable direct customization of typography, colors, and strings.
- The modular architecture allows advanced modifications for branding and accessibility.
-
Renamed settings for improved clarity
blurStrictnessLevel
→blurDetectionLevel
enableBlurFilter
→skipFramesWithBlur
glareStrictnessLevel
→glareDetectionLevel
enableGlareFilter
→skipFramesWithGlare
combineFrameResults
→enableMultiFrameExtraction
cardRotation
→documentRotation
- And more...
Plan Your Upgrade
Note that v6 is now considered legacy. Comprehensive documentation is in development - in the meantime, please refer to our example applications in the repository under apps/examples
for integration patterns:
- blinkid-simple: Minimal integration with default UI
- blinkid-core-api: Low-level usage of the core API
- blinkid-advanced-setup: Custom UI and advanced configuration
- blinkid-preload: Preloading resources for faster startup
For any questions or feedback, reach out to support@microblink.com. We value your input and look forward to hearing how BlinkID v7 improves your app's experience!
November 14, 2024
v6.12.0
What's New
-
Beta Feature: Second Page Passport Scanning
-
We've launched 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
scanPassportDataPageOnly
setting on theBlinkIdMultiSideRecognizer
. 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 Number
field, 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 number
field that were causing the data match feature to fail. - Chinese Passport: Enhanced reliability of extracted data with additional logic for the
Document Number
field. - German ID & Luxembourg ID: Adjusted name extraction logic to resolve issues with name separation, ensuring more consistent results.
October 25, 2024
v6.11.2
Bug fixes
- NYC Municipal ID & USA Border Crossing Card - Resolved an issue where the scanning process could get stuck on the back side during multi-side scanning.
- Multithreaded builds are no longer loaded on Safari by default due to a memory leak in the browser.
October 10, 2024
v6.11.1
Bug fixes
- Fixed memory leak in Safari
- Fixed incorrect positioning of the close button introduced in 6.11.0
October 3, 2024
v6.11.0
Expanded Document Coverage
New Documents Support
- Armenia - Paper Passport
- Bahamas - Temporary Residence Permit
- Bahamas - Work Permit
- Bangladesh - Polycarbonate Passport
- Comoros - Paper Passport
- Dominican Republic - Non Voter ID
- Greece - Polycarbonate Passport
- Jamaica - Voter ID
- Kazakhstan - Paper Passport
- Kyrgyzstan - Paper Passport
- Kyrgyzstan - Polycarbonate Passport
- Lebanon - Driver's License
- Tajikistan - Identity Card
- Turkmenistan - Polycarbonate Passport
- Uzbekistan - Identity Card
New Document Versions for Supported Documents
- Argentina - Alien ID
- Bulgaria - Identity Card
- Canada, British Columbia - Identity Card
- Canada, British Columbia - Minors Public Services Card
- Croatia - Driver's License
- Jamaica - Paper Passport
- Malaysia - i-Kad
- Mexico, Coahuila - Driver's License
- Montenegro - Driver's License
- Namibia - Identity Card
- Norway - Driver's License
- Pakistan - Proof of Registration
- Panama - Identity Card
- Panama - Residence Permit
- Peru - Minors ID
- Portugal - Identity Card
- Romania - Identity Card
- Trinidad and Tobago - Driver's License
- Turkey - Identity Card
- USA, Arizona - Identity Card
- USA, Colorado - Identity Card
- USA, Michigan - Identity Card
- USA, Mississippi - Driver's License
- USA, Mississippi - Identity Card
- USA, Montana - Identity Card
- USA, North Carolina - Identity Card
- USA, North Carolina - Driver's License
- USA, North Dakota - Driver's License
- USA, Vermont - Identity Card
- USA, Virginia - Identity Card
- USA, Wyoming - Driver's License
- USA, Wyoming - Identity Card
- Uzbekistan - Paper Passport
New Beta Documents Support
- Andorra - Paper Passport
- Andorra - Polycarbonate Passport
- Philippines - Driver's License
- Armenia - Work Permit
- Australia - Asic Card
- Azerbaijan - Driver's License
- Bahamas - Paper Passport
- Bahamas - Polycarbonate Passport
- Cayman Islands - Paper Passport
- Cayman Islands - Polycarbonate Passport
- Cayman Islands - Voter ID
- Gibraltar - Driver's License
- Gibraltar - Identity Card
- Gibraltar - Paper Passport
- Gibraltar - Polycarbonate Passport
- Guyana - Paper Passport
- Kuwait - Bidoon Card
- Kyrgyzstan - Driver's License
- Monaco - Paper Passport
- Pakistan - Afghan Citizen Card
- Philippines, Bangsamoro - Driver's License
- Saint Lucia - Driver's License
- Saint Lucia - Paper Passport
- San Marino - Polycarbonate Passport
- Turks and Caicos Islands - Driver's License
- Turks and Caicos Islands - Identity Card
- Turks and Caicos Islands - Paper Passport
- Australia - Interim Health Insurance Card
- Australia - Reciprocal Health Insurance Card
- UAE - Vehicle Registration
New Document Versions for Beta-Supported Documents
- Barbados - Identity Card
- Brazil - Paper Passport
- Dominican Republic - Driver's License
- India, Gujarat - Driver's License
- Mexico, Puebla - Driver's License
- Philippines - Tax ID
- Philippines - Health Insurance Card
- Australia - Health Insurance Card
New Segments Supported on Documents
- USA - Green Card -
eligibilityCategory
- USA - Work Permit -
eligibilityCategory
- Greece - Driver's License -
placeOfBirth
(greek and latin) - Saudi Arabia - Resident ID -
nationality
(arabic) - Bahrain -
dateOfExpiry
- USA - Driver's license & ID card -
specificDocumentValidity
- Pakistan - Proof of Registration -
DependentDateOfBirth
,DependentSex
,DependentDocumentNumber
&DependentFullName
Renamed segments
- Barbados - Identity Card -
personalIdNumber
->documentNumber
- Panama - Identity Card -
personalIdNumber
->documentNumber
- Panama - Residence Permit -
personalIdNumber
->documentNumber
New Features
- Greek Alphabet Support
- We’ve added support for extracting
Place of Birth
in both Greek and Latin scripts.
- We’ve added support for extracting
- API changes in
BlinkIdSingleSideRecognizer
andBlinkIdMultiSideRecognizer
:- new fields in result:
manufacturingYear
,vehicleType
,eligibilityCategory
,specificDocumentValidity
,dependentsInfo
- new values in
ClassInfo
enums:- Region:
BANGSAMORO
- Type:
ASIC_CARD
,BIDOON_CARD
,INTERIM_HEALTH_INSURANCE_CARD
,NON_VOTER_ID
,RECIPROCAL_HEALTH_INSURANCE_CARD
,VEHICLE_REGISTRATION
- Region:
- new values in
FieldType
enum:ManufacturingYear
,VehicleType
,DependentDateOfBirth
,DependentSex
,DependentDocumentNumber
,DependentFullName
,EligibilityCategory
,SpecificDocumentValidity
- new fields in result:
September 17, 2024
v6.10.1
- Barcode scanning is now optional for Paraguay ID documents.
September 6, 2024
v6.10.0
New features
- Improved reliability and first-time successful scanning experience
- Avoiding Double Scans of the Front Side: For a more reliable scanning process, BlinkID now prompts users to flip the document when they scan the front side twice. This improves the overall experience and reduces the chance of mistakes.
- Starting with the Right Side: If users attempt to scan the back side of a document first, BlinkID will prompt them to begin with the front side. This feature ensures that users follow the correct order, leading to a more reliable and user-friendly experience.
Expanded document coverage
New document versions for supported documents
- Sweden - Social Security Card - Back side
- Bolivia - Driver's License - Back side
- Brazil, Distrito Federal - Identity Card - Back side
Out of beta
- Colombia - Temporary Protection Permit
New beta documents support
- France - Professional ID
- Mexico - Tax ID
New document versions for beta-supported documents
- Brazil, Parana - Identity Card - Back side
- Brazil, Santa Catarina - Identity Card - Back side
New segments supported on documents
- Peru - Alien ID - MRZ
Other changes
- Added
imageExtractionFailures
toAdditionalProcessingInfo
- this allows clients to actively track if anyImageExtractionType
(FullDocument
,Face
,Signature
) is not visible on the presented document. - Added a new result member,
barcodeStepUsed
, to bothBlinkIdSingleSideRecognizer
andBlinkIdMultiSideRecognizer
. This member indicates whether the barcode scanning step was utilized during the process. - Added two new settings for
BlinkIdSingleSideRecognizer
andBlinkIdMultiSideRecognizer
:allowBarcodeScanOnly
- allows barcode recognition to proceed even if the initial extraction fails - set tofalse
by defaultcombineFrameResults
- enables the aggregation of data from multiple frames - set totrue
by default
August 27, 2024
v6.9.2
- added new member
barcodeStepUsed
toBlinkIDSingleSideRecognizer
andBlinkIDMultiSideRecognizer
results - improved barcode scanning
August 8, 2024
v6.9.1
- Fixes iOS camera selection logic when the system locale is set to Spanish
July 15, 2024
v6.9.0
New features
Custom mandatory fields
- We’re introducing the option for customers to define their own set of mandatory fields. This feature allows greater flexibility in the scanning process by enabling the extraction of only the necessary information from identity documents. Now you can customize the process and focus on only those fields that are relevant to your use case.
- Custom mandatory fields can be set at the document level or applied universally to all document types.
Expanded Document Coverage
New Documents Support
- Austria - Polycarbonate Passport
- Canada - Polycarbonate Passport
- Ecuador - Paper Passport
- Germany - eID
- Guatemala - Alien ID
- Iraq - Polycarbonate Passport
- Namibia - Identity Card
- Nepal - Polycarbonate Passport
- Sweden - SIS ID
- USA, Delaware - Identity Card
- USA, Louisiana - Identity Card
- USA, Vermont - Identity Card
New Document Versions for Supported Documents
- Bolivia - Identity Card
- Canada, British Columbia - Public Services Card
- Finland - Identity Card
- Greece - Identity Card
- Malaysia - iKAD
- Mexico, Nuevo Leon - Driver's License
- Mexico, Tlaxcala - Driver's License
- Morocco - Driver's License
- Thailand - Polycarbonate Passport
- USA - Alaska - Driver's License
- USA - Alaska - Identity Card
- USA - Connecticut - Identity Card
- USA - Delaware - Driver's License
- USA - District of Columbia - Driver's License
- USA - Hawaii - Identity Card
- USA - Idaho - Driver's License
- USA - Indiana - Driver's License
- USA - Indiana - Identity Card
- USA - Iowa - Identity Card
- USA - Kansas - Identity Card
- USA - Kentucky - Identity Card
- USA - Kentucky - Driver's License
- USA - Maine - Identity Card
- USA - Maine - Driver's License
- USA - Michigan - Driver's License
- USA - Minnesota - Driver's License
- USA - Minnesota - Identity Card
- USA - Montana - Identity Card
- USA - Montana - Driver's License
- USA - New Hampshire - Identity Card
- USA - New Mexico - Driver's License
- USA - New Mexico - Identity Card
- USA - New York - Identity Card
- USA - North Dakota - Identity Card
- USA - Oregon - Identity Card
- USA - Pennsylvania - Driver's License
- USA - Rhode Island - Identity Card
- USA - South Carolina - Identity Card
- USA - Vermont - Driver's License
- USA - Washington - Identity Card
- USA - Wyoming - Driver's License
- USA - Wyoming - Identity Card
Out of Beta
- European Union - Health Insurance Card
New Beta Documents Support
- Democratic Republic of the Congo - Voter ID
- Philippines - Alien ID
- Philippines - Postal ID
- Philippines - Work Permit
- Philippines - Health Insurance Card
New Document Versions for Beta-Supported Documents
- Honduras - Paper Passport
- Mexico, Sonora - Driver's License
- Peru - Alien ID
- Philippines - Alien ID
New Segments Supported on Documents
- China Exit Entry Permit - MRZ
- China Mainland Travel Permit Taiwan - MRZ
- France Residence permit -
Remarks
&ResidencePermitType
- Philippines Alien ID -
visaType
Bug Fixes
- German ID - Fixed issues in cases when documents contain multiple surnames.
- Paraguay ID - Added support for parsing the smaller barcode found on the back side of the ID.
- Bulgaria Driver’s License - The Address field is set to optional, improving the extraction process.
- Improved MRZ parsing for the back side of the following identity documents:
- Brazil Alien ID
- Kenya ID
- Bosnia and Herzegovina ID
- Ivory Coast ID
- Paraguay ID
API changes
ClassAnonymizationSettings
type now usesclassFilter
property of typeClassFilter
instead ofcountry
,region
andtype
properties- New result members:
remarks
,residencePermitType
andvisaType
added toBlinkIdMultiSideRecognizerResult
,BlinkIdSingleSideRecognizerResult
andVIZResult
- New field types:
Remarks
,ResidencePermitType
andVisaType
toFieldType
enum - Added new enum
AlphabetType
- Added new type
DetailedFieldType
- Added new type
ClassFilter
- Added new type
CustomClassRules
- Added new settings
customClassRules
as an array ofCustomClassRules
types for defining custom mandatory fields - Added new region:
ALAGOAS
toRegion
enum - Added new document types:
AFGHAN_CITIZEN_CARD
,EID
,PASS
,SIS_ID
toDocumentType
enum
June 12, 2024
v6.8.0
New Features
- BlinkID now extracts precise information about subtypes of driver’s licenses and ID cards (e.g., conditional driver’s license, learner’s permit, provision, enhanced, etc.). This information is included in the scanning results as a
documentSubtype
field allowing you to tailor workflows or processes based on document limitations.
Bugfixes
- Fixed data match for Paraguay ID 2023 to cover inconsistencies between the MRZ and Visual Inspection Zone (VIZ)
June 4, 2024
v6.7.2
Bugfix
- Fixes an issue introduced in 6.7.1 where the UI component overlay would not hide after finishing a scanning session.
May 7, 2024
v6.7.1
New Features
Improved blur and glare detection
enableBlurFilter
andenableGlareFilter
properties have been added on BlinkID recognizer settings. These are enabled by default, but users can turn them off if they want to allow blur and glare on captured frames.blurStrictnessLevel
andglareStrictnessLevel
properties have been added on BlinkID recognizer settings. These can be configured using theStrictnessLevel
enum, which can beStrict
,Normal
(default) orRelaxed
.- New properties on
ImageAnalysisResult
:blurDetected
andglareDetected
Bug fixes
- A bug that caused memory leaks when reconfiguring the recognizer runner has been fixed
- The barcode scanning step feedback is now properly displayed in the UI component
- Improved camera selection algorithm
Breaking changes ⚠️
allowBlurFilter
has been renamed toenableBlurFilter
- The
blurred
property onImageAnalysisResult
has been renamed toblurDetected
April 23, 2024
v6.7.0
New Features
- Real ID symbol detection on US driver's license
- BlinkID can now identify Real ID symbols from US driver’s licenses, providing feedback on their presence or absence. This ensures customers can quickly determine if a Real ID symbol is available on a scanned US driver’s license to be compliant with Real ID regulations.
- Partial anonymization of the "Document Number"
- To ensure user privacy and security, BlinkID now offers the option of partially anonymizing the document number from the scanned document.
- Mandatory Barcode Presence on US documents
- To minimize the cases of capturing the front side of the document as the back frame in the results, BlinkID now requires the presence of a barcode before saving the back frame on US documents. Processing status
BarcodeDetectionFailed
is returned when the mandatory barcode is not present on the back of US documents.
- To minimize the cases of capturing the front side of the document as the back frame in the results, BlinkID now requires the presence of a barcode before saving the back frame on US documents. Processing status
Minor API changes
- Added
BarcodeDetectionFailed
as a newProcessingStatus
- This status is triggered once the barcode was not found on the image. This processing status can only occur if the document has the mandatory barcode.
- Added new boolean member
realIdDetectionStatus
to theImageAnalysisResult
. Iftrue
, Real ID symbol is present,false
otherwise. - Added new member
documentNumberAnonymizationSettings
to theClassAnonymizationSettings
for seamless integration with the document number anonymization feature.
Bug Fixes
- Updated internal mapping for Myanmar Passports to display nationality as "Myanmarese" instead of "Burmese" on Myanmar passports.
- On Peru ID "Date of Issue" is marked optional, offering customers more flexibility in capturing ID information.
- Improved "Date of Expiry" handling logic for MRZ in cases where documents with a date of expiry year 1969 were not correctly sanitized.
March 22, 2024
v6.6.0
Document Updates
New Documents Support:
- Australia - Polycarbonate Passport
- Indonesia - Polycarbonate Passport
- Mexico - Consular Voter ID
- Moldova - Polycarbonate Passport
- Pakistan - Proof Of Registration
- Panama - Polycarbonate Passport
- USA - West Virginia - ID Card
New Beta Documents Support:
- Brazil - Ceara - ID Card
- Brazil - Goias - ID Card
- Brazil - Sergipe - ID Card
- China - Exit Entry Permit
- China - Mainland Travel Permit Taiwan
- Colombia - Temporary Protection Permit
- India - DL
- India - Andhra Pradesh - DL
- India - Haryana - DL
- European Union - Health Insurance Card
New Document Versions for Supported Documents:
- Australia - Queensland - DL
- Australia - Victoria - DL
- Australia - Western Australia - DL
- Bolivia - Minor's ID
- Brazil - Alien ID
- Estonia - DL
- Finland - Alien ID
- Guatemala - Paper Passport
- India - Paper Passport - New side type
- Malta - DL
- Mexico - Guanajuato - DL
- Mexico - San Luis Potosi - DL
- New Zealand - Polycarbonate Passport
- Paraguay - ID Card
- Slovenia - Residence Permit
- USA - Green Card
- USA - Work Permit
- USA - Arizona - ID Card
- USA - Colorado - DL
- USA - Colorado - ID Card
- USA - District of Columbia - DL
- USA - District of Columbia - ID Card
- USA - Idaho - DL
- USA - Idaho - ID Card
- USA - Missouri - ID Card
- USA - Nebraska - ID Card
- USA - Nevada - ID Card
- USA - New York - ID Card
- USA - North Dakota - DL
- USA - Oklahoma - ID Card
- USA - Pennsylvania - ID Card
- USA - Utah - ID Card
- USA - Virginia - DL
- USA - Virginia - ID Card
- USA - West Virginia - DL
- USA - Wisconsin - DL
- USA - Wisconsin - ID Card
New Document Versions for Beta Supported Documents:
- Australia - Queensland - Proof of Age Card
- Brazil - ID Card
- Ireland - Residence Permit
- Mexico - Consular ID
- Mexico - Residence Permit
- Mexico - Nayarit - DL
- USA - North Dakota - ID Card
Out of Beta:
- Croatia - Residence Permit
- Moldova - Paper Passport
Platform Updates
- Expanded geographic support with new
Region
enum values:ANDHRA_PRADESH
CEARA
GOIAS
GUERRERO_ACAPULCO_DE_JUAREZ
HARYANA
SERGIPE
- Document recognition enhanced with new
Type
enum values:EXIT_ENTRY_PERMIT
MAINLAND_TRAVEL_PERMIT_TAIWAN
NBI_CLEARANCE
PROOF_OF_REGISTRATION
TEMPORARY_PROTECTION_PERMIT
- Data extraction improvements:
- Added
Sponsor
andBloodType
result fields toBlinkIdMultiSideRecognizer.Result
,BlinkIdSingleSideRecognizer.Result
andVizResult
- Added
March 12, 2024
v6.5.2
- Fixed issue with improper packaging.
March 12, 2024
v6.5.1
Lightweight builds
- This release contains multiple builds tailored for different devices' capabilities.
These builds are:
Full
Regular build that has barcode deblurring models. This build is loaded automatically on desktop devices.
Lightweight
Build without deblurring models. This build is loaded automatically on mobile devices. Deblurring models are usually not necessary due to better quality cameras compared to front-facing laptop cameras.
These builds each contain previous build variants present so far: basic, advanced with SIMD and advanced with multithreading making a total of 6 possible builds.
These builds can be overridden by using a new property on the settings objects WasmSDKLoadSettings.blinkIdVariant
:
export type BlinkIDVariant = "full" | "lightweight";
These can also be set on the UI component via the blinkIdVariant
prop.
Dynamic webassembly memory management
Depending on the device used, the SDK will allocate different amounts of memory on startup. This is primarily used as a mitigation mechanism for iOS's memory management, which often blocks webassembly memory growth.
Although it's not recommended, this can be overridden using WasmSDKLoadSettings.initialMemory
.
Other fixes:
- Fixed an issue where certain iOS devices would display a zoomed in preview.
- Improved scanning of Bolivia IDs by addressing cases where the expiration date is covered by a signature, allowing the completion of the scanning process.
February 13, 2024
v6.3.3
Device-specific optimized builds
This release contains multiple builds tailored for different devices' memory management capabilities.
These builds are:
Full
Regular build that has dynamic memory allocation and deblurring models. This build is loaded automatically on desktop devices.
Lightweight
Build with dynamic memory allocation and no deblurring models. This build is loaded on Android devices. Deblurring models are not necessary due to better quality cameras compared to front-facing laptop cameras.
Lightweight with fixed memory
Same as lightweight, but without dynamic memory allocation. This build is loaded on iOS devices which have issues working with dynamic memory allocation.
These builds each contain further subsets present so far: basic, advanced with SIMD and advanced with multithreading making a total of 9 possible builds.
These builds can be overriden by using a new property on the settings objects WasmSDKLoadSettings.wasmFlavor
:
enum WasmFlavor {
Full,
Lightweight,
LighweightWithFixedMemory
}
These can also be set on the UI component via the wasmFlavor
prop with the values Full
, Lightweight
or LighweightWithFixedMemory
.
Other fixes:
- fixed an issue where certain iOS devices would display a zoomed in preview.
January 25, 2024
v6.5.0
New features
- Improved the document side detection for US driver's licenses which reduces the possibility of capturing the wrong side of the document
Breaking changes
- It's now mandatory to scan the barcode when scanning the back side of US driver's licences using the BlinkID Multi Side Recognizer
Bugfixes
- Fixed a bug where settings weren't updated correctly when set via the UI component
- Fixed data matching issue in Guatamala Passport
January 8, 2024
v6.4.0
New features
-
Added new result member
cardRotation
toImageAnalysisResult
structure -
New
CardOrientation
status -NotAvailable
-
New
Region
enum values:- DISTRITO_FEDERAL
- MARANHAO
- MATO_GROSSO
- MINAS_GERAIS
- PARA
- PARANA
- PERNAMBUCO
- SANTA_CATARINA
-
New
Type
enum values:- CONSULAR_VOTER_ID
- TWIC_CARD
Added support for 8 new documents
- Bolivia - Paper Passport
- Brazil - Alien ID
- Brazil - Distrito Federal - Identity Card
- Brazil - Minas Gerais - Identity Card
- Cameroon - Polycarbonate Passport
- Costa Rica - Paper Passport
- UK - Proof of Age Card
- USA - Twic Card
Added support for 17 new documents in BETA
- Australia - Australian Capital Territory - Identity Card
- Australia - Queensland - Proof of Age Card
- Australia - Tasmania - Identity Card
- Australia - Western Australia - Identity Card
- Bahrain - Driver’s License
- Bahrain - Paper Passport
- Brazil - Maranhao - Identity Card
- Brazil - Mato Grosso - Identity Card
- Brazil - Para - Identity Card
- Brazil - Parana - Identity Card
- Brazil - Pernambuco - Identity Card
- Brazil - Santa Catarina - Identity Card
- Cameroon - Paper Passport
- Mexico - Quintana Roo, Benito Juarez - Driver’s License
- Mexico - Quintana Roo -Driver’s License
- Switzerland - Polycarbonate Passport
- UAE - Polycarbonate Passport
Added support for 14 new versions of already supported documents
- Brazil - Driver’s License
- Luxembourg - Identity Card
- North Macedonia - Identity Card
- Portugal - Driver’s License
- Slovakia - Identity Card
- Switzerland - Identity Card
- Switzerland - Driver’s License
- Turkey - Polycarbonate Passport
- Ukraine - Driver’s License
- USA - Arizona - Driver’s License
- USA - Arizona - Identity Card
- USA - Nebraska - Driver’s License
- USA - Pennsylvania - Identity Card
- USA - Virginia - Driver’s License
Added support for 2 new versions of already supported documents in BETA
- Iceland - Paper Passport
- Mexico - Consular ID
December 11, 2023
v6.3.2
Bugfix:
- Export missing
DocumentSide
December 4, 2023
v6.3.1
- Reintroduce missing lightweight build
November 28, 2023
v6.3.0
New features
- Changes to the
BlinkIdSingleSideRecognizer
andBlinkIdMultiSideRecognizer
:- add new fields inside
StringResult
:arabicLocation
- location coordinates of the arabic text orundefined
if arabic text is emptycyrillicLocation
- location coordinates of the cyrillic text orundefined
if cyrillic text is emptylatinLocation
- location coordinates of the latin text orundefined
if latin text is emptyarabicSide
- document side of the arabic text orundefined
if arabic text is emptycyrillicSide
- document side of the cyrillic text orundefined
if cyrillic text is emptylatinSide
- document side of the latin text orundefined
if latin text is empty
- new results in
Recognizer.Result
:faceImageLocation
faceImageSide
- add new fields inside
- Add new
Country
enum value -SCHENGEN_AREA
- And new
Type
enum value -IMMIGRANT_VISA
Bugfixes
- Improved scanning success rate and stability when using
BlinkIdMultiSideRecognizer
Minor breaking changes
- renamed and reordeded elements in the
DetectionStatus
enum
September 27, 2023
v6.2.1
Bugfixes
- fixed "payload corrupted" error when using online license key
- fixed integer overflow in BlinkID class filter implementation
August 29, 2023
v6.2.0
New features
- new and improved machine learning models for data extraction
- expanded support for arabic documents
- added isFilledByDomainKnowledge flag to Date and DateResult
- indicates that date is not extracted from image but filled based on our internal document knowledge
- added new setting additionalAnonymization
- enables custom anonymization for any field per country, region and type of document
- added new items to enums:
- Region:
- NORTHWEST_TERRITORIES (added item to enum, no document support for NORTHWEST_TERRITORIES yet)
- NUNAVUT (added item to enum, no document support for NUNAVUT yet)
- PRINCE_EDWARD_ISLAND
- Type:
- ASYLUM_REQUEST
- DRIVER_QUALIFICATION_CARD
- PROVISIONAL_DL
- REFUGEE_PASSPORT
- SPECIAL_ID
- UNIFORMED_SERVICES_ID
- FieldType:
- BloodType
- Sponsor
- Region:
Added support for 9 new documents
- Belarus - ID Card
- Guyana - ID Card
- Jamaica - Paper Passport
- Myanmar - Paper Passport
- Palestine - Paper Passport
- Saint Kitts and Nevis - Driving License
- Syria - ID Card
- Trinidad and Tobago - Paper Passport
- USA - Uniformed Services ID Card
Added support for 23 new documents in BETA
- Barbados - Driving License
- Belarus - Polycarbonate Passport
- Belarus - Residence Permit
- Belgium - Provisional Driving License
- Belgium - Special ID Card
- Bulgaria - Alien ID Card
- Bulgaria - Residence Permit
- Canada - New Brunswick - ID Card
- Canada - Prince Edward Island - Driving License
- Estonia - Polycarbonate Passport
- Germany - Driver Qualification Card
- Guyana - Driving License
- Kuwait - Paper Passport
- Lebanon - Paper Passport
- Liechtenstein - Driving License
- Malta - Paper Passport
- Malta - Polycarbonate Passport
- Moldova - Driving License
- Netherlands - Alien ID Card
- Oman - Paper Passport
- Peru - Alien ID Card
- Romania - Residence Permit
- UK - Asylum Request
Added support for 28 new versions of already supported documents
- Canada - British Columbia - Public Services Card
- Canada - British Columbia - Driving License
- Cyprus - Residence Permit
- Denmark - Polycarbonate Passport
- Germany - ID Card
- Italy - ID Card
- Ireland - Passport Card
- Malta - ID Card
- Montenegro - ID Card
- Montenegro - Polycarbonate Passport
- North Macedonia - ID Card
- North Macedonia - Polycarbonate Passport
- Norway - Driving License
- Norway - Residence Permit
- Norway - Polycarbonate Passport
- Philippines - Driving License
- Sweden - Polycarbonate Refugee Passport
- Sweden - Social Security Card
- UAE - Resident ID Card
- UK - Proof of Age Card
- USA - Arkansas - ID Card
- USA - Colorado - ID Card
- USA - Idaho - ID Card
- USA - Illinois - ID Card
- USA - New York - Driving License
- USA - New York - ID card
- USA - Pennsylvania - Driving License
- USA - Washington - Driving License
Added support for 3 new versions of already supported documents in BETA
- Denmark - Residence Permit
- Estonia - Residence Permit
- Latvia - Residence Permit
Bugfixes
- We've fixed the issue with reading the information on the back side of USA/Washington and USA/Vermont driver's license documents.
Platform-related SDK changes
- We've fixed a bug within our UI component when using RTL direction on Safari and Firefox browsers.
May 23, 2023
v6.1.0
New features
- New and improved machine learning models for data extraction
- Further improved barcode scanning (parsing for non-standard US DLs)
- Added anonymization for QR code on Dutch ID card
- Anonymization of religion field on Malaysian documents
- Device-to-device (D2D) feature - BETA (see more in UI improvements section below)
Added support for 9 new documents:
- Australia - Victoria - Proof of Age Card
- Brazil - Rio de Janeiro - ID Card
- Liechtenstein - ID Card
- Luxembourg - Passport
- Mozambique - ID Card
- Norway - ID Card
- Togo - ID Card
- USA - Wyoming - ID Card
- Zimbabwe - ID Card
Added support for 9 new documents in BETA:
- Barbados - ID Card
- Belgium - Passport
- Brazil - Rio Grande do Sul - ID Card
- Ireland - Residence Permit
- Japan - Residence Permit
- Lithuania - Residence Permit
- Saint Lucia - ID Card
- USA - New Hampshire - ID Card
- USA - South Dakota - ID Card
Added support for 34 new versions of already supported documents:
- Belgium - Resident ID Card
- Canada - Residence Permit
- Estonia - ID Card
- Finland - Alien ID Card
- Finland - ID Card
- Latvia - Alien ID Card
- Lithuania - ID Card
- Luxembourg - ID Card
- Malta - Residence Permit
- Netherlands - ID Card
- Netherlands - Residence Permit
- Poland - ID Card
- Sweden Residence Permit
- USA - Alabama - ID Card
- USA - Alaska - ID Card
- USA - Colorado - Driving License
- USA - Connecticut - ID Card
- USA - District of Colombia - Driving License
- USA - District of Colombia - ID Card
- USA - Iowa - ID Card
- USA - Kansas - ID Card
- USA - Louisiana - Driving License
- USA - Maine - Driving License
- USA - Maine - ID Card
- USA - Minnesota - ID Card
- USA - Mississippi - ID Card
- USA - Nevada - Driving License
- USA - New York - Driving License
- USA - South Carolina - ID Card
- USA - South Dakota - Driving License
- USA - Texas - ID Card
- USA - Vermont - Driving License
- USA - Washington - ID Card
- USA - Wisconsin - Driving License
Added support for 2 new versions of already supported documents in BETA:
- Poland - Residence Permit
- Portugal - Residence Permit
Changes to BlinkID VideoRecognizer
VideoRecognizer
has been refactored.
- This refactor has fixed some memory leak issues present in the previous implementation.
- Now uses
requestVideoFrameCallback
for queuing video frames in browsers which support it. - Errors are no longer treated as rejected promises, but are instead thrown.
this.videoElement
can no longer be changed or removed on the instance.- Implemented iOS browser security rules for video playback.
- Added a helper
this.getVideoElement
method for getting the reference to the video.
Breaking changes:
NotSupportedReason
has been removed andvideoRecognizerErrors
are used directly instead.onScanningDone
will no longer trigger on user cancellation.setClearTimeoutCallback
has been removed from theRecognizerRunner
as it's effectively the same thing asonFirstSideDone
— it triggers once any recognizer has anything recognized for multi-side recognizers, which is the same asRecognizerResultState.StageValid
.
Environmental changes
- TypeScript has been upgraded to 5.x .
- Packages are now built without regenerator runtime. TSconfig compile target is now
ES2020
.
UI improvements
Device-to-device (D2D) feature - BETA
-
The idea behind the device-to-device (D2D) feature is to provide extraction functionality when the initial device has technical limitations like no camera or no support for WebAssembly. Also, it can be used to direct users to use mobile instead of web cameras for a better scanning experience. Being optimized for conference calls, web cameras often struggle with a focus which causes the image of a document to have a high level of blur thus making it hard to read.
-
D2D can achieve these goals without the need to restart the existing process, such as form filling. When D2D is used, the scanning process is moved from a problematic device to another auxiliary device that has the necessary requirements or better camera quality. There, the scanning will take place, and the extracted results will be sent directly between the initial and auxiliary device browsers without sending images or result data to a Microblink server.
-
Please check out our D2D documentation to learn more about this fantastic feature.
BlinkID MultiSide image upload
- The UI component now supports image upload on both front and back sides, meaning that through our UI component, it is now possible to use the MultiSide recognizer as well.
New user instructions, help screens, that lead to successful scans
- Detailed instructions on how to scan identity documents, via an intro tutorial (onboarding) or floating-action-button (FAB) during scanning, leading to improved success rates in ID scanning and data extraction.
- New properties introduced:
allowHelpScreensFab
,allowHelpScreensOnboarding
,allowHelpScreensOnboardingPerpetuity
andhelpScreensTooltipPauseTimeout
.
- New properties introduced:
Camera selection toolbar
- We've introduced the default option of camera selection through a dropdown menu of all available device cameras.
- If only one camera is available, the camera selection dropdown will not be displayed.
- We've introduced icon/button for the option of mirroring the camera video feed.
- Camera device names are now reported as
"[Front/Back] facing camera [n]"
on Android devices.
General
- We've improved the responsiveness of our user interface accross different browsers for users on mobile devices.