feat: add new fields to facial similarity report objects (#133)

onfido · Nov 14, 2024 · 369921f · 369921f
1 parent 78a91f9
commit 369921f
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 0 deletions.
diff --git a/schemas/reports/definitions.yaml b/schemas/reports/definitions.yaml
@@ -33,6 +33,39 @@ report_shared:
       $ref: "#/report_name"
       description: The name of the report type.
 
+facial_similarity_report_shared:
+  properties:
+    live_photos:
+      type: array
+      description: Array of objects with live photo ids that were used in the Onfido engine.
+      items:
+        $ref: "#/facial_similarity_report_media"
+    live_videos:
+      type: array
+      description: Array of objects with live video ids that were used in the Onfido engine.
+      items:
+        $ref: "#/facial_similarity_report_media"
+    motion_captures:
+      type: array
+      description: Array of objects with motion capture ids that were used in the Onfido engine.
+      items:
+        $ref: "#/facial_similarity_report_media"
+    id_photos:
+      type: array
+      description: Array of objects with id photo ids that were used in the Onfido engine.
+      items:
+        $ref: "#/facial_similarity_report_media"
+
+facial_similarity_report_media:
+  type: object
+  required:
+    - id
+  properties:
+    id:
+      type: string
+      format: uuid
+      description: ID of uploaded biometric media to use.
+
 report_status:
   type: string
   enum:

diff --git a/schemas/reports/facial_similarity_motion_report.yaml b/schemas/reports/facial_similarity_motion_report.yaml
@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/facial_similarity_report_shared
   - type: object
     properties:
       breakdown:

diff --git a/schemas/reports/facial_similarity_photo_fully_auto_report.yaml b/schemas/reports/facial_similarity_photo_fully_auto_report.yaml
@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/facial_similarity_report_shared
   - type: object
     properties:
       breakdown:

diff --git a/schemas/reports/facial_similarity_photo_report.yaml b/schemas/reports/facial_similarity_photo_report.yaml
@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/facial_similarity_report_shared
   - type: object
     properties:
       breakdown:

diff --git a/schemas/reports/facial_similarity_video_report.yaml b/schemas/reports/facial_similarity_video_report.yaml
@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/facial_similarity_report_shared
   - type: object
     properties:
       breakdown: