Introduction¶
IMPORTANT NOTE
Major versions represent a big change from the previous major version, providing more capabilities and potential. At the same time, moving from a major version means a break in backward compatibility that must be managed using the provided migration guide. Please make sure to perform proper tests in development environments to ensure that everything is working as expected.
Differential features and improvements of WC SDKs
- Greatly improved browser's compatibility
- Webviews support available
- Fully customizable UI with configuration and CSS Parts available
- Improved detection and quality of the captures generated
- Improved and organized configuration
- Optimization and reduction of memory requirements
- Reduced weight of the SDKs
Document SDK is a JS library that allows detecting and capturing documents, using advanced detection techniques. This allows to carry out a document verification step in the context of the identity verification process offered by Veridas. Document SDK supports the identification of different types of documents such as ID Card, Driving License, Residence Permit, or Passport.
Document type¶
The SDK allows you to capture a large number of documents from all over the world. To see the complete list you can go to the following link: Documents. Depending on the type of document to be detected, Document SDK will ask the user to capture only the front part of the document (observe) or both sides (observe and reverse).
Camera¶
Document SDK, also refering in this documentation as VDDocument, takes into account the type of device being used and attempts to launch the camera (front facing or rear) that will provide the user with the best experience:
- Rear camera is used on mobile devices (smartphones, tablets…)
- Front camera is used on computers (desktops, laptops…)
To improve user experience, VDDocument attempts to capture images of the document automatically, by having the user center each side in a frame. VDDocument uses several algorithms to detect a document in the camera’s field of vision, and snaps the photo without need for further user action. Also, the user can take a photo manually by touching/clicking on the button when the manual capture option is enabled.
The camera attempts to start at Full HD (1080p), but lower resolutions are intended whether the devices are unable to support the optimal one.
The photo is taken in .JPG format, being a 1080p capture about 500KB on size.
Specifications¶
The following permission is required for the framework to work:
- Camera: By default, the SDK launch Back camera on all devices (smartphones, tablets, desktops, laptops...), but you can choose the camera you want to use with the selectCamera property. With this property you can use the Front camera, interesting to capture documents.
Browser compatibility¶
The SDK supports the following devices and browsers:
Desktop Browsers¶
| Browser Name | Minimum version | Current version |
|---|---|---|
| Chrome | 83 | 136 |
| Firefox | 132 | 138 |
| Safari | 15.4 | 18.3 |
| Opera | 69 | 118 |
| Edge | 83 | 134 |
Mobile and Tablets Browsers¶
| Browser Name | Platform | Minimum version | Current version |
|---|---|---|---|
| Chrome | Android | 135 | 135 |
| Firefox | Android | 132 | 138 |
| Edge | Android | 83 | 135 |
| Opera Mobile | Android | 80 | 89 |
| Samsung Internet | Android | 13.0 | 27 |
| Chrome | iOS | 135 | 136 |
| Firefox | iOS | 132 | 130 |
| Edge | iOS | 135 | 135 |
| Opera Mobile | iOS | 80 | 5.5 |
| Safari | iOS | 15.4 | 18.4 |
Browser APIs¶
ResizeObserver GetUserMedia WebAssembly
Webview compatibility¶
The SDK supports the following webviews:
| Webview Name | iOS | Android |
|---|---|---|
| Yes | Yes | |
| Yes | Yes | |
| WKWebView native iOS webview | Yes | - |
| SFSafariViewController native iOS webview | Yes | - |
| Android WebView native Android webview | - | Yes |
| Chrome Custom Tabs native Android webview | - | Yes |
| Trusted Web Activity native Android webview | - | Yes |
The SDK is compatible with Meta webviews, i.e. you can run it in Facebook and Instagram apps for Android and iOS. We also support native webviews for iOS and Android. However, we do not guarantee full compatibility or functionality with webviews from applications built using other frameworks, including hybrid frameworks, the performance and behaviour may vary.
Minimum recommended requirements for devices¶
Veridas recommends the following minimum requirements:
| Android devices | Minimum recommended requirement |
|---|---|
| Camera resolution | At least 1080p (Full HD) |
| RAM | At least 4GB, 6GB preferred |
| Processor (CPU) | Mid-range and recent |
| Screen resolution | At least 1080p (Full HD) |
| iOS devices | Minimum recommended requirement |
|---|---|
| Device model | From iPhone 11 onwards |
Please note that devices below these minimums may not function properly. Additionally, it's important to emphasize that while meeting these minimum specifications ensures functionality, exceeding them does not guarantee impeccable performance in all cases.
Dependencies¶
| File Name | Size file |
|---|---|
| vd-document.umd.js | 1.99 MB |
| vd-document.es.js | 1.99 MB |
| images | 1.42 MB |
| OpenCV | 1.44 MB |
| cv.worker.js | 1.80 KB |