@regulaforensics/vp-frontend-document-components 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/README.md +67 -18
  2. package/dist/main.js +1 -1
  3. package/esm/main.js +1 -1
  4. package/lib/components/DocumentCapture.d.ts +1 -1
  5. package/lib/components/DocumentReaderFileCapture.d.ts +3 -3
  6. package/lib/constants.d.ts +40 -1
  7. package/lib/hooks/useDocumentReaderSeries.d.ts +1 -1
  8. package/lib/hooks/useDocumentReaderSingle.d.ts +3 -3
  9. package/lib/models/DocReaderWebclient/ext/authenticity/authenticity.d.ts +32 -0
  10. package/lib/models/DocReaderWebclient/ext/authenticity/fiber.d.ts +7 -0
  11. package/lib/models/DocReaderWebclient/ext/authenticity/ident.d.ts +8 -0
  12. package/lib/models/DocReaderWebclient/ext/authenticity/image-ident.d.ts +7 -0
  13. package/lib/models/DocReaderWebclient/ext/authenticity/index.d.ts +5 -0
  14. package/lib/models/DocReaderWebclient/ext/authenticity/ocr-security-text.d.ts +7 -0
  15. package/lib/models/DocReaderWebclient/ext/authenticity/security-feature.d.ts +8 -0
  16. package/lib/models/DocReaderWebclient/ext/images.d.ts +16 -0
  17. package/lib/models/DocReaderWebclient/ext/index.d.ts +6 -0
  18. package/lib/models/DocReaderWebclient/ext/process-request-image.d.ts +5 -0
  19. package/lib/models/DocReaderWebclient/ext/process-request.d.ts +38 -0
  20. package/lib/models/DocReaderWebclient/ext/process-response.d.ts +36 -0
  21. package/lib/models/DocReaderWebclient/ext/text-field.d.ts +40 -0
  22. package/lib/models/DocReaderWebclient/ext/text.d.ts +14 -0
  23. package/lib/models/DocReaderWebclient/models/area-array.d.ts +32 -0
  24. package/lib/models/DocReaderWebclient/models/area-container.d.ts +38 -0
  25. package/lib/models/DocReaderWebclient/models/authenticity-check-list.d.ts +31 -0
  26. package/lib/models/DocReaderWebclient/models/authenticity-check-result-item.d.ts +38 -0
  27. package/lib/models/DocReaderWebclient/models/authenticity-check-result.d.ts +43 -0
  28. package/lib/models/DocReaderWebclient/models/authenticity-result-all-of.d.ts +25 -0
  29. package/lib/models/DocReaderWebclient/models/authenticity-result-type.d.ts +33 -0
  30. package/lib/models/DocReaderWebclient/models/authenticity-result.d.ts +18 -0
  31. package/lib/models/DocReaderWebclient/models/bc-pdf417-info.d.ts +54 -0
  32. package/lib/models/DocReaderWebclient/models/bc-roidetect.d.ts +42 -0
  33. package/lib/models/DocReaderWebclient/models/check-diagnose.d.ts +98 -0
  34. package/lib/models/DocReaderWebclient/models/check-result.d.ts +30 -0
  35. package/lib/models/DocReaderWebclient/models/chosen-document-type-result-all-of.d.ts +25 -0
  36. package/lib/models/DocReaderWebclient/models/chosen-document-type-result.d.ts +19 -0
  37. package/lib/models/DocReaderWebclient/models/chosen-document-type.d.ts +74 -0
  38. package/lib/models/DocReaderWebclient/models/container-list.d.ts +45 -0
  39. package/lib/models/DocReaderWebclient/models/critical.d.ts +26 -0
  40. package/lib/models/DocReaderWebclient/models/cross-source-value-comparison.d.ts +38 -0
  41. package/lib/models/DocReaderWebclient/models/data-module.d.ts +48 -0
  42. package/lib/models/DocReaderWebclient/models/details-optical.d.ts +67 -0
  43. package/lib/models/DocReaderWebclient/models/details-rfid.d.ts +61 -0
  44. package/lib/models/DocReaderWebclient/models/device-info.d.ts +54 -0
  45. package/lib/models/DocReaderWebclient/models/doc-bar-code-info-all-of.d.ts +31 -0
  46. package/lib/models/DocReaderWebclient/models/doc-bar-code-info.d.ts +19 -0
  47. package/lib/models/DocReaderWebclient/models/doc-visual-extended-field.d.ts +70 -0
  48. package/lib/models/DocReaderWebclient/models/doc-visual-extended-info.d.ts +25 -0
  49. package/lib/models/DocReaderWebclient/models/document-format.d.ts +70 -0
  50. package/lib/models/DocReaderWebclient/models/document-image-result-all-of.d.ts +25 -0
  51. package/lib/models/DocReaderWebclient/models/document-image-result.d.ts +18 -0
  52. package/lib/models/DocReaderWebclient/models/document-image.d.ts +24 -0
  53. package/lib/models/DocReaderWebclient/models/document-position-result-all-of.d.ts +25 -0
  54. package/lib/models/DocReaderWebclient/models/document-position-result.d.ts +19 -0
  55. package/lib/models/DocReaderWebclient/models/document-position.d.ts +80 -0
  56. package/lib/models/DocReaderWebclient/models/document-type-recognition-result.d.ts +30 -0
  57. package/lib/models/DocReaderWebclient/models/document-type.d.ts +246 -0
  58. package/lib/models/DocReaderWebclient/models/document-types-candidates-list.d.ts +32 -0
  59. package/lib/models/DocReaderWebclient/models/document-types-candidates-result-all-of.d.ts +25 -0
  60. package/lib/models/DocReaderWebclient/models/document-types-candidates-result.d.ts +18 -0
  61. package/lib/models/DocReaderWebclient/models/document-types-candidates.d.ts +32 -0
  62. package/lib/models/DocReaderWebclient/models/encrypted-rclresult-all-of.d.ts +24 -0
  63. package/lib/models/DocReaderWebclient/models/encrypted-rclresult.d.ts +18 -0
  64. package/lib/models/DocReaderWebclient/models/fdsidlist.d.ts +80 -0
  65. package/lib/models/DocReaderWebclient/models/fiber-result-all-of.d.ts +74 -0
  66. package/lib/models/DocReaderWebclient/models/fiber-result.d.ts +18 -0
  67. package/lib/models/DocReaderWebclient/models/graphic-field-type.d.ts +118 -0
  68. package/lib/models/DocReaderWebclient/models/graphic-field.d.ts +63 -0
  69. package/lib/models/DocReaderWebclient/models/graphic-fields-list.d.ts +25 -0
  70. package/lib/models/DocReaderWebclient/models/graphics-result-all-of.d.ts +25 -0
  71. package/lib/models/DocReaderWebclient/models/graphics-result.d.ts +19 -0
  72. package/lib/models/DocReaderWebclient/models/ident-result-all-of.d.ts +65 -0
  73. package/lib/models/DocReaderWebclient/models/ident-result.d.ts +18 -0
  74. package/lib/models/DocReaderWebclient/models/image-data.d.ts +24 -0
  75. package/lib/models/DocReaderWebclient/models/image-qa.d.ts +54 -0
  76. package/lib/models/DocReaderWebclient/models/image-quality-check-list.d.ts +32 -0
  77. package/lib/models/DocReaderWebclient/models/image-quality-check-type.d.ts +50 -0
  78. package/lib/models/DocReaderWebclient/models/image-quality-check.d.ts +64 -0
  79. package/lib/models/DocReaderWebclient/models/image-quality-result-all-of.d.ts +25 -0
  80. package/lib/models/DocReaderWebclient/models/image-quality-result.d.ts +18 -0
  81. package/lib/models/DocReaderWebclient/models/images-available-source.d.ts +31 -0
  82. package/lib/models/DocReaderWebclient/models/images-field-value.d.ts +70 -0
  83. package/lib/models/DocReaderWebclient/models/images-field.d.ts +38 -0
  84. package/lib/models/DocReaderWebclient/models/images-result-all-of.d.ts +25 -0
  85. package/lib/models/DocReaderWebclient/models/images-result.d.ts +18 -0
  86. package/lib/models/DocReaderWebclient/models/images.d.ts +32 -0
  87. package/lib/models/DocReaderWebclient/models/index.d.ts +123 -0
  88. package/lib/models/DocReaderWebclient/models/lcid.d.ts +582 -0
  89. package/lib/models/DocReaderWebclient/models/lexical-analysis-result-all-of.d.ts +25 -0
  90. package/lib/models/DocReaderWebclient/models/lexical-analysis-result.d.ts +19 -0
  91. package/lib/models/DocReaderWebclient/models/license-result-all-of.d.ts +24 -0
  92. package/lib/models/DocReaderWebclient/models/license-result.d.ts +18 -0
  93. package/lib/models/DocReaderWebclient/models/light.d.ts +34 -0
  94. package/lib/models/DocReaderWebclient/models/list-verified-fields.d.ts +25 -0
  95. package/lib/models/DocReaderWebclient/models/log-level.d.ts +23 -0
  96. package/lib/models/DocReaderWebclient/models/measure-system.d.ts +26 -0
  97. package/lib/models/DocReaderWebclient/models/mrzformat.d.ts +24 -0
  98. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result-all-of.d.ts +81 -0
  99. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result.d.ts +18 -0
  100. package/lib/models/DocReaderWebclient/models/one-candidate.d.ts +74 -0
  101. package/lib/models/DocReaderWebclient/models/original-symbol.d.ts +37 -0
  102. package/lib/models/DocReaderWebclient/models/parray-field.d.ts +81 -0
  103. package/lib/models/DocReaderWebclient/models/per-document-config.d.ts +30 -0
  104. package/lib/models/DocReaderWebclient/models/photo-ident-result-all-of.d.ts +76 -0
  105. package/lib/models/DocReaderWebclient/models/photo-ident-result.d.ts +18 -0
  106. package/lib/models/DocReaderWebclient/models/point-array.d.ts +25 -0
  107. package/lib/models/DocReaderWebclient/models/point.d.ts +30 -0
  108. package/lib/models/DocReaderWebclient/models/points-container.d.ts +31 -0
  109. package/lib/models/DocReaderWebclient/models/process-params.d.ts +254 -0
  110. package/lib/models/DocReaderWebclient/models/process-request-image.d.ts +38 -0
  111. package/lib/models/DocReaderWebclient/models/process-request.d.ts +60 -0
  112. package/lib/models/DocReaderWebclient/models/process-response.d.ts +66 -0
  113. package/lib/models/DocReaderWebclient/models/process-system-info.d.ts +30 -0
  114. package/lib/models/DocReaderWebclient/models/processing-status.d.ts +30 -0
  115. package/lib/models/DocReaderWebclient/models/raw-image-container-list.d.ts +31 -0
  116. package/lib/models/DocReaderWebclient/models/rectangle-coordinates.d.ts +42 -0
  117. package/lib/models/DocReaderWebclient/models/result-item.d.ts +48 -0
  118. package/lib/models/DocReaderWebclient/models/result.d.ts +98 -0
  119. package/lib/models/DocReaderWebclient/models/rfid-location.d.ts +30 -0
  120. package/lib/models/DocReaderWebclient/models/rfid-origin.d.ts +42 -0
  121. package/lib/models/DocReaderWebclient/models/scenario.d.ts +36 -0
  122. package/lib/models/DocReaderWebclient/models/security-feature-result-all-of.d.ts +59 -0
  123. package/lib/models/DocReaderWebclient/models/security-feature-result.d.ts +18 -0
  124. package/lib/models/DocReaderWebclient/models/security-feature-type.d.ts +49 -0
  125. package/lib/models/DocReaderWebclient/models/source-validity.d.ts +32 -0
  126. package/lib/models/DocReaderWebclient/models/source.d.ts +23 -0
  127. package/lib/models/DocReaderWebclient/models/status-result-all-of.d.ts +25 -0
  128. package/lib/models/DocReaderWebclient/models/status-result.d.ts +18 -0
  129. package/lib/models/DocReaderWebclient/models/status.d.ts +63 -0
  130. package/lib/models/DocReaderWebclient/models/string-recognition-result.d.ts +25 -0
  131. package/lib/models/DocReaderWebclient/models/symbol-candidate.d.ts +30 -0
  132. package/lib/models/DocReaderWebclient/models/symbol-recognition-result.d.ts +32 -0
  133. package/lib/models/DocReaderWebclient/models/text-available-source.d.ts +38 -0
  134. package/lib/models/DocReaderWebclient/models/text-data-result-all-of.d.ts +25 -0
  135. package/lib/models/DocReaderWebclient/models/text-data-result.d.ts +19 -0
  136. package/lib/models/DocReaderWebclient/models/text-field-type.d.ts +2386 -0
  137. package/lib/models/DocReaderWebclient/models/text-field-value.d.ts +70 -0
  138. package/lib/models/DocReaderWebclient/models/text-field.d.ts +84 -0
  139. package/lib/models/DocReaderWebclient/models/text-post-processing.d.ts +22 -0
  140. package/lib/models/DocReaderWebclient/models/text-result-all-of.d.ts +25 -0
  141. package/lib/models/DocReaderWebclient/models/text-result.d.ts +18 -0
  142. package/lib/models/DocReaderWebclient/models/text.d.ts +51 -0
  143. package/lib/models/DocReaderWebclient/models/transaction-info.d.ts +42 -0
  144. package/lib/models/DocReaderWebclient/models/verification-result.d.ts +38 -0
  145. package/lib/models/DocReaderWebclient/models/verified-field-map.d.ts +63 -0
  146. package/lib/models/DocReaderWebclient/models/visibility.d.ts +23 -0
  147. package/lib/services/DocumentReaderProcessor.d.ts +7 -15
  148. package/lib/services/DocumentReaderService.d.ts +10 -4
  149. package/lib/types.d.ts +12 -9
  150. package/lib/utils.d.ts +4 -1
  151. package/package.json +1 -3
@@ -0,0 +1,118 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum GraphicFieldType {
18
+ /**
19
+ * Document holder photo
20
+ */
21
+ PORTRAIT = 201,
22
+ /**
23
+ * Fingerprint of document holder
24
+ */
25
+ FINGERPRINT = 202,
26
+ /**
27
+ * Image of the iris of document holder
28
+ */
29
+ EYE = 203,
30
+ /**
31
+ * Signature of document holder
32
+ */
33
+ SIGNATURE = 204,
34
+ /**
35
+ * Barcode image
36
+ */
37
+ BAR_CODE = 205,
38
+ /**
39
+ * Image of document confirming owner citizenship
40
+ */
41
+ PROOF_OF_CITIZENSHIP = 206,
42
+ /**
43
+ * Cropped and rotated with perspective compensation (front side) of a document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most coordinates in other types defined on that image.
44
+ */
45
+ DOCUMENT_FRONT = 207,
46
+ /**
47
+ * Image of the rear side of the document
48
+ */
49
+ DOCUMENT_REAR = 208,
50
+ /**
51
+ * Area with dynamic color change
52
+ */
53
+ COLOR_DYNAMIC = 209,
54
+ /**
55
+ * Additional Portrait
56
+ */
57
+ GHOST_PORTRAIT = 210,
58
+ /**
59
+ * Stamp
60
+ */
61
+ STAMP = 211,
62
+ /**
63
+ * Undefined image type
64
+ */
65
+ OTHER = 250,
66
+ /**
67
+ * Fingerprint (thumb, left hand)
68
+ */
69
+ FINGER_LEFT_THUMB = 300,
70
+ /**
71
+ * Fingerprint (index, left hand)
72
+ */
73
+ FINGER_LEFT_INDEX = 301,
74
+ /**
75
+ * Fingerprint (middle, left hand)
76
+ */
77
+ FINGER_LEFT_MIDDLE = 302,
78
+ /**
79
+ * Fingerprint (ring, left hand)
80
+ */
81
+ FINGER_LEFT_RING = 303,
82
+ /**
83
+ * Fingerprint (little, left hand)
84
+ */
85
+ FINGER_LEFT_LITTLE = 304,
86
+ /**
87
+ * Fingerprint (thumb, right hand)
88
+ */
89
+ FINGER_RIGHT_THUMB = 305,
90
+ /**
91
+ * Fingerprint (index, right hand)
92
+ */
93
+ FINGER_RIGHT_INDEX = 306,
94
+ /**
95
+ * Fingerprint (middle, right hand)
96
+ */
97
+ FINGER_RIGHT_MIDDLE = 307,
98
+ /**
99
+ * Fingerprint (ring, right hand)
100
+ */
101
+ FINGER_RIGHT_RING = 308,
102
+ /**
103
+ * Fingerprint (little, right hand)
104
+ */
105
+ FINGER_RIGHT_LITTLE = 309,
106
+ /**
107
+ * Fingerprint (four without thumb on right hand)
108
+ */
109
+ FINGER_RIGHT_FOUR_FINGERS = 313,
110
+ /**
111
+ * Fingerprint (four without thumb on left hand
112
+ */
113
+ FINGER_LEFT_FOUR_FINGERS = 314,
114
+ /**
115
+ * Fingerprint (two thumbs)
116
+ */
117
+ FINGER_TWO_THUMBS = 315
118
+ }
@@ -0,0 +1,63 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { GraphicFieldType } from './graphic-field-type';
13
+ import { ImageData } from './image-data';
14
+ import { RectangleCoordinates } from './rectangle-coordinates';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface GraphicField
19
+ */
20
+ export interface GraphicField {
21
+ /**
22
+ *
23
+ * @type {GraphicFieldType}
24
+ * @memberof GraphicField
25
+ */
26
+ FieldType: GraphicFieldType;
27
+ /**
28
+ *
29
+ * @type {ImageData}
30
+ * @memberof GraphicField
31
+ */
32
+ image: ImageData;
33
+ /**
34
+ *
35
+ * @type {RectangleCoordinates}
36
+ * @memberof GraphicField
37
+ */
38
+ FieldRect?: RectangleCoordinates;
39
+ /**
40
+ * Source data group file. Only for Result.RFID_GRAPHICS result.
41
+ * @type {number}
42
+ * @memberof GraphicField
43
+ */
44
+ RFID_OriginDG?: number;
45
+ /**
46
+ * Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result.
47
+ * @type {number}
48
+ * @memberof GraphicField
49
+ */
50
+ RFID_OriginDGTag?: number;
51
+ /**
52
+ * Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result.
53
+ * @type {number}
54
+ * @memberof GraphicField
55
+ */
56
+ RFID_OriginTagEntry?: number;
57
+ /**
58
+ * Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result.
59
+ * @type {number}
60
+ * @memberof GraphicField
61
+ */
62
+ RFID_OriginEntryView?: number;
63
+ }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { GraphicField } from './graphic-field';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GraphicFieldsList
17
+ */
18
+ export interface GraphicFieldsList {
19
+ /**
20
+ *
21
+ * @type {Array<GraphicField>}
22
+ * @memberof GraphicFieldsList
23
+ */
24
+ pArrayFields: Array<GraphicField>;
25
+ }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { GraphicFieldsList } from './graphic-fields-list';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GraphicsResultAllOf
17
+ */
18
+ export interface GraphicsResultAllOf {
19
+ /**
20
+ *
21
+ * @type {GraphicFieldsList}
22
+ * @memberof GraphicsResultAllOf
23
+ */
24
+ DocGraphicsInfo?: GraphicFieldsList;
25
+ }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { GraphicsResultAllOf } from './graphics-result-all-of';
13
+ import { ResultItem } from './result-item';
14
+ /**
15
+ * @type GraphicsResult
16
+ * Graphic fields extracted from one of the document sources. Returns separate results for each provided page.
17
+ * @export
18
+ */
19
+ export declare type GraphicsResult = GraphicsResultAllOf & ResultItem;
@@ -0,0 +1,65 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AreaContainer } from './area-container';
13
+ import { ImageData } from './image-data';
14
+ import { Light } from './light';
15
+ import { RectangleCoordinates } from './rectangle-coordinates';
16
+ import { SecurityFeatureType } from './security-feature-type';
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface IdentResultAllOf
21
+ */
22
+ export interface IdentResultAllOf {
23
+ /**
24
+ *
25
+ * @type {SecurityFeatureType}
26
+ * @memberof IdentResultAllOf
27
+ */
28
+ ElementType?: SecurityFeatureType;
29
+ /**
30
+ *
31
+ * @type {Light}
32
+ * @memberof IdentResultAllOf
33
+ */
34
+ LightIndex?: Light;
35
+ /**
36
+ *
37
+ * @type {RectangleCoordinates}
38
+ * @memberof IdentResultAllOf
39
+ */
40
+ Area?: RectangleCoordinates;
41
+ /**
42
+ *
43
+ * @type {ImageData}
44
+ * @memberof IdentResultAllOf
45
+ */
46
+ Image?: ImageData;
47
+ /**
48
+ *
49
+ * @type {ImageData}
50
+ * @memberof IdentResultAllOf
51
+ */
52
+ EtalonImage?: ImageData;
53
+ /**
54
+ * Probability percent for IMAGE_PATTERN check or element\'s visibility for IR_VISIBILITY
55
+ * @type {number}
56
+ * @memberof IdentResultAllOf
57
+ */
58
+ PercentValue?: number;
59
+ /**
60
+ *
61
+ * @type {AreaContainer}
62
+ * @memberof IdentResultAllOf
63
+ */
64
+ AreaList?: AreaContainer;
65
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AuthenticityCheckResultItem } from './authenticity-check-result-item';
13
+ import { IdentResultAllOf } from './ident-result-all-of';
14
+ /**
15
+ * @type IdentResult
16
+ * @export
17
+ */
18
+ export declare type IdentResult = AuthenticityCheckResultItem & IdentResultAllOf;
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ImageData
16
+ */
17
+ export interface ImageData {
18
+ /**
19
+ * Base64 encoded image
20
+ * @type {string}
21
+ * @memberof ImageData
22
+ */
23
+ image: string;
24
+ }
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ImageQA
16
+ */
17
+ export interface ImageQA {
18
+ /**
19
+ * This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.
20
+ * @type {number}
21
+ * @memberof ImageQA
22
+ */
23
+ dpiThreshold?: number;
24
+ /**
25
+ * This parameter sets threshold for Image QA check of the presented document perspective angle in degrees. If actual document perspective angle is above this threshold, check will fail.
26
+ * @type {number}
27
+ * @memberof ImageQA
28
+ */
29
+ angleThreshold?: number;
30
+ /**
31
+ * This option enables focus check while performing image quality validation.
32
+ * @type {boolean}
33
+ * @memberof ImageQA
34
+ */
35
+ focusCheck?: boolean;
36
+ /**
37
+ * This option enables glares check while performing image quality validation.
38
+ * @type {boolean}
39
+ * @memberof ImageQA
40
+ */
41
+ glaresCheck?: boolean;
42
+ /**
43
+ * This option enables colorness check while performing image quality validation.
44
+ * @type {boolean}
45
+ * @memberof ImageQA
46
+ */
47
+ colornessCheck?: boolean;
48
+ /**
49
+ * This option enables screen capture (moire patterns) check while performing image quality validation.
50
+ * @type {boolean}
51
+ * @memberof ImageQA
52
+ */
53
+ moireCheck?: boolean;
54
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { CheckResult } from './check-result';
13
+ import { ImageQualityCheck } from './image-quality-check';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface ImageQualityCheckList
18
+ */
19
+ export interface ImageQualityCheckList {
20
+ /**
21
+ *
22
+ * @type {CheckResult}
23
+ * @memberof ImageQualityCheckList
24
+ */
25
+ result: CheckResult;
26
+ /**
27
+ *
28
+ * @type {Array<ImageQualityCheck>}
29
+ * @memberof ImageQualityCheckList
30
+ */
31
+ List: Array<ImageQualityCheck>;
32
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Image quality check type
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum ImageQualityCheckType {
18
+ /**
19
+ * Signals glare presence on the image
20
+ */
21
+ ImageGlares = 0,
22
+ /**
23
+ * Signals whether image is in focus
24
+ */
25
+ ImageFocus = 1,
26
+ /**
27
+ * Signals if image resolution is below threshold
28
+ */
29
+ ImageResolution = 2,
30
+ /**
31
+ * Signals if image is colorless
32
+ */
33
+ ImageColorness = 3,
34
+ /**
35
+ * Signals if document in the image has prespective distortion above threshold
36
+ */
37
+ Perspective = 4,
38
+ /**
39
+ * Signals if document is not fully present in the image
40
+ */
41
+ Bounds = 5,
42
+ /**
43
+ * Signals if an image is captured from screen
44
+ */
45
+ ScreenCapture = 6,
46
+ /**
47
+ * Signals if the portrait is present
48
+ */
49
+ Portrait = 7
50
+ }
@@ -0,0 +1,64 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AreaArray } from './area-array';
13
+ import { CheckResult } from './check-result';
14
+ import { ImageQualityCheckType } from './image-quality-check-type';
15
+ import { SecurityFeatureType } from './security-feature-type';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ImageQualityCheck
20
+ */
21
+ export interface ImageQualityCheck {
22
+ /**
23
+ *
24
+ * @type {ImageQualityCheckType}
25
+ * @memberof ImageQualityCheck
26
+ */
27
+ type?: ImageQualityCheckType;
28
+ /**
29
+ *
30
+ * @type {CheckResult}
31
+ * @memberof ImageQualityCheck
32
+ */
33
+ result?: CheckResult;
34
+ /**
35
+ *
36
+ * @type {SecurityFeatureType}
37
+ * @memberof ImageQualityCheck
38
+ */
39
+ featureType?: SecurityFeatureType;
40
+ /**
41
+ *
42
+ * @type {AreaArray}
43
+ * @memberof ImageQualityCheck
44
+ */
45
+ areas?: AreaArray;
46
+ /**
47
+ *
48
+ * @type {number}
49
+ * @memberof ImageQualityCheck
50
+ */
51
+ mean?: number;
52
+ /**
53
+ *
54
+ * @type {number}
55
+ * @memberof ImageQualityCheck
56
+ */
57
+ std_dev?: number;
58
+ /**
59
+ *
60
+ * @type {number}
61
+ * @memberof ImageQualityCheck
62
+ */
63
+ probability?: number;
64
+ }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ImageQualityCheckList } from './image-quality-check-list';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ImageQualityResultAllOf
17
+ */
18
+ export interface ImageQualityResultAllOf {
19
+ /**
20
+ *
21
+ * @type {ImageQualityCheckList}
22
+ * @memberof ImageQualityResultAllOf
23
+ */
24
+ ImageQualityCheckList: ImageQualityCheckList;
25
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ImageQualityResultAllOf } from './image-quality-result-all-of';
13
+ import { ResultItem } from './result-item';
14
+ /**
15
+ * @type ImageQualityResult
16
+ * @export
17
+ */
18
+ export declare type ImageQualityResult = ImageQualityResultAllOf & ResultItem;
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Source } from './source';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ImagesAvailableSource
17
+ */
18
+ export interface ImagesAvailableSource {
19
+ /**
20
+ * Same as Result type, but used for safe parsing of not-described values. See Result type.
21
+ * @type {number}
22
+ * @memberof ImagesAvailableSource
23
+ */
24
+ containerType?: number;
25
+ /**
26
+ *
27
+ * @type {Source}
28
+ * @memberof ImagesAvailableSource
29
+ */
30
+ source: Source;
31
+ }