@regulaforensics/vp-frontend-face-components 1.4.0 → 2.0.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 (211) hide show
  1. package/README.md +47 -22
  2. package/dist/main.js +1 -1
  3. package/dist/main.js.LICENSE.txt +19 -20
  4. package/lib/common/Icon.d.ts +58 -1
  5. package/lib/common/Message.d.ts +3 -2
  6. package/lib/common/NoGlareIconLivenessDetection.d.ts +5 -0
  7. package/lib/common/NoSmilingIconLivenessDetection.d.ts +5 -0
  8. package/lib/common/PortraitOrientationOnlyIcon.d.ts +6 -0
  9. package/lib/common/RegulaLogoLivenessDetection.d.ts +5 -0
  10. package/lib/components/ButtonFaceLiveness.d.ts +7 -0
  11. package/lib/components/CameraCapture.d.ts +9 -0
  12. package/lib/components/CameraSnapshot.d.ts +2 -0
  13. package/lib/components/CameraSnapshotFileCapture.d.ts +10 -0
  14. package/lib/components/DocumentCapture.d.ts +11 -0
  15. package/lib/components/DocumentContainer.d.ts +11 -0
  16. package/lib/components/DocumentReader.d.ts +2 -0
  17. package/lib/components/DocumentReaderFileCapture.d.ts +12 -0
  18. package/lib/components/DocumentReaderLayout.d.ts +22 -0
  19. package/lib/components/DocumentReaderStartScreen.d.ts +10 -0
  20. package/lib/components/ErrorBoundary.d.ts +6 -5
  21. package/lib/components/FaceCapture.d.ts +17 -9
  22. package/lib/components/FaceFullScreenOverlay.d.ts +2 -3
  23. package/lib/components/FaceHintAnimaition.d.ts +16 -0
  24. package/lib/components/FaceLayout.d.ts +14 -10
  25. package/lib/components/InfoScreen.d.ts +2 -1
  26. package/lib/components/InfoScreenFaceLiveness.d.ts +12 -0
  27. package/lib/components/InstructionVideoScreen.d.ts +9 -0
  28. package/lib/components/ProcessScreenFaceLiveness.d.ts +6 -0
  29. package/lib/components/RetryScreenFaceLiveness.d.ts +7 -0
  30. package/lib/components/SectorAnimationSvg.d.ts +11 -0
  31. package/lib/components/WebCamera.d.ts +6 -7
  32. package/lib/constants.d.ts +489 -169
  33. package/lib/contexts/DocumentAttributesContext.d.ts +25 -0
  34. package/lib/contexts/DocumentSDKContext.d.ts +8 -0
  35. package/lib/contexts/FaceAttributesContext.d.ts +11 -10
  36. package/lib/hoc/withDocumentAttributesContext.d.ts +4 -0
  37. package/lib/hoc/withDocumentSDKContext.d.ts +3 -0
  38. package/lib/hoc/withLocalize.d.ts +5 -4
  39. package/lib/hooks/useDocumentReaderSeries.d.ts +20 -0
  40. package/lib/hooks/useDocumentReaderSingle.d.ts +15 -0
  41. package/lib/hooks/useFaceLiveness.d.ts +34 -26
  42. package/lib/hooks/useImageInputParam.d.ts +7 -0
  43. package/lib/hooks/useStateCallback.d.ts +1 -0
  44. package/lib/hooks/useStream.d.ts +3 -9
  45. package/lib/i18n/dictionaries/_dictionaries.d.ts +2212 -1988
  46. package/lib/index-document.d.ts +4 -0
  47. package/lib/media-resources/resourcesBase64.d.ts +7 -0
  48. package/lib/models/CameraModel.d.ts +2 -2
  49. package/lib/models/CustomError.d.ts +7 -0
  50. package/lib/models/DocReaderWebclient/ext/authenticity/authenticity.d.ts +32 -0
  51. package/lib/models/DocReaderWebclient/ext/authenticity/fiber.d.ts +7 -0
  52. package/lib/models/DocReaderWebclient/ext/authenticity/ident.d.ts +8 -0
  53. package/lib/models/DocReaderWebclient/ext/authenticity/image-ident.d.ts +7 -0
  54. package/lib/models/DocReaderWebclient/ext/authenticity/index.d.ts +5 -0
  55. package/lib/models/DocReaderWebclient/ext/authenticity/ocr-security-text.d.ts +7 -0
  56. package/lib/models/DocReaderWebclient/ext/authenticity/security-feature.d.ts +8 -0
  57. package/lib/models/DocReaderWebclient/ext/images.d.ts +16 -0
  58. package/lib/models/DocReaderWebclient/ext/index.d.ts +6 -0
  59. package/lib/models/DocReaderWebclient/ext/process-request-image.d.ts +5 -0
  60. package/lib/models/DocReaderWebclient/ext/process-request.d.ts +38 -0
  61. package/lib/models/DocReaderWebclient/ext/process-response.d.ts +36 -0
  62. package/lib/models/DocReaderWebclient/ext/text-field.d.ts +40 -0
  63. package/lib/models/DocReaderWebclient/ext/text.d.ts +14 -0
  64. package/lib/models/DocReaderWebclient/models/area-array.d.ts +32 -0
  65. package/lib/models/DocReaderWebclient/models/area-container.d.ts +38 -0
  66. package/lib/models/DocReaderWebclient/models/authenticity-check-list.d.ts +31 -0
  67. package/lib/models/DocReaderWebclient/models/authenticity-check-result-item.d.ts +38 -0
  68. package/lib/models/DocReaderWebclient/models/authenticity-check-result.d.ts +43 -0
  69. package/lib/models/DocReaderWebclient/models/authenticity-result-all-of.d.ts +25 -0
  70. package/lib/models/DocReaderWebclient/models/authenticity-result-type.d.ts +33 -0
  71. package/lib/models/DocReaderWebclient/models/authenticity-result.d.ts +18 -0
  72. package/lib/models/DocReaderWebclient/models/bc-pdf417-info.d.ts +54 -0
  73. package/lib/models/DocReaderWebclient/models/bc-roidetect.d.ts +42 -0
  74. package/lib/models/DocReaderWebclient/models/check-diagnose.d.ts +98 -0
  75. package/lib/models/DocReaderWebclient/models/check-result.d.ts +30 -0
  76. package/lib/models/DocReaderWebclient/models/chosen-document-type-result-all-of.d.ts +25 -0
  77. package/lib/models/DocReaderWebclient/models/chosen-document-type-result.d.ts +19 -0
  78. package/lib/models/DocReaderWebclient/models/chosen-document-type.d.ts +74 -0
  79. package/lib/models/DocReaderWebclient/models/container-list.d.ts +45 -0
  80. package/lib/models/DocReaderWebclient/models/critical.d.ts +26 -0
  81. package/lib/models/DocReaderWebclient/models/cross-source-value-comparison.d.ts +38 -0
  82. package/lib/models/DocReaderWebclient/models/data-module.d.ts +48 -0
  83. package/lib/models/DocReaderWebclient/models/details-optical.d.ts +67 -0
  84. package/lib/models/DocReaderWebclient/models/details-rfid.d.ts +61 -0
  85. package/lib/models/DocReaderWebclient/models/device-info.d.ts +54 -0
  86. package/lib/models/DocReaderWebclient/models/doc-bar-code-info-all-of.d.ts +31 -0
  87. package/lib/models/DocReaderWebclient/models/doc-bar-code-info.d.ts +19 -0
  88. package/lib/models/DocReaderWebclient/models/doc-visual-extended-field.d.ts +70 -0
  89. package/lib/models/DocReaderWebclient/models/doc-visual-extended-info.d.ts +25 -0
  90. package/lib/models/DocReaderWebclient/models/document-format.d.ts +70 -0
  91. package/lib/models/DocReaderWebclient/models/document-image-result-all-of.d.ts +25 -0
  92. package/lib/models/DocReaderWebclient/models/document-image-result.d.ts +18 -0
  93. package/lib/models/DocReaderWebclient/models/document-image.d.ts +24 -0
  94. package/lib/models/DocReaderWebclient/models/document-position-result-all-of.d.ts +25 -0
  95. package/lib/models/DocReaderWebclient/models/document-position-result.d.ts +19 -0
  96. package/lib/models/DocReaderWebclient/models/document-position.d.ts +80 -0
  97. package/lib/models/DocReaderWebclient/models/document-type-recognition-result.d.ts +30 -0
  98. package/lib/models/DocReaderWebclient/models/document-type.d.ts +246 -0
  99. package/lib/models/DocReaderWebclient/models/document-types-candidates-list.d.ts +32 -0
  100. package/lib/models/DocReaderWebclient/models/document-types-candidates-result-all-of.d.ts +25 -0
  101. package/lib/models/DocReaderWebclient/models/document-types-candidates-result.d.ts +18 -0
  102. package/lib/models/DocReaderWebclient/models/document-types-candidates.d.ts +32 -0
  103. package/lib/models/DocReaderWebclient/models/encrypted-rclresult-all-of.d.ts +24 -0
  104. package/lib/models/DocReaderWebclient/models/encrypted-rclresult.d.ts +18 -0
  105. package/lib/models/DocReaderWebclient/models/fdsidlist.d.ts +80 -0
  106. package/lib/models/DocReaderWebclient/models/fiber-result-all-of.d.ts +74 -0
  107. package/lib/models/DocReaderWebclient/models/fiber-result.d.ts +18 -0
  108. package/lib/models/DocReaderWebclient/models/graphic-field-type.d.ts +118 -0
  109. package/lib/models/DocReaderWebclient/models/graphic-field.d.ts +63 -0
  110. package/lib/models/DocReaderWebclient/models/graphic-fields-list.d.ts +25 -0
  111. package/lib/models/DocReaderWebclient/models/graphics-result-all-of.d.ts +25 -0
  112. package/lib/models/DocReaderWebclient/models/graphics-result.d.ts +19 -0
  113. package/lib/models/DocReaderWebclient/models/ident-result-all-of.d.ts +65 -0
  114. package/lib/models/DocReaderWebclient/models/ident-result.d.ts +18 -0
  115. package/lib/models/DocReaderWebclient/models/image-data.d.ts +24 -0
  116. package/lib/models/DocReaderWebclient/models/image-qa.d.ts +54 -0
  117. package/lib/models/DocReaderWebclient/models/image-quality-check-list.d.ts +32 -0
  118. package/lib/models/DocReaderWebclient/models/image-quality-check-type.d.ts +50 -0
  119. package/lib/models/DocReaderWebclient/models/image-quality-check.d.ts +64 -0
  120. package/lib/models/DocReaderWebclient/models/image-quality-result-all-of.d.ts +25 -0
  121. package/lib/models/DocReaderWebclient/models/image-quality-result.d.ts +18 -0
  122. package/lib/models/DocReaderWebclient/models/images-available-source.d.ts +31 -0
  123. package/lib/models/DocReaderWebclient/models/images-field-value.d.ts +70 -0
  124. package/lib/models/DocReaderWebclient/models/images-field.d.ts +38 -0
  125. package/lib/models/DocReaderWebclient/models/images-result-all-of.d.ts +25 -0
  126. package/lib/models/DocReaderWebclient/models/images-result.d.ts +18 -0
  127. package/lib/models/DocReaderWebclient/models/images.d.ts +32 -0
  128. package/lib/models/DocReaderWebclient/models/index.d.ts +123 -0
  129. package/lib/models/DocReaderWebclient/models/lcid.d.ts +582 -0
  130. package/lib/models/DocReaderWebclient/models/lexical-analysis-result-all-of.d.ts +25 -0
  131. package/lib/models/DocReaderWebclient/models/lexical-analysis-result.d.ts +19 -0
  132. package/lib/models/DocReaderWebclient/models/license-result-all-of.d.ts +24 -0
  133. package/lib/models/DocReaderWebclient/models/license-result.d.ts +18 -0
  134. package/lib/models/DocReaderWebclient/models/light.d.ts +34 -0
  135. package/lib/models/DocReaderWebclient/models/list-verified-fields.d.ts +25 -0
  136. package/lib/models/DocReaderWebclient/models/log-level.d.ts +23 -0
  137. package/lib/models/DocReaderWebclient/models/measure-system.d.ts +26 -0
  138. package/lib/models/DocReaderWebclient/models/mrzformat.d.ts +24 -0
  139. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result-all-of.d.ts +81 -0
  140. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result.d.ts +18 -0
  141. package/lib/models/DocReaderWebclient/models/one-candidate.d.ts +74 -0
  142. package/lib/models/DocReaderWebclient/models/original-symbol.d.ts +37 -0
  143. package/lib/models/DocReaderWebclient/models/parray-field.d.ts +81 -0
  144. package/lib/models/DocReaderWebclient/models/per-document-config.d.ts +30 -0
  145. package/lib/models/DocReaderWebclient/models/photo-ident-result-all-of.d.ts +76 -0
  146. package/lib/models/DocReaderWebclient/models/photo-ident-result.d.ts +18 -0
  147. package/lib/models/DocReaderWebclient/models/point-array.d.ts +25 -0
  148. package/lib/models/DocReaderWebclient/models/point.d.ts +30 -0
  149. package/lib/models/DocReaderWebclient/models/points-container.d.ts +31 -0
  150. package/lib/models/DocReaderWebclient/models/process-params.d.ts +254 -0
  151. package/lib/models/DocReaderWebclient/models/process-request-image.d.ts +38 -0
  152. package/lib/models/DocReaderWebclient/models/process-request.d.ts +60 -0
  153. package/lib/models/DocReaderWebclient/models/process-response.d.ts +66 -0
  154. package/lib/models/DocReaderWebclient/models/process-system-info.d.ts +30 -0
  155. package/lib/models/DocReaderWebclient/models/processing-status.d.ts +30 -0
  156. package/lib/models/DocReaderWebclient/models/raw-image-container-list.d.ts +31 -0
  157. package/lib/models/DocReaderWebclient/models/rectangle-coordinates.d.ts +42 -0
  158. package/lib/models/DocReaderWebclient/models/result-item.d.ts +48 -0
  159. package/lib/models/DocReaderWebclient/models/result.d.ts +98 -0
  160. package/lib/models/DocReaderWebclient/models/rfid-location.d.ts +30 -0
  161. package/lib/models/DocReaderWebclient/models/rfid-origin.d.ts +42 -0
  162. package/lib/models/DocReaderWebclient/models/scenario.d.ts +36 -0
  163. package/lib/models/DocReaderWebclient/models/security-feature-result-all-of.d.ts +59 -0
  164. package/lib/models/DocReaderWebclient/models/security-feature-result.d.ts +18 -0
  165. package/lib/models/DocReaderWebclient/models/security-feature-type.d.ts +49 -0
  166. package/lib/models/DocReaderWebclient/models/source-validity.d.ts +32 -0
  167. package/lib/models/DocReaderWebclient/models/source.d.ts +23 -0
  168. package/lib/models/DocReaderWebclient/models/status-result-all-of.d.ts +25 -0
  169. package/lib/models/DocReaderWebclient/models/status-result.d.ts +18 -0
  170. package/lib/models/DocReaderWebclient/models/status.d.ts +63 -0
  171. package/lib/models/DocReaderWebclient/models/string-recognition-result.d.ts +25 -0
  172. package/lib/models/DocReaderWebclient/models/symbol-candidate.d.ts +30 -0
  173. package/lib/models/DocReaderWebclient/models/symbol-recognition-result.d.ts +32 -0
  174. package/lib/models/DocReaderWebclient/models/text-available-source.d.ts +38 -0
  175. package/lib/models/DocReaderWebclient/models/text-data-result-all-of.d.ts +25 -0
  176. package/lib/models/DocReaderWebclient/models/text-data-result.d.ts +19 -0
  177. package/lib/models/DocReaderWebclient/models/text-field-type.d.ts +2386 -0
  178. package/lib/models/DocReaderWebclient/models/text-field-value.d.ts +70 -0
  179. package/lib/models/DocReaderWebclient/models/text-field.d.ts +84 -0
  180. package/lib/models/DocReaderWebclient/models/text-post-processing.d.ts +22 -0
  181. package/lib/models/DocReaderWebclient/models/text-result-all-of.d.ts +25 -0
  182. package/lib/models/DocReaderWebclient/models/text-result.d.ts +18 -0
  183. package/lib/models/DocReaderWebclient/models/text.d.ts +51 -0
  184. package/lib/models/DocReaderWebclient/models/transaction-info.d.ts +42 -0
  185. package/lib/models/DocReaderWebclient/models/verification-result.d.ts +38 -0
  186. package/lib/models/DocReaderWebclient/models/verified-field-map.d.ts +63 -0
  187. package/lib/models/DocReaderWebclient/models/visibility.d.ts +23 -0
  188. package/lib/services/DebugService.d.ts +4 -0
  189. package/lib/services/DocumentReaderProcessor.d.ts +50 -0
  190. package/lib/services/DocumentReaderService.d.ts +48 -30
  191. package/lib/services/FaceLivenessService.d.ts +35 -19
  192. package/lib/services/FaceService.d.ts +34 -6
  193. package/lib/services/StreamRecorderService.d.ts +24 -0
  194. package/lib/types.d.ts +261 -119
  195. package/lib/utils.d.ts +17 -52
  196. package/lib/web-components/CameraSnapshot.d.ts +14 -0
  197. package/lib/web-components/DocumentReader.d.ts +14 -0
  198. package/lib/web-components/FaceDetection.d.ts +3 -3
  199. package/lib/web-components/FaceLiveness.d.ts +7 -4
  200. package/lib/web-components/FullScreenContainer.d.ts +1 -1
  201. package/package.json +59 -62
  202. package/lib/common/InstructionIconFaceDetection.d.ts +0 -5
  203. package/lib/common/InstructionIconFaceLiveness.d.ts +0 -5
  204. package/lib/common/NoGlareIcon.d.ts +0 -5
  205. package/lib/common/NoSmilingIcon.d.ts +0 -5
  206. package/lib/components/InstructionScreen.d.ts +0 -9
  207. package/lib/components/RetryScreen.d.ts +0 -7
  208. package/lib/hooks/useDebounce.d.ts +0 -2
  209. package/lib/hooks/useInterval.d.ts +0 -3
  210. package/lib/services/WasmFeatureDetectService.d.ts +0 -4
  211. package/lib/web-components.d.ts +0 -47
@@ -0,0 +1,98 @@
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
+ * Enumeration contains identifiers which determinate the single document element authenticity check outcome reason
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum CheckDiagnose {
18
+ UNKNOWN = 0,
19
+ PASS = 1,
20
+ INVALID_INPUT_DATA = 2,
21
+ INTERNAL_ERROR = 3,
22
+ EXCEPTION_IN_MODULE = 4,
23
+ UNCERTAIN_VERIFICATION = 5,
24
+ NECESSARY_IMAGE_NOT_FOUND = 7,
25
+ PHOTO_SIDES_NOT_FOUND = 8,
26
+ INVALID_CHECKSUM = 10,
27
+ SYNTAX_ERROR = 11,
28
+ LOGIC_ERROR = 12,
29
+ SOURCES_COMPARISON_ERROR = 13,
30
+ FIELDS_COMPARISON_LOGIC_ERROR = 14,
31
+ INVALID_FIELD_FORMAT = 15,
32
+ TRUE_LUMINESCENCE_ERROR = 20,
33
+ FALSE_LUMINESCENCE_ERROR = 21,
34
+ FIXED_PATTERN_ERROR = 22,
35
+ LOW_CONTRAST_IN_IR_LIGHT = 23,
36
+ INCORRECT_BACKGROUND_LIGHT = 24,
37
+ BACKGROUND_COMPARISON_ERROR = 25,
38
+ INCORRECT_TEXT_COLOR = 26,
39
+ PHOTO_FALSE_LUMINESCENCE = 27,
40
+ TOO_MUCH_SHIFT = 28,
41
+ FIBERS_NOT_FOUND = 30,
42
+ TOO_MANY_OBJECTS = 31,
43
+ SPECKS_IN_UV = 33,
44
+ TOO_LOW_RESOLUTION = 34,
45
+ INVISIBLE_ELEMENT_PRESENT = 40,
46
+ VISIBLE_ELEMENT_ABSENT = 41,
47
+ ELEMENT_SHOULD_BE_COLORED = 42,
48
+ ELEMENT_SHOULD_BE_GRAYSCALE = 43,
49
+ PHOTO_WHITE_IR_DONT_MATCH = 44,
50
+ UV_DULL_PAPER_MRZ = 50,
51
+ FALSE_LUMINESCENCE_IN_MRZ = 51,
52
+ UV_DULL_PAPER_PHOTO = 52,
53
+ UV_DULL_PAPER_BLANK = 53,
54
+ UV_DULL_PAPER_ERROR = 54,
55
+ FALSE_LUMINESCENCE_IN_BLANK = 55,
56
+ BAD_AREA_IN_AXIAL = 60,
57
+ FALSE_IP_PARAMETERS = 65,
58
+ FIELD_POS_CORRECTOR_HIGHLIGHT_IR = 80,
59
+ OVI_IR_INVISIBLE = 90,
60
+ OVI_INSUFFICIENT_AREA = 91,
61
+ OVI_COLOR_INVARIABLE = 92,
62
+ OVI_BAD_COLOR_FRONT = 93,
63
+ OVI_BAD_COLOR_SIDE = 94,
64
+ OVI_WIDE_COLOR_SPREAD = 95,
65
+ OVI_BAD_COLOR_PERCENT = 96,
66
+ HOLOGRAM_ELEMENT_ABSENT = 100,
67
+ HOLOGRAM_SIDE_TOP_IMAGES_ABSENT = 101,
68
+ HOLOGRAM_ELEMENT_PRESENT = 102,
69
+ PHOTO_PATTERN_INTERRUPTED = 110,
70
+ PHOTO_PATTERN_SHIFTED = 111,
71
+ PHOTO_PATTERN_DIFFERENT_COLORS = 112,
72
+ PHOTO_PATTERN_IR_VISIBLE = 113,
73
+ PHOTO_PATTERN_NOT_INTERSECT = 114,
74
+ PHOTO_SIZE_IS_WRONG = 115,
75
+ PHOTO_PATTERN_INVALID_COLOR = 116,
76
+ PHOTO_PATTERN_SHIFTED_VERT = 117,
77
+ PHOTO_PATTERN_PATTERN_NOT_FOUND = 118,
78
+ PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS = 119,
79
+ PHOTO_IS_NOT_RECTANGLE = 120,
80
+ PHOTO_CORNERS_IS_WRONG = 121,
81
+ TEXT_COLOR_SHOULD_BE_BLUE = 130,
82
+ TEXT_COLOR_SHOULD_BE_GREEN = 131,
83
+ TEXT_COLOR_SHOULD_BE_RED = 132,
84
+ TEXT_SHOULD_BE_BLACK = 133,
85
+ BARCODE_WAS_READ_WITH_ERRORS = 140,
86
+ BARCODE_DATA_FORMAT_ERROR = 141,
87
+ BARCODE_SIZE_PARAMS_ERROR = 142,
88
+ NOT_ALL_BARCODES_READ = 143,
89
+ PORTRAIT_COMPARISON_PORTRAITS_DIFFER = 150,
90
+ PORTRAIT_COMPARISON_NO_SERVICE_REPLY = 151,
91
+ PORTRAIT_COMPARISON_SERVICE_ERROR = 152,
92
+ PORTRAIT_COMPARISON_NOT_ENOUGH_IMAGES = 153,
93
+ PORTRAIT_COMPARISON_NO_LIVE_PHOTO = 154,
94
+ PORTRAIT_COMPARISON_NO_SERVICE_LICENSE = 155,
95
+ PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED = 156,
96
+ LAST_DIAGNOSE_VALUE = 157,
97
+ FIELD_POS_CORRECTOR_PHOTO_REPLACED = 82
98
+ }
@@ -0,0 +1,30 @@
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
+ * 0 - result is negative; 1 - result is positive; 2 - сheck was not performed
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum CheckResult {
18
+ /**
19
+ * Check was performed and result is NEGATIVE
20
+ */
21
+ ERROR = 0,
22
+ /**
23
+ * Check was performed and result is POSITIVE
24
+ */
25
+ OK = 1,
26
+ /**
27
+ * Check was NOT PERFORMED
28
+ */
29
+ WAS_NOT_DONE = 2
30
+ }
@@ -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 { OneCandidate } from './one-candidate';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ChosenDocumentTypeResultAllOf
17
+ */
18
+ export interface ChosenDocumentTypeResultAllOf {
19
+ /**
20
+ *
21
+ * @type {OneCandidate}
22
+ * @memberof ChosenDocumentTypeResultAllOf
23
+ */
24
+ OneCandidate?: OneCandidate;
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 { ChosenDocumentTypeResultAllOf } from './chosen-document-type-result-all-of';
13
+ import { ResultItem } from './result-item';
14
+ /**
15
+ * @type ChosenDocumentTypeResult
16
+ * Contains information about the type of document that was determined based on the analysis of the provided image
17
+ * @export
18
+ */
19
+ export declare type ChosenDocumentTypeResult = ChosenDocumentTypeResultAllOf & ResultItem;
@@ -0,0 +1,74 @@
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 { FDSIDList } from './fdsidlist';
13
+ import { RfidLocation } from './rfid-location';
14
+ /**
15
+ * Contains information about one document type candidate
16
+ * @export
17
+ * @interface ChosenDocumentType
18
+ */
19
+ export interface ChosenDocumentType {
20
+ /**
21
+ * Document name
22
+ * @type {string}
23
+ * @memberof ChosenDocumentType
24
+ */
25
+ DocumentName?: string;
26
+ /**
27
+ * Unique document type template identifier (Regula\'s internal numeric code)
28
+ * @type {number}
29
+ * @memberof ChosenDocumentType
30
+ */
31
+ ID?: number;
32
+ /**
33
+ * A measure of the likelihood of correct recognition in the analysis of this type of document
34
+ * @type {number}
35
+ * @memberof ChosenDocumentType
36
+ */
37
+ P?: number;
38
+ /**
39
+ *
40
+ * @type {RfidLocation}
41
+ * @memberof ChosenDocumentType
42
+ */
43
+ RFID_Presence?: RfidLocation;
44
+ /**
45
+ *
46
+ * @type {FDSIDList}
47
+ * @memberof ChosenDocumentType
48
+ */
49
+ FDSIDList?: FDSIDList;
50
+ /**
51
+ * Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document
52
+ * @type {number}
53
+ * @memberof ChosenDocumentType
54
+ */
55
+ NecessaryLights?: number;
56
+ /**
57
+ * Set of authentication options provided for this type of document (combination of Authenticity enum)
58
+ * @type {number}
59
+ * @memberof ChosenDocumentType
60
+ */
61
+ CheckAuthenticity?: number;
62
+ /**
63
+ * The required exposure value of the camera when receiving images of a document of this type for a UV lighting scheme
64
+ * @type {number}
65
+ * @memberof ChosenDocumentType
66
+ */
67
+ UVExp?: number;
68
+ /**
69
+ * Combination of lighting scheme identifiers (combination of Light enum) needed to perform all authenticity checks specified in CheckAuthenticity
70
+ * @type {number}
71
+ * @memberof ChosenDocumentType
72
+ */
73
+ AuthenticityNecessaryLights?: number;
74
+ }
@@ -0,0 +1,45 @@
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 { AuthenticityResult } from './authenticity-result';
13
+ import { ChosenDocumentTypeResult } from './chosen-document-type-result';
14
+ import { DocBarCodeInfo } from './doc-bar-code-info';
15
+ import { DocumentImageResult } from './document-image-result';
16
+ import { DocumentPositionResult } from './document-position-result';
17
+ import { DocumentTypesCandidatesResult } from './document-types-candidates-result';
18
+ import { EncryptedRCLResult } from './encrypted-rclresult';
19
+ import { GraphicsResult } from './graphics-result';
20
+ import { ImageQualityResult } from './image-quality-result';
21
+ import { ImagesResult } from './images-result';
22
+ import { LexicalAnalysisResult } from './lexical-analysis-result';
23
+ import { LicenseResult } from './license-result';
24
+ import { StatusResult } from './status-result';
25
+ import { TextDataResult } from './text-data-result';
26
+ import { TextResult } from './text-result';
27
+ /**
28
+ * List with various objects, containing processing results
29
+ * @export
30
+ * @interface ContainerList
31
+ */
32
+ export interface ContainerList {
33
+ /**
34
+ * Length of list (Count for items)
35
+ * @type {number}
36
+ * @memberof ContainerList
37
+ */
38
+ Count?: number;
39
+ /**
40
+ *
41
+ * @type {Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>}
42
+ * @memberof ContainerList
43
+ */
44
+ List: Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>;
45
+ }
@@ -0,0 +1,26 @@
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
+ * Enumeration contains identifiers determining the criticality of the security element
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum Critical {
18
+ /**
19
+ * Security element may be absent in a valid document
20
+ */
21
+ NOT_CRITICAL = 0,
22
+ /**
23
+ * Security element must be present in a valid document
24
+ */
25
+ CRITICAL = 1
26
+ }
@@ -0,0 +1,38 @@
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 { Source } from './source';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface CrossSourceValueComparison
18
+ */
19
+ export interface CrossSourceValueComparison {
20
+ /**
21
+ *
22
+ * @type {Source}
23
+ * @memberof CrossSourceValueComparison
24
+ */
25
+ sourceLeft: Source;
26
+ /**
27
+ *
28
+ * @type {Source}
29
+ * @memberof CrossSourceValueComparison
30
+ */
31
+ sourceRight: Source;
32
+ /**
33
+ *
34
+ * @type {CheckResult}
35
+ * @memberof CrossSourceValueComparison
36
+ */
37
+ status: CheckResult;
38
+ }
@@ -0,0 +1,48 @@
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 DataModule
16
+ */
17
+ export interface DataModule {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof DataModule
22
+ */
23
+ mData?: string;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof DataModule
28
+ */
29
+ mLength?: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof DataModule
34
+ */
35
+ mReserved1?: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof DataModule
40
+ */
41
+ mReserver2?: number;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof DataModule
46
+ */
47
+ mType?: number;
48
+ }
@@ -0,0 +1,67 @@
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
+ /**
14
+ *
15
+ * @export
16
+ * @interface DetailsOptical
17
+ */
18
+ export interface DetailsOptical {
19
+ /**
20
+ *
21
+ * @type {CheckResult}
22
+ * @memberof DetailsOptical
23
+ */
24
+ overallStatus: CheckResult;
25
+ /**
26
+ *
27
+ * @type {CheckResult}
28
+ * @memberof DetailsOptical
29
+ */
30
+ docType: CheckResult;
31
+ /**
32
+ *
33
+ * @type {CheckResult}
34
+ * @memberof DetailsOptical
35
+ */
36
+ expiry: CheckResult;
37
+ /**
38
+ *
39
+ * @type {CheckResult}
40
+ * @memberof DetailsOptical
41
+ */
42
+ imageQA: CheckResult;
43
+ /**
44
+ *
45
+ * @type {CheckResult}
46
+ * @memberof DetailsOptical
47
+ */
48
+ mrz: CheckResult;
49
+ /**
50
+ * Number of processed pages in the document
51
+ * @type {number}
52
+ * @memberof DetailsOptical
53
+ */
54
+ pagesCount: number;
55
+ /**
56
+ *
57
+ * @type {CheckResult}
58
+ * @memberof DetailsOptical
59
+ */
60
+ security: CheckResult;
61
+ /**
62
+ *
63
+ * @type {CheckResult}
64
+ * @memberof DetailsOptical
65
+ */
66
+ text: CheckResult;
67
+ }
@@ -0,0 +1,61 @@
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
+ /**
14
+ *
15
+ * @export
16
+ * @interface DetailsRFID
17
+ */
18
+ export interface DetailsRFID {
19
+ /**
20
+ *
21
+ * @type {CheckResult}
22
+ * @memberof DetailsRFID
23
+ */
24
+ overallStatus: CheckResult;
25
+ /**
26
+ *
27
+ * @type {CheckResult}
28
+ * @memberof DetailsRFID
29
+ */
30
+ AA: CheckResult;
31
+ /**
32
+ *
33
+ * @type {CheckResult}
34
+ * @memberof DetailsRFID
35
+ */
36
+ BAC: CheckResult;
37
+ /**
38
+ *
39
+ * @type {CheckResult}
40
+ * @memberof DetailsRFID
41
+ */
42
+ CA: CheckResult;
43
+ /**
44
+ *
45
+ * @type {CheckResult}
46
+ * @memberof DetailsRFID
47
+ */
48
+ PA: CheckResult;
49
+ /**
50
+ *
51
+ * @type {CheckResult}
52
+ * @memberof DetailsRFID
53
+ */
54
+ PACE: CheckResult;
55
+ /**
56
+ *
57
+ * @type {CheckResult}
58
+ * @memberof DetailsRFID
59
+ */
60
+ TA: CheckResult;
61
+ }
@@ -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 DeviceInfo
16
+ */
17
+ export interface DeviceInfo {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof DeviceInfo
22
+ */
23
+ app_name?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof DeviceInfo
28
+ */
29
+ version?: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof DeviceInfo
34
+ */
35
+ license_id?: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof DeviceInfo
40
+ */
41
+ license_serial?: string;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof DeviceInfo
46
+ */
47
+ valid_until?: string;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof DeviceInfo
52
+ */
53
+ server_time?: string;
54
+ }
@@ -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 { PArrayField } from './parray-field';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface DocBarCodeInfoAllOf
17
+ */
18
+ export interface DocBarCodeInfoAllOf {
19
+ /**
20
+ * Count of array fields
21
+ * @type {number}
22
+ * @memberof DocBarCodeInfoAllOf
23
+ */
24
+ nFields?: number;
25
+ /**
26
+ * Data from barcode
27
+ * @type {Array<PArrayField>}
28
+ * @memberof DocBarCodeInfoAllOf
29
+ */
30
+ pArrayFields?: Array<PArrayField>;
31
+ }
@@ -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 { DocBarCodeInfoAllOf } from './doc-bar-code-info-all-of';
13
+ import { ResultItem } from './result-item';
14
+ /**
15
+ * @type DocBarCodeInfo
16
+ * Raw data from BarCodes
17
+ * @export
18
+ */
19
+ export declare type DocBarCodeInfo = DocBarCodeInfoAllOf & ResultItem;