Skip to content

chore: update v3 OpenAPI specs to v3.667.0 #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ed Fricker (beastawakens) merged 1 commit into from
Jun 15, 2026
Merged

chore: update v3 OpenAPI specs to v3.667.0 #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [Unreleased]

## [v3.667.0] - 2026-06-15

### Changed
- Updated `v3-biometric-authentication-entry`
- Updated `v3-biometric-enrollment-entry`
- Updated `v3-biometric-kyc-entry`
- Updated `v3-document-verification-entry`
- Updated `v3-enhanced-document-verification-entry`
- Updated `v3-smart-selfie-compare-entry`


## [v3.662.0] - 2026-06-15

### Changed
Expand Down
2 changes: 1 addition & 1 deletion specs/v3/v3-biometric-authentication-entry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.0

Check warning on line 1 in specs/v3/v3-biometric-authentication-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

oas3-api-servers
info:

Check warning on line 2 in specs/v3/v3-biometric-authentication-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

info-contact      Info object must have "contact" object.
title: V3 Biometric Authentication API
version: '1.0.0'
Expand All @@ -14,7 +14,7 @@
and must match an existing enrolled user.
paths:
/v3/authentication:
post:

Check warning on line 17 in specs/v3/v3-biometric-authentication-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

operation-tags    Operation must have non-empty "tags" array.
summary: Submit biometric authentication
operationId: v3BiometricAuthentication
description: >-
Expand Down Expand Up @@ -178,7 +178,7 @@
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness images. Required unless use_enrolled_image is true.
Array of JPEG liveness images. Required unless use_enrolled_image is true.
Comment on lines 178 to +181

@prfectionist prfectionist Bot Jun 15, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: The description no longer mentions the 6–8 range, but minItems: 6 and maxItems: 8 constraints are still present in the schema. This creates an inconsistency: the description says "Array of JPEG liveness images" (implying flexible count) while the schema still enforces 6–8. Either update the constraints to match the new description or restore the count range in the description. [general, importance: 5]

New proposed code: 
 liveness_images:
   type: array
-  minItems: 6
+  minItems: 1
   maxItems: 8
   items:
     type: string
     format: binary
   description: >-
     Array of JPEG liveness images. Required unless use_enrolled_image is true.

consent:
$ref: '#/components/schemas/Consent'
user_details:
Expand Down
7 changes: 1 addition & 6 deletions specs/v3/v3-biometric-enrollment-entry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.0

Check warning on line 1 in specs/v3/v3-biometric-enrollment-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

oas3-api-servers
info:

Check warning on line 2 in specs/v3/v3-biometric-enrollment-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

info-contact      Info object must have "contact" object.
title: V3 Biometric Enrollment API
version: '1.0.0'
Expand All @@ -13,7 +13,7 @@
At least one of `email` or `phone_number` is required.
paths:
/v3/registration:
post:

Check warning on line 16 in specs/v3/v3-biometric-enrollment-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

operation-tags    Operation must have non-empty "tags" array.
summary: Submit biometric enrollment
operationId: v3BiometricEnrollment
description: >-
Expand Down Expand Up @@ -106,11 +106,6 @@
value:
status: Bad Request
message: "Required field 'selfie_image' is missing or invalid."
insufficientLiveness:
summary: Too few liveness images
value:
status: Bad Request
message: liveness_images must contain at least 6 images.
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
Expand Down Expand Up @@ -227,7 +222,7 @@
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness sequence images captured during the liveness check.
Array of JPEG liveness sequence images captured during the liveness check.
These images are used for passive and active liveness verification.
consent:
$ref: '#/components/schemas/Consent'
Expand Down
7 changes: 1 addition & 6 deletions specs/v3/v3-biometric-kyc-entry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.0

Check warning on line 1 in specs/v3/v3-biometric-kyc-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

oas3-api-servers
info:

Check warning on line 2 in specs/v3/v3-biometric-kyc-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

info-contact      Info object must have "contact" object.
title: V3 Biometric KYC Entry API
version: '1.0.0'
Expand All @@ -13,7 +13,7 @@
At least one of `email` or `phone_number` is required.
paths:
/v3/biometric_kyc:
post:

Check warning on line 16 in specs/v3/v3-biometric-kyc-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

operation-tags    Operation must have non-empty "tags" array.
summary: Submit Biometric KYC verification
operationId: v3BiometricKycEntry
description: >-
Expand Down Expand Up @@ -115,11 +115,6 @@
value:
status: Bad Request
message: "Required field 'selfie_image' is missing or invalid."
insufficientLiveness:
summary: Too few liveness images
value:
status: Bad Request
message: liveness_images must contain at least 6 images.
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
Expand Down Expand Up @@ -254,7 +249,7 @@
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness sequence images captured during the liveness check.
Array of JPEG liveness sequence images captured during the liveness check.
These images are used for passive and active liveness verification.
consent:
$ref: '#/components/schemas/Consent'
Expand Down
7 changes: 1 addition & 6 deletions specs/v3/v3-document-verification-entry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.0

Check warning on line 1 in specs/v3/v3-document-verification-entry.yaml

View workflow job for this annotation

GitHub Actions / validate 

oas3-api-servers
info:
title: V3 Document Verification API
version: '1.0.0'
Expand Down Expand Up @@ -125,11 +125,6 @@
value:
status: Bad Request
message: "Required field 'selfie_image' is missing or invalid."
insufficientLiveness:
summary: Too few liveness images
value:
status: Bad Request
message: liveness_images must contain at least 6 images.
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
Expand Down Expand Up @@ -258,7 +253,7 @@
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness sequence images captured during the liveness check.
Array of JPEG liveness sequence images captured during the liveness check.
These images are used for liveness verification.
document:
type: string
Expand Down
7 changes: 1 addition & 6 deletions specs/v3/v3-enhanced-document-verification-entry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,6 @@ paths:
value:
status: Bad Request
message: "Required field 'selfie_image' is missing or invalid."
insufficientLiveness:
summary: Too few liveness images
value:
status: Bad Request
message: liveness_images must contain at least 6 images.
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
Expand Down Expand Up @@ -269,7 +264,7 @@ components:
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness sequence images captured during the liveness check.
Array of JPEG liveness sequence images captured during the liveness check.
These images are used for liveness verification.
document:
type: string
Expand Down
2 changes: 1 addition & 1 deletion specs/v3/v3-smart-selfie-compare-entry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ components:
type: string
format: binary
description: >-
Optional array of 6–8 JPEG liveness images. If omitted, active liveness check
Optional array of JPEG liveness images. If omitted, active liveness check
is skipped.
allow_new_enroll:
type: boolean
Expand Down
Loading