@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
+ * Describes possible extracted result types from documents
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum Result {
18
+ /**
19
+ * Contains cropped and rotated with perspective compensation image of document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most of coordinates in other types defined on that image
20
+ */
21
+ DOCUMENT_IMAGE = 1,
22
+ /**
23
+ * Contains image quality check results
24
+ */
25
+ IMAGE_QUALITY = 30,
26
+ /**
27
+ * Contains check statuses with details, grouped by source
28
+ */
29
+ STATUS = 33,
30
+ /**
31
+ * Contains document textual fields from all sources (mrz, rfid, visual, barcode) with validity and cross-source compare checks
32
+ */
33
+ TEXT = 36,
34
+ /**
35
+ * Contains images from all document sources (mrz, rfid, visual, barcode)
36
+ */
37
+ IMAGES = 37,
38
+ /**
39
+ * Contains MRZ OCR results
40
+ */
41
+ MRZ_TEXT = 3,
42
+ /**
43
+ * Contains Visual zone OCR results
44
+ */
45
+ VISUAL_TEXT = 17,
46
+ /**
47
+ * Contains barcode parsing result with text fields
48
+ */
49
+ BARCODE_TEXT = 18,
50
+ /**
51
+ * Contains RFID parsing result with text fields
52
+ */
53
+ RFID_TEXT = 102,
54
+ /**
55
+ * Contains lexical data analysis results that allow you to compare MRZ OCR results, Visual zone OCR results, barcodes and RFID chip data for an additional assessment of the authenticity of the document (this is an old format, better use TEXT type)
56
+ */
57
+ LEXICAL_ANALYSIS = 15,
58
+ /**
59
+ * Contains cropped graphic fields from Visual zone
60
+ */
61
+ VISUAL_GRAPHICS = 6,
62
+ /**
63
+ * Contains barcode parsing result with graphic fields
64
+ */
65
+ BARCODE_GRAPHICS = 19,
66
+ /**
67
+ * Contains RFID parsing result with graphic fields
68
+ */
69
+ RFID_GRAPHICS = 103,
70
+ /**
71
+ * Contains list of document type candidates with their probabilities and descriptions
72
+ */
73
+ DOCUMENT_TYPE_CANDIDATES = 8,
74
+ /**
75
+ * Contains description of determined document type, if any
76
+ */
77
+ DOCUMENT_TYPE = 9,
78
+ /**
79
+ * Contains result of document authenticity checks
80
+ */
81
+ AUTHENTICITY = 20,
82
+ /**
83
+ * Contains information about document position on the input image, its center, angle, etc
84
+ */
85
+ DOCUMENT_POSITION = 85,
86
+ /**
87
+ * Contains raw information about barcodes on the input image
88
+ */
89
+ BARCODES = 5,
90
+ /**
91
+ * Contains license
92
+ */
93
+ LICENSE = 50,
94
+ /**
95
+ * Contains encrypted ResultContainerList
96
+ */
97
+ ENCRYPTED_RCL = 49
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
+ * Determines the presence and location of an RFID chip in a document. 0 - no rfid chip; 1 - chip is located in the document data page; 2 - chip is located in the back page or inlay of the document
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum RfidLocation {
18
+ /**
19
+ * There is no RFID chip in the document
20
+ */
21
+ NONE = 0,
22
+ /**
23
+ * The RFID chip is located in the document data page
24
+ */
25
+ MAIN_PAGE = 1,
26
+ /**
27
+ * The RFID chip is located in the back page or inlay of the document
28
+ */
29
+ BACK_PAGE = 2
30
+ }
@@ -0,0 +1,42 @@
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
+ * Location of data in RFID chip
14
+ * @export
15
+ * @interface RfidOrigin
16
+ */
17
+ export interface RfidOrigin {
18
+ /**
19
+ * Source data group file
20
+ * @type {number}
21
+ * @memberof RfidOrigin
22
+ */
23
+ dg: number;
24
+ /**
25
+ * Index of the source record of the image with biometric information in the information data group
26
+ * @type {number}
27
+ * @memberof RfidOrigin
28
+ */
29
+ dgTag?: number;
30
+ /**
31
+ * Index of the template in the record with biometric data
32
+ * @type {number}
33
+ * @memberof RfidOrigin
34
+ */
35
+ tagEntry?: number;
36
+ /**
37
+ * Index of the variant of the biometric data template
38
+ * @type {number}
39
+ * @memberof RfidOrigin
40
+ */
41
+ entryView?: number;
42
+ }
@@ -0,0 +1,36 @@
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
+ * Document processing scenario
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum Scenario {
18
+ MRZ = "Mrz",
19
+ BARCODE = "Barcode",
20
+ LOCATE = "Locate",
21
+ OCR = "Ocr",
22
+ DOCTYPE = "DocType",
23
+ MRZ_OR_BARCODE = "MrzOrBarcode",
24
+ MRZ_OR_LOCATE = "MrzOrLocate",
25
+ MRZ_AND_LOCATE = "MrzAndLocate",
26
+ MRZ_OR_OCR = "MrzOrOcr",
27
+ MRZ_OR_BARCODE_OR_OCR = "MrzOrBarcodeOrOcr",
28
+ LOCATE_VISUAL_AND_MRZ_OR_OCR = "LocateVisual_And_MrzOrOcr",
29
+ FULL_PROCESS = "FullProcess",
30
+ FULL_AUTH = "FullAuth",
31
+ ID3RUS = "Id3Rus",
32
+ RUS_STAMP = "RusStamp",
33
+ OCR_FREE = "OcrFree",
34
+ CREDIT_CARD = "CreditCard",
35
+ CAPTURE = "Capture"
36
+ }
@@ -0,0 +1,59 @@
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 { Critical } from './critical';
14
+ import { RectangleCoordinates } from './rectangle-coordinates';
15
+ import { SecurityFeatureType } from './security-feature-type';
16
+ import { Visibility } from './visibility';
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface SecurityFeatureResultAllOf
21
+ */
22
+ export interface SecurityFeatureResultAllOf {
23
+ /**
24
+ *
25
+ * @type {SecurityFeatureType}
26
+ * @memberof SecurityFeatureResultAllOf
27
+ */
28
+ ElementType?: SecurityFeatureType;
29
+ /**
30
+ *
31
+ * @type {RectangleCoordinates}
32
+ * @memberof SecurityFeatureResultAllOf
33
+ */
34
+ ElementRect?: RectangleCoordinates;
35
+ /**
36
+ *
37
+ * @type {Visibility}
38
+ * @memberof SecurityFeatureResultAllOf
39
+ */
40
+ Visibility?: Visibility;
41
+ /**
42
+ *
43
+ * @type {Critical}
44
+ * @memberof SecurityFeatureResultAllOf
45
+ */
46
+ CriticalFlag?: Critical;
47
+ /**
48
+ *
49
+ * @type {AreaContainer}
50
+ * @memberof SecurityFeatureResultAllOf
51
+ */
52
+ AreaList?: AreaContainer;
53
+ /**
54
+ *
55
+ * @type {number}
56
+ * @memberof SecurityFeatureResultAllOf
57
+ */
58
+ Reserved2?: number;
59
+ }
@@ -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 { SecurityFeatureResultAllOf } from './security-feature-result-all-of';
14
+ /**
15
+ * @type SecurityFeatureResult
16
+ * @export
17
+ */
18
+ export declare type SecurityFeatureResult = AuthenticityCheckResultItem & SecurityFeatureResultAllOf;
@@ -0,0 +1,49 @@
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 type of features for a document authenticity checks
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum SecurityFeatureType {
18
+ BLANK = 0,
19
+ FILL = 1,
20
+ PHOTO = 2,
21
+ MRZ = 3,
22
+ FALSE_LUMINESCENCE = 4,
23
+ HOLO_SIMPLE = 5,
24
+ HOLO_VERIFY_STATIC = 6,
25
+ HOLO_VERIFY_MULTI_STATIC = 7,
26
+ HOLO_VERIFY_DYNAMIC = 8,
27
+ PATTERN_NOT_INTERRUPTED = 9,
28
+ PATTERN_NOT_SHIFTED = 10,
29
+ PATTERN_SAME_COLORS = 11,
30
+ PATTERN_IR_INVISIBLE = 12,
31
+ PHOTO_SIZE_CHECK = 13,
32
+ PORTRAIT_COMPARISON_VS_GHOST = 14,
33
+ PORTRAIT_COMPARISON_VS_RFID = 15,
34
+ PORTRAIT_COMPARISON_VS_VISUAL = 16,
35
+ BARCODE = 17,
36
+ PATTERN_DIFFERENT_LINES_THICKNESS = 18,
37
+ PORTRAIT_COMPARISON_VS_CAMERA = 19,
38
+ PORTRAIT_COMPARISON_RFID_VS_CAMERA = 20,
39
+ GHOST_PHOTO = 21,
40
+ CLEAR_GHOST_PHOTO = 22,
41
+ INVISIBLE_OBJECT = 23,
42
+ LOW_CONTRAST_OBJECT = 24,
43
+ PHOTO_COLOR = 25,
44
+ PHOTO_SHAPE = 26,
45
+ PHOTO_CORNERS = 27,
46
+ PORTRAIT_COMPARISON_EXT_VS_VISUAL = 29,
47
+ PORTRAIT_COMPARISON_EXT_VS_RFID = 30,
48
+ PORTRAIT_COMPARISON_EXT_VS_CAMERA = 31
49
+ }
@@ -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 { Source } from './source';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface SourceValidity
18
+ */
19
+ export interface SourceValidity {
20
+ /**
21
+ *
22
+ * @type {Source}
23
+ * @memberof SourceValidity
24
+ */
25
+ source: Source;
26
+ /**
27
+ *
28
+ * @type {CheckResult}
29
+ * @memberof SourceValidity
30
+ */
31
+ status: CheckResult;
32
+ }
@@ -0,0 +1,23 @@
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
+ * Document data sources
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum Source {
18
+ MRZ = "MRZ",
19
+ VISUAL = "VISUAL",
20
+ BARCODE = "BARCODE",
21
+ RFID = "RFID",
22
+ MAGNETIC = "MAGNETIC"
23
+ }
@@ -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 { Status } from './status';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface StatusResultAllOf
17
+ */
18
+ export interface StatusResultAllOf {
19
+ /**
20
+ *
21
+ * @type {Status}
22
+ * @memberof StatusResultAllOf
23
+ */
24
+ Status: Status;
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 { ResultItem } from './result-item';
13
+ import { StatusResultAllOf } from './status-result-all-of';
14
+ /**
15
+ * @type StatusResult
16
+ * @export
17
+ */
18
+ export declare type StatusResult = ResultItem & StatusResultAllOf;
@@ -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 { CheckResult } from './check-result';
13
+ import { DetailsOptical } from './details-optical';
14
+ import { DetailsRFID } from './details-rfid';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface Status
19
+ */
20
+ export interface Status {
21
+ /**
22
+ *
23
+ * @type {CheckResult}
24
+ * @memberof Status
25
+ */
26
+ overallStatus: CheckResult;
27
+ /**
28
+ *
29
+ * @type {CheckResult}
30
+ * @memberof Status
31
+ */
32
+ optical: CheckResult;
33
+ /**
34
+ *
35
+ * @type {CheckResult}
36
+ * @memberof Status
37
+ */
38
+ portrait?: CheckResult;
39
+ /**
40
+ *
41
+ * @type {CheckResult}
42
+ * @memberof Status
43
+ */
44
+ rfid?: CheckResult;
45
+ /**
46
+ *
47
+ * @type {CheckResult}
48
+ * @memberof Status
49
+ */
50
+ stopList?: CheckResult;
51
+ /**
52
+ *
53
+ * @type {DetailsRFID}
54
+ * @memberof Status
55
+ */
56
+ detailsRFID?: DetailsRFID;
57
+ /**
58
+ *
59
+ * @type {DetailsOptical}
60
+ * @memberof Status
61
+ */
62
+ detailsOptical: DetailsOptical;
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 { SymbolRecognitionResult } from './symbol-recognition-result';
13
+ /**
14
+ * Describes single row recognition results in multi-line text field of a document
15
+ * @export
16
+ * @interface StringRecognitionResult
17
+ */
18
+ export interface StringRecognitionResult {
19
+ /**
20
+ * Array of recognition results for individual characters of a string
21
+ * @type {Array<SymbolRecognitionResult>}
22
+ * @memberof StringRecognitionResult
23
+ */
24
+ StringResult: Array<SymbolRecognitionResult>;
25
+ }
@@ -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
+ * Describes an individual character recognition candidate
14
+ * @export
15
+ * @interface SymbolCandidate
16
+ */
17
+ export interface SymbolCandidate {
18
+ /**
19
+ * Unicode symbol code
20
+ * @type {number}
21
+ * @memberof SymbolCandidate
22
+ */
23
+ SymbolCode: number;
24
+ /**
25
+ * character recognition probability (0–100,%)
26
+ * @type {number}
27
+ * @memberof SymbolCandidate
28
+ */
29
+ SymbolProbability: number;
30
+ }
@@ -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 { RectangleCoordinates } from './rectangle-coordinates';
13
+ import { SymbolCandidate } from './symbol-candidate';
14
+ /**
15
+ * Describes a single character recognition results in the text field line
16
+ * @export
17
+ * @interface SymbolRecognitionResult
18
+ */
19
+ export interface SymbolRecognitionResult {
20
+ /**
21
+ *
22
+ * @type {RectangleCoordinates}
23
+ * @memberof SymbolRecognitionResult
24
+ */
25
+ SymbolRect: RectangleCoordinates;
26
+ /**
27
+ * Array of candidate characters. Sorted in descending order of recognition probabilities (the first element has highest probability)
28
+ * @type {Array<SymbolCandidate>}
29
+ * @memberof SymbolRecognitionResult
30
+ */
31
+ ListOfCandidates: Array<SymbolCandidate>;
32
+ }
@@ -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 TextAvailableSource
18
+ */
19
+ export interface TextAvailableSource {
20
+ /**
21
+ *
22
+ * @type {Source}
23
+ * @memberof TextAvailableSource
24
+ */
25
+ source: Source;
26
+ /**
27
+ *
28
+ * @type {CheckResult}
29
+ * @memberof TextAvailableSource
30
+ */
31
+ validityStatus: CheckResult;
32
+ /**
33
+ * Same as Result type, but used for safe parsing of not-described values. See Result type.
34
+ * @type {number}
35
+ * @memberof TextAvailableSource
36
+ */
37
+ containerType?: number;
38
+ }
@@ -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 { DocVisualExtendedInfo } from './doc-visual-extended-info';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface TextDataResultAllOf
17
+ */
18
+ export interface TextDataResultAllOf {
19
+ /**
20
+ *
21
+ * @type {DocVisualExtendedInfo}
22
+ * @memberof TextDataResultAllOf
23
+ */
24
+ DocVisualExtendedInfo?: DocVisualExtendedInfo;
25
+ }