Merge pull request #101 from regulaforensics/6.8

Release 6.8
regulaforensics · May 23, 2023 · 65db1c7 · 65db1c7
2 parents b31a973 + 29afe0f
commit 65db1c7
Show file tree

Hide file tree

Showing 36 changed files with 2,588 additions and 1,604 deletions.
diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml
@@ -1,10 +1,9 @@
 openapi: 3.0.3
 components:
   schemas:
-
     CheckDiagnose:
-      description: "Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/"
       type: integer
+      description: "Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/"
       enum:
         - 0
         - 1
@@ -47,6 +46,11 @@ components:
         - 60
         - 65
         - 80
+        - 81
+        - 82
+        - 83
+        - 84
+        - 85
         - 90
         - 91
         - 92
@@ -57,6 +61,8 @@ components:
         - 100
         - 101
         - 102
+        - 103
+        - 104
         - 110
         - 111
         - 112
@@ -69,6 +75,7 @@ components:
         - 119
         - 120
         - 121
+        - 122
         - 130
         - 131
         - 132
@@ -84,24 +91,6 @@ components:
         - 154
         - 155
         - 156
-        - 82
-        - 191
-        - 192
-        - 83
-        - 84
-        - 85
-        - 200
-        - 201
-        - 202
-        - 203
-        - 204
-        - 220
-        - 221
-        - 222
-        - 81
-        - 103
-        - 104
-        - 122
         - 160
         - 161
         - 170
@@ -114,8 +103,18 @@ components:
         - 186
         - 187
         - 190
+        - 200
+        - 201
+        - 202
+        - 203
+        - 204
+        - 205
+        - 220
+        - 221
+        - 222
         - 230
         - 240
+        - 250
       x-enum-varnames:
         - "UNKNOWN"
         - "PASS"
@@ -158,6 +157,11 @@ components:
         - "BAD_AREA_IN_AXIAL"
         - "FALSE_IP_PARAMETERS"
         - "FIELD_POS_CORRECTOR_HIGHLIGHT_IR"
+        - "FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA"
+        - "FIELD_POS_CORRECTOR_PHOTO_REPLACED"
+        - "FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR"
+        - "FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR"
+        - "FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR"
         - "OVI_IR_INVISIBLE"
         - "OVI_INSUFFICIENT_AREA"
         - "OVI_COLOR_INVARIABLE"
@@ -168,6 +172,8 @@ components:
         - "HOLOGRAM_ELEMENT_ABSENT"
         - "HOLOGRAM_SIDE_TOP_IMAGES_ABSENT"
         - "HOLOGRAM_ELEMENT_PRESENT"
+        - "HOLOGRAM_FRAMES_IS_ABSENT"
+        - "HOLOGRAM_HOLO_FIELD_IS_ABSENT"
         - "PHOTO_PATTERN_INTERRUPTED"
         - "PHOTO_PATTERN_SHIFTED"
         - "PHOTO_PATTERN_DIFFERENT_COLORS"
@@ -180,6 +186,7 @@ components:
         - "PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS"
         - "PHOTO_IS_NOT_RECTANGLE"
         - "PHOTO_CORNERS_IS_WRONG"
+        - "DOCUMENT_IS_CANCELLING"
         - "TEXT_COLOR_SHOULD_BE_BLUE"
         - "TEXT_COLOR_SHOULD_BE_GREEN"
         - "TEXT_COLOR_SHOULD_BE_RED"
@@ -195,24 +202,6 @@ components:
         - "PORTRAIT_COMPARISON_NO_LIVE_PHOTO"
         - "PORTRAIT_COMPARISON_NO_SERVICE_LICENSE"
         - "PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED"
-        - "FIELD_POS_CORRECTOR_PHOTO_REPLACED"
-        - "SCREEN_CAPTURE_DETECTED"
-        - "ELECTRONIC_DEVICE_DETECTED"
-        - "FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR"
-        - "FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR"
-        - "FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR"
-        - "WRONG_SYMBOL_BACKGROUND"
-        - "WRONG_BACKGROUND"
-        - "WRONG_MRZ_WIDTH"
-        - "WRONG_MRZ_HEIGHT"
-        - "WRONG_LINE_POSITION"
-        - "TEXT_POSITION"
-        - "INVALID_FONT"
-        - "INVALID_BACKGROUND"
-        - "FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA"
-        - "HOLOGRAM_FRAMES_IS_ABSENT"
-        - "HOLOGRAM_HOLO_FIELD_IS_ABSENT"
-        - "DOCUMENT_IS_CANCELLING"
         - "MOBILE_IMAGES_UNSUITABLE_LIGHT_CONDITIONS"
         - "MOBILE_IMAGES_WHITE_UV_NO_DIFFERENCE"
         - "FINGERPRINTS_COMPARISON_MISMATCH"
@@ -225,5 +214,15 @@ components:
         - "HOLO_PHOTO_FINISHED_BY_TIMEOUT"
         - "HOLO_PHOTO_DOCUMENT_OUTSIDE_FRAME"
         - "LIVENESS_DEPTH_CHECK_FAILED"
-        - "LAS_INK_INVALID_LINES_FREQUENCY"
-        - "LAST_DIAGNOSE_VALUE"
+        - "MRZ_QUALITY_WRONG_SYMBOL_POSITION"
+        - "MRZ_QUALITY_WRONG_BACKGROUND"
+        - "MRZ_QUALITY_WRONG_MRZ_WIDTH"
+        - "MRZ_QUALITY_WRONG_MRZ_HEIGHT"
+        - "MRZ_QUALITY_WRONG_LINE_POSITION"
+        - "MRZ_QUALITY_WRONG_FONT_TYPE"
+        - "OCR_QUALITY_TEXT_POSITION"
+        - "OCR_QUALITY_INVALID_FONT"
+        - "OCR_QUALITY_INVALID_BACKGROUND"
+        - "LASINK_INVALID_LINES_FREQUENCY"
+        - "DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED"
+        - "LAST_DIAGNOSE_VALUE"
diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml
@@ -1,10 +1,9 @@
 openapi: 3.0.3
 components:
   schemas:
-
     Critical:
-      description: "Enumeration contains identifiers determining the criticality of the security element"
       type: integer
+      description: "Enumeration contains identifiers determining the criticality of the security element"
       enum:
         - 0
         - 1
@@ -13,4 +12,4 @@ components:
         - "Security element must be present in a valid document"
       x-enum-varnames:
         - "NOT_CRITICAL"
-        - "CRITICAL"
+        - "CRITICAL"
diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml
@@ -1,10 +1,9 @@
 openapi: 3.0.3
 components:
   schemas:
-
     AuthenticityResultType:
-      description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/."
       type: integer
+      description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/."
       enum:
         - 1
         - 2
@@ -15,6 +14,7 @@ components:
         - 64
         - 128
         - 512
+        - 1024
         - 4096
         - 8192
         - 32768
@@ -36,6 +36,7 @@ components:
         - "OCR for the text field in UV light comparison with other text sources check"
         - "Invisible Personal Information (IPI) visualization"
         - "Owner's photo embedding check (is photo printed or sticked)"
+        - "OVI check"
         - "Hologram presence check"
         - "Owner's photo area advanced check (photo shape, size, position, etc.)"
         - "Portrait comparison check (document printed vs chip vs live)"
@@ -46,7 +47,7 @@ components:
         - "Fingerprint comparison check"
         - "Document liveness check"
         - "Extended OCR Check"
-        - "MRZ extended check"
+        - "Extended MRZ check"
       x-enum-varnames:
         - "UV_LUMINESCENCE"
         - "IR_B900"
@@ -58,6 +59,7 @@ components:
         - "IPI"
         - "PHOTO_EMBED_TYPE"
         - "HOLOGRAMS"
+        - "OVI"
         - "PHOTO_AREA"
         - "PORTRAIT_COMPARISON"
         - "BARCODE_FORMAT_CHECK"
@@ -67,4 +69,4 @@ components:
         - "FINGERPRINT_COMPARISON"
         - "LIVENESS"
         - "EXTENDED_OCR_CHECK"
-        - "MRZ"
+        - "EXTENDED_MRZ_CHECK"
diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml
@@ -1,10 +1,9 @@
 openapi: 3.0.3
 components:
   schemas:
-
     Visibility:
-      description: "Enumeration contains visibility status of the security element"
       type: integer
+      description: "Enumeration contains visibility status of the security element"
       enum:
         - 0
         - 1
@@ -22,4 +21,4 @@ components:
         - "VISIBLE"
         - "COLORED"
         - "GRAYSCALE"
-        - "WHITE_IR_MATCHING"
+        - "WHITE_IR_MATCHING"
diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml
@@ -5,7 +5,7 @@ components:
     FiberResult:
       title: "Fibers Check"
       allOf:
-        - $ref: '../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem'
+        - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem"
         - type: object
           properties:
             RectCount:
@@ -16,15 +16,15 @@ components:
               type: integer
             LightValue:
               description: "For UV_Background authentication result type"
-              $ref: '../common.yml#/components/schemas/Light'
+              $ref: "../common.yml#/components/schemas/Light"
             LightDisp:
               description: "For UV_Background authentication result type"
               type: integer
             RectArray:
               description: "Coordinates of located areas for defined fibers type"
               type: array
               items:
-                $ref: '../common.yml#/components/schemas/RectangleCoordinates'
+                $ref: "../common.yml#/components/schemas/RectangleCoordinates"
             Width:
               description: "Fibers width value for located areas (in pixels)"
               type: array

diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml
@@ -5,23 +5,23 @@ components:
     IdentResult:
       title: "Ident Check"
       allOf:
-        - $ref: '../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem'
+        - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem"
         - type: object
           properties:
             ElementType:
-              $ref: '../e-security-feature-type.yml#/components/schemas/SecurityFeatureType'
+              $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType"
             LightIndex:
-              $ref: '../common.yml#/components/schemas/Light'
+              $ref: "../common.yml#/components/schemas/Light"
             Area:
-              $ref: '../common.yml#/components/schemas/RectangleCoordinates'
+              $ref: "../common.yml#/components/schemas/RectangleCoordinates"
             Image:
               description: "Original image"
-              $ref: '../common.yml#/components/schemas/ImageData'
+              $ref: "../common.yml#/components/schemas/ImageData"
             EtalonImage:
               description: "Reference image"
-              $ref: '../common.yml#/components/schemas/ImageData'
+              $ref: "../common.yml#/components/schemas/ImageData"
             PercentValue:
               description: "Probability percent for IMAGE_PATTERN check or element's visibility for IR_VISIBILITY"
               type: integer
             AreaList:
-              $ref: '../rt-authenticity.yml#/components/schemas/AreaContainer'
+              $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer"
diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml
@@ -5,15 +5,15 @@ components:
     OCRSecurityTextResult:
       title: "OCR Security Text Check"
       allOf:
-        - $ref: '../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem'
+        - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem"
         - type: object
           properties:
             CriticalFlag:
-              $ref: './e-critical.yml#/components/schemas/Critical'
+              $ref: "./e-critical.yml#/components/schemas/Critical"
             LightType:
-              $ref: '../common.yml#/components/schemas/Light'
+              $ref: "../common.yml#/components/schemas/Light"
             FieldRect:
-              $ref: '../common.yml#/components/schemas/RectangleCoordinates'
+              $ref: "../common.yml#/components/schemas/RectangleCoordinates"
             EtalonResultType:
               type: integer
             EtalonFieldType:

diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml
@@ -5,17 +5,17 @@ components:
     PhotoIdentResult:
       title: "Photo Ident Check"
       allOf:
-        - $ref: '../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem'
+        - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem"
         - type: object
           properties:
             LightIndex:
-              $ref: '../common.yml#/components/schemas/Light'
+              $ref: "../common.yml#/components/schemas/Light"
             Area:
-              $ref: '../common.yml#/components/schemas/RectangleCoordinates'
+              $ref: "../common.yml#/components/schemas/RectangleCoordinates"
             SourceImage:
-              $ref: '../common.yml#/components/schemas/ImageData'
+              $ref: "../common.yml#/components/schemas/ImageData"
             ResultImages:
-              $ref: '#/components/schemas/RawImageContainerList'
+              $ref: "#/components/schemas/RawImageContainerList"
             FieldTypesCount:
               type: integer
             FieldTypesList:
@@ -37,4 +37,4 @@ components:
         Images:
           type: array
           items:
-            $ref: '../common.yml#/components/schemas/ImageData'
+            $ref: "../common.yml#/components/schemas/ImageData"
diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml
@@ -5,18 +5,18 @@ components:
     SecurityFeatureResult:
       title: "Security Feature Check"
       allOf:
-        - $ref: '../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem'
+        - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem"
         - type: object
           properties:
             ElementType:
-              $ref: '../e-security-feature-type.yml#/components/schemas/SecurityFeatureType'
+              $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType"
             ElementRect:
-              $ref: '../common.yml#/components/schemas/RectangleCoordinates'
+              $ref: "../common.yml#/components/schemas/RectangleCoordinates"
             Visibility:
-              $ref: './e-visibility.yml#/components/schemas/Visibility'
+              $ref: "./e-visibility.yml#/components/schemas/Visibility"
             CriticalFlag:
-              $ref: './e-critical.yml#/components/schemas/Critical'
+              $ref: "./e-critical.yml#/components/schemas/Critical"
             AreaList:
-              $ref: '../rt-authenticity.yml#/components/schemas/AreaContainer'
+              $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer"
             Reserved2:
               type: integer