From a6a22cf22895b313164643cd3b58c13fd8f140f1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 30 Oct 2026 18:51:20 +0000 Subject: [PATCH] chore: update v3 OpenAPI specs to v3.1115.0 --- CHANGELOG.md | 10 ++++++++++ specs/v3/openapi.yaml | 20 +++++++------------ specs/v3/v3-document-verification-entry.yaml | 6 ++---- ...-enhanced-document-verification-entry.yaml | 6 ++---- ...residency-document-verification-entry.yaml | 6 ++---- specs/v3/v3-token.yaml | 2 +- 6 files changed, 24 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1018814..0c614e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/specs/v3/openapi.yaml b/specs/v3/openapi.yaml index 780d91c..47d31a0 100644 --- a/specs/v3/openapi.yaml +++ b/specs/v3/openapi.yaml @@ -4110,7 +4110,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 @@ -5168,8 +5168,6 @@ components: DocumentVerificationRequest: type: object required: - - selfie_image - - liveness_images - consent - country - document @@ -5179,7 +5177,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 @@ -5188,7 +5186,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 @@ -5305,8 +5303,6 @@ components: EnhancedDocumentVerificationRequest: type: object required: - - selfie_image - - liveness_images - consent - country - document @@ -5317,7 +5313,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 @@ -5326,7 +5322,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 @@ -6135,8 +6131,6 @@ components: ResidencyDocumentVerificationRequest: type: object required: - - selfie_image - - liveness_images - consent - country - document @@ -6148,7 +6142,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 @@ -6157,7 +6151,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 diff --git a/specs/v3/v3-document-verification-entry.yaml b/specs/v3/v3-document-verification-entry.yaml index 6d6722d..5cd7382 100644 --- a/specs/v3/v3-document-verification-entry.yaml +++ b/specs/v3/v3-document-verification-entry.yaml @@ -210,8 +210,6 @@ components: DocumentVerificationRequest: type: object required: - - selfie_image - - liveness_images - consent - country - document @@ -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 @@ -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 diff --git a/specs/v3/v3-enhanced-document-verification-entry.yaml b/specs/v3/v3-enhanced-document-verification-entry.yaml index de8f768..f84ee2b 100644 --- a/specs/v3/v3-enhanced-document-verification-entry.yaml +++ b/specs/v3/v3-enhanced-document-verification-entry.yaml @@ -220,8 +220,6 @@ components: EnhancedDocumentVerificationRequest: type: object required: - - selfie_image - - liveness_images - consent - country - document @@ -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 @@ -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 diff --git a/specs/v3/v3-residency-document-verification-entry.yaml b/specs/v3/v3-residency-document-verification-entry.yaml index 7512954..8ab0c96 100644 --- a/specs/v3/v3-residency-document-verification-entry.yaml +++ b/specs/v3/v3-residency-document-verification-entry.yaml @@ -330,8 +330,6 @@ components: ResidencyDocumentVerificationRequest: type: object required: - - selfie_image - - liveness_images - consent - country - document @@ -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 @@ -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 diff --git a/specs/v3/v3-token.yaml b/specs/v3/v3-token.yaml index 3dc2f3c..f6dde34 100644 --- a/specs/v3/v3-token.yaml +++ b/specs/v3/v3-token.yaml @@ -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