BlinkID Web SDK v8003.0.0

What's new

• Simplified integration and scanning presets
  • Added ready-made settings builders for document video, document photo, standalone barcode, and BlinkID Verify capture workflows.
  • Presets can be configured for specific document scenarios, quality requirements, and capture environments.
  • The all-in-one @microblink/blinkid package now provides the high-level presetScanningSettingsBuilder option, removing the need to initialize BlinkID Core separately when using presets.
• Global barcode and document expansion
  • Upgraded the barcode and QR recognition engine for faster and more resilient recognition across 1D and 2D barcodes.
  • Added dedicated barcode and QR parsing for Argentina DNI and Philippines identity documents.
• Passport-only scanning experience
  • Added a dedicated passport-only UX mode that accepts passport booklets and guides users toward the data page.
  • Includes passport-specific onboarding, help content, illustrations, and scanning instructions.
• Help tooltip timing
  • Increased the default delay before automatically showing the help tooltip from 5 to 10 seconds, giving users more time to complete scanning without interruption.

Bug fixes

• Passport card scanning flow: Fixed an issue where the scanning workflow could occasionally skip the back side of passport cards.
• Single-image cropping: Resolved edge cases where document crop detection could fail or return inaccurate bounds for photo inputs.
• Centenarian date handling: Fixed two-digit birth-year rollover in MRZ and date parsing, ensuring correct age calculation for people aged 100 and older.

New document support

• Bahrain - Vehicle Ownership Certificate
• British Virgin Islands - DL
• British Virgin Islands - Passport
• British Virgin Islands - Rigid Passport
• China - DL
• Colombia - Consular ID
• Congo - ID
• Dominican Republic - Consular ID
• Dominican Republic - Residence Permit
• Ethiopia - Rigid Passport
• Fiji - Passport
• Honduras - Consular ID
• Hong Kong - DL
• Iraq - DL
• Iraq - Vehicle Registration
• Jordan - Rigid Passport
• Kazakhstan - DL
• Liechtenstein - Passport
• Liechtenstein - Rigid Passport
• Moldova - Resident ID
• Namibia - DL
• Niger - DL
• Northern Mariana Islands - DL
• Somalia - ID
• Suriname - Rigid Passport
• Syria - DL
• Syria - Resident ID
• Tajikistan - DL
• UAE - Golden Card
• Yemen - ID

New versions of supported documents

• China - DL
• Colombia - Passport
• Dominican Republic - DL
• Gambia - Passport
• Japan - Residence Permit
• Kyrgyzstan - DL
• Kyrgyzstan - ID
• Moldova - DL
• Moldova - Rigid Passport
• Paraguay - DL
• Tajikistan - Rigid Passport
• USA, Montana - DL
• USA, Montana - ID
• USA, Nebraska - DL
• USA, Nebraska - ID
• USA, Oklahoma - DL
• USA, Oklahoma - ID
• Virgin Islands of the United States - DL
• Virgin Islands of the United States - ID

New extracted fields

• documentAdditionalNumber is now returned as cardAccessNumber for:
  • Austria - ID
  • Austria - Residence Permit
  • Austria - Rigid Passport
  • Austria - Rigid Refugee Passport
  • Bulgaria - ID
  • Cameroon - Rigid Passport
  • Costa Rica - Rigid Passport
  • Croatia - ID
  • Croatia - Residence Permit
  • Cyprus - Residence Permit
  • Czechia - ID
  • Czechia - Residence Permit
  • Denmark - Residence Permit
  • Dominican Republic - ID
  • Ecuador - ID
  • Ecuador - Passport
  • Estonia - ID
  • Estonia - Residence Permit
  • Finland - Alien ID
  • Finland - ID
  • Finland - Residence Permit
  • Finland - Rigid Passport
  • France - ID
  • Gambia - ID
  • Georgia - ID
  • Georgia - Residence Permit
  • Georgia - Rigid Passport
  • Germany - ID
  • Germany - eID
  • Germany - Residence Permit
  • Greece - ID
  • Greece - Residence Permit
  • Haiti - Passport
  • Hungary - Residence Permit
  • Iceland - Passport
  • Ireland - Residence Permit
  • Italy - Residence Permit
  • Ivory Coast - ID
  • Kosovo - ID
  • Kosovo - Passport
  • Latvia - Alien ID
  • Latvia - ID
  • Latvia - Residence Permit
  • Liechtenstein - ID
  • Lithuania - ID
  • Lithuania - Residence Permit
  • Luxembourg - ID
  • Luxembourg - Residence Permit
  • Luxembourg - Rigid Passport
  • Malta - ID
  • Malta - Residence Permit
  • Moldova - ID
  • Montenegro - ID
  • Montenegro - Rigid Passport
  • Namibia - Passport
  • Netherlands - ID
  • Netherlands - Residence Permit
  • Netherlands - Rigid Passport
  • Norway - ID
  • Norway - Residence Permit
  • Norway - Rigid Passport
  • Peru - Minors ID
  • Poland - ID
  • Poland - Residence Permit
  • Portugal - ID
  • Portugal - Residence Permit
  • Romania - ID
  • Slovakia - ID
  • Slovakia - Residence Permit
  • Slovenia - Residence Permit
  • Spain - ID
  • Spain - Passport
  • Sweden - ID
  • Sweden - Residence Permit
  • Sweden - Social Security Card
  • Switzerland - Residence Permit
  • Uganda - Passport
• documentOptionalAdditionalNumber is now returned as cardAccessNumber for:
  • Bulgaria - Residence Permit
  • France - Residence Permit
  • Italy - ID
  • Peru - ID
  • Spain - Residence Permit
• documentAdditionalNumber is now returned as passportNumber for:
  • Zambia - Residence Permit
• Added parent information extraction through parentsInfo for:
  • Brazil - Alien ID
  • Brazil - DL
  • Brazil - Passport
• Added extraction of Cyrillic firstName, lastName, nationality, and sex for:
  • Kyrgyzstan - ID

API changes

Breaking changes

• The Country value "virgin-islands-british" has been renamed to "british-virgin-islands".

Update integrations that inspect DocumentClassInfo.country.id:

- result.documentClassInfo?.country?.id === "virgin-islands-british"
+ result.documentClassInfo?.country?.id === "british-virgin-islands"

Scanning preset builders

The initialized BlinkIdCore instance now provides:

• buildDocumentVideoSettings(useCase?)
• buildDocumentPhotoSettings(useCase?)
• buildStandaloneBarcodeSettings()
• buildVerifyCaptureSettings()

Each method returns complete session settings that can be passed to createScanningSession().

import { loadBlinkIdCore } from "@microblink/blinkid-core";

const blinkIdCore = await loadBlinkIdCore({
  licenseKey: "your-license-key",
});

const sessionSettings = await blinkIdCore.buildDocumentVideoSettings({
  scenario: "mrz-mandatory",
  quality: "high-accuracy",
  captureEnvironment: "stationary",
});

const scanningSession = await blinkIdCore.createScanningSession(sessionSettings);

The high-level createBlinkId() API exposes the same presets through presetScanningSettingsBuilder:

import { createBlinkId } from "@microblink/blinkid";

const blinkId = await createBlinkId({
  licenseKey: "your-license-key",
  presetScanningSettingsBuilder: (presetBuilder) =>
    presetBuilder.buildDocumentVideoSettings({
      scenario: "mrz-mandatory",
      quality: "high-accuracy",
      captureEnvironment: "stationary",
    }),
});

presetScanningSettingsBuilder and manually supplied scanningSettings and scanningMode are mutually exclusive configuration approaches.

New preset types

• DocumentVideoUseCase
  • scenario: DocumentScenario; defaults to "general"
  • quality: VideoQualityProfile; defaults to "balanced"
  • captureEnvironment: VideoCaptureEnvironment; defaults to "hand-held"
• DocumentPhotoUseCase
  • scenario: DocumentScenario; defaults to "general"
  • quality: PhotoQualityProfile; defaults to "balanced"

New preset values

• DocumentScenario
  • "general": General-purpose document scanning.
  • "mrz-mandatory": Requires an MRZ while keeping VIZ and barcode extraction enabled.
  • "mrz-only": Enables only MRZ extraction and configures a single-side scan.
  • "barcode-only": Extracts a barcode from a detected document while disabling VIZ and MRZ extraction. Document detection remains enabled, unlike standalone barcode scanning.
• VideoQualityProfile
  • "balanced"
  • "high-speed"
  • "high-accuracy"
  • "permissive"
• VideoCaptureEnvironment
  • "hand-held"
  • "stationary"
• PhotoQualityProfile
  • "balanced"
  • "high-accuracy"
  • "permissive"

New result fields

The following fields were added to BlinkIdScanningResult and VizResult:

• vehicleNumber
• passportNumber
• trafficParticipantNumber

The corresponding values were also added to FieldType.

New classification values

Added to DocumentType:

• "specified-residence-card"
• "golden-card"
• "vehicle-ownership-certificate"
• "byid-card"

Added to Region:

• "northern-ireland"

Web UX updates

Passport-only mode

Enable the passport-specific scanning experience independently through uxManagerOptions:

import { createBlinkId } from "@microblink/blinkid";

const blinkId = await createBlinkId({
  licenseKey: "your-license-key",
  uxManagerOptions: {
    enablePassportOnlyExtractionMode: true,
  },
});

This mode filters out non-passport documents and provides dedicated onboarding, help screens, feedback messages, and scanning instructions for passport booklets.

Help tooltip

The help tooltip now appears automatically after 10 seconds instead of 5 seconds. The delay remains configurable through feedbackUiOptions.helpTooltipShowDelay; set it to null to disable automatic display.