Release 6.9 (#125)

* [SP-10893] New enum values (#124) * Update e-check-diagnose.yml * Update e-security-feature-type.yml * Update e-text-field-type.yml * Added BarcodeType enum * [SP-9874] add doDetectCan to processParams (#119) * add doDetectCan to processParams * Update p-process.yml * Update p-process.yml --------- Co-authored-by: Vladislav Yakimchik <[email protected]> Co-authored-by: Ihar Kliashchou <[email protected]> * [SP-10868] Add live portrait field (#123) * add live portrait field * extPortrait & faceApi * remove json sample * add oneShotIdentification and update descriptions * Update * update faceApi model * Update p-process.yml * Update * Added examples * Update * Update common.yml * update search --------- Co-authored-by: Vladislav Yakimchik <[email protected]> Co-authored-by: Vladislav Yakimchik <[email protected]> * [SP-10234] update enums descriptions (#121) * update enums * update Source descriptions * add descriptions to parsing error codes & notification codes * update description in RFIDErrorCodes * update Scenario * update DocumentType description * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml --------- Co-authored-by: Vladislav Yakimchik <[email protected]> Co-authored-by: Vladislav Yakimchik <[email protected]> * Update common.yml * [SP-10198] update TextFieldType (#116) * update textfieldtype * Update e-text-field-type.yml * update TextFieldType * Update e-text-field-type.yml * Update e-text-field-type.yml * Update e-text-field-type.yml * Update e-text-field-type.yml * Updated DL codes * Updated constants * Updated values * Updated values * Updated values * Update e-text-field-type.yml * Update e-text-field-type.yml --------- Co-authored-by: Vladislav Yakimchik <[email protected]> Co-authored-by: Vladislav Yakimchik <[email protected]> --------- Co-authored-by: Danila Kislitsyn <[email protected]> Co-authored-by: Ihar Kliashchou <[email protected]>
regulaforensics · Aug 31, 2023 · b4fbee0 · b4fbee0
1 parent 10dd7a5
commit b4fbee0
Show file tree

Hide file tree

Showing 11 changed files with 1,370 additions and 457 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@ document-reader-api-doc.html
 /openapi.json
 document-reader-static-doc.html
 *.DS_Store
+*.txt
+*.strings
+*.json
diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml
@@ -84,6 +84,7 @@ components:
         - 141
         - 142
         - 143
+        - 144
         - 150
         - 151
         - 152
@@ -114,6 +115,7 @@ components:
         - 222
         - 230
         - 240
+        - 241
         - 250
       x-enum-varnames:
         - "UNKNOWN"
@@ -195,6 +197,7 @@ components:
         - "BARCODE_DATA_FORMAT_ERROR"
         - "BARCODE_SIZE_PARAMS_ERROR"
         - "NOT_ALL_BARCODES_READ"
+        - "GLARES_IN_BARCODE_AREA"
         - "PORTRAIT_COMPARISON_PORTRAITS_DIFFER"
         - "PORTRAIT_COMPARISON_NO_SERVICE_REPLY"
         - "PORTRAIT_COMPARISON_SERVICE_ERROR"
@@ -225,4 +228,5 @@ components:
         - "OCR_QUALITY_INVALID_BACKGROUND"
         - "LASINK_INVALID_LINES_FREQUENCY"
         - "DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED"
+        - "DOC_LIVENESS_INVALID_BARCODE_BACKGROUND"
         - "LAST_DIAGNOSE_VALUE"
diff --git a/common.yml b/common.yml
@@ -29,6 +29,12 @@ components:
         - "BARCODE"
         - "RFID"
         - "MAGNETIC"
+      x-enum-descriptions:
+        - "Machine readable zone (MRZ)"
+        - "Visual zone"
+        - "Barcode"
+        - "RFID"
+        - "Magnetic"
 
     CheckResult:
       type: integer
@@ -65,7 +71,6 @@ components:
         - "LocateVisual_And_MrzOrOcr"
         - "FullProcess"
         - "FullAuth"
-        - "Id3Rus"
         - "RusStamp"
         - "OcrFree"
         - "CreditCard"
@@ -85,11 +90,29 @@ components:
         - "LOCATE_VISUAL_AND_MRZ_OR_OCR"
         - "FULL_PROCESS"
         - "FULL_AUTH"
-        - "ID3RUS"
         - "RUS_STAMP"
         - "OCR_FREE"
         - "CREDIT_CARD"
         - "CAPTURE"
+      x-enum-descriptions:
+        - "Processing scenario for obtaining MRZ data"
+        - "Processing scenario for obtaining barcode data"
+        - "Processing scenario for detecting document boundaries"
+        - "Processing scenario for obtaining visual zone OCR results"
+        - "Processing scenario for document type recognition"
+        - "Processing scenario for obtaining MRZ and/or barcode data"
+        - "Processing scenario for detecting document boundaries and/or obtaining MRZ data"
+        - "Processing scenario for detecting document boundaries and obtaining MRZ data"
+        - "Processing scenario for detecting the document boundaries and obtaining barcode data"
+        - "Processing scenario for obtaining MRZ data or visual zone OCR results"
+        - "Processing scenario for obtaining MRZ or barcode or visual zone OCR results"
+        - "Processing scenario for detecting document boundaries and obtaining MRZ data or visual zone OCR results"
+        - "Processing scenario for obtaining all document data"
+        - "Processing scenario for obtaining all document data and document authentication"
+        - "Processing scenario for obtaining data from registration stamps"
+        - "Processing scenario for obtaining OCR results of any image"
+        - "Processing scenario for obtaining bank card data"
+        - "Scenario for obtaining an original image without any processing"
 
     ImageData:
       type: object
@@ -196,3 +219,50 @@ components:
       type: string
       format: byte
       example: "Base64 encoded data"
+
+    FaceApi:
+      type: object
+      properties:
+        url:
+          type: string
+          example: "https://faceapi.regulaforensics.com"
+          description: "The URL of the Regula Face Web service to be used."
+        mode:
+          type: string
+          example: "match"
+          description: "The processing mode: \"match\" or \"match+search\"."
+        search:
+          type: object
+          description: "A search filter that can be applied if the \"match+search\" mode is enabled. May include limit, threshold, group_ids. If the group_ids are specified, the search is performed only in these groups. Find more information in the <a href=\"https://dev.regulaforensics.com/FaceSDK-web-openapi/#tag/search/operation/search\" target=\"_blank\">OpenAPI documentation</a>."
+          properties:
+            limit:
+              type: integer
+              description: "The maximum number of results to be returned."
+            threshold:
+              type: float
+              description: "The similarity threshold."
+            group_ids:
+              type: array
+              items:
+                type: integer
+              description: " The groups where to conduct the search."
+        threshold:
+          type: integer
+          example: 75
+          description: "The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not."
+        serviceTimeout:
+          type: integer
+          example: 3000
+          description: "The Regula Face Web service requests timeout, ms."
+        proxy:
+          type: string
+          example: "http://localhost:8080"
+          description: "Proxy to use, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXY.html\" target=\"_blank\">cURL standard</a>."
+        proxy_userpwd:
+          type: string
+          example: "user:pass"
+          description: "Username and password to use for proxy authentication, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXYUSERPWD.html\" target=\"_blank\">cURL standard</a>."
+        proxy_type:
+          type: integer
+          example: 0
+          description: "Proxy protocol type, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXYTYPE.html\" target=\"_blank\">cURL standard</a>."
diff --git a/e-barcode-type.yml b/e-barcode-type.yml
@@ -0,0 +1,69 @@
+openapi: 3.0.3
+components:
+  schemas:
+    BarcodeType:
+      type: integer
+      description: "Enumeration contains the types of barcodes that can be processed"
+      enum:
+        - 0
+        - 1
+        - 2
+        - 3
+        - 4
+        - 5
+        - 6
+        - 7
+        - 8
+        - 9
+        - 10
+        - 11
+        - 12
+        - 13
+        - 14
+        - 15
+        - 16
+        - 17
+        - 18
+        - 19
+      x-enum-varnames:
+        - "UNKNOWN"
+        - "CODE128"
+        - "CODE39"
+        - "EAN8"
+        - "ITF"
+        - "PDF417"
+        - "STF"
+        - "MTF"
+        - "IATA"
+        - "CODABAR"
+        - "UPCA"
+        - "CODE93"
+        - "UPCE"
+        - "EAN13"
+        - "QRCODE"
+        - "AZTEC"
+        - "DATAMATRIX"
+        - "ALL_1D"
+        - "CODE11"
+        - "JABCODE"
+      x-enum-descriptions:
+        - "Unknown"
+        - "Code 128"
+        - "Code 39"
+        - "EAN-8"
+        - "ITF"
+        - "PDF417"
+        - "STF"
+        - "MTF"
+        - "IATA"
+        - "Codabar"
+        - "UPC-A"
+        - "Code 93"
+        - "UPC-E"
+        - "EAN-13"
+        - "QR code"
+        - "Aztec code"
+        - "Datamatrix"
+        - "All 1D barcodes"
+        - "Code 11"
+        - "JAB code"