Release Notes

Contains release notes from both:

WebCapture SDK - Face Autocapture and Face Liveness
WebCapture SDK - Identity Document Autocapture includes passport, identity card, and driver's license

March 28, 2025 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Overall performance improvement
Activate age estimation for the current liveness session

December 20, 2024 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Overall performance improvement
Added progress bar before starting the liveness process : trackingInfo.downloadProgress

November, 22th : Identity Document Capture

What's New

Support of docType PASSPORT without specifying countryCode in session creation
Added new supported country documents

September, 27th : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Minimal iOS Safari support : version 15+
New browsers support on iOS :
- Edge 125+
- Chrome 120+
- Firefox 129+
- Opera Touch 5+
New browsers support on Android :
- Edge 127+
Otherwise, on other operating systems :
- Chrome 60+
- Firefox 79+
- Opera 57+
- Edge 92+
Adding a progress bar to display the upload progress of results being transmitted from the device to the backend.

September, 27th : Identity Document Capture

What's New

Manual Capture
Document status update: return document status FAILED instead of TIMEOUT when timeout occurs and pdf417 or mrz are found but not well decoding
Minimal iOS Safari support : version 15+
New browser support on iOS :
- Edge 125+
- Chrome 120+
- Firefox 129+
- Opera Touch 5+
New browsers support on Android :
- Edge 127+
Otherwise, on other operating systems :
- Chrome 60+
- Firefox 79+
- Opera 57+
Manual capture support
- startManualCapture: starts a manual capture of a document side
- pushImage: pushes the image of the document side captured manually

June 21, 2024 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Various improvements that ease internal deployment

June 21, 2024 : Identity Document Capture

What's New

Various improvements that ease internal deployment

March 22, 2024 : WebCapture SDK - Face Autocapture and Face Liveness

Recommendation

For deploying bioserver-video, we recommend utilizing a server that is CPU-focused. An AWS server with specifications similar to a c5.2xlarge is advised. This setup is ideal for achieving elasticity.

What's New

Overall performance improvement
Back pressure mechanism has been implemented. On session creation a 429 HTTP response can be raised if server is overloaded.

Fixes

Improvement frames management on redis regarding internal fraud detection which cause latency on production environment

December 15, 2023 : WebCapture SDK - Face Autocapture and Face Liveness

Recommendation

Liveness mode LIVENESS_PASSIVE_VIDEO is recommended
Security level HIGH is recommended

What's New

Minimal iOS Safari support : version 14+

December 15, 2023 : Identity Document Capture

Recommendation

JS API order recommendations : initDocCapture API should be called before getDeviceStream API to improve 4K phone capture coverage
New feedback to take into account during autocapture : mrzDecoding

What's New

Minimal iOS Safari support : version 14+
Support Brave browser
With 4K resolution support on iphones, best images can now reach a size up to 2 MB
Improvement of MRZ and PDF417 extraction

October 6, 2023 : WebCapture SDK - Face Autocapture and Face Liveness

Recommendation

Liveness mode LIVENESS_PASSIVE_VIDEO is recommended
Security level HIGH is recommended

What's New

Passive Video - passrate improvement

September 25, 2023 : Identity Document Capture

What's New

Enhanced document capture with improved rectangle detection and superior blur detection capabilities.
Continued focus on ensuring Abroadia document auto-capture compliancy.

July 27, 2023 : WebCapture SDK - Face Autocapture and Face Liveness

Recommendation

Liveness mode LIVENESS_PASSIVE_VIDEO is recommended
Security level HIGH is recommended

What's New

Injection fraud detection - passrate improvement

July 05, 2023 : Identity Document Capture

What's New

Minimal iOS Safari support : version 12+
Documentation on Rest APIs is no longer available
Use case Capture both sides of an identity card from a known issuing country (web SDK workflow) description is no longer available

May 17, 2023 : WebCapture SDK - Face Autocapture and Face Liveness

Recommendation

Liveness mode LIVENESS_PASSIVE_VIDEO is recommended
Security level HIGH is recommended

What's New

Liveness detection to enhance fraud detection and liveness verification

April 05, 2023 : WebCapture SDK - Face Autocapture and Face Liveness

Recommendation

Liveness mode LIVENESS_PASSIVE_VIDEO is recommended
Security level HIGH is recommended

What's New

Device model characteristics are available when getting liveness result

Notes : For iPhone devices, a group of device models separated by comma can be returned such as iPhone SE 2022,iPhone SE 2020,iPhone 8,iPhone 7,iPhone 6s,iPhone 6

Liveness detection to enhance fraud detection and liveness verification
Support for error code 503 on errorFn() to reject a transaction if server is overloaded
Minimal iOS Safari support : version 12+
Input field identityId of BioserverVideo.initFaceCaptureClient() is now deprecated

March 23, 2023 : Identity Document Capture

What's New

Device model characteristics are available when getting capture result Notes :

For iPhone devices, a group of device models separated by comma can be returned such as iPhone SE 2022,iPhone SE 2020,iPhone 8,iPhone 7,iPhone 6s,iPhone 6

February 1, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

COTS update for security compliance

Notes :

If devtool is opened during the autocapture - the request will be rejected on purpose

Fixes

Add the possibility to perform the face autocapture integration within an iFrame

January 06, 2023 : Identity Document Capture

What's New

Add Iphone 14 pro & Iphone 14 pro max support

Fixes

After a duplicateRule failure, it was not possible to get success on retry on demo-server
Support of elasticache with tls disabled

December 9, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification
High liveness terminology is deprecated and replaced by active liveness. Backward compatibility is assured.

Notes :

All REST APIs support LIVENESS_ACTIVE enum instead of supports LIVENESS_HIGH.
Under the /init-liveness-session REST API, use LIVENESS_ACTIVE as livenessMode parameter.
The trackingFn JS callback was updated. The trackingInfo parameter returns the parameter livenessActive (same content as livenessHigh parameter).
The UI extension JS library was updated in order to consider active liveness terminology. Use resetLivenessActiveGraphics and updateLivenessActiveGraphics methods.

Add monitoring API GET /video-server/v2/capabilities in the documentation
Monitoring API returns an HTTP code 500 if the service is not functional

October 3, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification
LIVENESS_MEDIUM and NO_LIVENESS are officially not supported anymore
Remove WebRTC and Coturn dependencies for active liveness
rtcConfigurationPath from BioserverVideo.initFaceCaptureClient() is deprecated

Fixes

iOS 15.7 support

September 5, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification

August 31, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

Fixes

Fixed showChallengeInstruction callback of web SDK as optional callback

August 8, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification

July 5, 2022 : Identity Document Capture

What's New

Liveness detection to enhance fraud detection and liveness verification
Automatic selection of the camera resolution
Enrich the diagnostic of a capture : decoding, missingRules, duplicatedRules
Ability to capture optional rules
Ability to detect if the same side is captured on the French and Argentinian ID card

Fixes

Fix random freeze during auto-capture with an iphone

June 15, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification

Fixes

Fixed Xiaomi MI9T devices which are systematically rejected

May 24, 2022 : Identity Document Capture

Fixes

Fixed blurriness during auto-capture with iphone 13 PRO

May 10, 2022 : Identity Document Capture

What's New

Increased default latency timings for better user experience
Improvement of back camera selection when several available within a webview integration

May 3, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification

Fixes

Fixed visual artifacts appearing at the end of the liveness capture
Increased default latency timings for better user experience

Limitations

Pixel 3 & 4 no longer works on high liveness

April 4, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification

March 31, 2022 : Identity Document Capture

What's New

Supports Firefox version 68+
Ability to design a progress bar during data transmission.

Note : The callback docCaptureOptions.trackingFn() (passed as parameter to DocserverVideo.initDocCaptureClient() method) has a new field: uploadProgress.

JavaScript
1const docCaptureOptions = {
2        [...]
3        trackingFn: (trackingInfo) => {
4            displayInstructionsToUser(trackingInfo);
5        }
6    };
7client = await DocserverVideo.initDocCaptureClient(docCaptureOptions);

Array field mrz added in documentInfo object

Limitations

Huawei browser is not anymore authorized
rawData` field format changes, in case the barcode of a card is decoded

March 28, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification

March 4, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification
Huawei browser version 12+ support. For more details refer to the below function :

JavaScript
1BioserverEnvironment.detection()

Limitations

Pixel 3 & 4 no longer works on high liveness

February 9, 2022 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification

December 17, 2021 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification

Limitations

Pixel 3 & 4 no longer works on high liveness

December 10, 2021 : Identity Document Capture

Fixes

When creating a document session without issuing country, API should not return any issuing country (as the input instead of the issuing country UNKNOW)

November 9, 2021 : Identity Document Capture

What's New

Bug fix for NativeSDK when processing one side workflow

Fixes

Unable to process a passport workflow within nativeSDK integration

November 4, 2021 : Identity Document Capture

What's New

WebDocServer is now FIPS 140-2 compliance (Internal COTS upgrades & Node 16 with FIPS compatible openssl)
Upgraded the OCR/MRZ capture library

Fixes

Unable to do the liveness high with a Pixel 3 with the last upgrade and chrome

October 10, 2021 : Identity Document Capture

What's New

Several fixes that improves the user experience of enduser
Redis 5 is no longer supported. Please migration to Redis 6
S3 data storage must be enabled by default (AWS or Minio server). Data purging and data encryption is mandatory.
SSL 2, 3 and TLS 1.0, 1.1 are now disabled

Fixes

Fix Freeze and crash on iPhone iOS.15.x
WebDoc is no more capturing random images too quickly in order to process document extraction
Block unsupported browser Edge because of several incompatibilities
Fix crashes of the browser because of two recorders trying to start
Remove diagostic field from API response in case capture status is DONE

September 07, 2021: Identity Document Capture

What's New

The identity document is no longer captured side by side. The new workflow captures the identity document with both sides in the same video steam. The workflow 'side by side' still exists but is now deprecated.
Ability to record a video of the document capture for adjudication and proof purposes
Internal service permits native SDK to send data (images/video) to the back end through a secure channel

July 16, 2021 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification
Deprecated old security levels; use instead LOW, MEDIUM, HIGH

Fixes

Unable to do the liveness high with a Pixel 3 with the last upgrade and chrome

July 07, 2021: Identity Document Capture

What's New

New monitoring API GetHealthCheck: /v2/healthcheck
documentId property (RFU) added in GetDocSessionCaptures API response: /v1/document-sessions/{id}/captures

Fixes

Browser could be blocked when capturing with Google Pixel 3 phone
Black screen issue on specific devices: SM-A105, SM-A920, SM-A202, LG-H870, LG-H873
Processing time reduced for MRZ rule

June 10, 2021 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Fixed default user access blocking time if too many failed liveness tries are detected

May 21, 2021 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification
Liveness pass rate improvement

Fixes

The field, fakeWebcam, (previously optional) is now officially deprecated in getLivenessChallengeResult API

April 9, 2021 : WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification
Ability to override liveness parameters via a multi-tenancy configuration
Ability to record the video stream while processing a liveness verification via a multi-tenancy configuration

Fixes

Support of Chrome 89
Support of Google Pixel 3 device model

Important Notes

Video recording

Once video is stored, it is possible to retrieve it directly via an S3 endpoint. S3 endpoint building is based on videoStorage from /liveness-challenge-result REST API.

Rest
1GET /bioserver-app/v2/bio-sessions/{bioSessionId}/liveness-challenge-result/{livenessMode}
2
3Response :
4{
5  livenessStatus: "SUCCESS",
6  […]
7  videoStorage: {
8    region: '<region>',
9    bucketName: '<bucketname>',
10    key: '<tenant-id>/<session-id>.<content-type-extention>',
11    hash: '<hash>',
12    hashAlgorithm: 'SHA256',
13    contentType: '<content-type>'
14  }
15}

S3 access is limited.

Monitoring / HealthCheck

API https://[URL_MAIN_PART]/bioserver-app/v2/monitor is deprecated and replaced by https://[URL_MAIN_PART]/bioserver-app/v2/capabilities

March 25, 2021: Identity Document Autocapture

Fixes

Capture not permitted if document is too far from the camera; user receives a message to move the camera closer
Fix compatibility with devices: Samsung A9, Samsung A20E, Samsung A10, Google Pixel 3
Add the ability to capture both front and back side of the Polish driver's license by default

March 10, 2021: WebCapture SDK - Face Autocapture and Face Liveness

Fixes

Fix incompatibility between Chrome 89 (stable version from March 2021, 2nd) and liveness workflows (medium and high)

March 10, 2021: Identity Document Autocapture

Fixes

Document capture improvement

February 15, 2021: Identity Document Autocapture

What's New

Support of 'IDENTITY_CARD' as input for identity cards in addition to 'ID_CARD'.
Added v2 API on /countries-doc-types to display 'IDENTITY_CARD' as the identity card type instead of 'ID_CARD’ (v1)
Support of sides as input in addition to the country code and document type when initializing the session
OCR reading improvement
Support of more document models

Important Notes

API /v1/countries-doc-types is now deprecated, use API /v2/countries-doc-types; this endpoint returns 'IDENTITY_CARD' instead of 'ID_CARD' (as compared to v1)
API /v1/countries-doc-types/$COUNTRY_CODE is now deprecated, use API /v2/countries-doc-types; this endpoint returns 'IDENTITY_CARD' instead of 'ID_CARD' (as compared to v1)
API /v1/document-sessions now accepts sides when the country code and document type are provided

February 09, 2021: WebCapture SDK - Face Autocapture and Face Liveness

Fixes

Fix issue for wrong integration when fraud detection is disabled

January 22, 2021: WebCapture SDK - Face Autocapture and Face Liveness

What's New

Liveness detection to enhance fraud detection and liveness verification
User access will block a new liveness verification if too many failed liveness tries are detected

Fixes

Fixed zoom effect causing integration difficulties with several captures in the same page (see Important Notes below)

Important Notes

Zoom Effect Fix Impact

JavaScript function BioserverVideo.getDeviceStream() is now deprecated; use instead BioserverVideo.getMediaStream().
The function BioserverVideo.getMediaStream() does the same thing as getDeviceStream(), but requires a new parameter videoId, which is the videoHTMLElement identifier
Function BioserverVideo.getDeviceStream() is now deprecated; use instead BioserverVideo.getMediaStream()

Sample Code

JavaScript
1{
2// HTML Code: <video id="my-video-player" autoplay></video>
3// Use of new function
4    client = await BioserverVideo.getMediaStream({videoId: 'my-video-player', video: {deviceId: 321}});
5// instead of BioserverVideo.getDeviceStream({video:{deviceId:321}}); that is deprecated but still working
6}

User Access Blocking Impact

When a user is blocked, the server returns a 429 message error code under the errorFn callback from integrator. Here is an example of the error that JSON sent to the integrator:

HTTP
1{
2  code: 429,
3  error: "Maximum captures attempt reached",
4  unlockDateTime: "2021-01-14T14:30:05.643Z"
5}

This response can be returned by the server on two API calls from the client: initFaceCaptureClientandstart
initFaceCaptureClient

The initFaceCaptureClientcall creates the connection with the backend and sends user information for validation. The call can take a bit longer than before, so for proper integration add a loading page on the UX (see our sample-app integration).

Sample Code

The snippet below is an example of the client integration of FP functionality:

JavaScript
1const faceCaptureOptions = {
2    wspath: wspath,
3    bioserverVideoUrl: bioserverVideoUrl,
4    rtcConfigurationPath: rtcConfigurationPath,
5    showChallengeInstruction: (challengeInstruction) => {
6      // custom code
7    },    
8    showChallengeResult: async () => { 
9        // custom code 
10    },
11    trackingFn: () => { 
12        // custom code 
13    },
14    errorFn: (error) => {
15      if (error.code && error.code === 429) { //  user is blocked
16        // we reset the session when we finished the liveness check real session
17        resetLivenessDesign();
18        document.querySelectorAll('.step').forEach((step) => step.classList.add('d-none'));
19
20        // the lock counter is displayed to the user
21        userBlockInterval(new Date(error.unlockDateTime));
22        document.querySelector('#step-liveness-fp-block').classList.remove('d-none');
23      }
24      // custom code  
25    }
26};
27client = await BioserverVideo.initFaceCaptureClient(faceCaptureOptions);
28client.start(stream);
29// both previous calls can raise the 429 error message

December 18, 2020: WebCapture SDK - Face Autocapture and Face Liveness

What's New

Added zoom effect on user video to hide corners; in HIGH LIVENESS mode, it means dots are not hidden when the user's face is too far or too close from their screen
Liveness detection to enhance fraud detection and liveness verification~~~~

Fixes

Start capture rework

Important Notes

Start Capture Rework

The client.start() function is deprecated. It is replaced by client.startCapture().

Sample Code

JavaScript
1client = await BioserverVideo.initFaceCaptureClient(faceCaptureOptions);
2client.startCapture({ stream: videoStream }); // new way to start capture
3// instead of client.start(videoStream) that is deprecated but still working

November 05, 2020: Identity Document Autocapture

Fixes

Fix capture using devices with multiple cameras
Block capture if device is unsupported

Important Notes

Environment Detection

Now DocserverEnvironment.detection() is asynchronous and takes a callback parameter that is executed when the check is done.

Previous Sample Code for Synchronous

JavaScript
1var env = DocserverEnvironment.detection(); // << synchronous check
2 
3if (!env.envDetected) { console.log("env detection failed with error:" + env.message); return }
4var envOS = env.envDetected.os;
5if (!envOs.isSupported) { console.log("env detection error: ", env.message , "Supported OS list", envOs.supportedList); return }
6var envBrowser = env.envDetected.browser;
7if (!envBrowser.isSupported) { console.log("env detection error: ", env.message , "Supported Browsers", envBrowser.supportedList); return }

New Sample Code for Asynchronous

JavaScript
1function envCheckCb(env) {
2  if (!env.envDetected) { console.log("env detection failed with error:" + env.message); return }
3  var envOS = env.envDetected.os;
4  if (!envOs.isSupported) { console.log("env detection error: ", env.message , "Supported OS list", envOs.supportedList); return }
5  var envBrowser = env.envDetected.browser;
6  if (!envBrowser.isSupported) { console.log("env detection error: ", env.message , "Supported Browsers", envBrowser.supportedList); return }
7}
8 
9DocserverEnvironment.detection(true, envCheckCb); // << async check with new callback paramif (!envBrowser.isSupported) { console.log("env detection error: ", env.message , "Supported Browsers", envBrowser.supportedList); return }

October 28, 2020: WebCapture SDK - Face Autocapture and Face Liveness

Fixes

On a high liveness mode, after a liveness fraud, there was a 20 seconds freeze. This freeze has been removed.