Skip to content
Open
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
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ All notable changes to the Smile Identity API specifications will be documented
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [Unreleased]
## [v3.635.0] - 2026-06-04

### Changed
- Updated `v3-biometric-authentication-entry`
- Updated `v3-biometric-enrollment-entry`
- Updated `v3-biometric-kyc-entry`
- Updated `v3-document-verification-entry`
- Updated `v3-enhanced-document-verification-entry`
- Updated `v3-enhanced-kyc-entry`
- Updated `v3-report-user-fraud`
- Updated `v3-smart-selfie-compare-entry`
Comment on lines +10 to +18

### Removed
- `v3-block-user`

## [v3.619.0] - 2026-05-29

### Changed
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ OpenAPI 3.0 specifications for the Smile Identity v3 API.
| [Biometric Authentication](specs/v3/v3-biometric-authentication-entry.yaml) | `POST /v3/authentication` | Submit biometric authentication |
| [Biometric Enrollment](specs/v3/v3-biometric-enrollment-entry.yaml) | `POST /v3/registration` | Submit biometric enrollment |
| [Biometric KYC](specs/v3/v3-biometric-kyc-entry.yaml) | `POST /v3/biometric_kyc` | Submit Biometric KYC verification |
| [Block User](specs/v3/v3-block-user.yaml) | `POST /v3/users/{user_id}` | Block or unblock an enrolled user |
| [Document Verification](specs/v3/v3-document-verification-entry.yaml) | `POST /v3/document-verification` | Submit Document Verification |
| [Enhanced Document Verification](specs/v3/v3-enhanced-document-verification-entry.yaml) | `POST /v3/enhanced-document-verification` | Submit Enhanced Document Verification |
| [Enhanced KYC](specs/v3/v3-enhanced-kyc-entry.yaml) | `POST /v3/enhanced_kyc` | Submit Enhanced KYC verification |
| [Replay Callback](specs/v3/v3-replay-callback.yaml) | `POST /v3/replay/{job_id}` | Replay a callback for a completed verification |
| [Report User Fraud](specs/v3/v3-report-user-fraud.yaml) | `POST /v3/users/{user_id}/report_fraud` | Flag or clear fraud status for a user |
| [Services](specs/v3/v3-services.yaml) | `GET /v3/services/bank_codes` | List bank codes |
| [Services](specs/v3/v3-services.yaml) | `GET /v3/services/id_status` | Get ID type availability status |
| [Services](specs/v3/v3-services.yaml) | `GET /v3/services/supported_documents` | List supported documents for verification |
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,11 @@ <h2>APIs</h2>
{ file: "v3-biometric-authentication-entry", label: "Biometric Authentication" },
{ file: "v3-biometric-enrollment-entry", label: "Biometric Enrollment" },
{ file: "v3-biometric-kyc-entry", label: "Biometric KYC" },
{ file: "v3-block-user", label: "Block User" },
{ file: "v3-document-verification-entry", label: "Document Verification" },
{ file: "v3-enhanced-document-verification-entry", label: "Enhanced Document Verification" },
{ file: "v3-enhanced-kyc-entry", label: "Enhanced KYC" },
{ file: "v3-replay-callback", label: "Replay Callback" },
{ file: "v3-report-user-fraud", label: "Report User Fraud" },
{ file: "v3-services", label: "Services" },
{ file: "v3-smart-selfie-compare-entry", label: "Smart Selfie Compare" },
{ file: "v3-token", label: "Token" },
Expand Down
5 changes: 5 additions & 0 deletions specs/v3/v3-biometric-authentication-entry.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.0

Check warning on line 1 in specs/v3/v3-biometric-authentication-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

oas3-api-servers
info:

Check warning on line 2 in specs/v3/v3-biometric-authentication-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

info-contact Info object must have "contact" object.
title: V3 Biometric Authentication API
version: '1.0.0'
Expand All @@ -14,7 +14,7 @@
and must match an existing enrolled user.
paths:
/v3/authentication:
post:

Check warning on line 17 in specs/v3/v3-biometric-authentication-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

operation-tags Operation must have non-empty "tags" array.
summary: Submit biometric authentication
operationId: v3BiometricAuthentication
description: >-
Expand Down Expand Up @@ -99,6 +99,11 @@
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
status: Bad Request
message: A valid callback_url is required in the request or a default callback URL must be configured in the portal.
missingUserId:
summary: Missing user_id
value:
Expand Down
5 changes: 5 additions & 0 deletions specs/v3/v3-biometric-enrollment-entry.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.0

Check warning on line 1 in specs/v3/v3-biometric-enrollment-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

oas3-api-servers
info:

Check warning on line 2 in specs/v3/v3-biometric-enrollment-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

info-contact Info object must have "contact" object.
title: V3 Biometric Enrollment API
version: '1.0.0'
Expand All @@ -13,7 +13,7 @@
At least one of `email` or `phone_number` is required.
paths:
/v3/registration:
post:

Check warning on line 16 in specs/v3/v3-biometric-enrollment-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

operation-tags Operation must have non-empty "tags" array.
summary: Submit biometric enrollment
operationId: v3BiometricEnrollment
description: >-
Expand Down Expand Up @@ -111,6 +111,11 @@
value:
status: Bad Request
message: liveness_images must contain at least 6 images.
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
status: Bad Request
message: A valid callback_url is required in the request or a default callback URL must be configured in the portal.
missingContact:
summary: Missing email and phone
value:
Expand Down
5 changes: 5 additions & 0 deletions specs/v3/v3-biometric-kyc-entry.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.0

Check warning on line 1 in specs/v3/v3-biometric-kyc-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

oas3-api-servers
info:

Check warning on line 2 in specs/v3/v3-biometric-kyc-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

info-contact Info object must have "contact" object.
title: V3 Biometric KYC Entry API
version: '1.0.0'
Expand All @@ -13,7 +13,7 @@
At least one of `email` or `phone_number` is required.
paths:
/v3/biometric_kyc:
post:

Check warning on line 16 in specs/v3/v3-biometric-kyc-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

operation-tags Operation must have non-empty "tags" array.
summary: Submit Biometric KYC verification
operationId: v3BiometricKycEntry
description: >-
Expand Down Expand Up @@ -120,6 +120,11 @@
value:
status: Bad Request
message: liveness_images must contain at least 6 images.
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
status: Bad Request
message: A valid callback_url is required in the request or a default callback URL must be configured in the portal.
missingCountry:
summary: Missing required field
value:
Expand Down
261 changes: 0 additions & 261 deletions specs/v3/v3-block-user.yaml

This file was deleted.

5 changes: 5 additions & 0 deletions specs/v3/v3-document-verification-entry.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.0

Check warning on line 1 in specs/v3/v3-document-verification-entry.yaml

View workflow job for this annotation

GitHub Actions / validate

oas3-api-servers
info:
title: V3 Document Verification API
version: '1.0.0'
Expand Down Expand Up @@ -130,6 +130,11 @@
value:
status: Bad Request
message: liveness_images must contain at least 6 images.
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
status: Bad Request
message: A valid callback_url is required in the request or a default callback URL must be configured in the portal.
missingCountry:
summary: Missing required field
value:
Expand Down
5 changes: 5 additions & 0 deletions specs/v3/v3-enhanced-document-verification-entry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,11 @@ paths:
value:
status: Bad Request
message: liveness_images must contain at least 6 images.
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
status: Bad Request
message: A valid callback_url is required in the request or a default callback URL must be configured in the portal.
missingCountry:
summary: Missing required field
value:
Expand Down
5 changes: 5 additions & 0 deletions specs/v3/v3-enhanced-kyc-entry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,11 @@ paths:
value:
status: Bad Request
message: "Required field 'country' is missing or invalid."
missingCallbackUrl:
summary: Missing callback_url and no default set
value:
status: Bad Request
message: A valid callback_url is required in the request or a default callback URL must be configured in the portal.
missingContact:
summary: Missing email and phone
value:
Expand Down
Loading
Loading