@idscan/onboarding 2.6.1 → 2.6.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/readme.md CHANGED
@@ -1,564 +1,571 @@
1
- ## Overview
2
-
3
- Wrapper of the IDVC library for DVS Online.
4
-
5
- ## Use cases
6
-
7
- - Capture and determination of the document type
8
- - Capture of pdf417
9
- - Capture of MRZ
10
- - Capture of faces
11
-
12
- ## Recommendations
13
-
14
- Use a modern phone with a good camera having the definition of not less than 8 megapixels.
15
- The capture must be made in a well-lighted room. A document must be located at the uniform background.
16
-
17
- ## Limitations
18
-
19
- This component works in phones with the operating system Android in the browser Chrome (minimum version 52) and in phones with the operating system iOS (minimum version 15) in the browser Safari
20
-
21
- ## Installation
22
-
23
- ```
24
- $ npm install @idscan/onboarding
25
- ```
26
-
27
- This component contains JS, CSS files which require the mandatory import into your project.
28
-
29
- 1. Before importing it is necessary to set the webpack-configuration.
30
-
31
- *Note: The project must use the webpack 4 and later versions.*
32
-
33
- 1.1. Add the following rules of loading to the field rules
34
- ```javascript
35
- {
36
- test: /\.css$/,
37
- use: ["style-loader", "css-loader"]
38
- }
39
- ```
40
-
41
- 1.2. If you prefer to use neural networks from your domain, you should add the 'CopyWebpackPlugin' into the section 'plugins' which will copy the files, which are necessary for the work of the neural network, from the folder to another folder that should be selected by you.
42
-
43
- *Note: The structure inside the folder of the component 'networks' must be saved on the server with due regard to the nesting.
44
- There are binary files in the folder which do not have the extension. These files must be provided by the server with the header `Content-Type: application/octet-stream`.*
45
- ```javascript
46
- new CopyWebpackPlugin ([
47
- {
48
- from: 'node_modules/@idscan/onboarding/dist/networks/**/*',
49
- to: `${networkUrl}/[folder]/[name].[ext]`,
50
- toType: 'template'
51
- }
52
- ])
53
- ```
54
-
55
- 1.3. Import the library and css to your project.
56
-
57
- ```javascript
58
- import DVSOIDVC from '@idscan/onboarding';
59
- import '@idscan/onboarding/dist/css/onboarding.css';
60
- ```
61
- ## Initialization
62
-
63
- Create an instance of the object 'DVS Online IDVC library wrapper'. The object takes one object of the component configuration as a parameter.
64
-
65
- All configurations of @idscan/IDVC will be fetched from DVS Online by domainId.
66
-
67
- Available fields:
68
-
69
- **el** (string) - Id of an element on the page where the component will be integrated. Required.
70
-
71
- **applicantId** (string) - Id of applicant. Required.
72
-
73
- **domainId** (string) - Domain id where from will get configs and styles. Required.
74
-
75
- **domainApi** (string) - URL address of onboarding API. Required.
76
-
77
- **publicKey** (string) - DVS Web API Public Key. Required.
78
-
79
- **isAuth** (boolean) - Flag indicating that only face authentication is required.
80
-
81
- **faceOnly** (boolean) - Flag indicating that only face registration is required.
82
-
83
- **chunkPublicPath** (string) - Path to the folder with chunks. Specify the path on the server if you need to remove the folder to another location. The default path is \'networks\'.
84
-
85
- **networkUrl** (string) - Path to the folder with neural networks. Specify the path on the server if you need to remove the folder to another location. The default path is \'networks\'.'
86
-
87
- **useCDN** (boolean) - Flag indicating that you want to load networks from cdn instead of your domain.
88
-
89
- **preferApiConfig** (boolean) - Flag indicating that you prefer to use IDVC library configuration, that was sent from the DVS Online API, instead of the configuration used when initializing the wrapper.
90
-
91
- **hideDocumentTitle** (boolean) - This option switches on/off the displaying document titles.
92
-
93
- **processingImageFormat** (string) - This option switches image format, that used for image processing.
94
-
95
- **demoMode** (boolean) - In true mode, the wrapper stops documents validation.
96
-
97
- **qrCodeLinkOrigin** (string) - Allows you to change the QR-link. Should look like window.location.origin (protocol://domain:port)
98
-
99
- **getApplicantIdFromURL** (boolean) - Allows you to take the applicant id from the browser URL
100
-
101
- **wrapperSettings** (object) - Object with wrapper (not IDVC) settings. Allows you to override the config that came from the API. Available fields:
102
-
103
- - **showQrCode** (boolean) - Enable validation on another device using a QR link.
104
-
105
- - **showConsentForm** (boolean) - This option switches on/off the displaying consent form.
106
-
107
- - **consentText** (string) - This option allows you to set the body text of the consent form.
108
-
109
- - **checkboxText** (string) - This option allows you to set the confirmation text of the consent form.
110
-
111
- **callbacks** (object) - Object with callback hooks. Available hooks:
112
-
113
- - **onChange** - Callback-function which will be called after change one step. The returnable value is the object with the type and the image.
114
-
115
- - **onCameraError** - Callback-function which is invoked in case if the camera is not available. The response value is the object with the error code and the message.
116
-
117
- - **onReset** - Callback-function which will be called after reset all the steps. The returnable value is the object with the steps.
118
-
119
- - **onRetakeHook** - Callback-function which will be called before reset the current step. The returnable value is the object with the current step.
120
-
121
- - **onValidate** - Callback-function which will be called after validation response received. The returnable value is the object with validation information.
122
-
123
- - **onError** - Callback-function which will be called on error. The response value is the object with the error code and the message.
124
-
125
- - **onReloaded** - Callback-function which will be called after the component finishes reloading. This function doesn't return a value.
126
-
127
- - **onMounted** - Callback-function which will be called on the component mounted. This function doesn't return a value.
128
-
129
- - **submit** - Callback-function which will be called after completing all the steps. The returnable value is the object with the following content:
130
- ```javascript
131
- documentTypes: [
132
- {
133
- type: "ID",
134
- steps:[
135
- { type: 'front', name: 'Document Front', mode: { uploader: true, video: true } },
136
- { type: 'pdf', name: 'Document PDF417 Barcode' , mode: { uploader: true, video: true } },
137
- { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
138
- ]},
139
- {
140
- type: "Passport",
141
- steps:[
142
- { type: 'mrz', name: 'Passport Front' , mode: { uploader: true, video: true } },
143
- { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
144
- ]},
145
- ]
146
- ```
147
-
148
- steps – steps with the type and the image in the format 'base64'.
149
-
150
- Also, if you use automatic capture, in the "back" step **trackstring** will be returned (raw PDF417 data from Barcode encoded in base64)
151
-
152
-
153
- *Note: Request an license key for the library by emailing
154
- [sales@idscan.net](mailto:sales@idscan.net) or [support@idscan.net](mailto:support@idscan.net)*
155
-
156
- ## Methods
157
-
158
- **setApplicant** (string) - the method that reinitialize wrapper for new applicant. Parameter is an applicant id of string type.
159
- ```javascript
160
- import DVSOIDVC from './Wrapper';
161
-
162
- const lib = new DVSOIDVC({
163
- applicantId: '...',
164
- domainId: '...',
165
- publicKey: '...',
166
- chunkPublicPath: '/customPath/',
167
- domainApi: '...',
168
- });
169
-
170
- const btn = document.getElementById('btn');
171
- btn.addEventListener('click', () => {
172
- const applicantId = 'new applicant id';
173
- lib.setApplicant(applicantId);
174
- });
175
- ```
176
-
177
- **updateConfig** (string) - the method that reinitialize wrapper with new config. Parameter is an JSON encoded IDVC config. Works only in demo mode.
178
-
179
- ## Version history
180
-
181
- - **2.6.1**
182
- - Updated IDVC component
183
-
184
- - **2.6.0**
185
- - feat: Added new options: getApplicantIdFromURL, qrCodeLinkOrigin
186
- - Updated IDVC component
187
-
188
- - **2.5.1**
189
- - feat: added 'isOcrEnabled' field in Validation request
190
-
191
- - **2.5.0**
192
- - Updated IDVC component
193
- - feat: update UI
194
-
195
- - **2.4.1**
196
- - Minor fixes
197
-
198
- - **2.4.0**
199
- - feat: added a new public method to show the loader.
200
- Method: showLoader(val: boolean, bottomText?: string, topText?: string)
201
- - Updated IDVC component
202
-
203
- - **2.3.16**
204
- - Updated IDVC component
205
-
206
- - **2.3.15**
207
- - Updated IDVC component
208
- - feat: added 'isBackOrSecondImageProcessingEnabled' field in Validation request
209
-
210
- - **2.3.14**
211
- - fix: validation modal showing
212
-
213
- - **2.3.13**
214
- - Updated IDVC component
215
- - feat: performance improvement
216
-
217
- - **2.3.12**
218
- - Updated IDVC component
219
-
220
- - **2.3.11**
221
- - Updated IDVC component
222
-
223
- - **2.3.10**
224
- - Updated IDVC component
225
- - feat: changed UI for QR Code modal
226
-
227
- - **2.3.9**
228
- - Updated IDVC component
229
- - fix: track string capturing from MRZ
230
-
231
- - **2.3.8**
232
- - fix: validation process
233
-
234
- - **2.3.7**
235
- - Little fixes
236
-
237
- - **2.3.6**
238
- - Updated IDVC component
239
- - Now, the wrapper replaces the 'front' step for the 'Passport' document with the 'mrz' step.
240
-
241
- - **2.3.5**
242
- - Updated IDVC component
243
-
244
- - **2.3.4**
245
- - Updated IDVC component
246
-
247
- - **2.3.3**
248
- - fix: QR code process on SPA
249
-
250
- - **2.3.2**
251
- - Improving modal window styles
252
-
253
- - **2.3.1**
254
- - Updated IDVC component
255
-
256
- - **2.3.0**
257
- - feat: added 'wrapperSettings' option that allows you to override the wrapper config that comes from the API. This option works if the 'preferApiConfig' option is set to false.
258
-
259
- - **2.2.27**
260
- - Updated IDVC component
261
-
262
- - **2.2.26**
263
- - Updated IDVC component
264
-
265
- - **2.2.25**
266
- - Updated IDVC component
267
- - fix: wrapper config option 'el'
268
-
269
- - **2.2.24**
270
- - Updated IDVC component
271
-
272
- - **2.2.23**
273
- - Updated IDVC component
274
- - feat: simplify the Passport verification, now front step it's union of front and mrz
275
-
276
- - **2.2.22**
277
- - Updated IDVC component
278
-
279
- - **2.2.21**
280
- - Fixes: The image of the back of the document was not sent when International ID was selected
281
-
282
- - **2.2.20**
283
- - Updated IDVC component
284
- - Fixes: Response when isAuth = true
285
-
286
- - **2.2.19**
287
- - Updated IDVC component
288
-
289
- - **2.2.18**
290
- - Updated IDVC component
291
-
292
- - **2.2.17**
293
- - Added: documents config validation
294
- - Fixes: QR code processing
295
-
296
- - **2.2.16**
297
- - Added: mobile checking for qr code
298
-
299
- - **2.2.15**
300
- - Added: new config options 'hideDocumentTitle', 'processingImageFormat'
301
- - Updated IDVC component
302
-
303
- - **2.2.14**
304
- - Change webpack build options. Remove eval
305
-
306
- - **2.2.13**
307
- - Added: new config options 'networkUrl', 'useCDN', 'preferApiConfig'
308
-
309
- - **2.2.12**
310
- - Updated IDVC component
311
- - Updated readme
312
-
313
- - **2.2.11**
314
- - Feat: some minor fixes
315
-
316
- - **2.2.10**
317
- - Feat: face only mode
318
-
319
- - **2.2.9**
320
- - Fixed qr link
321
-
322
- - **2.2.8**
323
- - Updated IDVC component
324
-
325
- - **2.2.7**
326
- - Update TS types
327
-
328
- - **2.2.6**
329
- - Fixed config
330
-
331
- - **2.2.5**
332
- - Fixed build issue
333
- - Added: webp support
334
-
335
- - **2.2.4**
336
- - Updated IDVC component
337
-
338
- - **2.2.3**
339
- - Added: face auth success modal
340
-
341
- - **2.2.2**
342
- - Added: config change
343
- - Changed API calls
344
-
345
- - **2.2.1**
346
- - Fix: face validation
347
-
348
- - **2.2.0**
349
- - Feat: add flag indicating that only face authentication is required
350
- - Feat: some minor fixes
351
-
352
- - **2.1.29**
353
- - Feat: some minor fixes
354
-
355
- - **2.1.28**
356
- - Updated IDVC component
357
-
358
- - **2.1.27**
359
- - Updated IDVC component
360
-
361
- - **2.1.26**
362
- - Fix: Consent Form styles
363
-
364
- - **2.1.25**
365
- - Feat: Add attempt left status text
366
- - Fix: Validation Modal
367
-
368
- - **2.1.24**
369
- - Fix: Consent Form styles
370
-
371
- - **2.1.23**
372
- - Feat: rework Consent Form
373
- - Feat: change Domains Api to Integrations Api
374
-
375
- - **2.1.22**
376
- - Fix: embedded app status from api
377
- - Feat: update IDVC callbacks readme
378
-
379
- - **2.1.21**
380
- - Feat: change domain to domainApi
381
- - Feat: domainApi is required now
382
-
383
- - **2.1.20**
384
- - Fix: change showQRCode flag name to showQrCode
385
-
386
- - **2.1.19**
387
- - Fix: return old check validation endpoint
388
- - Feat: add check for showQRCode flag from backend
389
-
390
- - **2.1.18**
391
- - Add the possibility of continuing the documents' check on a mobile device
392
-
393
- - **2.1.17**
394
- - Change verifyFace option behavior
395
-
396
- - **2.1.16**
397
- - Updated IDVC component
398
-
399
- - **2.1.15**
400
- - Updated IDVC component
401
-
402
- - **2.1.14**
403
- - Updated IDVC component
404
-
405
- - **2.1.13**
406
- - Updated IDVC component
407
-
408
- - **2.1.12**
409
- - Fix: validation model
410
-
411
- - **2.1.11**
412
- - Updated IDVC component
413
-
414
- - **2.1.10**
415
- - Updated IDVC component
416
-
417
- - **2.1.9**
418
- - Fixed API path
419
-
420
- - **2.1.8**
421
- - Updated IDVC component
422
-
423
- - **2.1.7**
424
- - Added support for Proxy based frameworks
425
-
426
- - **2.1.6**
427
- - Added support for ios < 15
428
-
429
- - **2.1.5**
430
- - Updated IDVC component
431
-
432
- - **2.1.4**
433
- - Improved document types validation
434
-
435
- - **2.1.3**
436
- - Updated IDVC component
437
-
438
- - **2.1.2**
439
- - Updated IDVC component
440
- - Changed: modal message behaviour
441
-
442
- - **2.1.1**
443
- - Fixed: submit mrz
444
-
445
- - **2.1.0**
446
- - Added: new option in config "chunkPublicPath"
447
-
448
- - **2.0.19**
449
- - Updated IDVC component
450
-
451
- - **2.0.18**
452
- - Updated IDVC component
453
-
454
- - **2.0.17**
455
- - Some improvements
456
-
457
- - **2.0.16**
458
- - Some improvements
459
-
460
- - **2.0.15**
461
- - Some improvements
462
-
463
- - **2.0.14**
464
- - Some improvements
465
-
466
- - **2.0.13**
467
- - Updated IDVC component
468
-
469
- - **2.0.12**
470
- - Updated IDVC component
471
-
472
- - **2.0.11**
473
- - Updated IDVC component
474
-
475
- - **2.0.10**
476
- - Updated IDVC component
477
-
478
- - **2.0.9**
479
- - Updated IDVC component
480
-
481
- - **2.0.8**
482
- - Some improvements
483
-
484
- - **2.0.7**
485
- - Fixed background
486
-
487
- - **2.0.6**
488
- - Added version 1 config support
489
-
490
- - **2.0.5**
491
- - Updated IDVC component
492
- - Fixed submit method
493
-
494
- - **2.0.4**
495
- - Updated IDVC component
496
-
497
- - **2.0.3**
498
- - Some improvements
499
-
500
- - **2.0.2**
501
- - Updated IDVC component
502
-
503
- - **2.0.1**
504
- - Added consent form
505
-
506
- - **2.0.0**
507
- - Migrate to the IDVC version 2
508
-
509
- - **1.0.18**
510
- - Fixed spinner
511
-
512
- - **1.0.17**
513
- - Fixed license key
514
-
515
- - **1.0.16**
516
- - Added sign for forced closing of the request
517
-
518
- - **1.0.15**
519
- - updated IDVC component
520
-
521
- - **1.0.14**
522
- - updated IDVC component
523
-
524
- - **1.0.13**
525
- - added ids for style tags
526
-
527
- - **1.0.12**
528
- - updated IDVC component
529
-
530
- - **1.0.11**
531
- - updated using DVS Online API
532
-
533
- - **1.0.10**
534
- - added: onMounted callback
535
-
536
- - **1.0.9**
537
- - @idscan/idvc dependency updated
538
-
539
- - **1.0.8**
540
- - added: reload component with new configs in demo mode
541
-
542
- - **1.0.7**
543
- - updated using DVS Online API
544
-
545
- - **1.0.6**
546
- - updated using DVS Online API
547
-
548
- - **1.0.5**
549
- - updated IDVC component
550
- - updated using DVS Online API
551
-
552
- - **1.0.4**
553
- - use CDN
554
-
555
- - **1.0.3**
556
- - Changed readme
557
-
558
- - **1.0.2**
559
- - Some improvements
560
-
561
- - **1.0.1**
562
- - Changed readme
563
-
564
- - **1.0.0**
1
+ ## Overview
2
+
3
+ Wrapper of the IDVC library for DVS Online.
4
+
5
+ ## Use cases
6
+
7
+ - Capture and determination of the document type
8
+ - Capture of pdf417
9
+ - Capture of MRZ
10
+ - Capture of faces
11
+
12
+ ## Recommendations
13
+
14
+ Use a modern phone with a good camera having the definition of not less than 8 megapixels.
15
+ The capture must be made in a well-lighted room. A document must be located at the uniform background.
16
+
17
+ ## Limitations
18
+
19
+ This component works in phones with the operating system Android in the browser Chrome (minimum version 52) and in phones with the operating system iOS (minimum version 15) in the browser Safari
20
+
21
+ ## Installation
22
+
23
+ ```
24
+ $ npm install @idscan/onboarding
25
+ ```
26
+
27
+ This component contains JS, CSS files which require the mandatory import into your project.
28
+
29
+ 1. Before importing it is necessary to set the webpack-configuration.
30
+
31
+ *Note: The project must use the webpack 4 and later versions.*
32
+
33
+ 1.1. Add the following rules of loading to the field rules
34
+ ```javascript
35
+ {
36
+ test: /\.css$/,
37
+ use: ["style-loader", "css-loader"]
38
+ }
39
+ ```
40
+
41
+ 1.2. If you prefer to use neural networks from your domain, you should add the &#39;CopyWebpackPlugin&#39; into the section &#39;plugins&#39; which will copy the files, which are necessary for the work of the neural network, from the folder to another folder that should be selected by you.
42
+
43
+ *Note: The structure inside the folder of the component &#39;networks&#39; must be saved on the server with due regard to the nesting.
44
+ There are binary files in the folder which do not have the extension. These files must be provided by the server with the header `Content-Type: application/octet-stream`.*
45
+ ```javascript
46
+ new CopyWebpackPlugin ([
47
+ {
48
+ from: 'node_modules/@idscan/onboarding/dist/networks/**/*',
49
+ to: `${networkUrl}/[folder]/[name].[ext]`,
50
+ toType: 'template'
51
+ }
52
+ ])
53
+ ```
54
+
55
+ 1.3. Import the library and css to your project.
56
+
57
+ ```javascript
58
+ import DVSOIDVC from '@idscan/onboarding';
59
+ import '@idscan/onboarding/dist/css/onboarding.css';
60
+ ```
61
+ ## Initialization
62
+
63
+ Create an instance of the object &#39;DVS Online IDVC library wrapper&#39;. The object takes one object of the component configuration as a parameter.
64
+
65
+ All configurations of @idscan/IDVC will be fetched from DVS Online by domainId.
66
+
67
+ Available fields:
68
+
69
+ **el** (string) - Id of an element on the page where the component will be integrated. Required.
70
+
71
+ **applicantId** (string) - Id of applicant. Required.
72
+
73
+ **domainId** (string) - Domain id where from will get configs and styles. Required.
74
+
75
+ **domainApi** (string) - URL address of onboarding API. Required.
76
+
77
+ **publicKey** (string) - DVS Web API Public Key. Required.
78
+
79
+ **isAuth** (boolean) - Flag indicating that only face authentication is required.
80
+
81
+ **faceOnly** (boolean) - Flag indicating that only face registration is required.
82
+
83
+ **chunkPublicPath** (string) - Path to the folder with chunks. Specify the path on the server if you need to remove the folder to another location. The default path is \'networks\'.
84
+
85
+ **networkUrl** (string) - Path to the folder with neural networks. Specify the path on the server if you need to remove the folder to another location. The default path is \'networks\'.'
86
+
87
+ **useCDN** (boolean) - Flag indicating that you want to load networks from cdn instead of your domain.
88
+
89
+ **preferApiConfig** (boolean) - Flag indicating that you prefer to use IDVC library configuration, that was sent from the DVS Online API, instead of the configuration used when initializing the wrapper.
90
+
91
+ **hideDocumentTitle** (boolean) - This option switches on/off the displaying document titles.
92
+
93
+ **processingImageFormat** (string) - This option switches image format, that used for image processing.
94
+
95
+ **demoMode** (boolean) - In true mode, the wrapper stops documents validation.
96
+
97
+ **qrCodeLinkOrigin** (string) - Allows you to change the QR-link. Should look like window.location.origin (protocol://domain:port)
98
+
99
+ **getApplicantIdFromURL** (boolean) - Allows you to take the applicant id from the browser URL
100
+
101
+ **wrapperSettings** (object) - Object with wrapper (not IDVC) settings. Allows you to override the config that came from the API. Available fields:
102
+
103
+ - **showQrCode** (boolean) - Enable validation on another device using a QR link.
104
+
105
+ - **showConsentForm** (boolean) - This option switches on/off the displaying consent form.
106
+
107
+ - **consentText** (string) - This option allows you to set the body text of the consent form.
108
+
109
+ - **checkboxText** (string) - This option allows you to set the confirmation text of the consent form.
110
+
111
+ **callbacks** (object) - Object with callback hooks. Available hooks:
112
+
113
+ - **onChange** - Callback-function which will be called after change one step. The returnable value is the object with the type and the image.
114
+
115
+ - **onCameraError** - Callback-function which is invoked in case if the camera is not available. The response value is the object with the error code and the message.
116
+
117
+ - **onReset** - Callback-function which will be called after reset all the steps. The returnable value is the object with the steps.
118
+
119
+ - **onRetakeHook** - Callback-function which will be called before reset the current step. The returnable value is the object with the current step.
120
+
121
+ - **onValidate** - Callback-function which will be called after validation response received. The returnable value is the object with validation information.
122
+
123
+ - **onError** - Callback-function which will be called on error. The response value is the object with the error code and the message.
124
+
125
+ - **onReloaded** - Callback-function which will be called after the component finishes reloading. This function doesn't return a value.
126
+
127
+ - **onMounted** - Callback-function which will be called on the component mounted. This function doesn't return a value.
128
+
129
+ - **submit** - Callback-function which will be called after completing all the steps. The returnable value is the object with the following content:
130
+ ```javascript
131
+ documentTypes: [
132
+ {
133
+ type: "ID",
134
+ steps:[
135
+ { type: 'front', name: 'Document Front', mode: { uploader: true, video: true } },
136
+ { type: 'pdf', name: 'Document PDF417 Barcode' , mode: { uploader: true, video: true } },
137
+ { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
138
+ ]},
139
+ {
140
+ type: "Passport",
141
+ steps:[
142
+ { type: 'mrz', name: 'Passport Front' , mode: { uploader: true, video: true } },
143
+ { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
144
+ ]},
145
+ ]
146
+ ```
147
+
148
+ steps – steps with the type and the image in the format &#39;base64&#39;.
149
+
150
+ Also, if you use automatic capture, in the "back" step **trackstring** will be returned (raw PDF417 data from Barcode encoded in base64)
151
+
152
+
153
+ *Note: Request an license key for the library by emailing
154
+ [sales@idscan.net](mailto:sales@idscan.net) or [support@idscan.net](mailto:support@idscan.net)*
155
+
156
+ ## Methods
157
+
158
+ **setApplicant** (string) - the method that reinitialize wrapper for new applicant. Parameter is an applicant id of string type.
159
+ ```javascript
160
+ import DVSOIDVC from './Wrapper';
161
+
162
+ const lib = new DVSOIDVC({
163
+ applicantId: '...',
164
+ domainId: '...',
165
+ publicKey: '...',
166
+ chunkPublicPath: '/customPath/',
167
+ domainApi: '...',
168
+ });
169
+
170
+ const btn = document.getElementById('btn');
171
+ btn.addEventListener('click', () => {
172
+ const applicantId = 'new applicant id';
173
+ lib.setApplicant(applicantId);
174
+ });
175
+ ```
176
+
177
+ **updateConfig** (string) - the method that reinitialize wrapper with new config. Parameter is an JSON encoded IDVC config. Works only in demo mode.
178
+
179
+ ## Version history
180
+
181
+ - **2.6.3**
182
+ - Updated IDVC component
183
+ - fix: hide validation modal after using the 'setApplicant' method
184
+
185
+ - **2.6.2**
186
+ - Updated IDVC component
187
+
188
+ - **2.6.1**
189
+ - Updated IDVC component
190
+
191
+ - **2.6.0**
192
+ - feat: Added new options: getApplicantIdFromURL, qrCodeLinkOrigin
193
+ - Updated IDVC component
194
+
195
+ - **2.5.1**
196
+ - feat: added 'isOcrEnabled' field in Validation request
197
+
198
+ - **2.5.0**
199
+ - Updated IDVC component
200
+ - feat: update UI
201
+
202
+ - **2.4.1**
203
+ - Minor fixes
204
+
205
+ - **2.4.0**
206
+ - feat: added a new public method to show the loader.
207
+ Method: showLoader(val: boolean, bottomText?: string, topText?: string)
208
+ - Updated IDVC component
209
+
210
+ - **2.3.16**
211
+ - Updated IDVC component
212
+
213
+ - **2.3.15**
214
+ - Updated IDVC component
215
+ - feat: added 'isBackOrSecondImageProcessingEnabled' field in Validation request
216
+
217
+ - **2.3.14**
218
+ - fix: validation modal showing
219
+
220
+ - **2.3.13**
221
+ - Updated IDVC component
222
+ - feat: performance improvement
223
+
224
+ - **2.3.12**
225
+ - Updated IDVC component
226
+
227
+ - **2.3.11**
228
+ - Updated IDVC component
229
+
230
+ - **2.3.10**
231
+ - Updated IDVC component
232
+ - feat: changed UI for QR Code modal
233
+
234
+ - **2.3.9**
235
+ - Updated IDVC component
236
+ - fix: track string capturing from MRZ
237
+
238
+ - **2.3.8**
239
+ - fix: validation process
240
+
241
+ - **2.3.7**
242
+ - Little fixes
243
+
244
+ - **2.3.6**
245
+ - Updated IDVC component
246
+ - Now, the wrapper replaces the 'front' step for the 'Passport' document with the 'mrz' step.
247
+
248
+ - **2.3.5**
249
+ - Updated IDVC component
250
+
251
+ - **2.3.4**
252
+ - Updated IDVC component
253
+
254
+ - **2.3.3**
255
+ - fix: QR code process on SPA
256
+
257
+ - **2.3.2**
258
+ - Improving modal window styles
259
+
260
+ - **2.3.1**
261
+ - Updated IDVC component
262
+
263
+ - **2.3.0**
264
+ - feat: added 'wrapperSettings' option that allows you to override the wrapper config that comes from the API. This option works if the 'preferApiConfig' option is set to false.
265
+
266
+ - **2.2.27**
267
+ - Updated IDVC component
268
+
269
+ - **2.2.26**
270
+ - Updated IDVC component
271
+
272
+ - **2.2.25**
273
+ - Updated IDVC component
274
+ - fix: wrapper config option 'el'
275
+
276
+ - **2.2.24**
277
+ - Updated IDVC component
278
+
279
+ - **2.2.23**
280
+ - Updated IDVC component
281
+ - feat: simplify the Passport verification, now front step it's union of front and mrz
282
+
283
+ - **2.2.22**
284
+ - Updated IDVC component
285
+
286
+ - **2.2.21**
287
+ - Fixes: The image of the back of the document was not sent when International ID was selected
288
+
289
+ - **2.2.20**
290
+ - Updated IDVC component
291
+ - Fixes: Response when isAuth = true
292
+
293
+ - **2.2.19**
294
+ - Updated IDVC component
295
+
296
+ - **2.2.18**
297
+ - Updated IDVC component
298
+
299
+ - **2.2.17**
300
+ - Added: documents config validation
301
+ - Fixes: QR code processing
302
+
303
+ - **2.2.16**
304
+ - Added: mobile checking for qr code
305
+
306
+ - **2.2.15**
307
+ - Added: new config options 'hideDocumentTitle', 'processingImageFormat'
308
+ - Updated IDVC component
309
+
310
+ - **2.2.14**
311
+ - Change webpack build options. Remove eval
312
+
313
+ - **2.2.13**
314
+ - Added: new config options 'networkUrl', 'useCDN', 'preferApiConfig'
315
+
316
+ - **2.2.12**
317
+ - Updated IDVC component
318
+ - Updated readme
319
+
320
+ - **2.2.11**
321
+ - Feat: some minor fixes
322
+
323
+ - **2.2.10**
324
+ - Feat: face only mode
325
+
326
+ - **2.2.9**
327
+ - Fixed qr link
328
+
329
+ - **2.2.8**
330
+ - Updated IDVC component
331
+
332
+ - **2.2.7**
333
+ - Update TS types
334
+
335
+ - **2.2.6**
336
+ - Fixed config
337
+
338
+ - **2.2.5**
339
+ - Fixed build issue
340
+ - Added: webp support
341
+
342
+ - **2.2.4**
343
+ - Updated IDVC component
344
+
345
+ - **2.2.3**
346
+ - Added: face auth success modal
347
+
348
+ - **2.2.2**
349
+ - Added: config change
350
+ - Changed API calls
351
+
352
+ - **2.2.1**
353
+ - Fix: face validation
354
+
355
+ - **2.2.0**
356
+ - Feat: add flag indicating that only face authentication is required
357
+ - Feat: some minor fixes
358
+
359
+ - **2.1.29**
360
+ - Feat: some minor fixes
361
+
362
+ - **2.1.28**
363
+ - Updated IDVC component
364
+
365
+ - **2.1.27**
366
+ - Updated IDVC component
367
+
368
+ - **2.1.26**
369
+ - Fix: Consent Form styles
370
+
371
+ - **2.1.25**
372
+ - Feat: Add attempt left status text
373
+ - Fix: Validation Modal
374
+
375
+ - **2.1.24**
376
+ - Fix: Consent Form styles
377
+
378
+ - **2.1.23**
379
+ - Feat: rework Consent Form
380
+ - Feat: change Domains Api to Integrations Api
381
+
382
+ - **2.1.22**
383
+ - Fix: embedded app status from api
384
+ - Feat: update IDVC callbacks readme
385
+
386
+ - **2.1.21**
387
+ - Feat: change domain to domainApi
388
+ - Feat: domainApi is required now
389
+
390
+ - **2.1.20**
391
+ - Fix: change showQRCode flag name to showQrCode
392
+
393
+ - **2.1.19**
394
+ - Fix: return old check validation endpoint
395
+ - Feat: add check for showQRCode flag from backend
396
+
397
+ - **2.1.18**
398
+ - Add the possibility of continuing the documents' check on a mobile device
399
+
400
+ - **2.1.17**
401
+ - Change verifyFace option behavior
402
+
403
+ - **2.1.16**
404
+ - Updated IDVC component
405
+
406
+ - **2.1.15**
407
+ - Updated IDVC component
408
+
409
+ - **2.1.14**
410
+ - Updated IDVC component
411
+
412
+ - **2.1.13**
413
+ - Updated IDVC component
414
+
415
+ - **2.1.12**
416
+ - Fix: validation model
417
+
418
+ - **2.1.11**
419
+ - Updated IDVC component
420
+
421
+ - **2.1.10**
422
+ - Updated IDVC component
423
+
424
+ - **2.1.9**
425
+ - Fixed API path
426
+
427
+ - **2.1.8**
428
+ - Updated IDVC component
429
+
430
+ - **2.1.7**
431
+ - Added support for Proxy based frameworks
432
+
433
+ - **2.1.6**
434
+ - Added support for ios < 15
435
+
436
+ - **2.1.5**
437
+ - Updated IDVC component
438
+
439
+ - **2.1.4**
440
+ - Improved document types validation
441
+
442
+ - **2.1.3**
443
+ - Updated IDVC component
444
+
445
+ - **2.1.2**
446
+ - Updated IDVC component
447
+ - Changed: modal message behaviour
448
+
449
+ - **2.1.1**
450
+ - Fixed: submit mrz
451
+
452
+ - **2.1.0**
453
+ - Added: new option in config "chunkPublicPath"
454
+
455
+ - **2.0.19**
456
+ - Updated IDVC component
457
+
458
+ - **2.0.18**
459
+ - Updated IDVC component
460
+
461
+ - **2.0.17**
462
+ - Some improvements
463
+
464
+ - **2.0.16**
465
+ - Some improvements
466
+
467
+ - **2.0.15**
468
+ - Some improvements
469
+
470
+ - **2.0.14**
471
+ - Some improvements
472
+
473
+ - **2.0.13**
474
+ - Updated IDVC component
475
+
476
+ - **2.0.12**
477
+ - Updated IDVC component
478
+
479
+ - **2.0.11**
480
+ - Updated IDVC component
481
+
482
+ - **2.0.10**
483
+ - Updated IDVC component
484
+
485
+ - **2.0.9**
486
+ - Updated IDVC component
487
+
488
+ - **2.0.8**
489
+ - Some improvements
490
+
491
+ - **2.0.7**
492
+ - Fixed background
493
+
494
+ - **2.0.6**
495
+ - Added version 1 config support
496
+
497
+ - **2.0.5**
498
+ - Updated IDVC component
499
+ - Fixed submit method
500
+
501
+ - **2.0.4**
502
+ - Updated IDVC component
503
+
504
+ - **2.0.3**
505
+ - Some improvements
506
+
507
+ - **2.0.2**
508
+ - Updated IDVC component
509
+
510
+ - **2.0.1**
511
+ - Added consent form
512
+
513
+ - **2.0.0**
514
+ - Migrate to the IDVC version 2
515
+
516
+ - **1.0.18**
517
+ - Fixed spinner
518
+
519
+ - **1.0.17**
520
+ - Fixed license key
521
+
522
+ - **1.0.16**
523
+ - Added sign for forced closing of the request
524
+
525
+ - **1.0.15**
526
+ - updated IDVC component
527
+
528
+ - **1.0.14**
529
+ - updated IDVC component
530
+
531
+ - **1.0.13**
532
+ - added ids for style tags
533
+
534
+ - **1.0.12**
535
+ - updated IDVC component
536
+
537
+ - **1.0.11**
538
+ - updated using DVS Online API
539
+
540
+ - **1.0.10**
541
+ - added: onMounted callback
542
+
543
+ - **1.0.9**
544
+ - @idscan/idvc dependency updated
545
+
546
+ - **1.0.8**
547
+ - added: reload component with new configs in demo mode
548
+
549
+ - **1.0.7**
550
+ - updated using DVS Online API
551
+
552
+ - **1.0.6**
553
+ - updated using DVS Online API
554
+
555
+ - **1.0.5**
556
+ - updated IDVC component
557
+ - updated using DVS Online API
558
+
559
+ - **1.0.4**
560
+ - use CDN
561
+
562
+ - **1.0.3**
563
+ - Changed readme
564
+
565
+ - **1.0.2**
566
+ - Some improvements
567
+
568
+ - **1.0.1**
569
+ - Changed readme
570
+
571
+ - **1.0.0**