Skip to main content

4000.0.0

This release bundles the Verify 4000.0.0 API and the BlinkID 8001.0.0 extraction engine.

API changes​

Migration guide

If you're moving from the standalone self-hosted extraction API, see Migrate from self-hosted extraction API.

This release introduces the v3 endpoint, /api/v3/verify. Both the request and the response have changed significantly, and numerous fields have been renamed. The most important changes are:

  • All requests are now multipart-only. Image URLs and base64-encoded image strings are no longer accepted.
  • The recommended outcome is now called verdict in the response.
  • The response now contains a failedChecks array that lists the checks the document failed.
  • Match levels are now called sensitivity.
  • Checks that take a sensitivity now report passesAtOrBelowSensitivity, the highest sensitivity at which they would still pass.
  • Individual image quality checks are consolidated under a single imageAssessment.imageQualityCheck result. BlinkID and Verify now use the same module.
  • Certainty levels are removed.
  • The response now contains a pipeline object with a separate status for the extraction and verification stages.
  • Checks are renamed for consistency, and enum-like values are now open enums. The schema lists the values known today, but new values can be added without a breaking change, so handle unrecognized values rather than rejecting them.
  • Invalid requests now return structured validation errors that name the offending parameter path and the reason it was rejected.
  • The default portraitForgerySensitivity is re-tuned to Level5.
  • Messages are revised.

For the rest of the extraction engine changes, see the BlinkID 8001.0.0 release notes.

Deployment​

The deployment ships as a new image, on our own container registry rather than Dockerhub:

docker pull us-docker.pkg.dev/document-verification-public/on-prem/core:4000.0.0

Your existing license continues to work with the new image.

Image tags follow the epoch versioning scheme, {EPOCH * 1000 + MAJOR}.MINOR.PATCH. Since the previous Verify image tag was 3.22.3, the new image tag 4000.0.0 rather than 4.0.0.

On-prem-specific changes​

  • The image exposes the extraction endpoints /api/v3/extract and /api/v3/extract-barcode alongside /api/v3/verify. These are not available in the Verify cloud deployment.
  • No consent object is required. Consent is a cloud-only requirement.
  • There is no per-request authentication. Licensing happens at deployment time, through environment variables.
  • Every response carries additional runtime fields: workerIndex, workerCount, licenseExpiry, licenseId, and executionId.

Migrating from Verify v2​

For the API changes between v2 and v3, see Migrate to Verify v3. The notes below are specific to on-prem deployments.

New image​

The image now bundles the standalone self-hosted extraction API, and has changed its name. See Deployment for the new image.

The new GitHub repo with the Helm charts and other deployment-related information is here.

git clone https://github.com/microblink/on-prem-ops.git

Licensing​

Your existing licenses and license environment variables are unchanged.

Single image​

If you're still on a release earlier than 3.19.0, you're moving from the multi-service stack at the same time. Remove the old conf/doc-ver-api, conf/doc-ver-runner, and conf/bundle-doc-ver directories as part of that move. See On-prem deployment for how the current image is deployed.

The container reports its own sizing in the runtime object of every response (workerCount, inflightLimit, cpus, ram, and others), which is useful when you are capacity planning against v2 numbers.

New response codes​

The new 503, 413, and 429 behavior described in Migrate to Verify v3 applies to on-prem deployments too.

Extraction endpoints​

V2 was verification-only. V3 adds an extraction-only endpoint, POST /api/v3/extract, which runs the extraction half of the pipeline and skips verification.

It's the right endpoint if you only need the data off the document and don't need a verdict. The extraction results are identical in shape to the extraction object of a verification response, so you can move between the two endpoints without changing your parsing.

The extraction endpoint accepts only the extraction and imageAssessment sections of the configuration; verification settings are rejected. There is also a barcode-only endpoint, POST /api/v3/extract-barcode.

If you are coming to this endpoint from the standalone self-hosted extraction API rather than from Verify v2, see Migrate from self-hosted extraction API, which covers that migration in full.

Other changes​

  • Verification latency is significantly lower, on both the v2 and v3 endpoints.

Bug fixes​

  • Fixed an issue where barcode read checks for Tennessee 2018 and North Carolina 2008 Under 21 driver's licenses returned NotPerformed.
  • Fixed an issue where NONE sometimes appeared in the firstName extraction result.

New documents support​

  • Bailiwick Of Jersey - Driver's License
  • Bailiwick Of Jersey - Paper Passport
  • Bailiwick Of Jersey - Polycarbonate Passport
  • Botswana - Driver's License
  • Brunei - Polycarbonate Passport
  • Democratic Republic Of The Congo - Polycarbonate Passport
  • Dominican Republic - Polycarbonate Passport
  • Eswatini - Driver's License
  • Gambia - Driver's License
  • Georgia - Residence Permit
  • Iceland - Identity Card
  • Iceland - Residence Permit
  • Japan - Specified Residence Card
  • Liechtenstein - Residence Permit
  • Liechtenstein - Resident ID
  • Mali - Polycarbonate Passport
  • Mauritania - Resident ID
  • Monaco - Identity Card
  • Monaco - Residence Permit
  • Nepal - Identity Card
  • Palestine - Identity Card
  • San Marino - Identity Card
  • Sudan - Driver's License
  • UK, Northern Ireland - Voter ID
  • USA, Arkansas - Medical Marijuana ID
  • USA, Massachusetts - Medical Marijuana ID
  • USA, Michigan - Medical Marijuana ID
  • USA, New Jersey - Medical Marijuana ID
  • Zambia - Residence Permit

New document versions for supported documents​

  • Bolivia - Driver's License
  • Burkina Faso - Identity Card
  • Central African Republic - Paper Passport
  • Estonia - Identity Card
  • Dominican Republic - Identity Card
  • Guyana - Identity Card
  • Israel - Identity Card
  • Luxembourg - Polycarbonate Passport
  • Mexico, Baja California - Driver's License
  • Mexico, Hidalgo - Driver's License
  • Oman - Identity Card
  • Oman - Resident ID
  • Uruguay - Identity Card
  • USA, Mississippi - Identity Card
  • USA, Nebraska - Driver's License
  • USA, Nebraska - Identity Card
  • USA, North Carolina - Identity Card
  • USA, Oklahoma - Driver's License
  • USA, Oklahoma - Identity Card
  • USA, Texas - Weapon Permit