You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1.Definte a custom path to load files (if different than root):
59
+
1.Define a custom path to load files (if different than root):
60
60
61
61
const acuantConfig = {
62
62
path: "/custom/path/to/sdk/"
@@ -69,87 +69,19 @@ The SDK includes the following modules:
69
69
//sdk has been loaded;
70
70
}
71
71
72
-
----------
73
-
## AcuantPassiveLiveness
74
-
75
-
Acuant recommends using the **LiveAssessment** property rather than the score) to evaluate response. **AcuantPassiveLiveness.startSelfieCapture** will return a rescaled image.
76
-
77
-
Follow these recommendations to effectively process an image for passive liveness:
78
-
#### Image requirements
79
-
-**Height**: minimum 480 pixels; recommended 720 or 1080 pixels
80
-
-**Compression**: Image compression is not recommended (JPEG 70 level or above is acceptable). For best results, use uncompressed images.
81
-
82
-
#### Face requirements
83
-
- Out-of-plane rotation: Face pitch and yaw angle: from -20 to 20 degrees +/-3 degrees
84
-
- In-plane rotation: Face roll angle: from -30 to 30 degrees +/- 3 degrees
85
-
- Pupillary distance: Minimum distance between the eyes 90 +/- 5 pixels
86
-
- Face size: Minimum 200 pixels in either dimension
87
-
- Faces per image: 1
88
-
- Sunglasses: Must be removed
89
-
90
-
#### Capture requirements
91
-
The following may significantly increase errors or false results:
92
-
93
-
- Using a motion blur effect
94
-
- Texture filtering
95
-
- A spotlight on the face and nearest surroundings
96
-
- An environment with poor lighting or colored light
97
-
98
-
**Note** The use of fish-eye lenses is not supported by this API.
99
-
100
-
### Start face capture and send Passive Liveness request
Live capture offers guidance to the user to position documents and initiates autocapture when detected. This feature is present only when WebRTC is available in the browser.
76
+
145
77
**Supported browsers**
146
78
147
79
The JavaScript Web SDK supports the following web browsers for live capture of ID documents:
148
80
149
81
-**Android**: Chrome
150
82
-**iOS**: Safari, with iOS version <= 13.0
151
83
152
-
For other browsers, regular HTML capture is used.
84
+
For other browsers that do not support WebRTC, the device's camera app (manual capture) is used.
153
85
154
86
**Camera Preview**
155
87
@@ -159,7 +91,7 @@ For other browsers, regular HTML capture is used.
159
91
**Tap to Capture**
160
92
161
93
- Tap to capture will be enabled for devices that can support the resolution constraints, but cannot support the image processing.
162
-
-Upon launching the camera, we will check the speed of image processing. If the speed is above the threshold, tap to capturewill be enabled.
94
+
-When the camera is launched, the image processing speed is automatically checked. If the speed is above the threshold set at 300ms, live document detection and autocapture features are disabled and switched to tap to capture. The user will have to manually capture the document.
163
95
164
96
165
97
----------
@@ -172,14 +104,14 @@ For other browsers, regular HTML capture is used.
172
104
1. Initialize the Worker. (**Note**: If worker has not been started, this call will start the Worker.)
173
105
174
106
function initialize(
175
-
token : string, //token provided by Acuant
176
-
endpoint : string, //Acuant endpoint
107
+
token : string, //Acuant credentials in base64 (basic auth format id:pass)
108
+
endpoint : string, //endpoint for Acuant's ACAS server
177
109
callback: object); //callback shown below
178
110
179
111
var callback = {
180
112
onSuccess:function(){
181
113
},
182
-
onFail:function(){
114
+
onFail:function(code, description){
183
115
}
184
116
}
185
117
@@ -195,7 +127,7 @@ For other browsers, regular HTML capture is used.
195
127
----------
196
128
## AcuantCameraUI
197
129
198
-
- Uses AcuantCamera to access native camera.
130
+
- Uses AcuantCamera to access device's native camera. AcuantCameraUI applies to the WebRTC live capture UI.
199
131
- Default implementation of UI. Use AcuantCamera directly for any custom UI.
200
132
201
133
**Prerequisite**: Initialize Acuant Worker (see Step 2 above).
@@ -263,13 +195,13 @@ For other browsers, regular HTML capture is used.
263
195
----------
264
196
265
197
## AcuantCamera
266
-
198
+
- WebRTC is used for live capture when available; otherwise, use manual capture.
@@ -298,7 +230,7 @@ For other browsers, regular HTML capture is used.
298
230
299
231
AcuantCamera.start((response) => {
300
232
response = {
301
-
//type of document
233
+
//type of document
302
234
type: AcuantCamera.ACUANT_DOCUMENT_TYPE,
303
235
304
236
//state of camera
@@ -341,11 +273,11 @@ For other browsers, regular HTML capture is used.
341
273
}
342
274
});
343
275
344
-
1.Manual Capture:
276
+
1.Start manual capture (when WebRTC live capture is unavailable)
345
277
346
-
**IMPORTANT**: AcuantCamera manual capture uses \<input type="file"/> html tags to access the native camera. This REQUIRES a user initiated event to start the camera.
278
+
**IMPORTANT**: AcuantCamera manual capture uses `<input type="file"/>` html tags to access the device's camera app. This REQUIRES a user initiated event to start the camera.
347
279
348
-
**NOTE**: We recommend not hiding any UI elements when starting manual capture. Be aware users will be able to cancel out of the native camera screen.
280
+
**NOTE**: Acuant recommends not hiding any UI elements when starting manual capture. Be aware users will be able to cancel out of the device's camera app screen.
349
281
350
282
AcuantCamera.startManualCapture({
351
283
onCaptured: function(response){
@@ -436,7 +368,78 @@ For other browsers, regular HTML capture is used.
Acuant recommends using the **LiveAssessment** property rather than the score) to evaluate response. **AcuantPassiveLiveness.startSelfieCapture** will return a rescaled image.
376
+
377
+
Follow these recommendations to effectively process an image for passive liveness:
378
+
#### Image requirements
379
+
-**Height**: minimum 480 pixels; recommended 720 or 1080 pixels
380
+
-**Compression**: Image compression is not recommended (JPEG 70 level or above is acceptable). For best results, use uncompressed images.
381
+
382
+
#### Face requirements
383
+
- Out-of-plane rotation: Face pitch and yaw angle: from -20 to 20 degrees +/-3 degrees
384
+
- In-plane rotation: Face roll angle: from -30 to 30 degrees +/- 3 degrees
385
+
- Pupillary distance: Minimum distance between the eyes 90 +/- 5 pixels
386
+
- Face size: Minimum 200 pixels in either dimension
387
+
- Faces per image: 1
388
+
- Sunglasses: Must be removed
389
+
390
+
#### Capture requirements
391
+
The following may significantly increase errors or false results:
392
+
393
+
- Using a motion blur effect
394
+
- Texture filtering
395
+
- A spotlight on the face and nearest surroundings
396
+
- An environment with poor lighting or colored light
397
+
398
+
**Note** Face live capture and guidance is not supported, only manual capture is available. Also, the use of fish-eye lenses is not supported by this API.
399
+
400
+
### Start face capture and send Passive Liveness request
**Copyright 2020 Acuant Inc. All rights reserved.**
441
444
442
445
This document contains proprietary and confidential information and creative works owned by Acuant and its respective licensors, if any. Any use, copying, publication, distribution, display, modification, or transmission of such technology, in whole or in part, in any form or by any means, without the prior express written permission of Acuant is strictly prohibited. Except where expressly provided by Acuant in writing, possession of this information shall not be construed to confer any license or rights under any Acuant intellectual property rights, whether by estoppel, implication, or otherwise.
0 commit comments