Merge pull request #48 from regulaforensics/update-structure

Liveness fix

liveness.yml

@@ -16,48 +16,31 @@ paths:
               schema:
                 $ref: "#/components/schemas/TransactionInfo"
 
-
 components:
   schemas:
     TransactionInfo:
       type: object
       properties:
         code:
           type: integer
-          description: "Return code value"
+          description: "The result code, one of the FaceSDKResultCode enum values. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/"
+        status:
+          type: integer
+          default: null
+          description: "Whether the liveness detection is confirmed (0) or not (1)."
         sessionId:
           type: integer
-          description: "Session ID"
+          description: "Session ID, one session may include many transactions."
         transactionId:
           type: string
-          description: "Transaction ID"
+          description: "Transaction ID, there can be several transactions within one session."
         video:
           type: string
-          description: "S3 link to transaction video"
+          description: "An S3 link to the session video."
         portrait:
           type: string
-          description: "S3 link to transaction portrait"
-        metadata:
-          type: object
-          additionalProperties: true
-    LivenessTransaction:
-      type: object
-      properties:
-        code:
-          type: integer
-          default: null
-        sessionId:
-          type: string
-        status:
-          type: integer
-          default: null
-          description: "Whether the liveness detection is confirmed (0) or not (1)"
-        transactionId:
-          type: string
+          description: "An S3 link to the portrait."
         metadata:
           type: object
-          additionalProperties: true
+          additionalProperties: true          
           description: "A free-form object containing person's extended attributes."
-        elapsed:
-          type: integer
-          default: null