From 8af21d5ca62b88d35324acbd1a869f56c2afef0e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 14 Oct 2026 19:20:31 +0000 Subject: [PATCH] chore: update v3 OpenAPI specs to v3.1015.0 --- CHANGELOG.md | 8 +++++ specs/v3/openapi.yaml | 29 ++++++------------- .../v3/v3-biometric-authentication-entry.yaml | 20 +++---------- specs/v3/v3-token.yaml | 5 ++++ 4 files changed, 26 insertions(+), 36 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b050b37..e341ad9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ## [Unreleased] +## [v3.1015.0] - 2026-10-14 + +### Changed +- Updated `openapi` +- Updated `v3-biometric-authentication-entry` +- Updated `v3-token` + + ## [v3.1004.0] - 2026-10-13 ### Changed diff --git a/specs/v3/openapi.yaml b/specs/v3/openapi.yaml index e3fdfb1..e7b412b 100644 --- a/specs/v3/openapi.yaml +++ b/specs/v3/openapi.yaml @@ -557,8 +557,6 @@ paths: - SmileIDToken: [] description: >- Authenticates a user by comparing a submitted selfie against their enrolled image. The selfie and liveness images are uploaded, validated at entry, then queued for async ML processing (passive liveness, active liveness, face matching). Results are delivered via callback URL. - - Supports `use_enrolled_image: true` to skip selfie/liveness upload and re-use the enrolled image for the comparison (useful for server-side re-verification). parameters: [] requestBody: required: true @@ -3972,6 +3970,11 @@ paths: - smart_selfie_registration - smart_selfie_compare example: smart_selfie_authentication + use_enrolled_image: + type: boolean + default: false + description: >- + Grants the session a Biometric KYC job that verifies against the user's enrolled selfie instead of a fresh capture, so selfie_image and liveness_images may be omitted on that job. Only this request can grant it, because only it is authenticated with the partner's API key — a value sent on the job itself is discarded. Applies to Biometric KYC only. payload: type: object description: >- @@ -4662,17 +4665,8 @@ components: - user_id - consent - user_details - anyOf: - - required: - - selfie_image - - liveness_images - - required: - - use_enrolled_image - properties: - use_enrolled_image: - type: boolean - enum: - - true + - selfie_image + - liveness_images properties: user_id: type: string @@ -4681,7 +4675,7 @@ components: selfie_image: type: string format: binary - description: JPEG selfie image for authentication. Required unless use_enrolled_image is true. + description: JPEG selfie image for authentication. liveness_images: type: array minItems: 6 @@ -4690,7 +4684,7 @@ components: type: string format: binary description: >- - Array of 6–8 JPEG liveness images, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. Required unless use_enrolled_image is true. + Array of 6–8 JPEG liveness images, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. consent: $ref: '#/components/schemas/Consent' user_details: @@ -4725,11 +4719,6 @@ components: nullable: true description: Phone number in E.164 format. At least one of email or phone_number is required. example: '+2348012345678' - use_enrolled_image: - type: boolean - default: false - description: >- - If true, skips selfie and liveness image upload and uses the enrolled image for re-verification. Useful for server-side re-authentication. callback_url: type: string format: uri diff --git a/specs/v3/v3-biometric-authentication-entry.yaml b/specs/v3/v3-biometric-authentication-entry.yaml index 3d40ed1..0ebf708 100644 --- a/specs/v3/v3-biometric-authentication-entry.yaml +++ b/specs/v3/v3-biometric-authentication-entry.yaml @@ -32,8 +32,6 @@ paths: - SmileIDToken: [] description: >- Authenticates a user by comparing a submitted selfie against their enrolled image. The selfie and liveness images are uploaded, validated at entry, then queued for async ML processing (passive liveness, active liveness, face matching). Results are delivered via callback URL. - - Supports `use_enrolled_image: true` to skip selfie/liveness upload and re-use the enrolled image for the comparison (useful for server-side re-verification). parameters: [] requestBody: required: true @@ -142,13 +140,8 @@ components: - user_id - consent - user_details - anyOf: - - required: [selfie_image, liveness_images] - - required: [use_enrolled_image] - properties: - use_enrolled_image: - type: boolean - enum: [true] + - selfie_image + - liveness_images properties: user_id: type: string @@ -159,7 +152,7 @@ components: type: string format: binary description: >- - JPEG selfie image for authentication. Required unless use_enrolled_image is true. + JPEG selfie image for authentication. liveness_images: type: array minItems: 6 @@ -168,7 +161,7 @@ components: type: string format: binary description: >- - Array of 6–8 JPEG liveness images, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. Required unless use_enrolled_image is true. + Array of 6–8 JPEG liveness images, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. consent: $ref: '#/components/schemas/Consent' user_details: @@ -202,11 +195,6 @@ components: nullable: true description: Phone number in E.164 format. At least one of email or phone_number is required. example: '+2348012345678' - use_enrolled_image: - type: boolean - default: false - description: >- - If true, skips selfie and liveness image upload and uses the enrolled image for re-verification. Useful for server-side re-authentication. callback_url: type: string format: uri diff --git a/specs/v3/v3-token.yaml b/specs/v3/v3-token.yaml index eef739d..b4d8f1d 100644 --- a/specs/v3/v3-token.yaml +++ b/specs/v3/v3-token.yaml @@ -74,6 +74,11 @@ paths: - smart_selfie_registration - smart_selfie_compare example: smart_selfie_authentication + use_enrolled_image: + type: boolean + default: false + description: >- + Grants the session a Biometric KYC job that verifies against the user's enrolled selfie instead of a fresh capture, so selfie_image and liveness_images may be omitted on that job. Only this request can grant it, because only it is authenticated with the partner's API key — a value sent on the job itself is discarded. Applies to Biometric KYC only. payload: type: object description: >-