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
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [Unreleased]

## [v3.1115.0] - 2026-10-30

### Changed
- Updated `openapi`
- Updated `v3-document-verification-entry`
- Updated `v3-enhanced-document-verification-entry`
- Updated `v3-residency-document-verification-entry`
- Updated `v3-token`


## [v3.1108.0] - 2026-10-29

### Changed
Expand Down
20 changes: 7 additions & 13 deletions specs/v3/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,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 311 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 @@ -4110,7 +4110,7 @@
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. Cannot be true together with allow_new_enroll.
Grants the session a job that verifies against the user's enrolled selfie instead of a fresh capture. On Biometric KYC, selfie_image and liveness_images may be omitted. On Document Verification (standard, enhanced and residency), the document is compared against the enrolled selfie: selfie_image is ignored if sent, and liveness_images may be omitted or sent to be checked against the enrolled selfie. Requires user_id; a Document Verification job for a user with no enrolled selfie ends with status error and reason no_enrolled_user_found or no_enrolled_photo. 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 and Document Verification only. Cannot be true together with allow_new_enroll.
allow_new_enroll:
type: boolean
default: false
Expand Down Expand Up @@ -5168,8 +5168,6 @@
DocumentVerificationRequest:
type: object
required:
- selfie_image
- liveness_images
- consent
- country
- document
Expand All @@ -5179,7 +5177,7 @@
type: string
format: binary
description: >-
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo.
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo. Required unless the session token was issued with use_enrolled_image: then the document is compared against the user's enrolled selfie, and a selfie sent anyway is ignored. If the user has no enrolled selfie, the job ends with status error and reason no_enrolled_user_found or no_enrolled_photo.
liveness_images:
type: array
minItems: 6
Expand All @@ -5188,7 +5186,7 @@
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness sequence images captured during the liveness check, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. These images are used for liveness verification.
Array of 6–8 JPEG liveness sequence images captured during the liveness check, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. These images are used for liveness verification. Required unless the session token was issued with use_enrolled_image. When sent with that grant, they are checked for liveness against the user's enrolled selfie.
document:
type: string
format: binary
Expand Down Expand Up @@ -5305,8 +5303,6 @@
EnhancedDocumentVerificationRequest:
type: object
required:
- selfie_image
- liveness_images
- consent
- country
- document
Expand All @@ -5317,7 +5313,7 @@
type: string
format: binary
description: >-
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo.
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo. Required unless the session token was issued with use_enrolled_image: then the document is compared against the user's enrolled selfie, and a selfie sent anyway is ignored. If the user has no enrolled selfie, the job ends with status error and reason no_enrolled_user_found or no_enrolled_photo.
liveness_images:
type: array
minItems: 6
Expand All @@ -5326,7 +5322,7 @@
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness sequence images captured during the liveness check, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. These images are used for liveness verification.
Array of 6–8 JPEG liveness sequence images captured during the liveness check, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. These images are used for liveness verification. Required unless the session token was issued with use_enrolled_image. When sent with that grant, they are checked for liveness against the user's enrolled selfie.
document:
type: string
format: binary
Expand Down Expand Up @@ -6135,8 +6131,6 @@
ResidencyDocumentVerificationRequest:
type: object
required:
- selfie_image
- liveness_images
- consent
- country
- document
Expand All @@ -6148,7 +6142,7 @@
type: string
format: binary
description: >-
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo.
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo. Required unless the session token was issued with use_enrolled_image: then the document is compared against the user's enrolled selfie, and a selfie sent anyway is ignored. If the user has no enrolled selfie, the job ends with status error and reason no_enrolled_user_found or no_enrolled_photo.
liveness_images:
type: array
minItems: 6
Expand All @@ -6157,7 +6151,7 @@
type: string
format: binary
description: >-
Array of JPEG liveness sequence images captured during the liveness check. These images are used for liveness verification.
Array of JPEG liveness sequence images captured during the liveness check. These images are used for liveness verification. Required unless the session token was issued with use_enrolled_image. When sent with that grant, they are checked for liveness against the user's enrolled selfie.
document:
type: string
format: binary
Expand Down
6 changes: 2 additions & 4 deletions specs/v3/v3-document-verification-entry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,6 @@ components:
DocumentVerificationRequest:
type: object
required:
- selfie_image
- liveness_images
- consent
- country
- document
Expand All @@ -221,7 +219,7 @@ components:
type: string
format: binary
description: >-
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo.
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo. Required unless the session token was issued with use_enrolled_image: then the document is compared against the user's enrolled selfie, and a selfie sent anyway is ignored. If the user has no enrolled selfie, the job ends with status error and reason no_enrolled_user_found or no_enrolled_photo.
liveness_images:
type: array
minItems: 6
Expand All @@ -230,7 +228,7 @@ components:
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness sequence images captured during the liveness check, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. These images are used for liveness verification.
Array of 6–8 JPEG liveness sequence images captured during the liveness check, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. These images are used for liveness verification. Required unless the session token was issued with use_enrolled_image. When sent with that grant, they are checked for liveness against the user's enrolled selfie.
document:
type: string
format: binary
Expand Down
6 changes: 2 additions & 4 deletions specs/v3/v3-enhanced-document-verification-entry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,6 @@ components:
EnhancedDocumentVerificationRequest:
type: object
required:
- selfie_image
- liveness_images
- consent
- country
- document
Expand All @@ -232,7 +230,7 @@ components:
type: string
format: binary
description: >-
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo.
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo. Required unless the session token was issued with use_enrolled_image: then the document is compared against the user's enrolled selfie, and a selfie sent anyway is ignored. If the user has no enrolled selfie, the job ends with status error and reason no_enrolled_user_found or no_enrolled_photo.
liveness_images:
type: array
minItems: 6
Expand All @@ -241,7 +239,7 @@ components:
type: string
format: binary
description: >-
Array of 6–8 JPEG liveness sequence images captured during the liveness check, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. These images are used for liveness verification.
Array of 6–8 JPEG liveness sequence images captured during the liveness check, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. These images are used for liveness verification. Required unless the session token was issued with use_enrolled_image. When sent with that grant, they are checked for liveness against the user's enrolled selfie.
document:
type: string
format: binary
Expand Down
6 changes: 2 additions & 4 deletions specs/v3/v3-residency-document-verification-entry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,6 @@ components:
ResidencyDocumentVerificationRequest:
type: object
required:
- selfie_image
- liveness_images
- consent
- country
- document
Expand All @@ -343,7 +341,7 @@ components:
type: string
format: binary
description: >-
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo.
JPEG selfie image used for biometric verification. Must be a clear, well-lit, front-facing photo. Required unless the session token was issued with use_enrolled_image: then the document is compared against the user's enrolled selfie, and a selfie sent anyway is ignored. If the user has no enrolled selfie, the job ends with status error and reason no_enrolled_user_found or no_enrolled_photo.
liveness_images:
type: array
minItems: 6
Expand All @@ -352,7 +350,7 @@ components:
type: string
format: binary
description: >-
Array of JPEG liveness sequence images captured during the liveness check. These images are used for liveness verification.
Array of JPEG liveness sequence images captured during the liveness check. These images are used for liveness verification. Required unless the session token was issued with use_enrolled_image. When sent with that grant, they are checked for liveness against the user's enrolled selfie.
document:
type: string
format: binary
Expand Down
2 changes: 1 addition & 1 deletion specs/v3/v3-token.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ paths:
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. Cannot be true together with allow_new_enroll.
Grants the session a job that verifies against the user's enrolled selfie instead of a fresh capture. On Biometric KYC, selfie_image and liveness_images may be omitted. On Document Verification (standard, enhanced and residency), the document is compared against the enrolled selfie: selfie_image is ignored if sent, and liveness_images may be omitted or sent to be checked against the enrolled selfie. Requires user_id; a Document Verification job for a user with no enrolled selfie ends with status error and reason no_enrolled_user_found or no_enrolled_photo. 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 and Document Verification only. Cannot be true together with allow_new_enroll.
allow_new_enroll:
type: boolean
default: false
Expand Down
Loading