@regulaforensics/document-reader-webclient 7.5.182-rc → 7.5.183-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 +317 -50
- 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
|
|
924
933
|
*/
|
|
925
|
-
CONTACT_CHIP_CLASSIFICATION = 51
|
|
934
|
+
CONTACT_CHIP_CLASSIFICATION = 51,
|
|
935
|
+
/**
|
|
936
|
+
* Head position check
|
|
937
|
+
*/
|
|
938
|
+
HEAD_POSITION_CHECK = 52,
|
|
939
|
+
/**
|
|
940
|
+
* Black and white copy check
|
|
941
|
+
*/
|
|
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}
|
|
@@ -1401,6 +1412,30 @@ export interface AuthenticityResultAllOf {
|
|
|
1401
1412
|
*/
|
|
1402
1413
|
AuthenticityCheckList: AuthenticityCheckList;
|
|
1403
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
|
+
}
|
|
1404
1439
|
/**
|
|
1405
1440
|
* Regula Document Reader Web API
|
|
1406
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
|
|
@@ -2836,7 +2871,7 @@ export interface DocBarCodeInfoAllOf {
|
|
|
2836
2871
|
DocBarCodeInfo?: DocBarCodeInfoFieldsList;
|
|
2837
2872
|
}
|
|
2838
2873
|
/**
|
|
2839
|
-
*
|
|
2874
|
+
*
|
|
2840
2875
|
* @export
|
|
2841
2876
|
* @interface DocumentImageResultAllOf
|
|
2842
2877
|
*/
|
|
@@ -5379,6 +5414,18 @@ export enum TextFieldType {
|
|
|
5379
5414
|
*/
|
|
5380
5415
|
ISO_ISSUER_ID_NUMBER = 336,
|
|
5381
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
|
+
/**
|
|
5382
5429
|
* GNIB number
|
|
5383
5430
|
*/
|
|
5384
5431
|
GNIB_NUMBER = 340,
|
|
@@ -6785,7 +6832,11 @@ export enum TextFieldType {
|
|
|
6785
6832
|
/**
|
|
6786
6833
|
* Date of First Positive Test Result
|
|
6787
6834
|
*/
|
|
6788
|
-
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
|
|
6789
6840
|
}
|
|
6790
6841
|
/**
|
|
6791
6842
|
* Regula Document Reader Web API
|
|
@@ -7597,6 +7648,7 @@ export type DocumentTypesCandidatesResult = DocumentTypesCandidatesResultAllOf &
|
|
|
7597
7648
|
export type DocumentPositionResult = DocumentPositionResultAllOf & ResultItem;
|
|
7598
7649
|
/**
|
|
7599
7650
|
* @type DocumentImageResult
|
|
7651
|
+
* Contains document image.
|
|
7600
7652
|
* @export
|
|
7601
7653
|
*/
|
|
7602
7654
|
export type DocumentImageResult = DocumentImageResultAllOf & ResultItem;
|
|
@@ -7612,6 +7664,11 @@ export type DocBarCodeInfo = DocBarCodeInfoAllOf & ResultItem;
|
|
|
7612
7664
|
* @export
|
|
7613
7665
|
*/
|
|
7614
7666
|
export type ChosenDocumentTypeResult = ChosenDocumentTypeResultAllOf & ResultItem;
|
|
7667
|
+
/**
|
|
7668
|
+
* @type ByteArrayResult
|
|
7669
|
+
* @export
|
|
7670
|
+
*/
|
|
7671
|
+
export type ByteArrayResult = ByteArrayResultAllOf & ResultItem;
|
|
7615
7672
|
/**
|
|
7616
7673
|
* @type AuthenticityResult
|
|
7617
7674
|
* @export
|
|
@@ -7692,10 +7749,10 @@ export interface ContainerList {
|
|
|
7692
7749
|
Count?: number;
|
|
7693
7750
|
/**
|
|
7694
7751
|
*
|
|
7695
|
-
* @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>}
|
|
7696
7753
|
* @memberof ContainerList
|
|
7697
7754
|
*/
|
|
7698
|
-
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>;
|
|
7699
7756
|
}
|
|
7700
7757
|
/**
|
|
7701
7758
|
* Regula Document Reader Web API
|
|
@@ -7774,6 +7831,12 @@ export interface DocumentImage {
|
|
|
7774
7831
|
* @memberof DocumentImage
|
|
7775
7832
|
*/
|
|
7776
7833
|
image: string;
|
|
7834
|
+
/**
|
|
7835
|
+
* Image format
|
|
7836
|
+
* @type {string}
|
|
7837
|
+
* @memberof DocumentImage
|
|
7838
|
+
*/
|
|
7839
|
+
format?: string;
|
|
7777
7840
|
}
|
|
7778
7841
|
/**
|
|
7779
7842
|
*
|
|
@@ -7794,6 +7857,48 @@ export interface DocumentTypesCandidates {
|
|
|
7794
7857
|
*/
|
|
7795
7858
|
Candidates?: Array<OneCandidate>;
|
|
7796
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
|
+
}
|
|
7797
7902
|
/**
|
|
7798
7903
|
* Regula Document Reader Web API
|
|
7799
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
|
|
@@ -7904,10 +8009,10 @@ export interface FaceApi {
|
|
|
7904
8009
|
export interface GetTransactionsByTagResponse {
|
|
7905
8010
|
/**
|
|
7906
8011
|
* Transaction id
|
|
7907
|
-
* @type {
|
|
8012
|
+
* @type {string}
|
|
7908
8013
|
* @memberof GetTransactionsByTagResponse
|
|
7909
8014
|
*/
|
|
7910
|
-
id?:
|
|
8015
|
+
id?: string;
|
|
7911
8016
|
/**
|
|
7912
8017
|
* Transaction status
|
|
7913
8018
|
* @type {number}
|
|
@@ -7921,6 +8026,103 @@ export interface GetTransactionsByTagResponse {
|
|
|
7921
8026
|
*/
|
|
7922
8027
|
updatedAt?: string;
|
|
7923
8028
|
}
|
|
8029
|
+
/**
|
|
8030
|
+
* Regula Document Reader Web API
|
|
8031
|
+
* 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
|
|
8032
|
+
*
|
|
8033
|
+
* The version of the OpenAPI document: 7.2.0
|
|
8034
|
+
*
|
|
8035
|
+
*
|
|
8036
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8037
|
+
* https://openapi-generator.tech
|
|
8038
|
+
* Do not edit the class manually.
|
|
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
|
+
}
|
|
7924
8126
|
/**
|
|
7925
8127
|
* Regula Document Reader Web API
|
|
7926
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
|
|
@@ -8193,17 +8395,6 @@ export enum ProcessingStatus {
|
|
|
8193
8395
|
*/
|
|
8194
8396
|
TIMEOUT = 2
|
|
8195
8397
|
}
|
|
8196
|
-
/**
|
|
8197
|
-
* Regula Document Reader Web API
|
|
8198
|
-
* 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
|
|
8199
|
-
*
|
|
8200
|
-
* The version of the OpenAPI document: 7.2.0
|
|
8201
|
-
*
|
|
8202
|
-
*
|
|
8203
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8204
|
-
* https://openapi-generator.tech
|
|
8205
|
-
* Do not edit the class manually.
|
|
8206
|
-
*/
|
|
8207
8398
|
/**
|
|
8208
8399
|
*
|
|
8209
8400
|
* @export
|
|
@@ -8211,29 +8402,53 @@ export enum ProcessingStatus {
|
|
|
8211
8402
|
*/
|
|
8212
8403
|
export interface TransactionInfo {
|
|
8213
8404
|
/**
|
|
8214
|
-
*
|
|
8405
|
+
* Computer name
|
|
8215
8406
|
* @type {string}
|
|
8216
8407
|
* @memberof TransactionInfo
|
|
8217
8408
|
*/
|
|
8218
8409
|
ComputerName?: string;
|
|
8219
8410
|
/**
|
|
8220
|
-
*
|
|
8411
|
+
* Date and time
|
|
8221
8412
|
* @type {string}
|
|
8222
8413
|
* @memberof TransactionInfo
|
|
8223
8414
|
*/
|
|
8224
8415
|
DateTime?: string;
|
|
8225
8416
|
/**
|
|
8226
8417
|
*
|
|
8418
|
+
* @type {DocumentsDatabase}
|
|
8419
|
+
* @memberof TransactionInfo
|
|
8420
|
+
*/
|
|
8421
|
+
DocumentsDatabase?: DocumentsDatabase;
|
|
8422
|
+
/**
|
|
8423
|
+
* System information
|
|
8424
|
+
* @type {string}
|
|
8425
|
+
* @memberof TransactionInfo
|
|
8426
|
+
*/
|
|
8427
|
+
SystemInfo?: string;
|
|
8428
|
+
/**
|
|
8429
|
+
* Transaction tag
|
|
8430
|
+
* @type {string}
|
|
8431
|
+
* @memberof TransactionInfo
|
|
8432
|
+
*/
|
|
8433
|
+
Tag?: string;
|
|
8434
|
+
/**
|
|
8435
|
+
* Transaction identifier
|
|
8227
8436
|
* @type {string}
|
|
8228
8437
|
* @memberof TransactionInfo
|
|
8229
8438
|
*/
|
|
8230
8439
|
TransactionID?: string;
|
|
8231
8440
|
/**
|
|
8232
|
-
*
|
|
8441
|
+
* User name
|
|
8233
8442
|
* @type {string}
|
|
8234
8443
|
* @memberof TransactionInfo
|
|
8235
8444
|
*/
|
|
8236
8445
|
UserName?: string;
|
|
8446
|
+
/**
|
|
8447
|
+
* SDK version
|
|
8448
|
+
* @type {string}
|
|
8449
|
+
* @memberof TransactionInfo
|
|
8450
|
+
*/
|
|
8451
|
+
Version?: string;
|
|
8237
8452
|
}
|
|
8238
8453
|
/**
|
|
8239
8454
|
*
|
|
@@ -9515,7 +9730,11 @@ export enum Result {
|
|
|
9515
9730
|
/**
|
|
9516
9731
|
* Contains RFID original graphics data
|
|
9517
9732
|
*/
|
|
9518
|
-
RFID_ORIGINAL_GRAPHICS = 105
|
|
9733
|
+
RFID_ORIGINAL_GRAPHICS = 105,
|
|
9734
|
+
/**
|
|
9735
|
+
* Digital Travel Credential data
|
|
9736
|
+
*/
|
|
9737
|
+
DTC_VC = 109
|
|
9519
9738
|
}
|
|
9520
9739
|
/**
|
|
9521
9740
|
* Regula Document Reader Web API
|
|
@@ -9605,7 +9824,11 @@ export enum Scenario {
|
|
|
9605
9824
|
/**
|
|
9606
9825
|
* Scenario for obtaining an original image without any processing
|
|
9607
9826
|
*/
|
|
9608
|
-
CAPTURE = "Capture"
|
|
9827
|
+
CAPTURE = "Capture",
|
|
9828
|
+
/**
|
|
9829
|
+
* Processing scenario for Digital Travel Credentials (DTC-VC) data processing
|
|
9830
|
+
*/
|
|
9831
|
+
DTC = "DTC"
|
|
9609
9832
|
}
|
|
9610
9833
|
/**
|
|
9611
9834
|
* Regula Document Reader Web API
|
|
@@ -9647,6 +9870,12 @@ export enum TextPostProcessing {
|
|
|
9647
9870
|
* @interface ProcessParams
|
|
9648
9871
|
*/
|
|
9649
9872
|
export interface ProcessParams {
|
|
9873
|
+
/**
|
|
9874
|
+
* This parameter is used to generate separate DTC-VC data container from RFID session data.
|
|
9875
|
+
* @type {boolean}
|
|
9876
|
+
* @memberof ProcessParams
|
|
9877
|
+
*/
|
|
9878
|
+
generateDTCVC?: boolean;
|
|
9650
9879
|
/**
|
|
9651
9880
|
* The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default.
|
|
9652
9881
|
* @type {Array<number>}
|
|
@@ -9820,10 +10049,17 @@ export interface ProcessParams {
|
|
|
9820
10049
|
*/
|
|
9821
10050
|
imageQa?: ImageQA;
|
|
9822
10051
|
/**
|
|
9823
|
-
* When enabled, image quality
|
|
10052
|
+
* When enabled, the image quality check status affects the document optical and overall status. Disabled by default.
|
|
9824
10053
|
* @type {boolean}
|
|
9825
10054
|
* @memberof ProcessParams
|
|
9826
10055
|
*/
|
|
10056
|
+
strictImageQuality?: boolean;
|
|
10057
|
+
/**
|
|
10058
|
+
* Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default.
|
|
10059
|
+
* @type {boolean}
|
|
10060
|
+
* @memberof ProcessParams
|
|
10061
|
+
* @deprecated
|
|
10062
|
+
*/
|
|
9827
10063
|
respectImageQuality?: boolean;
|
|
9828
10064
|
/**
|
|
9829
10065
|
*
|
|
@@ -9975,6 +10211,18 @@ export interface ProcessParams {
|
|
|
9975
10211
|
* @memberof ProcessParams
|
|
9976
10212
|
*/
|
|
9977
10213
|
generateNumericCodes?: boolean;
|
|
10214
|
+
/**
|
|
10215
|
+
* 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.
|
|
10216
|
+
* @type {boolean}
|
|
10217
|
+
* @memberof ProcessParams
|
|
10218
|
+
*/
|
|
10219
|
+
strictBarcodeDigitalSignatureCheck?: boolean;
|
|
10220
|
+
/**
|
|
10221
|
+
* 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.
|
|
10222
|
+
* @type {boolean}
|
|
10223
|
+
* @memberof ProcessParams
|
|
10224
|
+
*/
|
|
10225
|
+
selectLongestNames?: boolean;
|
|
9978
10226
|
}
|
|
9979
10227
|
/**
|
|
9980
10228
|
*
|
|
@@ -10099,6 +10347,18 @@ export interface ProcessRequest {
|
|
|
10099
10347
|
passBackObject?: {
|
|
10100
10348
|
[key: string]: object;
|
|
10101
10349
|
};
|
|
10350
|
+
/**
|
|
10351
|
+
* Digital Travel Credential (DTC-VC) data in base64 format for processing
|
|
10352
|
+
* @type {string}
|
|
10353
|
+
* @memberof ProcessRequest
|
|
10354
|
+
*/
|
|
10355
|
+
dtc?: string;
|
|
10356
|
+
/**
|
|
10357
|
+
* URLs to the document images for processing.
|
|
10358
|
+
* @type {Array<string>}
|
|
10359
|
+
* @memberof ProcessRequest
|
|
10360
|
+
*/
|
|
10361
|
+
ImageUrls?: Array<string>;
|
|
10102
10362
|
}
|
|
10103
10363
|
/**
|
|
10104
10364
|
*
|
|
@@ -10178,10 +10438,10 @@ export interface TransactionImage {
|
|
|
10178
10438
|
export interface TransactionProcessGetResponse {
|
|
10179
10439
|
/**
|
|
10180
10440
|
*
|
|
10181
|
-
* @type {
|
|
10441
|
+
* @type {string}
|
|
10182
10442
|
* @memberof TransactionProcessGetResponse
|
|
10183
10443
|
*/
|
|
10184
|
-
transactionId?:
|
|
10444
|
+
transactionId?: string;
|
|
10185
10445
|
/**
|
|
10186
10446
|
*
|
|
10187
10447
|
* @type {string}
|
|
@@ -10251,6 +10511,12 @@ export interface TransactionProcessRequest {
|
|
|
10251
10511
|
passBackObject?: {
|
|
10252
10512
|
[key: string]: object;
|
|
10253
10513
|
};
|
|
10514
|
+
/**
|
|
10515
|
+
* Digital Travel Credential (DTC-VC) data in base64 format for processing
|
|
10516
|
+
* @type {string}
|
|
10517
|
+
* @memberof TransactionProcessRequest
|
|
10518
|
+
*/
|
|
10519
|
+
dtc?: string;
|
|
10254
10520
|
}
|
|
10255
10521
|
export class TextFieldExt implements TextField {
|
|
10256
10522
|
fieldType: TextFieldType;
|
|
@@ -10375,6 +10641,7 @@ export class Response {
|
|
|
10375
10641
|
status?: Status;
|
|
10376
10642
|
text?: TextExt;
|
|
10377
10643
|
images?: ImagesExt;
|
|
10644
|
+
TransactionInfo: TransactionInfo;
|
|
10378
10645
|
lowLvlResponse: LowLvlResponse;
|
|
10379
10646
|
rawResponse: ProcessResponse | InlineResponse2001;
|
|
10380
10647
|
constructor(original: ProcessResponse | InlineResponse2001);
|
|
@@ -10402,9 +10669,9 @@ export class LowLvlResponse implements ProcessResponse {
|
|
|
10402
10669
|
imagesResult(): ImagesResult | undefined;
|
|
10403
10670
|
barcodeResult(): DocBarCodeInfo | undefined;
|
|
10404
10671
|
documentTypeResults(): Array<ChosenDocumentTypeResult> | undefined;
|
|
10405
|
-
resultByType(type: Result):
|
|
10406
|
-
resultByTypeAndPage(type: Result, page_idx?: number):
|
|
10407
|
-
resultsByType(type: Result):
|
|
10672
|
+
resultByType(type: Result): ContainerList['List'][number] | undefined;
|
|
10673
|
+
resultByTypeAndPage(type: Result, page_idx?: number): ContainerList['List'][number] | undefined;
|
|
10674
|
+
resultsByType(type: Result): ContainerList['List'];
|
|
10408
10675
|
}
|
|
10409
10676
|
export interface ProcessRequestImageWrapper extends Omit<ProcessRequestImage, 'ImageData'> {
|
|
10410
10677
|
ImageData: ArrayBuffer | Base64String;
|
|
@@ -10460,25 +10727,25 @@ export class DocumentReaderApi {
|
|
|
10460
10727
|
/**
|
|
10461
10728
|
*
|
|
10462
10729
|
* @summary Reprocess
|
|
10463
|
-
* @param {
|
|
10730
|
+
* @param {string} transactionId Transaction id
|
|
10464
10731
|
* @param {TransactionProcessRequest} transactionProcessRequest
|
|
10465
10732
|
* @param {*} [options] Override http request option.
|
|
10466
10733
|
* @throws {RequiredError}
|
|
10467
10734
|
*/
|
|
10468
|
-
reprocessTransaction(transactionId:
|
|
10735
|
+
reprocessTransaction(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: any): Promise<AxiosResponse<InlineResponse200, any>>;
|
|
10469
10736
|
/**
|
|
10470
10737
|
*
|
|
10471
10738
|
* @summary Get Reprocess transaction result
|
|
10472
|
-
* @param {
|
|
10739
|
+
* @param {string} transactionId Transaction id
|
|
10473
10740
|
* @param {boolean} [withImages] With base64 images or url
|
|
10474
10741
|
* @param {*} [options] Override http request option.
|
|
10475
10742
|
* @throws {RequiredError}
|
|
10476
10743
|
*/
|
|
10477
|
-
getReprocessTransactionResult(transactionId:
|
|
10744
|
+
getReprocessTransactionResult(transactionId: string, withImages?: boolean, options?: any): Promise<Response>;
|
|
10478
10745
|
/**
|
|
10479
10746
|
*
|
|
10480
10747
|
* @summary Get transactions by tag
|
|
10481
|
-
* @param {
|
|
10748
|
+
* @param {string} tagId Tag id
|
|
10482
10749
|
* @param {*} [options] Override http request option.
|
|
10483
10750
|
* @throws {RequiredError}
|
|
10484
10751
|
*/
|
|
@@ -10486,27 +10753,27 @@ export class DocumentReaderApi {
|
|
|
10486
10753
|
/**
|
|
10487
10754
|
*
|
|
10488
10755
|
* @summary Delete Reprocess transactions by tag
|
|
10489
|
-
* @param {
|
|
10756
|
+
* @param {string} tagId Tag id
|
|
10490
10757
|
* @param {*} [options] Override http request option.
|
|
10491
10758
|
* @throws {RequiredError}
|
|
10492
10759
|
*/
|
|
10493
|
-
deleteReprocessTransactionsByTag(tagId:
|
|
10760
|
+
deleteReprocessTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<object, any>>;
|
|
10494
10761
|
/**
|
|
10495
10762
|
*
|
|
10496
10763
|
* @summary Get Reprocess transaction file
|
|
10497
|
-
* @param {
|
|
10764
|
+
* @param {string} transactionId Transaction id
|
|
10498
10765
|
* @param {string} name File name
|
|
10499
10766
|
* @param {*} [options] Override http request option.
|
|
10500
10767
|
* @throws {RequiredError}
|
|
10501
10768
|
*/
|
|
10502
|
-
getReprocessTransactionFile(transactionId:
|
|
10769
|
+
getReprocessTransactionFile(transactionId: string, name: string, options?: any): Promise<AxiosResponse<any, any>>;
|
|
10503
10770
|
/**
|
|
10504
10771
|
*
|
|
10505
10772
|
* @summary Get Reprocess transaction data
|
|
10506
|
-
* @param {
|
|
10773
|
+
* @param {string} transactionId Transaction id
|
|
10507
10774
|
* @param {*} [options] Override http request option.
|
|
10508
10775
|
* @throws {RequiredError}
|
|
10509
10776
|
*/
|
|
10510
|
-
getReprocessTransactionData(transactionId:
|
|
10777
|
+
getReprocessTransactionData(transactionId: string, options?: any): Promise<AxiosResponse<TransactionProcessGetResponse, any>>;
|
|
10511
10778
|
}
|
|
10512
10779
|
export function requestToBaseRequest(request: ProcessRequestExt): ProcessRequest;
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"> 0.2%",
|
|
6
6
|
"not dead"
|
|
7
7
|
],
|
|
8
|
-
"version": "7.5.
|
|
8
|
+
"version": "7.5.183-nightly",
|
|
9
9
|
"description": "Regula Document Reader js client for the browser and node.js based on axios",
|
|
10
10
|
"author": "Regula Forensics, Inc.",
|
|
11
11
|
"keywords": [
|
|
@@ -51,8 +51,8 @@
|
|
|
51
51
|
"*.{js,ts}": "eslint --fix"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"@swc/helpers": "^0.5.
|
|
55
|
-
"axios": "^1.7.
|
|
54
|
+
"@swc/helpers": "^0.5.13",
|
|
55
|
+
"axios": "^1.7.7",
|
|
56
56
|
"base64-arraybuffer": "^1.0.2",
|
|
57
57
|
"pako": "^2.1.0"
|
|
58
58
|
},
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"eslint-config-prettier": "^9.1.0",
|
|
67
67
|
"eslint-plugin-prettier": "^5.2.1",
|
|
68
68
|
"husky": "^9.1.5",
|
|
69
|
-
"lint-staged": "^15.2.
|
|
69
|
+
"lint-staged": "^15.2.10",
|
|
70
70
|
"parcel": "^2.12.0",
|
|
71
71
|
"prettier": "^3.3.3",
|
|
72
72
|
"typescript": "^5.3.2"
|