Develop -> Stable

detect.yml

@@ -51,6 +51,12 @@ components:
           $ref: "./common.yml#/components/schemas/ProcessParam"
         image:
           $ref: "./common.yml#/components/schemas/ImageData"
+        tenant:
+          type: string
+          description: "A label used to group transactions by customers, applications, or other criteria."
+        env:
+          type: string
+          description: "A label used to differentiate transactions by development stages."
 
     DetectResponse:
       allOf:
@@ -128,11 +134,9 @@ components:
               type: array
               description: "Attributes assessment details. Returns `DetectDetailsMeta` or `DetectAttributesDetails`."
               items:
-                items:
-                  anyOf:
-                    - $ref: '#/components/schemas/DetectAttributesDetails'
-                    - $ref: '#/components/schemas/DetectDetailsMeta'
-
+                anyOf:
+                  - $ref: '#/components/schemas/DetectAttributesDetails'
+                  - $ref: '#/components/schemas/DetectDetailsMeta'
             elapsedTime:
               type: number
               description: "Server processing time for attribute detection, ms."

identification.yml

@@ -185,6 +185,12 @@ components:
         limit:
           type: integer
           description: "The maximum number of results to be returned."
+        tenant:
+          type: string
+          description: "A label used to group transactions by customers, applications, or other criteria."
+        env:
+          type: string
+          description: "A label used to differentiate transactions by development stages."
 
     ResizeOptions:
       type: object

index.yml

@@ -1,6 +1,6 @@
 openapi: 3.0.3
 info:
-  version: 7.1.0
+  version: 7.2.0
   title: Regula Face SDK Web API
   x-logo:
     url: 'https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg'

match.yml

@@ -54,11 +54,17 @@ components:
           description: "Session identificator, should be unique for each session."
         images: 
           type: array
-          description: "All images included in the comparison."
+          description: "An array of images to be processed. At least two images must be provided."
           items:
             $ref: "#/components/schemas/MatchImage"
         outputImageParams:
           $ref: "./common.yml#/components/schemas/ProcessParam/properties/outputImageParams"
+        tenant:
+          type: string
+          description: "A label used to group transactions by customers, applications, or other criteria."
+        env:
+          type: string
+          description: "A label used to differentiate transactions by development stages."
 
     MatchImageIndex:
       type: integer

match_and_search.yml

@@ -7,7 +7,7 @@ paths:
       tags:
         - match
       summary: 'match and search (1:1 + 1:N)'
-      description: "To compare several images from a document and look up a person in the database in one request, use POST `/api/match_and_search`. In this case, the calculation of the descriptor will be performed only once, as opposed to using two requests for the same operation. If only one person is identified, match is not performed and only search is carried out."
+      description: "To compare several images from a document and look up a person in the database in one request, use POST `/api/match_and_search`. In this case, the calculation of the descriptor will be performed only once, as opposed to using two requests for the same operation. At least two photos are required. If, after processing two or more photos, only one face is detected across them, the match step is skipped, and only the search is carried out."
       operationId: match_and_search
       requestBody:
         required: true
@@ -27,28 +27,42 @@ paths:
 components:
   schemas:
     MatchAndSearchRequest:
-      allOf:
-        - type: object
-          properties:
-            tag:
-              type: string
-              description: "Session identificator, should be unique for each session."
-            images:
-              type: array
-              description: "Person's images."
-              items:
-                type: object
-                properties:
-                  content:
-                    $ref: './common.yml#/components/schemas/ImageData'
-                  type:
-                    $ref: './match.yml#/components/schemas/ImageSource'
-            groupIds:
-              type: array
-              description: "IDs of the groups in which the search is performed."
-              items:
+      type: object
+      properties:
+        tag:
+          type: string
+          description: "Session identificator, should be unique for each session."
+        images:
+          type: array
+          description: "An array of images to be processed. At least two images must be provided."
+          items:
+            type: object
+            properties:
+              content:
+                $ref: './common.yml#/components/schemas/ImageData'
+              imageUrl:
+                description: "Image URL."
                 type: string
-                format: uuid
+              type:
+                $ref: './match.yml#/components/schemas/ImageSource'
+        groupIds:
+          type: array
+          description: "IDs of the groups in which the search is performed."
+          items:
+            type: string
+            format: uuid
+        threshold:
+          description: "The similarity threshold."
+          type: number
+        limit:
+          description: "The maximum number of results to be returned."
+          type: integer
+        tenant:
+          type: string
+          description: "A label used to group transactions by customers, applications, or other criteria."
+        env:
+          type: string
+          description: "A label used to differentiate transactions by development stages."
 
     MatchAndSearchResponse:
       allOf:

search.yml

@@ -43,6 +43,14 @@ definitions:
     allOf:
       - $ref: "#/definitions/SearchParameters"
       - $ref: "./identification.yml#/components/schemas/ImageFields"
+      - type: object
+        properties:
+          tenant:
+            type: string
+            description: "A label used to group transactions by customers, applications, or other criteria."
+          env:
+            type: string
+            description: "A label used to differentiate transactions by development stages."
 
   SearchParameters:
     type: object