@idscan/onboarding 2.5.0 → 2.6.0

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,550 +1,561 @@
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
- **wrapperSettings** (object) - Object with wrapper (not IDVC) settings. Allows you to override the config that came from the API. Available fields:
98
-
99
- - **showQrCode** - Enable validation on another device using a QR link.
100
-
101
- - **showConsentForm** - This option switches on/off the displaying consent form.
102
-
103
- - **consentText** - This option allows you to set the body text of the consent form.
104
-
105
- - **checkboxText** - This option allows you to set the confirmation text of the consent form.
106
-
107
- **callbacks** (object) - Object with callback hooks. Available hooks:
108
-
109
- - **onChange** - Callback-function which will be called after change one step. The returnable value is the object with the type and the image.
110
-
111
- - **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.
112
-
113
- - **onReset** - Callback-function which will be called after reset all the steps. The returnable value is the object with the steps.
114
-
115
- - **onRetakeHook** - Callback-function which will be called before reset the current step. The returnable value is the object with the current step.
116
-
117
- - **onValidate** - Callback-function which will be called after validation response received. The returnable value is the object with validation information.
118
-
119
- - **onError** - Callback-function which will be called on error. The response value is the object with the error code and the message.
120
-
121
- - **onReloaded** - Callback-function which will be called after the component finishes reloading. This function doesn't return a value.
122
-
123
- - **onMounted** - Callback-function which will be called on the component mounted. This function doesn't return a value.
124
-
125
- - **submit** - Callback-function which will be called after completing all the steps. The returnable value is the object with the following content:
126
- ```javascript
127
- documentTypes: [
128
- {
129
- type: "ID",
130
- steps:[
131
- { type: 'front', name: 'Document Front', mode: { uploader: true, video: true } },
132
- { type: 'pdf', name: 'Document PDF417 Barcode' , mode: { uploader: true, video: true } },
133
- { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
134
- ]},
135
- {
136
- type: "Passport",
137
- steps:[
138
- { type: 'mrz', name: 'Passport Front' , mode: { uploader: true, video: true } },
139
- { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
140
- ]},
141
- ]
142
- ```
143
-
144
- steps – steps with the type and the image in the format 'base64'.
145
-
146
- Also, if you use automatic capture, in the "back" step **trackstring** will be returned (raw PDF417 data from Barcode encoded in base64)
147
-
148
-
149
- *Note: Request an license key for the library by emailing
150
- [sales@idscan.net](mailto:sales@idscan.net) or [support@idscan.net](mailto:support@idscan.net)*
151
-
152
- ## Methods
153
-
154
- **setApplicant** (string) - the method that reinitialize wrapper for new applicant. Parameter is an applicant id of string type.
155
- ```javascript
156
- import DVSOIDVC from './Wrapper';
157
-
158
- const lib = new DVSOIDVC({
159
- applicantId: '...',
160
- domainId: '...',
161
- publicKey: '...',
162
- chunkPublicPath: '/customPath/',
163
- domainApi: '...',
164
- });
165
-
166
- const btn = document.getElementById('btn');
167
- btn.addEventListener('click', () => {
168
- const applicantId = 'new applicant id';
169
- lib.setApplicant(applicantId);
170
- });
171
- ```
172
-
173
- **updateConfig** (string) - the method that reinitialize wrapper with new config. Parameter is an JSON encoded IDVC config. Works only in demo mode.
174
-
175
- ## Version history
176
-
177
- - **2.5.0**
178
- - Updated IDVC component
179
- - feat: update UI
180
-
181
- - **2.4.1**
182
- - Minor fixes
183
-
184
- - **2.4.0**
185
- - feat: added a new public method to show the loader.
186
- Method: showLoader(val: boolean, bottomText?: string, topText?: string)
187
- - Updated IDVC component
188
-
189
- - **2.3.16**
190
- - Updated IDVC component
191
-
192
- - **2.3.15**
193
- - Updated IDVC component
194
- - feat: added 'isBackOrSecondImageProcessingEnabled' field in Validation request
195
-
196
- - **2.3.14**
197
- - fix: validation modal showing
198
-
199
- - **2.3.13**
200
- - Updated IDVC component
201
- - feat: performance improvement
202
-
203
- - **2.3.12**
204
- - Updated IDVC component
205
-
206
- - **2.3.11**
207
- - Updated IDVC component
208
-
209
- - **2.3.10**
210
- - Updated IDVC component
211
- - feat: changed UI for QR Code modal
212
-
213
- - **2.3.9**
214
- - Updated IDVC component
215
- - fix: track string capturing from MRZ
216
-
217
- - **2.3.8**
218
- - fix: validation process
219
-
220
- - **2.3.7**
221
- - Little fixes
222
-
223
- - **2.3.6**
224
- - Updated IDVC component
225
- - Now, the wrapper replaces the 'front' step for the 'Passport' document with the 'mrz' step.
226
-
227
- - **2.3.5**
228
- - Updated IDVC component
229
-
230
- - **2.3.4**
231
- - Updated IDVC component
232
-
233
- - **2.3.3**
234
- - fix: QR code process on SPA
235
-
236
- - **2.3.2**
237
- - Improving modal window styles
238
-
239
- - **2.3.1**
240
- - Updated IDVC component
241
-
242
- - **2.3.0**
243
- - 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.
244
-
245
- - **2.2.27**
246
- - Updated IDVC component
247
-
248
- - **2.2.26**
249
- - Updated IDVC component
250
-
251
- - **2.2.25**
252
- - Updated IDVC component
253
- - fix: wrapper config option 'el'
254
-
255
- - **2.2.24**
256
- - Updated IDVC component
257
-
258
- - **2.2.23**
259
- - Updated IDVC component
260
- - feat: simplify the Passport verification, now front step it's union of front and mrz
261
-
262
- - **2.2.22**
263
- - Updated IDVC component
264
-
265
- - **2.2.21**
266
- - Fixes: The image of the back of the document was not sent when International ID was selected
267
-
268
- - **2.2.20**
269
- - Updated IDVC component
270
- - Fixes: Response when isAuth = true
271
-
272
- - **2.2.19**
273
- - Updated IDVC component
274
-
275
- - **2.2.18**
276
- - Updated IDVC component
277
-
278
- - **2.2.17**
279
- - Added: documents config validation
280
- - Fixes: QR code processing
281
-
282
- - **2.2.16**
283
- - Added: mobile checking for qr code
284
-
285
- - **2.2.15**
286
- - Added: new config options 'hideDocumentTitle', 'processingImageFormat'
287
- - Updated IDVC component
288
-
289
- - **2.2.14**
290
- - Change webpack build options. Remove eval
291
-
292
- - **2.2.13**
293
- - Added: new config options 'networkUrl', 'useCDN', 'preferApiConfig'
294
-
295
- - **2.2.12**
296
- - Updated IDVC component
297
- - Updated readme
298
-
299
- - **2.2.11**
300
- - Feat: some minor fixes
301
-
302
- - **2.2.10**
303
- - Feat: face only mode
304
-
305
- - **2.2.9**
306
- - Fixed qr link
307
-
308
- - **2.2.8**
309
- - Updated IDVC component
310
-
311
- - **2.2.7**
312
- - Update TS types
313
-
314
- - **2.2.6**
315
- - Fixed config
316
-
317
- - **2.2.5**
318
- - Fixed build issue
319
- - Added: webp support
320
-
321
- - **2.2.4**
322
- - Updated IDVC component
323
-
324
- - **2.2.3**
325
- - Added: face auth success modal
326
-
327
- - **2.2.2**
328
- - Added: config change
329
- - Changed API calls
330
-
331
- - **2.2.1**
332
- - Fix: face validation
333
-
334
- - **2.2.0**
335
- - Feat: add flag indicating that only face authentication is required
336
- - Feat: some minor fixes
337
-
338
- - **2.1.29**
339
- - Feat: some minor fixes
340
-
341
- - **2.1.28**
342
- - Updated IDVC component
343
-
344
- - **2.1.27**
345
- - Updated IDVC component
346
-
347
- - **2.1.26**
348
- - Fix: Consent Form styles
349
-
350
- - **2.1.25**
351
- - Feat: Add attempt left status text
352
- - Fix: Validation Modal
353
-
354
- - **2.1.24**
355
- - Fix: Consent Form styles
356
-
357
- - **2.1.23**
358
- - Feat: rework Consent Form
359
- - Feat: change Domains Api to Integrations Api
360
-
361
- - **2.1.22**
362
- - Fix: embedded app status from api
363
- - Feat: update IDVC callbacks readme
364
-
365
- - **2.1.21**
366
- - Feat: change domain to domainApi
367
- - Feat: domainApi is required now
368
-
369
- - **2.1.20**
370
- - Fix: change showQRCode flag name to showQrCode
371
-
372
- - **2.1.19**
373
- - Fix: return old check validation endpoint
374
- - Feat: add check for showQRCode flag from backend
375
-
376
- - **2.1.18**
377
- - Add the possibility of continuing the documents' check on a mobile device
378
-
379
- - **2.1.17**
380
- - Change verifyFace option behavior
381
-
382
- - **2.1.16**
383
- - Updated IDVC component
384
-
385
- - **2.1.15**
386
- - Updated IDVC component
387
-
388
- - **2.1.14**
389
- - Updated IDVC component
390
-
391
- - **2.1.13**
392
- - Updated IDVC component
393
-
394
- - **2.1.12**
395
- - Fix: validation model
396
-
397
- - **2.1.11**
398
- - Updated IDVC component
399
-
400
- - **2.1.10**
401
- - Updated IDVC component
402
-
403
- - **2.1.9**
404
- - Fixed API path
405
-
406
- - **2.1.8**
407
- - Updated IDVC component
408
-
409
- - **2.1.7**
410
- - Added support for Proxy based frameworks
411
-
412
- - **2.1.6**
413
- - Added support for ios < 15
414
-
415
- - **2.1.5**
416
- - Updated IDVC component
417
-
418
- - **2.1.4**
419
- - Improved document types validation
420
-
421
- - **2.1.3**
422
- - Updated IDVC component
423
-
424
- - **2.1.2**
425
- - Updated IDVC component
426
- - Changed: modal message behaviour
427
-
428
- - **2.1.1**
429
- - Fixed: submit mrz
430
-
431
- - **2.1.0**
432
- - Added: new option in config "chunkPublicPath"
433
-
434
- - **2.0.19**
435
- - Updated IDVC component
436
-
437
- - **2.0.18**
438
- - Updated IDVC component
439
-
440
- - **2.0.17**
441
- - Some improvements
442
-
443
- - **2.0.16**
444
- - Some improvements
445
-
446
- - **2.0.15**
447
- - Some improvements
448
-
449
- - **2.0.14**
450
- - Some improvements
451
-
452
- - **2.0.13**
453
- - Updated IDVC component
454
-
455
- - **2.0.12**
456
- - Updated IDVC component
457
-
458
- - **2.0.11**
459
- - Updated IDVC component
460
-
461
- - **2.0.10**
462
- - Updated IDVC component
463
-
464
- - **2.0.9**
465
- - Updated IDVC component
466
-
467
- - **2.0.8**
468
- - Some improvements
469
-
470
- - **2.0.7**
471
- - Fixed background
472
-
473
- - **2.0.6**
474
- - Added version 1 config support
475
-
476
- - **2.0.5**
477
- - Updated IDVC component
478
- - Fixed submit method
479
-
480
- - **2.0.4**
481
- - Updated IDVC component
482
-
483
- - **2.0.3**
484
- - Some improvements
485
-
486
- - **2.0.2**
487
- - Updated IDVC component
488
-
489
- - **2.0.1**
490
- - Added consent form
491
-
492
- - **2.0.0**
493
- - Migrate to the IDVC version 2
494
-
495
- - **1.0.18**
496
- - Fixed spinner
497
-
498
- - **1.0.17**
499
- - Fixed license key
500
-
501
- - **1.0.16**
502
- - Added sign for forced closing of the request
503
-
504
- - **1.0.15**
505
- - updated IDVC component
506
-
507
- - **1.0.14**
508
- - updated IDVC component
509
-
510
- - **1.0.13**
511
- - added ids for style tags
512
-
513
- - **1.0.12**
514
- - updated IDVC component
515
-
516
- - **1.0.11**
517
- - updated using DVS Online API
518
-
519
- - **1.0.10**
520
- - added: onMounted callback
521
-
522
- - **1.0.9**
523
- - @idscan/idvc dependency updated
524
-
525
- - **1.0.8**
526
- - added: reload component with new configs in demo mode
527
-
528
- - **1.0.7**
529
- - updated using DVS Online API
530
-
531
- - **1.0.6**
532
- - updated using DVS Online API
533
-
534
- - **1.0.5**
535
- - updated IDVC component
536
- - updated using DVS Online API
537
-
538
- - **1.0.4**
539
- - use CDN
540
-
541
- - **1.0.3**
542
- - Changed readme
543
-
544
- - **1.0.2**
545
- - Some improvements
546
-
547
- - **1.0.1**
548
- - Changed readme
549
-
550
- - **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.0**
182
+ - feat: Added new options: getApplicantIdFromURL, qrCodeLinkOrigin
183
+ - Updated IDVC component
184
+
185
+ - **2.5.1**
186
+ - feat: added 'isOcrEnabled' field in Validation request
187
+
188
+ - **2.5.0**
189
+ - Updated IDVC component
190
+ - feat: update UI
191
+
192
+ - **2.4.1**
193
+ - Minor fixes
194
+
195
+ - **2.4.0**
196
+ - feat: added a new public method to show the loader.
197
+ Method: showLoader(val: boolean, bottomText?: string, topText?: string)
198
+ - Updated IDVC component
199
+
200
+ - **2.3.16**
201
+ - Updated IDVC component
202
+
203
+ - **2.3.15**
204
+ - Updated IDVC component
205
+ - feat: added 'isBackOrSecondImageProcessingEnabled' field in Validation request
206
+
207
+ - **2.3.14**
208
+ - fix: validation modal showing
209
+
210
+ - **2.3.13**
211
+ - Updated IDVC component
212
+ - feat: performance improvement
213
+
214
+ - **2.3.12**
215
+ - Updated IDVC component
216
+
217
+ - **2.3.11**
218
+ - Updated IDVC component
219
+
220
+ - **2.3.10**
221
+ - Updated IDVC component
222
+ - feat: changed UI for QR Code modal
223
+
224
+ - **2.3.9**
225
+ - Updated IDVC component
226
+ - fix: track string capturing from MRZ
227
+
228
+ - **2.3.8**
229
+ - fix: validation process
230
+
231
+ - **2.3.7**
232
+ - Little fixes
233
+
234
+ - **2.3.6**
235
+ - Updated IDVC component
236
+ - Now, the wrapper replaces the 'front' step for the 'Passport' document with the 'mrz' step.
237
+
238
+ - **2.3.5**
239
+ - Updated IDVC component
240
+
241
+ - **2.3.4**
242
+ - Updated IDVC component
243
+
244
+ - **2.3.3**
245
+ - fix: QR code process on SPA
246
+
247
+ - **2.3.2**
248
+ - Improving modal window styles
249
+
250
+ - **2.3.1**
251
+ - Updated IDVC component
252
+
253
+ - **2.3.0**
254
+ - 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.
255
+
256
+ - **2.2.27**
257
+ - Updated IDVC component
258
+
259
+ - **2.2.26**
260
+ - Updated IDVC component
261
+
262
+ - **2.2.25**
263
+ - Updated IDVC component
264
+ - fix: wrapper config option 'el'
265
+
266
+ - **2.2.24**
267
+ - Updated IDVC component
268
+
269
+ - **2.2.23**
270
+ - Updated IDVC component
271
+ - feat: simplify the Passport verification, now front step it's union of front and mrz
272
+
273
+ - **2.2.22**
274
+ - Updated IDVC component
275
+
276
+ - **2.2.21**
277
+ - Fixes: The image of the back of the document was not sent when International ID was selected
278
+
279
+ - **2.2.20**
280
+ - Updated IDVC component
281
+ - Fixes: Response when isAuth = true
282
+
283
+ - **2.2.19**
284
+ - Updated IDVC component
285
+
286
+ - **2.2.18**
287
+ - Updated IDVC component
288
+
289
+ - **2.2.17**
290
+ - Added: documents config validation
291
+ - Fixes: QR code processing
292
+
293
+ - **2.2.16**
294
+ - Added: mobile checking for qr code
295
+
296
+ - **2.2.15**
297
+ - Added: new config options 'hideDocumentTitle', 'processingImageFormat'
298
+ - Updated IDVC component
299
+
300
+ - **2.2.14**
301
+ - Change webpack build options. Remove eval
302
+
303
+ - **2.2.13**
304
+ - Added: new config options 'networkUrl', 'useCDN', 'preferApiConfig'
305
+
306
+ - **2.2.12**
307
+ - Updated IDVC component
308
+ - Updated readme
309
+
310
+ - **2.2.11**
311
+ - Feat: some minor fixes
312
+
313
+ - **2.2.10**
314
+ - Feat: face only mode
315
+
316
+ - **2.2.9**
317
+ - Fixed qr link
318
+
319
+ - **2.2.8**
320
+ - Updated IDVC component
321
+
322
+ - **2.2.7**
323
+ - Update TS types
324
+
325
+ - **2.2.6**
326
+ - Fixed config
327
+
328
+ - **2.2.5**
329
+ - Fixed build issue
330
+ - Added: webp support
331
+
332
+ - **2.2.4**
333
+ - Updated IDVC component
334
+
335
+ - **2.2.3**
336
+ - Added: face auth success modal
337
+
338
+ - **2.2.2**
339
+ - Added: config change
340
+ - Changed API calls
341
+
342
+ - **2.2.1**
343
+ - Fix: face validation
344
+
345
+ - **2.2.0**
346
+ - Feat: add flag indicating that only face authentication is required
347
+ - Feat: some minor fixes
348
+
349
+ - **2.1.29**
350
+ - Feat: some minor fixes
351
+
352
+ - **2.1.28**
353
+ - Updated IDVC component
354
+
355
+ - **2.1.27**
356
+ - Updated IDVC component
357
+
358
+ - **2.1.26**
359
+ - Fix: Consent Form styles
360
+
361
+ - **2.1.25**
362
+ - Feat: Add attempt left status text
363
+ - Fix: Validation Modal
364
+
365
+ - **2.1.24**
366
+ - Fix: Consent Form styles
367
+
368
+ - **2.1.23**
369
+ - Feat: rework Consent Form
370
+ - Feat: change Domains Api to Integrations Api
371
+
372
+ - **2.1.22**
373
+ - Fix: embedded app status from api
374
+ - Feat: update IDVC callbacks readme
375
+
376
+ - **2.1.21**
377
+ - Feat: change domain to domainApi
378
+ - Feat: domainApi is required now
379
+
380
+ - **2.1.20**
381
+ - Fix: change showQRCode flag name to showQrCode
382
+
383
+ - **2.1.19**
384
+ - Fix: return old check validation endpoint
385
+ - Feat: add check for showQRCode flag from backend
386
+
387
+ - **2.1.18**
388
+ - Add the possibility of continuing the documents' check on a mobile device
389
+
390
+ - **2.1.17**
391
+ - Change verifyFace option behavior
392
+
393
+ - **2.1.16**
394
+ - Updated IDVC component
395
+
396
+ - **2.1.15**
397
+ - Updated IDVC component
398
+
399
+ - **2.1.14**
400
+ - Updated IDVC component
401
+
402
+ - **2.1.13**
403
+ - Updated IDVC component
404
+
405
+ - **2.1.12**
406
+ - Fix: validation model
407
+
408
+ - **2.1.11**
409
+ - Updated IDVC component
410
+
411
+ - **2.1.10**
412
+ - Updated IDVC component
413
+
414
+ - **2.1.9**
415
+ - Fixed API path
416
+
417
+ - **2.1.8**
418
+ - Updated IDVC component
419
+
420
+ - **2.1.7**
421
+ - Added support for Proxy based frameworks
422
+
423
+ - **2.1.6**
424
+ - Added support for ios < 15
425
+
426
+ - **2.1.5**
427
+ - Updated IDVC component
428
+
429
+ - **2.1.4**
430
+ - Improved document types validation
431
+
432
+ - **2.1.3**
433
+ - Updated IDVC component
434
+
435
+ - **2.1.2**
436
+ - Updated IDVC component
437
+ - Changed: modal message behaviour
438
+
439
+ - **2.1.1**
440
+ - Fixed: submit mrz
441
+
442
+ - **2.1.0**
443
+ - Added: new option in config "chunkPublicPath"
444
+
445
+ - **2.0.19**
446
+ - Updated IDVC component
447
+
448
+ - **2.0.18**
449
+ - Updated IDVC component
450
+
451
+ - **2.0.17**
452
+ - Some improvements
453
+
454
+ - **2.0.16**
455
+ - Some improvements
456
+
457
+ - **2.0.15**
458
+ - Some improvements
459
+
460
+ - **2.0.14**
461
+ - Some improvements
462
+
463
+ - **2.0.13**
464
+ - Updated IDVC component
465
+
466
+ - **2.0.12**
467
+ - Updated IDVC component
468
+
469
+ - **2.0.11**
470
+ - Updated IDVC component
471
+
472
+ - **2.0.10**
473
+ - Updated IDVC component
474
+
475
+ - **2.0.9**
476
+ - Updated IDVC component
477
+
478
+ - **2.0.8**
479
+ - Some improvements
480
+
481
+ - **2.0.7**
482
+ - Fixed background
483
+
484
+ - **2.0.6**
485
+ - Added version 1 config support
486
+
487
+ - **2.0.5**
488
+ - Updated IDVC component
489
+ - Fixed submit method
490
+
491
+ - **2.0.4**
492
+ - Updated IDVC component
493
+
494
+ - **2.0.3**
495
+ - Some improvements
496
+
497
+ - **2.0.2**
498
+ - Updated IDVC component
499
+
500
+ - **2.0.1**
501
+ - Added consent form
502
+
503
+ - **2.0.0**
504
+ - Migrate to the IDVC version 2
505
+
506
+ - **1.0.18**
507
+ - Fixed spinner
508
+
509
+ - **1.0.17**
510
+ - Fixed license key
511
+
512
+ - **1.0.16**
513
+ - Added sign for forced closing of the request
514
+
515
+ - **1.0.15**
516
+ - updated IDVC component
517
+
518
+ - **1.0.14**
519
+ - updated IDVC component
520
+
521
+ - **1.0.13**
522
+ - added ids for style tags
523
+
524
+ - **1.0.12**
525
+ - updated IDVC component
526
+
527
+ - **1.0.11**
528
+ - updated using DVS Online API
529
+
530
+ - **1.0.10**
531
+ - added: onMounted callback
532
+
533
+ - **1.0.9**
534
+ - @idscan/idvc dependency updated
535
+
536
+ - **1.0.8**
537
+ - added: reload component with new configs in demo mode
538
+
539
+ - **1.0.7**
540
+ - updated using DVS Online API
541
+
542
+ - **1.0.6**
543
+ - updated using DVS Online API
544
+
545
+ - **1.0.5**
546
+ - updated IDVC component
547
+ - updated using DVS Online API
548
+
549
+ - **1.0.4**
550
+ - use CDN
551
+
552
+ - **1.0.3**
553
+ - Changed readme
554
+
555
+ - **1.0.2**
556
+ - Some improvements
557
+
558
+ - **1.0.1**
559
+ - Changed readme
560
+
561
+ - **1.0.0**