@regulaforensics/document-reader-webclient 6.9.6 → 7.1.1
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/dist/main/index.cjs +1 -1
- package/dist/module/index.js +1 -1
- package/lib/index.d.ts +564 -105
- package/package.json +1 -1
package/lib/index.d.ts
CHANGED
|
@@ -230,6 +230,145 @@ export interface AreaContainer {
|
|
|
230
230
|
*/
|
|
231
231
|
Points?: Array<PointsContainer>;
|
|
232
232
|
}
|
|
233
|
+
/**
|
|
234
|
+
* Regula Document Reader Web API
|
|
235
|
+
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
236
|
+
*
|
|
237
|
+
* The version of the OpenAPI document: 6.9.0
|
|
238
|
+
*
|
|
239
|
+
*
|
|
240
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
241
|
+
* https://openapi-generator.tech
|
|
242
|
+
* Do not edit the class manually.
|
|
243
|
+
*/
|
|
244
|
+
/**
|
|
245
|
+
*
|
|
246
|
+
* @export
|
|
247
|
+
* @interface LivenessParams
|
|
248
|
+
*/
|
|
249
|
+
export interface LivenessParams {
|
|
250
|
+
/**
|
|
251
|
+
* This parameter is used to enable OVI check
|
|
252
|
+
* @type {boolean}
|
|
253
|
+
* @memberof LivenessParams
|
|
254
|
+
*/
|
|
255
|
+
checkOVI?: boolean;
|
|
256
|
+
/**
|
|
257
|
+
* This parameter is used to enable MLI check
|
|
258
|
+
* @type {boolean}
|
|
259
|
+
* @memberof LivenessParams
|
|
260
|
+
*/
|
|
261
|
+
checkMLI?: boolean;
|
|
262
|
+
/**
|
|
263
|
+
* This parameter is used to enable Hologram detection
|
|
264
|
+
* @type {boolean}
|
|
265
|
+
* @memberof LivenessParams
|
|
266
|
+
*/
|
|
267
|
+
checkHolo?: boolean;
|
|
268
|
+
/**
|
|
269
|
+
* This parameter is used to enable Electronic device detection
|
|
270
|
+
* @type {boolean}
|
|
271
|
+
* @memberof LivenessParams
|
|
272
|
+
*/
|
|
273
|
+
checkED?: boolean;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
*
|
|
277
|
+
* @export
|
|
278
|
+
* @interface AuthParams
|
|
279
|
+
*/
|
|
280
|
+
export interface AuthParams {
|
|
281
|
+
/**
|
|
282
|
+
* This parameter is used to enable document liveness check
|
|
283
|
+
* @type {boolean}
|
|
284
|
+
* @memberof AuthParams
|
|
285
|
+
*/
|
|
286
|
+
checkLiveness?: boolean;
|
|
287
|
+
/**
|
|
288
|
+
*
|
|
289
|
+
* @type {LivenessParams}
|
|
290
|
+
* @memberof AuthParams
|
|
291
|
+
*/
|
|
292
|
+
livenessParams?: LivenessParams;
|
|
293
|
+
/**
|
|
294
|
+
* This parameter is used to enable Document luminescence check in UV light
|
|
295
|
+
* @type {boolean}
|
|
296
|
+
* @memberof AuthParams
|
|
297
|
+
*/
|
|
298
|
+
checkUVLuminiscence?: boolean;
|
|
299
|
+
/**
|
|
300
|
+
* This parameter is used to enable B900 ink MRZ contrast check in IR light
|
|
301
|
+
* @type {boolean}
|
|
302
|
+
* @memberof AuthParams
|
|
303
|
+
*/
|
|
304
|
+
checkIRB900?: boolean;
|
|
305
|
+
/**
|
|
306
|
+
* This parameter is used to enable Image patterns presence/absence check (position, shape, color)
|
|
307
|
+
* @type {boolean}
|
|
308
|
+
* @memberof AuthParams
|
|
309
|
+
*/
|
|
310
|
+
checkImagePatterns?: boolean;
|
|
311
|
+
/**
|
|
312
|
+
* This parameter is used to enable Fibers detection
|
|
313
|
+
* @type {boolean}
|
|
314
|
+
* @memberof AuthParams
|
|
315
|
+
*/
|
|
316
|
+
checkFibers?: boolean;
|
|
317
|
+
/**
|
|
318
|
+
* This parameter is used to enable Extended MRZ Check
|
|
319
|
+
* @type {boolean}
|
|
320
|
+
* @memberof AuthParams
|
|
321
|
+
*/
|
|
322
|
+
checkExtMRZ?: boolean;
|
|
323
|
+
/**
|
|
324
|
+
* This parameter is used to enable Extended OCR Check
|
|
325
|
+
* @type {boolean}
|
|
326
|
+
* @memberof AuthParams
|
|
327
|
+
*/
|
|
328
|
+
checkExtOCR?: boolean;
|
|
329
|
+
/**
|
|
330
|
+
* This parameter is used to enable laminate integrity check in axial light
|
|
331
|
+
* @type {boolean}
|
|
332
|
+
* @memberof AuthParams
|
|
333
|
+
*/
|
|
334
|
+
checkAxial?: boolean;
|
|
335
|
+
/**
|
|
336
|
+
* This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)
|
|
337
|
+
* @type {boolean}
|
|
338
|
+
* @memberof AuthParams
|
|
339
|
+
*/
|
|
340
|
+
checkBarcodeFormat?: boolean;
|
|
341
|
+
/**
|
|
342
|
+
* This parameter is used to enable Document elements visibility check in IR light
|
|
343
|
+
* @type {boolean}
|
|
344
|
+
* @memberof AuthParams
|
|
345
|
+
*/
|
|
346
|
+
checkIRVisibility?: boolean;
|
|
347
|
+
/**
|
|
348
|
+
* This parameter is used to enable Invisible Personal Information (IPI) check
|
|
349
|
+
* @type {boolean}
|
|
350
|
+
* @memberof AuthParams
|
|
351
|
+
*/
|
|
352
|
+
checkIPI?: boolean;
|
|
353
|
+
/**
|
|
354
|
+
* This parameter is used to enable Owner\'s photo embedding check (is photo printed or sticked)
|
|
355
|
+
* @type {boolean}
|
|
356
|
+
* @memberof AuthParams
|
|
357
|
+
*/
|
|
358
|
+
checkPhotoEmbedding?: boolean;
|
|
359
|
+
/**
|
|
360
|
+
* This parameter is used to enable Portrait comparison check
|
|
361
|
+
* @type {boolean}
|
|
362
|
+
* @memberof AuthParams
|
|
363
|
+
*/
|
|
364
|
+
checkPhotoComparison?: boolean;
|
|
365
|
+
/**
|
|
366
|
+
* This parameter is used to enable LetterScreen check
|
|
367
|
+
* @type {boolean}
|
|
368
|
+
* @memberof AuthParams
|
|
369
|
+
*/
|
|
370
|
+
checkLetterScreen?: boolean;
|
|
371
|
+
}
|
|
233
372
|
/**
|
|
234
373
|
* Regula Document Reader Web API
|
|
235
374
|
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
@@ -402,6 +541,7 @@ export enum CheckDiagnose {
|
|
|
402
541
|
INCORRECT_TEXT_COLOR = 26,
|
|
403
542
|
PHOTO_FALSE_LUMINESCENCE = 27,
|
|
404
543
|
TOO_MUCH_SHIFT = 28,
|
|
544
|
+
CONTACT_CHIP_TYPE_MISMATCH = 29,
|
|
405
545
|
FIBERS_NOT_FOUND = 30,
|
|
406
546
|
TOO_MANY_OBJECTS = 31,
|
|
407
547
|
SPECKS_IN_UV = 33,
|
|
@@ -746,7 +886,31 @@ export enum SecurityFeatureType {
|
|
|
746
886
|
/**
|
|
747
887
|
* Liveness barcode background
|
|
748
888
|
*/
|
|
749
|
-
LIVENESS_BARCODE_BACKGROUND = 45
|
|
889
|
+
LIVENESS_BARCODE_BACKGROUND = 45,
|
|
890
|
+
/**
|
|
891
|
+
* Visual zone portrait image vs. image from barcode
|
|
892
|
+
*/
|
|
893
|
+
PORTRAIT_COMPARISON_VS_BARCODE = 46,
|
|
894
|
+
/**
|
|
895
|
+
* Image from barcode vs. image from RFID
|
|
896
|
+
*/
|
|
897
|
+
PORTRAIT_COMPARISON_RFID_VS_BARCODE = 47,
|
|
898
|
+
/**
|
|
899
|
+
* Image from barcode vs. external source image
|
|
900
|
+
*/
|
|
901
|
+
PORTRAIT_COMPARISON_EXT_VS_BARCODE = 48,
|
|
902
|
+
/**
|
|
903
|
+
* Image from barcode vs. photo from camera
|
|
904
|
+
*/
|
|
905
|
+
PORTRAIT_COMPARISON_BARCODE_VS_CAMERA = 49,
|
|
906
|
+
/**
|
|
907
|
+
* Digital signature сheck
|
|
908
|
+
*/
|
|
909
|
+
CHECK_DIGITAL_SIGNATURE = 50,
|
|
910
|
+
/**
|
|
911
|
+
* Contact сhip check
|
|
912
|
+
*/
|
|
913
|
+
CONTACT_CHIP_CLASSIFICATION = 51
|
|
750
914
|
}
|
|
751
915
|
/**
|
|
752
916
|
*
|
|
@@ -2882,6 +3046,10 @@ export enum GraphicFieldType {
|
|
|
2882
3046
|
*/
|
|
2883
3047
|
STAMP = 211,
|
|
2884
3048
|
/**
|
|
3049
|
+
* Contact chip
|
|
3050
|
+
*/
|
|
3051
|
+
CONTACT_CHIP = 213,
|
|
3052
|
+
/**
|
|
2885
3053
|
* Undefined image type
|
|
2886
3054
|
*/
|
|
2887
3055
|
OTHER = 250,
|
|
@@ -3488,26 +3656,10 @@ export enum LCID {
|
|
|
3488
3656
|
*/
|
|
3489
3657
|
CATALAN = 1027,
|
|
3490
3658
|
/**
|
|
3491
|
-
* Chinese (HongKong S.A.R.)
|
|
3492
|
-
*/
|
|
3493
|
-
CHINESE_HONGKONG_SAR = 3076,
|
|
3494
|
-
/**
|
|
3495
|
-
* Chinese (Macao S.A.R.)
|
|
3496
|
-
*/
|
|
3497
|
-
CHINESE_MACAO_SAR = 5124,
|
|
3498
|
-
/**
|
|
3499
3659
|
* Chinese
|
|
3500
3660
|
*/
|
|
3501
3661
|
CHINESE = 2052,
|
|
3502
3662
|
/**
|
|
3503
|
-
* Chinese (Singapore)
|
|
3504
|
-
*/
|
|
3505
|
-
CHINESE_SINGAPORE = 4100,
|
|
3506
|
-
/**
|
|
3507
|
-
* Chinese (Taiwan)
|
|
3508
|
-
*/
|
|
3509
|
-
CHINESE_TAIWAN = 1028,
|
|
3510
|
-
/**
|
|
3511
3663
|
* Croatian
|
|
3512
3664
|
*/
|
|
3513
3665
|
CROATIAN = 1050,
|
|
@@ -3520,10 +3672,6 @@ export enum LCID {
|
|
|
3520
3672
|
*/
|
|
3521
3673
|
DANISH = 1030,
|
|
3522
3674
|
/**
|
|
3523
|
-
* Divehi
|
|
3524
|
-
*/
|
|
3525
|
-
DIVEHI = 1125,
|
|
3526
|
-
/**
|
|
3527
3675
|
* Dutch (Belgium)
|
|
3528
3676
|
*/
|
|
3529
3677
|
DUTCH_BELGIUM = 2067,
|
|
@@ -3796,6 +3944,10 @@ export enum LCID {
|
|
|
3796
3944
|
*/
|
|
3797
3945
|
SERBIAN_LATIN = 2074,
|
|
3798
3946
|
/**
|
|
3947
|
+
* Sinhala
|
|
3948
|
+
*/
|
|
3949
|
+
SINHALA = 1115,
|
|
3950
|
+
/**
|
|
3799
3951
|
* Slovak
|
|
3800
3952
|
*/
|
|
3801
3953
|
SLOVAK = 1051,
|
|
@@ -3896,10 +4048,6 @@ export enum LCID {
|
|
|
3896
4048
|
*/
|
|
3897
4049
|
SWEDISH_FINLAND = 2077,
|
|
3898
4050
|
/**
|
|
3899
|
-
* Syriac
|
|
3900
|
-
*/
|
|
3901
|
-
SYRIAC = 1114,
|
|
3902
|
-
/**
|
|
3903
4051
|
* Tamil
|
|
3904
4052
|
*/
|
|
3905
4053
|
TAMIL = 1097,
|
|
@@ -3966,7 +4114,79 @@ export enum LCID {
|
|
|
3966
4114
|
/**
|
|
3967
4115
|
* Assamese
|
|
3968
4116
|
*/
|
|
3969
|
-
Assamese = 1101
|
|
4117
|
+
Assamese = 1101,
|
|
4118
|
+
/**
|
|
4119
|
+
* Oriya
|
|
4120
|
+
*/
|
|
4121
|
+
ORIYA = 1096,
|
|
4122
|
+
/**
|
|
4123
|
+
* Malayalam
|
|
4124
|
+
*/
|
|
4125
|
+
MALAYALAM = 1100,
|
|
4126
|
+
/**
|
|
4127
|
+
* Lao
|
|
4128
|
+
*/
|
|
4129
|
+
LAO = 1108,
|
|
4130
|
+
/**
|
|
4131
|
+
* Sindhi (India)
|
|
4132
|
+
*/
|
|
4133
|
+
SINDHI_INDIA = 1113,
|
|
4134
|
+
/**
|
|
4135
|
+
* Amharic
|
|
4136
|
+
*/
|
|
4137
|
+
AMHARIC = 1118,
|
|
4138
|
+
/**
|
|
4139
|
+
* Kashmiri
|
|
4140
|
+
*/
|
|
4141
|
+
KASHMIRI = 1120,
|
|
4142
|
+
/**
|
|
4143
|
+
* Nepali
|
|
4144
|
+
*/
|
|
4145
|
+
NEPALI = 1121,
|
|
4146
|
+
/**
|
|
4147
|
+
* Pashto
|
|
4148
|
+
*/
|
|
4149
|
+
PASHTO = 1123,
|
|
4150
|
+
/**
|
|
4151
|
+
* Sindhi
|
|
4152
|
+
*/
|
|
4153
|
+
SINDHI = 2137,
|
|
4154
|
+
/**
|
|
4155
|
+
* Arabic (World)
|
|
4156
|
+
*/
|
|
4157
|
+
ARABIC = 4096,
|
|
4158
|
+
/**
|
|
4159
|
+
* Bank Card Number
|
|
4160
|
+
*/
|
|
4161
|
+
BANK_CARD_NUMBER = 10000,
|
|
4162
|
+
/**
|
|
4163
|
+
* Bank Card Expiry Date
|
|
4164
|
+
*/
|
|
4165
|
+
BANK_CARD_EXPIRY_DATE = 10001,
|
|
4166
|
+
/**
|
|
4167
|
+
* Bank Card Name
|
|
4168
|
+
*/
|
|
4169
|
+
BANK_CARD_NAME = 10002,
|
|
4170
|
+
/**
|
|
4171
|
+
* Bank Card
|
|
4172
|
+
*/
|
|
4173
|
+
BANK_CARD = 10003,
|
|
4174
|
+
/**
|
|
4175
|
+
* Bank Card CVV2
|
|
4176
|
+
*/
|
|
4177
|
+
BANK_CARD_CVV2 = 10004,
|
|
4178
|
+
/**
|
|
4179
|
+
* Abkhazian (Cyrillic)
|
|
4180
|
+
*/
|
|
4181
|
+
ABKHAZIAN = 10011,
|
|
4182
|
+
/**
|
|
4183
|
+
* Karakalpak (Latin)
|
|
4184
|
+
*/
|
|
4185
|
+
KARAKALPAK = 10012,
|
|
4186
|
+
/**
|
|
4187
|
+
* Urdu Detection
|
|
4188
|
+
*/
|
|
4189
|
+
URDU_DETECTION = 10560
|
|
3970
4190
|
}
|
|
3971
4191
|
/**
|
|
3972
4192
|
* Regula Document Reader Web API
|
|
@@ -6492,7 +6712,15 @@ export enum TextFieldType {
|
|
|
6492
6712
|
/**
|
|
6493
6713
|
* Building type
|
|
6494
6714
|
*/
|
|
6495
|
-
ADDRESS_BUILDING_TYPE = 680
|
|
6715
|
+
ADDRESS_BUILDING_TYPE = 680,
|
|
6716
|
+
/**
|
|
6717
|
+
* Date of Retirement
|
|
6718
|
+
*/
|
|
6719
|
+
DATE_OF_RETIREMENT = 681,
|
|
6720
|
+
/**
|
|
6721
|
+
* Document Status
|
|
6722
|
+
*/
|
|
6723
|
+
DOCUMENT_STATUS = 682
|
|
6496
6724
|
}
|
|
6497
6725
|
/**
|
|
6498
6726
|
* Regula Document Reader Web API
|
|
@@ -7658,6 +7886,246 @@ export interface ImageQA {
|
|
|
7658
7886
|
*/
|
|
7659
7887
|
documentPositionIndent?: number;
|
|
7660
7888
|
}
|
|
7889
|
+
/**
|
|
7890
|
+
* Regula Document Reader Web API
|
|
7891
|
+
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
7892
|
+
*
|
|
7893
|
+
* The version of the OpenAPI document: 6.9.0
|
|
7894
|
+
*
|
|
7895
|
+
*
|
|
7896
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7897
|
+
* https://openapi-generator.tech
|
|
7898
|
+
* Do not edit the class manually.
|
|
7899
|
+
*/
|
|
7900
|
+
/**
|
|
7901
|
+
*
|
|
7902
|
+
* @export
|
|
7903
|
+
* @interface InDataRfidSession
|
|
7904
|
+
*/
|
|
7905
|
+
export interface InDataRfidSession {
|
|
7906
|
+
/**
|
|
7907
|
+
* Image url
|
|
7908
|
+
* @type {string}
|
|
7909
|
+
* @memberof InDataRfidSession
|
|
7910
|
+
*/
|
|
7911
|
+
url?: string;
|
|
7912
|
+
}
|
|
7913
|
+
/**
|
|
7914
|
+
* Regula Document Reader Web API
|
|
7915
|
+
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
7916
|
+
*
|
|
7917
|
+
* The version of the OpenAPI document: 6.9.0
|
|
7918
|
+
*
|
|
7919
|
+
*
|
|
7920
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7921
|
+
* https://openapi-generator.tech
|
|
7922
|
+
* Do not edit the class manually.
|
|
7923
|
+
*/
|
|
7924
|
+
/**
|
|
7925
|
+
* Video
|
|
7926
|
+
* @export
|
|
7927
|
+
* @interface InDataVideo
|
|
7928
|
+
*/
|
|
7929
|
+
export interface InDataVideo {
|
|
7930
|
+
/**
|
|
7931
|
+
* A free-form object containing video\'s extended attributes.
|
|
7932
|
+
* @type {{ [key: string]: object; }}
|
|
7933
|
+
* @memberof InDataVideo
|
|
7934
|
+
*/
|
|
7935
|
+
metadata?: {
|
|
7936
|
+
[key: string]: object;
|
|
7937
|
+
};
|
|
7938
|
+
/**
|
|
7939
|
+
* Video url
|
|
7940
|
+
* @type {string}
|
|
7941
|
+
* @memberof InDataVideo
|
|
7942
|
+
*/
|
|
7943
|
+
url?: string;
|
|
7944
|
+
}
|
|
7945
|
+
/**
|
|
7946
|
+
*
|
|
7947
|
+
* @export
|
|
7948
|
+
* @interface InData
|
|
7949
|
+
*/
|
|
7950
|
+
export interface InData {
|
|
7951
|
+
/**
|
|
7952
|
+
*
|
|
7953
|
+
* @type {InDataRfidSession}
|
|
7954
|
+
* @memberof InData
|
|
7955
|
+
*/
|
|
7956
|
+
rfidSession?: InDataRfidSession;
|
|
7957
|
+
/**
|
|
7958
|
+
*
|
|
7959
|
+
* @type {InDataVideo}
|
|
7960
|
+
* @memberof InData
|
|
7961
|
+
*/
|
|
7962
|
+
video?: InDataVideo;
|
|
7963
|
+
/**
|
|
7964
|
+
*
|
|
7965
|
+
* @type {Array<Array<ImagesFieldValue>>}
|
|
7966
|
+
* @memberof InData
|
|
7967
|
+
*/
|
|
7968
|
+
images?: Array<Array<ImagesFieldValue>>;
|
|
7969
|
+
}
|
|
7970
|
+
/**
|
|
7971
|
+
* Regula Document Reader Web API
|
|
7972
|
+
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
7973
|
+
*
|
|
7974
|
+
* The version of the OpenAPI document: 6.9.0
|
|
7975
|
+
*
|
|
7976
|
+
*
|
|
7977
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7978
|
+
* https://openapi-generator.tech
|
|
7979
|
+
* Do not edit the class manually.
|
|
7980
|
+
*/
|
|
7981
|
+
/**
|
|
7982
|
+
*
|
|
7983
|
+
* @export
|
|
7984
|
+
* @interface InlineResponse200
|
|
7985
|
+
*/
|
|
7986
|
+
export interface InlineResponse200 {
|
|
7987
|
+
/**
|
|
7988
|
+
*
|
|
7989
|
+
* @type {string}
|
|
7990
|
+
* @memberof InlineResponse200
|
|
7991
|
+
*/
|
|
7992
|
+
tag?: string;
|
|
7993
|
+
/**
|
|
7994
|
+
*
|
|
7995
|
+
* @type {string}
|
|
7996
|
+
* @memberof InlineResponse200
|
|
7997
|
+
*/
|
|
7998
|
+
transactionId?: string;
|
|
7999
|
+
}
|
|
8000
|
+
/**
|
|
8001
|
+
* Regula Document Reader Web API
|
|
8002
|
+
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
8003
|
+
*
|
|
8004
|
+
* The version of the OpenAPI document: 6.9.0
|
|
8005
|
+
*
|
|
8006
|
+
*
|
|
8007
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8008
|
+
* https://openapi-generator.tech
|
|
8009
|
+
* Do not edit the class manually.
|
|
8010
|
+
*/
|
|
8011
|
+
/**
|
|
8012
|
+
*
|
|
8013
|
+
* @export
|
|
8014
|
+
* @enum {string}
|
|
8015
|
+
*/
|
|
8016
|
+
export enum ProcessingStatus {
|
|
8017
|
+
/**
|
|
8018
|
+
* Processing was not finished
|
|
8019
|
+
*/
|
|
8020
|
+
NOT_FINISHED = 0,
|
|
8021
|
+
/**
|
|
8022
|
+
* Processing finished
|
|
8023
|
+
*/
|
|
8024
|
+
FINISHED = 1,
|
|
8025
|
+
/**
|
|
8026
|
+
* Processing finished by timeout
|
|
8027
|
+
*/
|
|
8028
|
+
TIMEOUT = 2
|
|
8029
|
+
}
|
|
8030
|
+
/**
|
|
8031
|
+
* Regula Document Reader Web API
|
|
8032
|
+
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
8033
|
+
*
|
|
8034
|
+
* The version of the OpenAPI document: 6.9.0
|
|
8035
|
+
*
|
|
8036
|
+
*
|
|
8037
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8038
|
+
* https://openapi-generator.tech
|
|
8039
|
+
* Do not edit the class manually.
|
|
8040
|
+
*/
|
|
8041
|
+
/**
|
|
8042
|
+
*
|
|
8043
|
+
* @export
|
|
8044
|
+
* @interface TransactionInfo
|
|
8045
|
+
*/
|
|
8046
|
+
export interface TransactionInfo {
|
|
8047
|
+
/**
|
|
8048
|
+
*
|
|
8049
|
+
* @type {string}
|
|
8050
|
+
* @memberof TransactionInfo
|
|
8051
|
+
*/
|
|
8052
|
+
ComputerName?: string;
|
|
8053
|
+
/**
|
|
8054
|
+
*
|
|
8055
|
+
* @type {string}
|
|
8056
|
+
* @memberof TransactionInfo
|
|
8057
|
+
*/
|
|
8058
|
+
DateTime?: string;
|
|
8059
|
+
/**
|
|
8060
|
+
*
|
|
8061
|
+
* @type {string}
|
|
8062
|
+
* @memberof TransactionInfo
|
|
8063
|
+
*/
|
|
8064
|
+
TransactionID?: string;
|
|
8065
|
+
/**
|
|
8066
|
+
*
|
|
8067
|
+
* @type {string}
|
|
8068
|
+
* @memberof TransactionInfo
|
|
8069
|
+
*/
|
|
8070
|
+
UserName?: string;
|
|
8071
|
+
}
|
|
8072
|
+
/**
|
|
8073
|
+
*
|
|
8074
|
+
* @export
|
|
8075
|
+
* @interface InlineResponse2001
|
|
8076
|
+
*/
|
|
8077
|
+
export interface InlineResponse2001 {
|
|
8078
|
+
/**
|
|
8079
|
+
*
|
|
8080
|
+
* @type {RfidLocation}
|
|
8081
|
+
* @memberof InlineResponse2001
|
|
8082
|
+
*/
|
|
8083
|
+
ChipPage?: RfidLocation;
|
|
8084
|
+
/**
|
|
8085
|
+
*
|
|
8086
|
+
* @type {ProcessingStatus}
|
|
8087
|
+
* @memberof InlineResponse2001
|
|
8088
|
+
*/
|
|
8089
|
+
ProcessingFinished?: ProcessingStatus;
|
|
8090
|
+
/**
|
|
8091
|
+
*
|
|
8092
|
+
* @type {ContainerList}
|
|
8093
|
+
* @memberof InlineResponse2001
|
|
8094
|
+
*/
|
|
8095
|
+
ContainerList?: ContainerList;
|
|
8096
|
+
/**
|
|
8097
|
+
*
|
|
8098
|
+
* @type {TransactionInfo}
|
|
8099
|
+
* @memberof InlineResponse2001
|
|
8100
|
+
*/
|
|
8101
|
+
TransactionInfo?: TransactionInfo;
|
|
8102
|
+
/**
|
|
8103
|
+
* Base64 encoded transaction processing log
|
|
8104
|
+
* @type {string}
|
|
8105
|
+
* @memberof InlineResponse2001
|
|
8106
|
+
*/
|
|
8107
|
+
log?: string;
|
|
8108
|
+
/**
|
|
8109
|
+
* Free-form object provided in request. See passBackObject property of ProcessRequest.
|
|
8110
|
+
* @type {{ [key: string]: object; }}
|
|
8111
|
+
* @memberof InlineResponse2001
|
|
8112
|
+
*/
|
|
8113
|
+
passBackObject?: {
|
|
8114
|
+
[key: string]: object;
|
|
8115
|
+
};
|
|
8116
|
+
/**
|
|
8117
|
+
*
|
|
8118
|
+
* @type {number}
|
|
8119
|
+
* @memberof InlineResponse2001
|
|
8120
|
+
*/
|
|
8121
|
+
morePagesAvailable?: number;
|
|
8122
|
+
/**
|
|
8123
|
+
* Time the document processing has taken, ms.
|
|
8124
|
+
* @type {number}
|
|
8125
|
+
* @memberof InlineResponse2001
|
|
8126
|
+
*/
|
|
8127
|
+
elapsedTime?: number;
|
|
8128
|
+
}
|
|
7661
8129
|
/**
|
|
7662
8130
|
* Regula Document Reader Web API
|
|
7663
8131
|
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
@@ -7764,6 +8232,30 @@ export enum MeasureSystem {
|
|
|
7764
8232
|
*/
|
|
7765
8233
|
IMPERIAL = 1
|
|
7766
8234
|
}
|
|
8235
|
+
/**
|
|
8236
|
+
* Regula Document Reader Web API
|
|
8237
|
+
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
8238
|
+
*
|
|
8239
|
+
* The version of the OpenAPI document: 6.9.0
|
|
8240
|
+
*
|
|
8241
|
+
*
|
|
8242
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8243
|
+
* https://openapi-generator.tech
|
|
8244
|
+
* Do not edit the class manually.
|
|
8245
|
+
*/
|
|
8246
|
+
/**
|
|
8247
|
+
*
|
|
8248
|
+
* @export
|
|
8249
|
+
* @interface OutData
|
|
8250
|
+
*/
|
|
8251
|
+
export interface OutData {
|
|
8252
|
+
/**
|
|
8253
|
+
* Image url
|
|
8254
|
+
* @type {string}
|
|
8255
|
+
* @memberof OutData
|
|
8256
|
+
*/
|
|
8257
|
+
url?: string;
|
|
8258
|
+
}
|
|
7767
8259
|
/**
|
|
7768
8260
|
* Regula Document Reader Web API
|
|
7769
8261
|
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
@@ -8951,12 +9443,6 @@ export interface ProcessParams {
|
|
|
8951
9443
|
* @memberof ProcessParams
|
|
8952
9444
|
*/
|
|
8953
9445
|
lcidFilter?: Array<number>;
|
|
8954
|
-
/**
|
|
8955
|
-
* This parameter is used to enable document liveness check.
|
|
8956
|
-
* @type {boolean}
|
|
8957
|
-
* @memberof ProcessParams
|
|
8958
|
-
*/
|
|
8959
|
-
checkLiveness?: boolean;
|
|
8960
9446
|
/**
|
|
8961
9447
|
* The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default.
|
|
8962
9448
|
* @type {Array<number>}
|
|
@@ -9015,6 +9501,7 @@ export interface ProcessParams {
|
|
|
9015
9501
|
* Enable this option if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or some others. Disabled by default.
|
|
9016
9502
|
* @type {boolean}
|
|
9017
9503
|
* @memberof ProcessParams
|
|
9504
|
+
* @deprecated
|
|
9018
9505
|
*/
|
|
9019
9506
|
doublePageSpread?: boolean;
|
|
9020
9507
|
/**
|
|
@@ -9095,6 +9582,7 @@ export interface ProcessParams {
|
|
|
9095
9582
|
* When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds. Enabled by default.
|
|
9096
9583
|
* @type {boolean}
|
|
9097
9584
|
* @memberof ProcessParams
|
|
9585
|
+
* @deprecated
|
|
9098
9586
|
*/
|
|
9099
9587
|
fastDocDetect?: boolean;
|
|
9100
9588
|
/**
|
|
@@ -9259,6 +9747,18 @@ export interface ProcessParams {
|
|
|
9259
9747
|
* @memberof ProcessParams
|
|
9260
9748
|
*/
|
|
9261
9749
|
rfid?: ProcessParamsRfid;
|
|
9750
|
+
/**
|
|
9751
|
+
* This parameter is used to enable authenticity checks
|
|
9752
|
+
* @type {boolean}
|
|
9753
|
+
* @memberof ProcessParams
|
|
9754
|
+
*/
|
|
9755
|
+
checkAuth?: boolean;
|
|
9756
|
+
/**
|
|
9757
|
+
*
|
|
9758
|
+
* @type {AuthParams}
|
|
9759
|
+
* @memberof ProcessParams
|
|
9760
|
+
*/
|
|
9761
|
+
authParams?: AuthParams;
|
|
9262
9762
|
}
|
|
9263
9763
|
/**
|
|
9264
9764
|
*
|
|
@@ -9372,78 +9872,6 @@ export interface ProcessRequest {
|
|
|
9372
9872
|
[key: string]: object;
|
|
9373
9873
|
};
|
|
9374
9874
|
}
|
|
9375
|
-
/**
|
|
9376
|
-
* Regula Document Reader Web API
|
|
9377
|
-
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
9378
|
-
*
|
|
9379
|
-
* The version of the OpenAPI document: 6.9.0
|
|
9380
|
-
*
|
|
9381
|
-
*
|
|
9382
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9383
|
-
* https://openapi-generator.tech
|
|
9384
|
-
* Do not edit the class manually.
|
|
9385
|
-
*/
|
|
9386
|
-
/**
|
|
9387
|
-
*
|
|
9388
|
-
* @export
|
|
9389
|
-
* @enum {string}
|
|
9390
|
-
*/
|
|
9391
|
-
export enum ProcessingStatus {
|
|
9392
|
-
/**
|
|
9393
|
-
* Processing was not finished
|
|
9394
|
-
*/
|
|
9395
|
-
NOT_FINISHED = 0,
|
|
9396
|
-
/**
|
|
9397
|
-
* Processing finished
|
|
9398
|
-
*/
|
|
9399
|
-
FINISHED = 1,
|
|
9400
|
-
/**
|
|
9401
|
-
* Processing finished by timeout
|
|
9402
|
-
*/
|
|
9403
|
-
TIMEOUT = 2
|
|
9404
|
-
}
|
|
9405
|
-
/**
|
|
9406
|
-
* Regula Document Reader Web API
|
|
9407
|
-
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
9408
|
-
*
|
|
9409
|
-
* The version of the OpenAPI document: 6.9.0
|
|
9410
|
-
*
|
|
9411
|
-
*
|
|
9412
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9413
|
-
* https://openapi-generator.tech
|
|
9414
|
-
* Do not edit the class manually.
|
|
9415
|
-
*/
|
|
9416
|
-
/**
|
|
9417
|
-
*
|
|
9418
|
-
* @export
|
|
9419
|
-
* @interface TransactionInfo
|
|
9420
|
-
*/
|
|
9421
|
-
export interface TransactionInfo {
|
|
9422
|
-
/**
|
|
9423
|
-
*
|
|
9424
|
-
* @type {string}
|
|
9425
|
-
* @memberof TransactionInfo
|
|
9426
|
-
*/
|
|
9427
|
-
ComputerName?: string;
|
|
9428
|
-
/**
|
|
9429
|
-
*
|
|
9430
|
-
* @type {string}
|
|
9431
|
-
* @memberof TransactionInfo
|
|
9432
|
-
*/
|
|
9433
|
-
DateTime?: string;
|
|
9434
|
-
/**
|
|
9435
|
-
*
|
|
9436
|
-
* @type {string}
|
|
9437
|
-
* @memberof TransactionInfo
|
|
9438
|
-
*/
|
|
9439
|
-
TransactionID?: string;
|
|
9440
|
-
/**
|
|
9441
|
-
*
|
|
9442
|
-
* @type {string}
|
|
9443
|
-
* @memberof TransactionInfo
|
|
9444
|
-
*/
|
|
9445
|
-
UserName?: string;
|
|
9446
|
-
}
|
|
9447
9875
|
/**
|
|
9448
9876
|
*
|
|
9449
9877
|
* @export
|
|
@@ -9501,6 +9929,37 @@ export interface ProcessResponse {
|
|
|
9501
9929
|
*/
|
|
9502
9930
|
elapsedTime?: number;
|
|
9503
9931
|
}
|
|
9932
|
+
/**
|
|
9933
|
+
*
|
|
9934
|
+
* @export
|
|
9935
|
+
* @interface TransactionProcessGetResponse
|
|
9936
|
+
*/
|
|
9937
|
+
export interface TransactionProcessGetResponse {
|
|
9938
|
+
/**
|
|
9939
|
+
*
|
|
9940
|
+
* @type {number}
|
|
9941
|
+
* @memberof TransactionProcessGetResponse
|
|
9942
|
+
*/
|
|
9943
|
+
transactionId?: number;
|
|
9944
|
+
/**
|
|
9945
|
+
*
|
|
9946
|
+
* @type {string}
|
|
9947
|
+
* @memberof TransactionProcessGetResponse
|
|
9948
|
+
*/
|
|
9949
|
+
tag?: string;
|
|
9950
|
+
/**
|
|
9951
|
+
*
|
|
9952
|
+
* @type {OutData}
|
|
9953
|
+
* @memberof TransactionProcessGetResponse
|
|
9954
|
+
*/
|
|
9955
|
+
outData?: OutData;
|
|
9956
|
+
/**
|
|
9957
|
+
*
|
|
9958
|
+
* @type {InData}
|
|
9959
|
+
* @memberof TransactionProcessGetResponse
|
|
9960
|
+
*/
|
|
9961
|
+
inData?: InData;
|
|
9962
|
+
}
|
|
9504
9963
|
export class TextFieldExt implements TextField {
|
|
9505
9964
|
fieldType: TextFieldType;
|
|
9506
9965
|
fieldName: string;
|