diff --git a/CHANGELOG.md b/CHANGELOG.md index d245046..6946872 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ## [Unreleased] +## [v3.1107.0] - 2026-10-29 + +### Changed +- Updated `openapi` +- Updated `v3-biometric-enrollment-entry` +- Updated `v3-smart-selfie-compare-entry` +- Updated `v3-token` + + ## [v3.1094.0] - 2026-10-29 ### Changed diff --git a/specs/v3/openapi.yaml b/specs/v3/openapi.yaml index a072189..cc004a8 100644 --- a/specs/v3/openapi.yaml +++ b/specs/v3/openapi.yaml @@ -4080,7 +4080,8 @@ paths: properties: user_id: type: string - description: Optional partner-provided user identifier. + description: >- + Optional partner-provided user identifier. Required when use_enrolled_image or allow_new_enroll is true. partner_params: type: object additionalProperties: @@ -4109,7 +4110,12 @@ 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. + 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. + allow_new_enroll: + type: boolean + default: false + description: >- + Grants the session's job permission to re-enrol the user: when the job passes, its selfie replaces the user's enrolled selfie. Requires user_id, and the user must already be enrolled with a selfie on file: otherwise the job ends with status error and reason no_enrolled_user_found or no_enrolled_photo. Only true has an effect. Only this request can grant it — a value sent on the job itself is discarded. Without it, an enrolled user's selfie is never replaced. Applies to SmartSelfie Registration, SmartSelfie Compare, Biometric KYC, Document Verification and Residency Document Verification. Cannot be true together with use_enrolled_image: a request with both is rejected with 400. payload: type: object description: >- @@ -4963,11 +4969,6 @@ components: description: >- Phone number in E.164 format (must start with +). At least one of email or phone_number is required. example: '+2348012345678' - allow_new_enroll: - type: boolean - default: false - description: >- - If true, allows re-enrollment for a user who is already enrolled. The existing enrollment will be replaced with the new selfie. If false (default), enrollment fails if the user is already enrolled. user_id: type: string description: >- @@ -6671,10 +6672,6 @@ components: format: binary description: >- Optional array of 6–8 JPEG liveness images, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. If omitted, active liveness check is skipped. - allow_new_enroll: - type: boolean - default: false - description: If true, allows re-enrollment for a user who is already enrolled. user_id: type: string description: Optional user identifier. If provided and the job passes, the user will be enrolled. diff --git a/specs/v3/v3-biometric-enrollment-entry.yaml b/specs/v3/v3-biometric-enrollment-entry.yaml index 8c6305a..da7d685 100644 --- a/specs/v3/v3-biometric-enrollment-entry.yaml +++ b/specs/v3/v3-biometric-enrollment-entry.yaml @@ -249,11 +249,6 @@ components: description: >- Phone number in E.164 format (must start with +). At least one of email or phone_number is required. example: '+2348012345678' - allow_new_enroll: - type: boolean - default: false - description: >- - If true, allows re-enrollment for a user who is already enrolled. The existing enrollment will be replaced with the new selfie. If false (default), enrollment fails if the user is already enrolled. user_id: type: string description: Optional partner-provided user identifier. Must match the token user identifier when both are supplied. If no user identifier is supplied, a TypeID is generated automatically. diff --git a/specs/v3/v3-smart-selfie-compare-entry.yaml b/specs/v3/v3-smart-selfie-compare-entry.yaml index 94557cc..b48e5d4 100644 --- a/specs/v3/v3-smart-selfie-compare-entry.yaml +++ b/specs/v3/v3-smart-selfie-compare-entry.yaml @@ -215,11 +215,6 @@ components: format: binary description: >- Optional array of 6–8 JPEG liveness images, or exactly the count set by sdk_config.livenessImageCount when the session token carries one. If omitted, active liveness check is skipped. - allow_new_enroll: - type: boolean - default: false - description: >- - If true, allows re-enrollment for a user who is already enrolled. user_id: type: string description: >- diff --git a/specs/v3/v3-token.yaml b/specs/v3/v3-token.yaml index 616a92d..3dc2f3c 100644 --- a/specs/v3/v3-token.yaml +++ b/specs/v3/v3-token.yaml @@ -49,7 +49,8 @@ paths: properties: user_id: type: string - description: Optional partner-provided user identifier. + description: >- + Optional partner-provided user identifier. Required when use_enrolled_image or allow_new_enroll is true. partner_params: type: object additionalProperties: @@ -78,7 +79,12 @@ 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. + 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. + allow_new_enroll: + type: boolean + default: false + description: >- + Grants the session's job permission to re-enrol the user: when the job passes, its selfie replaces the user's enrolled selfie. Requires user_id, and the user must already be enrolled with a selfie on file: otherwise the job ends with status error and reason no_enrolled_user_found or no_enrolled_photo. Only true has an effect. Only this request can grant it — a value sent on the job itself is discarded. Without it, an enrolled user's selfie is never replaced. Applies to SmartSelfie Registration, SmartSelfie Compare, Biometric KYC, Document Verification and Residency Document Verification. Cannot be true together with use_enrolled_image: a request with both is rejected with 400. payload: type: object description: >-