@regulaforensics/document-reader-webclient 7.4.95 → 7.4.286-nightly
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 +391 -52
- package/package.json +4 -4
package/lib/index.d.ts
CHANGED
|
@@ -423,11 +423,11 @@ export enum AuthenticityResultType {
|
|
|
423
423
|
*/
|
|
424
424
|
PHOTO_EMBED_TYPE = 512,
|
|
425
425
|
/**
|
|
426
|
-
* OVI check
|
|
426
|
+
* OVI check. Deprecated, use Document liveness check instead
|
|
427
427
|
*/
|
|
428
428
|
OVI = 1024,
|
|
429
429
|
/**
|
|
430
|
-
* Hologram presence check
|
|
430
|
+
* Hologram presence check. Deprecated
|
|
431
431
|
*/
|
|
432
432
|
HOLOGRAMS = 4096,
|
|
433
433
|
/**
|
|
@@ -571,6 +571,7 @@ export enum CheckDiagnose {
|
|
|
571
571
|
FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR = 83,
|
|
572
572
|
FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR = 84,
|
|
573
573
|
FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR = 85,
|
|
574
|
+
FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION = 86,
|
|
574
575
|
OVI_IR_INVISIBLE = 90,
|
|
575
576
|
OVI_INSUFFICIENT_AREA = 91,
|
|
576
577
|
OVI_COLOR_INVARIABLE = 92,
|
|
@@ -605,6 +606,7 @@ export enum CheckDiagnose {
|
|
|
605
606
|
BARCODE_SIZE_PARAMS_ERROR = 142,
|
|
606
607
|
NOT_ALL_BARCODES_READ = 143,
|
|
607
608
|
GLARES_IN_BARCODE_AREA = 144,
|
|
609
|
+
NO_CERTIFICATE_FOR_DIGITAL_SIGNATURE_CHECK = 145,
|
|
608
610
|
PORTRAIT_COMPARISON_PORTRAITS_DIFFER = 150,
|
|
609
611
|
PORTRAIT_COMPARISON_NO_SERVICE_REPLY = 151,
|
|
610
612
|
PORTRAIT_COMPARISON_SERVICE_ERROR = 152,
|
|
@@ -634,6 +636,7 @@ export enum CheckDiagnose {
|
|
|
634
636
|
OCR_QUALITY_INVALID_FONT = 221,
|
|
635
637
|
OCR_QUALITY_INVALID_BACKGROUND = 222,
|
|
636
638
|
LASINK_INVALID_LINES_FREQUENCY = 230,
|
|
639
|
+
DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED = 239,
|
|
637
640
|
DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED = 240,
|
|
638
641
|
DOC_LIVENESS_INVALID_BARCODE_BACKGROUND = 241,
|
|
639
642
|
CHD_ICAO_IDB_BASE32_ERROR = 243,
|
|
@@ -667,6 +670,12 @@ export interface ImageData {
|
|
|
667
670
|
* @memberof ImageData
|
|
668
671
|
*/
|
|
669
672
|
image: string;
|
|
673
|
+
/**
|
|
674
|
+
* Image format
|
|
675
|
+
* @type {string}
|
|
676
|
+
* @memberof ImageData
|
|
677
|
+
*/
|
|
678
|
+
format?: string;
|
|
670
679
|
}
|
|
671
680
|
/**
|
|
672
681
|
* Regula Document Reader Web API
|
|
@@ -916,13 +925,21 @@ export enum SecurityFeatureType {
|
|
|
916
925
|
*/
|
|
917
926
|
PORTRAIT_COMPARISON_BARCODE_VS_CAMERA = 49,
|
|
918
927
|
/**
|
|
919
|
-
* Digital signature
|
|
928
|
+
* Digital signature check
|
|
920
929
|
*/
|
|
921
930
|
CHECK_DIGITAL_SIGNATURE = 50,
|
|
922
931
|
/**
|
|
923
|
-
* Contact
|
|
932
|
+
* Contact chip check
|
|
933
|
+
*/
|
|
934
|
+
CONTACT_CHIP_CLASSIFICATION = 51,
|
|
935
|
+
/**
|
|
936
|
+
* Head position check
|
|
937
|
+
*/
|
|
938
|
+
HEAD_POSITION_CHECK = 52,
|
|
939
|
+
/**
|
|
940
|
+
* Black and white copy check
|
|
924
941
|
*/
|
|
925
|
-
|
|
942
|
+
LIVENESS_BLACK_AND_WHITE_COPY_CHECK = 53
|
|
926
943
|
}
|
|
927
944
|
/**
|
|
928
945
|
*
|
|
@@ -960,12 +977,6 @@ export interface IdentResultAllOf {
|
|
|
960
977
|
* @memberof IdentResultAllOf
|
|
961
978
|
*/
|
|
962
979
|
EtalonImage?: ImageData;
|
|
963
|
-
/**
|
|
964
|
-
* Probability percent for IMAGE_PATTERN check or element\'s visibility for IR_VISIBILITY
|
|
965
|
-
* @type {number}
|
|
966
|
-
* @memberof IdentResultAllOf
|
|
967
|
-
*/
|
|
968
|
-
PercentValue?: number;
|
|
969
980
|
/**
|
|
970
981
|
*
|
|
971
982
|
* @type {AreaContainer}
|
|
@@ -1271,6 +1282,12 @@ export interface AuthenticityCheckResultItem {
|
|
|
1271
1282
|
* @memberof AuthenticityCheckResultItem
|
|
1272
1283
|
*/
|
|
1273
1284
|
ElementDiagnose?: CheckDiagnose;
|
|
1285
|
+
/**
|
|
1286
|
+
*
|
|
1287
|
+
* @type {number}
|
|
1288
|
+
* @memberof AuthenticityCheckResultItem
|
|
1289
|
+
*/
|
|
1290
|
+
PercentValue?: number;
|
|
1274
1291
|
}
|
|
1275
1292
|
/**
|
|
1276
1293
|
*
|
|
@@ -1395,6 +1412,30 @@ export interface AuthenticityResultAllOf {
|
|
|
1395
1412
|
*/
|
|
1396
1413
|
AuthenticityCheckList: AuthenticityCheckList;
|
|
1397
1414
|
}
|
|
1415
|
+
/**
|
|
1416
|
+
* Regula Document Reader Web API
|
|
1417
|
+
* 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
|
|
1418
|
+
*
|
|
1419
|
+
* The version of the OpenAPI document: 7.2.0
|
|
1420
|
+
*
|
|
1421
|
+
*
|
|
1422
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1423
|
+
* https://openapi-generator.tech
|
|
1424
|
+
* Do not edit the class manually.
|
|
1425
|
+
*/
|
|
1426
|
+
/**
|
|
1427
|
+
*
|
|
1428
|
+
* @export
|
|
1429
|
+
* @interface ByteArrayResultAllOf
|
|
1430
|
+
*/
|
|
1431
|
+
export interface ByteArrayResultAllOf {
|
|
1432
|
+
/**
|
|
1433
|
+
* Byte array in base64
|
|
1434
|
+
* @type {string}
|
|
1435
|
+
* @memberof ByteArrayResultAllOf
|
|
1436
|
+
*/
|
|
1437
|
+
ByteArray: string;
|
|
1438
|
+
}
|
|
1398
1439
|
/**
|
|
1399
1440
|
* Regula Document Reader Web API
|
|
1400
1441
|
* 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
|
|
@@ -2830,7 +2871,7 @@ export interface DocBarCodeInfoAllOf {
|
|
|
2830
2871
|
DocBarCodeInfo?: DocBarCodeInfoFieldsList;
|
|
2831
2872
|
}
|
|
2832
2873
|
/**
|
|
2833
|
-
*
|
|
2874
|
+
*
|
|
2834
2875
|
* @export
|
|
2835
2876
|
* @interface DocumentImageResultAllOf
|
|
2836
2877
|
*/
|
|
@@ -5373,6 +5414,18 @@ export enum TextFieldType {
|
|
|
5373
5414
|
*/
|
|
5374
5415
|
ISO_ISSUER_ID_NUMBER = 336,
|
|
5375
5416
|
/**
|
|
5417
|
+
* DTC version
|
|
5418
|
+
*/
|
|
5419
|
+
DTC_VERSION = 337,
|
|
5420
|
+
/**
|
|
5421
|
+
* DTC ID
|
|
5422
|
+
*/
|
|
5423
|
+
DTC_ID = 338,
|
|
5424
|
+
/**
|
|
5425
|
+
* DTC date of expiry
|
|
5426
|
+
*/
|
|
5427
|
+
DTC_DATE_OF_EXPIRY = 339,
|
|
5428
|
+
/**
|
|
5376
5429
|
* GNIB number
|
|
5377
5430
|
*/
|
|
5378
5431
|
GNIB_NUMBER = 340,
|
|
@@ -6779,7 +6832,11 @@ export enum TextFieldType {
|
|
|
6779
6832
|
/**
|
|
6780
6833
|
* Date of First Positive Test Result
|
|
6781
6834
|
*/
|
|
6782
|
-
FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT = 691
|
|
6835
|
+
FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT = 691,
|
|
6836
|
+
/**
|
|
6837
|
+
* EF.CardAccess
|
|
6838
|
+
*/
|
|
6839
|
+
EF_CARD_ACCESS = 692
|
|
6783
6840
|
}
|
|
6784
6841
|
/**
|
|
6785
6842
|
* Regula Document Reader Web API
|
|
@@ -7591,6 +7648,7 @@ export type DocumentTypesCandidatesResult = DocumentTypesCandidatesResultAllOf &
|
|
|
7591
7648
|
export type DocumentPositionResult = DocumentPositionResultAllOf & ResultItem;
|
|
7592
7649
|
/**
|
|
7593
7650
|
* @type DocumentImageResult
|
|
7651
|
+
* Contains document image.
|
|
7594
7652
|
* @export
|
|
7595
7653
|
*/
|
|
7596
7654
|
export type DocumentImageResult = DocumentImageResultAllOf & ResultItem;
|
|
@@ -7606,6 +7664,11 @@ export type DocBarCodeInfo = DocBarCodeInfoAllOf & ResultItem;
|
|
|
7606
7664
|
* @export
|
|
7607
7665
|
*/
|
|
7608
7666
|
export type ChosenDocumentTypeResult = ChosenDocumentTypeResultAllOf & ResultItem;
|
|
7667
|
+
/**
|
|
7668
|
+
* @type ByteArrayResult
|
|
7669
|
+
* @export
|
|
7670
|
+
*/
|
|
7671
|
+
export type ByteArrayResult = ByteArrayResultAllOf & ResultItem;
|
|
7609
7672
|
/**
|
|
7610
7673
|
* @type AuthenticityResult
|
|
7611
7674
|
* @export
|
|
@@ -7686,10 +7749,10 @@ export interface ContainerList {
|
|
|
7686
7749
|
Count?: number;
|
|
7687
7750
|
/**
|
|
7688
7751
|
*
|
|
7689
|
-
* @type {Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>}
|
|
7752
|
+
* @type {Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult | ByteArrayResult>}
|
|
7690
7753
|
* @memberof ContainerList
|
|
7691
7754
|
*/
|
|
7692
|
-
List: Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>;
|
|
7755
|
+
List: Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult | ByteArrayResult>;
|
|
7693
7756
|
}
|
|
7694
7757
|
/**
|
|
7695
7758
|
* Regula Document Reader Web API
|
|
@@ -7768,6 +7831,12 @@ export interface DocumentImage {
|
|
|
7768
7831
|
* @memberof DocumentImage
|
|
7769
7832
|
*/
|
|
7770
7833
|
image: string;
|
|
7834
|
+
/**
|
|
7835
|
+
* Image format
|
|
7836
|
+
* @type {string}
|
|
7837
|
+
* @memberof DocumentImage
|
|
7838
|
+
*/
|
|
7839
|
+
format?: string;
|
|
7771
7840
|
}
|
|
7772
7841
|
/**
|
|
7773
7842
|
*
|
|
@@ -7788,6 +7857,48 @@ export interface DocumentTypesCandidates {
|
|
|
7788
7857
|
*/
|
|
7789
7858
|
Candidates?: Array<OneCandidate>;
|
|
7790
7859
|
}
|
|
7860
|
+
/**
|
|
7861
|
+
* Regula Document Reader Web API
|
|
7862
|
+
* 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
|
|
7863
|
+
*
|
|
7864
|
+
* The version of the OpenAPI document: 7.2.0
|
|
7865
|
+
*
|
|
7866
|
+
*
|
|
7867
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7868
|
+
* https://openapi-generator.tech
|
|
7869
|
+
* Do not edit the class manually.
|
|
7870
|
+
*/
|
|
7871
|
+
/**
|
|
7872
|
+
* Document database information
|
|
7873
|
+
* @export
|
|
7874
|
+
* @interface DocumentsDatabase
|
|
7875
|
+
*/
|
|
7876
|
+
export interface DocumentsDatabase {
|
|
7877
|
+
/**
|
|
7878
|
+
* Document database description
|
|
7879
|
+
* @type {string}
|
|
7880
|
+
* @memberof DocumentsDatabase
|
|
7881
|
+
*/
|
|
7882
|
+
Description?: string;
|
|
7883
|
+
/**
|
|
7884
|
+
* Date the document database was created
|
|
7885
|
+
* @type {string}
|
|
7886
|
+
* @memberof DocumentsDatabase
|
|
7887
|
+
*/
|
|
7888
|
+
ExportDate?: string;
|
|
7889
|
+
/**
|
|
7890
|
+
* Document database identifier
|
|
7891
|
+
* @type {string}
|
|
7892
|
+
* @memberof DocumentsDatabase
|
|
7893
|
+
*/
|
|
7894
|
+
ID?: string;
|
|
7895
|
+
/**
|
|
7896
|
+
* Document database version
|
|
7897
|
+
* @type {string}
|
|
7898
|
+
* @memberof DocumentsDatabase
|
|
7899
|
+
*/
|
|
7900
|
+
Version?: string;
|
|
7901
|
+
}
|
|
7791
7902
|
/**
|
|
7792
7903
|
* Regula Document Reader Web API
|
|
7793
7904
|
* 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
|
|
@@ -7898,10 +8009,10 @@ export interface FaceApi {
|
|
|
7898
8009
|
export interface GetTransactionsByTagResponse {
|
|
7899
8010
|
/**
|
|
7900
8011
|
* Transaction id
|
|
7901
|
-
* @type {
|
|
8012
|
+
* @type {string}
|
|
7902
8013
|
* @memberof GetTransactionsByTagResponse
|
|
7903
8014
|
*/
|
|
7904
|
-
id?:
|
|
8015
|
+
id?: string;
|
|
7905
8016
|
/**
|
|
7906
8017
|
* Transaction status
|
|
7907
8018
|
* @type {number}
|
|
@@ -7926,6 +8037,142 @@ export interface GetTransactionsByTagResponse {
|
|
|
7926
8037
|
* https://openapi-generator.tech
|
|
7927
8038
|
* Do not edit the class manually.
|
|
7928
8039
|
*/
|
|
8040
|
+
/**
|
|
8041
|
+
* Database information.
|
|
8042
|
+
* @export
|
|
8043
|
+
* @interface HealthcheckDocumentsDatabase
|
|
8044
|
+
*/
|
|
8045
|
+
export interface HealthcheckDocumentsDatabase {
|
|
8046
|
+
/**
|
|
8047
|
+
* Database identifier.
|
|
8048
|
+
* @type {string}
|
|
8049
|
+
* @memberof HealthcheckDocumentsDatabase
|
|
8050
|
+
*/
|
|
8051
|
+
id: string | null;
|
|
8052
|
+
/**
|
|
8053
|
+
* Database version.
|
|
8054
|
+
* @type {string}
|
|
8055
|
+
* @memberof HealthcheckDocumentsDatabase
|
|
8056
|
+
*/
|
|
8057
|
+
version: string | null;
|
|
8058
|
+
/**
|
|
8059
|
+
* Date of database creation.
|
|
8060
|
+
* @type {string}
|
|
8061
|
+
* @memberof HealthcheckDocumentsDatabase
|
|
8062
|
+
*/
|
|
8063
|
+
exportDate: string | null;
|
|
8064
|
+
/**
|
|
8065
|
+
* Description of the database contents, such as the list of supported countries and documents.
|
|
8066
|
+
* @type {string}
|
|
8067
|
+
* @memberof HealthcheckDocumentsDatabase
|
|
8068
|
+
*/
|
|
8069
|
+
description: string | null;
|
|
8070
|
+
}
|
|
8071
|
+
/**
|
|
8072
|
+
*
|
|
8073
|
+
* @export
|
|
8074
|
+
* @interface Healthcheck
|
|
8075
|
+
*/
|
|
8076
|
+
export interface Healthcheck {
|
|
8077
|
+
/**
|
|
8078
|
+
* Application name.
|
|
8079
|
+
* @type {string}
|
|
8080
|
+
* @memberof Healthcheck
|
|
8081
|
+
*/
|
|
8082
|
+
app: string;
|
|
8083
|
+
/**
|
|
8084
|
+
* Unique license identifier.
|
|
8085
|
+
* @type {string}
|
|
8086
|
+
* @memberof Healthcheck
|
|
8087
|
+
*/
|
|
8088
|
+
licenseId: string | null;
|
|
8089
|
+
/**
|
|
8090
|
+
* License type.
|
|
8091
|
+
* @type {string}
|
|
8092
|
+
* @memberof Healthcheck
|
|
8093
|
+
*/
|
|
8094
|
+
licenseType: string | null;
|
|
8095
|
+
/**
|
|
8096
|
+
* License serial number.
|
|
8097
|
+
* @type {string}
|
|
8098
|
+
* @memberof Healthcheck
|
|
8099
|
+
*/
|
|
8100
|
+
licenseSerial: string | null;
|
|
8101
|
+
/**
|
|
8102
|
+
* License validity date.
|
|
8103
|
+
* @type {string}
|
|
8104
|
+
* @memberof Healthcheck
|
|
8105
|
+
*/
|
|
8106
|
+
licenseValidUntil: string | null;
|
|
8107
|
+
/**
|
|
8108
|
+
* List of supported scenarios.
|
|
8109
|
+
* @type {Array<string>}
|
|
8110
|
+
* @memberof Healthcheck
|
|
8111
|
+
*/
|
|
8112
|
+
scenarios: Array<string> | null;
|
|
8113
|
+
/**
|
|
8114
|
+
* Product version.
|
|
8115
|
+
* @type {string}
|
|
8116
|
+
* @memberof Healthcheck
|
|
8117
|
+
*/
|
|
8118
|
+
version: string | null;
|
|
8119
|
+
/**
|
|
8120
|
+
*
|
|
8121
|
+
* @type {HealthcheckDocumentsDatabase}
|
|
8122
|
+
* @memberof Healthcheck
|
|
8123
|
+
*/
|
|
8124
|
+
documentsDatabase?: HealthcheckDocumentsDatabase;
|
|
8125
|
+
}
|
|
8126
|
+
/**
|
|
8127
|
+
* Regula Document Reader Web API
|
|
8128
|
+
* 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
|
|
8129
|
+
*
|
|
8130
|
+
* The version of the OpenAPI document: 7.2.0
|
|
8131
|
+
*
|
|
8132
|
+
*
|
|
8133
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8134
|
+
* https://openapi-generator.tech
|
|
8135
|
+
* Do not edit the class manually.
|
|
8136
|
+
*/
|
|
8137
|
+
/**
|
|
8138
|
+
* Input image quality checks for the document processing
|
|
8139
|
+
* @export
|
|
8140
|
+
* @enum {string}
|
|
8141
|
+
*/
|
|
8142
|
+
export enum InputImageQualityChecks {
|
|
8143
|
+
/**
|
|
8144
|
+
* Signals glare presence on the image
|
|
8145
|
+
*/
|
|
8146
|
+
Glares = "glaresCheck",
|
|
8147
|
+
/**
|
|
8148
|
+
* Signals whether image is in focus
|
|
8149
|
+
*/
|
|
8150
|
+
Focus = "focusCheck",
|
|
8151
|
+
/**
|
|
8152
|
+
* Signals if image resolution is below threshold
|
|
8153
|
+
*/
|
|
8154
|
+
Resolution = "dpiThreshold",
|
|
8155
|
+
/**
|
|
8156
|
+
* Signals if image is colorless
|
|
8157
|
+
*/
|
|
8158
|
+
Colorness = "colornessCheck",
|
|
8159
|
+
/**
|
|
8160
|
+
* Signals if document in the image has prespective distortion above threshold
|
|
8161
|
+
*/
|
|
8162
|
+
Perspective = "perspectiveCheck",
|
|
8163
|
+
/**
|
|
8164
|
+
* Signals if document is not fully present in the image
|
|
8165
|
+
*/
|
|
8166
|
+
Bounds = "documentPosition",
|
|
8167
|
+
/**
|
|
8168
|
+
* Signals if the portrait is present
|
|
8169
|
+
*/
|
|
8170
|
+
Portrait = "portraitCheck",
|
|
8171
|
+
/**
|
|
8172
|
+
* Signals if the document image is bright enough
|
|
8173
|
+
*/
|
|
8174
|
+
Brightness = "brightnessCheck"
|
|
8175
|
+
}
|
|
7929
8176
|
/**
|
|
7930
8177
|
*
|
|
7931
8178
|
* @export
|
|
@@ -7974,6 +8221,12 @@ export interface ImageQA {
|
|
|
7974
8221
|
* @memberof ImageQA
|
|
7975
8222
|
*/
|
|
7976
8223
|
documentPositionIndent?: number;
|
|
8224
|
+
/**
|
|
8225
|
+
* This parameter controls the quality checks that the image should pass to be considered a valid input during the scanning process.
|
|
8226
|
+
* @type {Array<InputImageQualityChecks>}
|
|
8227
|
+
* @memberof ImageQA
|
|
8228
|
+
*/
|
|
8229
|
+
expectedPass?: Array<InputImageQualityChecks>;
|
|
7977
8230
|
}
|
|
7978
8231
|
/**
|
|
7979
8232
|
*
|
|
@@ -8187,17 +8440,6 @@ export enum ProcessingStatus {
|
|
|
8187
8440
|
*/
|
|
8188
8441
|
TIMEOUT = 2
|
|
8189
8442
|
}
|
|
8190
|
-
/**
|
|
8191
|
-
* Regula Document Reader Web API
|
|
8192
|
-
* 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
|
|
8193
|
-
*
|
|
8194
|
-
* The version of the OpenAPI document: 7.2.0
|
|
8195
|
-
*
|
|
8196
|
-
*
|
|
8197
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8198
|
-
* https://openapi-generator.tech
|
|
8199
|
-
* Do not edit the class manually.
|
|
8200
|
-
*/
|
|
8201
8443
|
/**
|
|
8202
8444
|
*
|
|
8203
8445
|
* @export
|
|
@@ -8205,29 +8447,53 @@ export enum ProcessingStatus {
|
|
|
8205
8447
|
*/
|
|
8206
8448
|
export interface TransactionInfo {
|
|
8207
8449
|
/**
|
|
8208
|
-
*
|
|
8450
|
+
* Computer name
|
|
8209
8451
|
* @type {string}
|
|
8210
8452
|
* @memberof TransactionInfo
|
|
8211
8453
|
*/
|
|
8212
8454
|
ComputerName?: string;
|
|
8213
8455
|
/**
|
|
8214
|
-
*
|
|
8456
|
+
* Date and time
|
|
8215
8457
|
* @type {string}
|
|
8216
8458
|
* @memberof TransactionInfo
|
|
8217
8459
|
*/
|
|
8218
8460
|
DateTime?: string;
|
|
8219
8461
|
/**
|
|
8220
8462
|
*
|
|
8463
|
+
* @type {DocumentsDatabase}
|
|
8464
|
+
* @memberof TransactionInfo
|
|
8465
|
+
*/
|
|
8466
|
+
DocumentsDatabase?: DocumentsDatabase;
|
|
8467
|
+
/**
|
|
8468
|
+
* System information
|
|
8469
|
+
* @type {string}
|
|
8470
|
+
* @memberof TransactionInfo
|
|
8471
|
+
*/
|
|
8472
|
+
SystemInfo?: string;
|
|
8473
|
+
/**
|
|
8474
|
+
* Transaction tag
|
|
8475
|
+
* @type {string}
|
|
8476
|
+
* @memberof TransactionInfo
|
|
8477
|
+
*/
|
|
8478
|
+
Tag?: string;
|
|
8479
|
+
/**
|
|
8480
|
+
* Transaction identifier
|
|
8221
8481
|
* @type {string}
|
|
8222
8482
|
* @memberof TransactionInfo
|
|
8223
8483
|
*/
|
|
8224
8484
|
TransactionID?: string;
|
|
8225
8485
|
/**
|
|
8226
|
-
*
|
|
8486
|
+
* User name
|
|
8227
8487
|
* @type {string}
|
|
8228
8488
|
* @memberof TransactionInfo
|
|
8229
8489
|
*/
|
|
8230
8490
|
UserName?: string;
|
|
8491
|
+
/**
|
|
8492
|
+
* SDK version
|
|
8493
|
+
* @type {string}
|
|
8494
|
+
* @memberof TransactionInfo
|
|
8495
|
+
*/
|
|
8496
|
+
Version?: string;
|
|
8231
8497
|
}
|
|
8232
8498
|
/**
|
|
8233
8499
|
*
|
|
@@ -8292,6 +8558,27 @@ export interface InlineResponse2001 {
|
|
|
8292
8558
|
*/
|
|
8293
8559
|
CoreLibResultCode?: number;
|
|
8294
8560
|
}
|
|
8561
|
+
/**
|
|
8562
|
+
*
|
|
8563
|
+
* @export
|
|
8564
|
+
* @interface ListTransactionsByTagResponse
|
|
8565
|
+
*/
|
|
8566
|
+
export interface ListTransactionsByTagResponse {
|
|
8567
|
+
/**
|
|
8568
|
+
*
|
|
8569
|
+
* @type {Array<GetTransactionsByTagResponse>}
|
|
8570
|
+
* @memberof ListTransactionsByTagResponse
|
|
8571
|
+
*/
|
|
8572
|
+
items?: Array<GetTransactionsByTagResponse>;
|
|
8573
|
+
/**
|
|
8574
|
+
*
|
|
8575
|
+
* @type {{ [key: string]: object; }}
|
|
8576
|
+
* @memberof ListTransactionsByTagResponse
|
|
8577
|
+
*/
|
|
8578
|
+
metadata?: {
|
|
8579
|
+
[key: string]: object;
|
|
8580
|
+
};
|
|
8581
|
+
}
|
|
8295
8582
|
/**
|
|
8296
8583
|
* Regula Document Reader Web API
|
|
8297
8584
|
* 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
|
|
@@ -9488,7 +9775,11 @@ export enum Result {
|
|
|
9488
9775
|
/**
|
|
9489
9776
|
* Contains RFID original graphics data
|
|
9490
9777
|
*/
|
|
9491
|
-
RFID_ORIGINAL_GRAPHICS = 105
|
|
9778
|
+
RFID_ORIGINAL_GRAPHICS = 105,
|
|
9779
|
+
/**
|
|
9780
|
+
* Digital Travel Credential data
|
|
9781
|
+
*/
|
|
9782
|
+
DTC_VC = 109
|
|
9492
9783
|
}
|
|
9493
9784
|
/**
|
|
9494
9785
|
* Regula Document Reader Web API
|
|
@@ -9578,7 +9869,11 @@ export enum Scenario {
|
|
|
9578
9869
|
/**
|
|
9579
9870
|
* Scenario for obtaining an original image without any processing
|
|
9580
9871
|
*/
|
|
9581
|
-
CAPTURE = "Capture"
|
|
9872
|
+
CAPTURE = "Capture",
|
|
9873
|
+
/**
|
|
9874
|
+
* Processing scenario for Digital Travel Credentials (DTC-VC) data processing
|
|
9875
|
+
*/
|
|
9876
|
+
DTC = "DTC"
|
|
9582
9877
|
}
|
|
9583
9878
|
/**
|
|
9584
9879
|
* Regula Document Reader Web API
|
|
@@ -9620,6 +9915,12 @@ export enum TextPostProcessing {
|
|
|
9620
9915
|
* @interface ProcessParams
|
|
9621
9916
|
*/
|
|
9622
9917
|
export interface ProcessParams {
|
|
9918
|
+
/**
|
|
9919
|
+
* This parameter is used to generate separate DTC-VC data container from RFID session data.
|
|
9920
|
+
* @type {boolean}
|
|
9921
|
+
* @memberof ProcessParams
|
|
9922
|
+
*/
|
|
9923
|
+
generateDTCVC?: boolean;
|
|
9623
9924
|
/**
|
|
9624
9925
|
* The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default.
|
|
9625
9926
|
* @type {Array<number>}
|
|
@@ -9793,9 +10094,16 @@ export interface ProcessParams {
|
|
|
9793
10094
|
*/
|
|
9794
10095
|
imageQa?: ImageQA;
|
|
9795
10096
|
/**
|
|
9796
|
-
* When enabled, image quality
|
|
10097
|
+
* When enabled, the image quality check status affects the document optical and overall status. Disabled by default.
|
|
10098
|
+
* @type {boolean}
|
|
10099
|
+
* @memberof ProcessParams
|
|
10100
|
+
*/
|
|
10101
|
+
strictImageQuality?: boolean;
|
|
10102
|
+
/**
|
|
10103
|
+
* Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default.
|
|
9797
10104
|
* @type {boolean}
|
|
9798
10105
|
* @memberof ProcessParams
|
|
10106
|
+
* @deprecated
|
|
9799
10107
|
*/
|
|
9800
10108
|
respectImageQuality?: boolean;
|
|
9801
10109
|
/**
|
|
@@ -9948,6 +10256,18 @@ export interface ProcessParams {
|
|
|
9948
10256
|
* @memberof ProcessParams
|
|
9949
10257
|
*/
|
|
9950
10258
|
generateNumericCodes?: boolean;
|
|
10259
|
+
/**
|
|
10260
|
+
* This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed.
|
|
10261
|
+
* @type {boolean}
|
|
10262
|
+
* @memberof ProcessParams
|
|
10263
|
+
*/
|
|
10264
|
+
strictBarcodeDigitalSignatureCheck?: boolean;
|
|
10265
|
+
/**
|
|
10266
|
+
* Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc.
|
|
10267
|
+
* @type {boolean}
|
|
10268
|
+
* @memberof ProcessParams
|
|
10269
|
+
*/
|
|
10270
|
+
selectLongestNames?: boolean;
|
|
9951
10271
|
}
|
|
9952
10272
|
/**
|
|
9953
10273
|
*
|
|
@@ -9960,7 +10280,7 @@ export interface ProcessRequestImage {
|
|
|
9960
10280
|
* @type {ImageData}
|
|
9961
10281
|
* @memberof ProcessRequestImage
|
|
9962
10282
|
*/
|
|
9963
|
-
ImageData
|
|
10283
|
+
ImageData?: ImageData;
|
|
9964
10284
|
/**
|
|
9965
10285
|
*
|
|
9966
10286
|
* @type {Light}
|
|
@@ -10072,6 +10392,18 @@ export interface ProcessRequest {
|
|
|
10072
10392
|
passBackObject?: {
|
|
10073
10393
|
[key: string]: object;
|
|
10074
10394
|
};
|
|
10395
|
+
/**
|
|
10396
|
+
* Digital Travel Credential (DTC-VC) data in base64 format for processing
|
|
10397
|
+
* @type {string}
|
|
10398
|
+
* @memberof ProcessRequest
|
|
10399
|
+
*/
|
|
10400
|
+
dtc?: string;
|
|
10401
|
+
/**
|
|
10402
|
+
* URLs to the document images for processing.
|
|
10403
|
+
* @type {Array<string>}
|
|
10404
|
+
* @memberof ProcessRequest
|
|
10405
|
+
*/
|
|
10406
|
+
ImageUrls?: Array<string>;
|
|
10075
10407
|
}
|
|
10076
10408
|
/**
|
|
10077
10409
|
*
|
|
@@ -10151,10 +10483,10 @@ export interface TransactionImage {
|
|
|
10151
10483
|
export interface TransactionProcessGetResponse {
|
|
10152
10484
|
/**
|
|
10153
10485
|
*
|
|
10154
|
-
* @type {
|
|
10486
|
+
* @type {string}
|
|
10155
10487
|
* @memberof TransactionProcessGetResponse
|
|
10156
10488
|
*/
|
|
10157
|
-
transactionId?:
|
|
10489
|
+
transactionId?: string;
|
|
10158
10490
|
/**
|
|
10159
10491
|
*
|
|
10160
10492
|
* @type {string}
|
|
@@ -10224,6 +10556,12 @@ export interface TransactionProcessRequest {
|
|
|
10224
10556
|
passBackObject?: {
|
|
10225
10557
|
[key: string]: object;
|
|
10226
10558
|
};
|
|
10559
|
+
/**
|
|
10560
|
+
* Digital Travel Credential (DTC-VC) data in base64 format for processing
|
|
10561
|
+
* @type {string}
|
|
10562
|
+
* @memberof TransactionProcessRequest
|
|
10563
|
+
*/
|
|
10564
|
+
dtc?: string;
|
|
10227
10565
|
}
|
|
10228
10566
|
export class TextFieldExt implements TextField {
|
|
10229
10567
|
fieldType: TextFieldType;
|
|
@@ -10348,6 +10686,7 @@ export class Response {
|
|
|
10348
10686
|
status?: Status;
|
|
10349
10687
|
text?: TextExt;
|
|
10350
10688
|
images?: ImagesExt;
|
|
10689
|
+
TransactionInfo: TransactionInfo;
|
|
10351
10690
|
lowLvlResponse: LowLvlResponse;
|
|
10352
10691
|
rawResponse: ProcessResponse | InlineResponse2001;
|
|
10353
10692
|
constructor(original: ProcessResponse | InlineResponse2001);
|
|
@@ -10375,9 +10714,9 @@ export class LowLvlResponse implements ProcessResponse {
|
|
|
10375
10714
|
imagesResult(): ImagesResult | undefined;
|
|
10376
10715
|
barcodeResult(): DocBarCodeInfo | undefined;
|
|
10377
10716
|
documentTypeResults(): Array<ChosenDocumentTypeResult> | undefined;
|
|
10378
|
-
resultByType(type: Result):
|
|
10379
|
-
resultByTypeAndPage(type: Result, page_idx?: number):
|
|
10380
|
-
resultsByType(type: Result):
|
|
10717
|
+
resultByType(type: Result): ContainerList['List'][number] | undefined;
|
|
10718
|
+
resultByTypeAndPage(type: Result, page_idx?: number): ContainerList['List'][number] | undefined;
|
|
10719
|
+
resultsByType(type: Result): ContainerList['List'];
|
|
10381
10720
|
}
|
|
10382
10721
|
export interface ProcessRequestImageWrapper extends Omit<ProcessRequestImage, 'ImageData'> {
|
|
10383
10722
|
ImageData: ArrayBuffer | Base64String;
|
|
@@ -10433,53 +10772,53 @@ export class DocumentReaderApi {
|
|
|
10433
10772
|
/**
|
|
10434
10773
|
*
|
|
10435
10774
|
* @summary Reprocess
|
|
10436
|
-
* @param {
|
|
10775
|
+
* @param {string} transactionId Transaction id
|
|
10437
10776
|
* @param {TransactionProcessRequest} transactionProcessRequest
|
|
10438
10777
|
* @param {*} [options] Override http request option.
|
|
10439
10778
|
* @throws {RequiredError}
|
|
10440
10779
|
*/
|
|
10441
|
-
reprocessTransaction(transactionId:
|
|
10780
|
+
reprocessTransaction(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: any): Promise<AxiosResponse<InlineResponse200, any>>;
|
|
10442
10781
|
/**
|
|
10443
10782
|
*
|
|
10444
10783
|
* @summary Get Reprocess transaction result
|
|
10445
|
-
* @param {
|
|
10784
|
+
* @param {string} transactionId Transaction id
|
|
10446
10785
|
* @param {boolean} [withImages] With base64 images or url
|
|
10447
10786
|
* @param {*} [options] Override http request option.
|
|
10448
10787
|
* @throws {RequiredError}
|
|
10449
10788
|
*/
|
|
10450
|
-
getReprocessTransactionResult(transactionId:
|
|
10789
|
+
getReprocessTransactionResult(transactionId: string, withImages?: boolean, options?: any): Promise<Response>;
|
|
10451
10790
|
/**
|
|
10452
10791
|
*
|
|
10453
10792
|
* @summary Get transactions by tag
|
|
10454
|
-
* @param {
|
|
10793
|
+
* @param {string} tagId Tag id
|
|
10455
10794
|
* @param {*} [options] Override http request option.
|
|
10456
10795
|
* @throws {RequiredError}
|
|
10457
10796
|
*/
|
|
10458
|
-
getTransactionsByTag(tagId:
|
|
10797
|
+
getTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<ListTransactionsByTagResponse>>;
|
|
10459
10798
|
/**
|
|
10460
10799
|
*
|
|
10461
10800
|
* @summary Delete Reprocess transactions by tag
|
|
10462
|
-
* @param {
|
|
10801
|
+
* @param {string} tagId Tag id
|
|
10463
10802
|
* @param {*} [options] Override http request option.
|
|
10464
10803
|
* @throws {RequiredError}
|
|
10465
10804
|
*/
|
|
10466
|
-
deleteReprocessTransactionsByTag(tagId:
|
|
10805
|
+
deleteReprocessTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<object, any>>;
|
|
10467
10806
|
/**
|
|
10468
10807
|
*
|
|
10469
10808
|
* @summary Get Reprocess transaction file
|
|
10470
|
-
* @param {
|
|
10809
|
+
* @param {string} transactionId Transaction id
|
|
10471
10810
|
* @param {string} name File name
|
|
10472
10811
|
* @param {*} [options] Override http request option.
|
|
10473
10812
|
* @throws {RequiredError}
|
|
10474
10813
|
*/
|
|
10475
|
-
getReprocessTransactionFile(transactionId:
|
|
10814
|
+
getReprocessTransactionFile(transactionId: string, name: string, options?: any): Promise<AxiosResponse<any, any>>;
|
|
10476
10815
|
/**
|
|
10477
10816
|
*
|
|
10478
10817
|
* @summary Get Reprocess transaction data
|
|
10479
|
-
* @param {
|
|
10818
|
+
* @param {string} transactionId Transaction id
|
|
10480
10819
|
* @param {*} [options] Override http request option.
|
|
10481
10820
|
* @throws {RequiredError}
|
|
10482
10821
|
*/
|
|
10483
|
-
getReprocessTransactionData(transactionId:
|
|
10822
|
+
getReprocessTransactionData(transactionId: string, options?: any): Promise<AxiosResponse<TransactionProcessGetResponse, any>>;
|
|
10484
10823
|
}
|
|
10485
10824
|
export function requestToBaseRequest(request: ProcessRequestExt): ProcessRequest;
|