SP-11596: Add outputImageParams

matching.yml

@@ -25,9 +25,12 @@ paths:
         403:
           $ref: "./common.yml#/components/responses/BadLicense"
 
+info:
+  title: Regula FaceSDK Web API
+  version: 5.2.0
+
 components:
   schemas:
-
     MatchRequest:
       type: object
       required:
@@ -45,6 +48,46 @@ components:
           description: "The array of all images included in the comparison."
           items:
             $ref: "#/components/schemas/MatchImage"
+        outputImageParams:
+          type: object
+          description: "Whether to process the uploaded image according to the indicated settings."
+          properties:
+            backgroundColor:
+              type: array
+              description: "The RGB value of a color for filling background behind a person's silhouette and for aligning the image."
+              default: null
+              items:
+                type: integer
+            crop:
+              type: object
+              description: "Whether to return the Base64 of an aligned and cropped portrait in the crop field."
+              properties:
+                padColor:
+                  type: array
+                  description: "The RGB value of a color for filling background behind a person's silhouette and for aligning the image."
+                  default: null
+                  items:
+                    type: integer
+                returnOriginalRect:
+                  type: boolean
+                  description: "Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop."
+                  default: null
+                size:
+                  type: array
+                  description: "The resize value in case type matches this value. If it doesn't, no resize is done."
+                  default: null
+                  items:
+                    type: integer
+                type:
+                  type: integer
+                  description: "The aspect ratio according to which face alignment is performed during face detection."
+                  default: null
+                  enum:
+                    - 0
+                    - 1
+                    - 2
+                    - 3
+                    - 4
 
     MatchImageIndex:
       type: integer
@@ -142,11 +185,15 @@ components:
           example: [ [ x, y ] ]
         rotationAngle:
           description: "Angle of rotation of the face from the vertical axis, degrees."
-          type: float
+          type: number
         roi:
           $ref: "./common.yml#/components/schemas/FaceRectangular"
         thumbnail:
           $ref: "./common.yml#/components/schemas/Thumbnail"
+        crop:
+          type: string
+          format: byte
+          description: "Base64 of the cropped portrait."
 
     ImageSource:
       description: "The type of the image, defines the way the comparison is performed. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/"