Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
29 changes: 9 additions & 20 deletions specs/v3/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@
status: Internal Server Error
message: An unexpected error occurred. Please try again or contact support.
/v3/aml/monitoring/{job_id}/news/{reference}:
get:

Check warning on line 345 in specs/v3/openapi.yaml

View workflow job for this annotation

GitHub Actions / validate

operation-description Operation "description" must be present and non-empty string.
operationId: getAmlMonitoringNews
tags:
- AML Monitoring News
Expand Down Expand Up @@ -557,8 +557,6 @@
- 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
Expand Down Expand Up @@ -3972,6 +3970,11 @@
- 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: >-
Expand Down Expand Up @@ -4662,17 +4665,8 @@
- 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
Expand All @@ -4681,7 +4675,7 @@
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
Expand All @@ -4690,7 +4684,7 @@
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:
Expand Down Expand Up @@ -4725,11 +4719,6 @@
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
Expand Down
20 changes: 4 additions & 16 deletions specs/v3/v3-biometric-authentication-entry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions specs/v3/v3-token.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: >-
Expand Down
Loading