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

## [Unreleased]

## [v3.847.0] - 2026-08-24

### Changed
- Updated `openapi`
- Updated `v3-aml-monitoring-news`


## [v3.845.0] - 2026-08-21

### Changed
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ OpenAPI 3.0 specifications for the Smile Identity v3 API.
| Spec | Endpoint | Description |
|------|----------|-------------|
| [Aml Monitoring](specs/v3/v3-aml-monitoring-entry.yaml) | `POST /v3/aml/monitoring` | Submit AML Monitoring screening |
| [Aml Monitoring News](specs/v3/v3-aml-monitoring-news.yaml) | `GET /v3/aml/monitoring/{job_id}/news/{reference}` | Get AML Monitoring news media details for a reference |
| [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 |
Expand Down
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@ <h2>APIs</h2>
const SPECS = [
{ file: "openapi", label: "Full V3 API" },
{ file: "v3-aml-monitoring-entry", label: "Aml Monitoring" },
{ file: "v3-aml-monitoring-news", label: "Aml Monitoring News" },
{ file: "v3-biometric-authentication-entry", label: "Biometric Authentication" },
{ file: "v3-biometric-enrollment-entry", label: "Biometric Enrollment" },
{ file: "v3-biometric-kyc-entry", label: "Biometric KYC" },
Expand Down
284 changes: 284 additions & 0 deletions specs/v3/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
description: Production
tags:
- name: AML Monitoring
- name: AML Monitoring News
- name: Authentication
- name: Biometric Authentication
- name: Biometric Enrollment
Expand Down Expand Up @@ -242,6 +243,219 @@
example:
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 247 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
security:
- SmileIDToken: []
summary: Get AML Monitoring news media details for a reference
parameters:
- name: job_id
in: path
required: true
description: Partner job identifier for an existing V3 AML Monitoring job.
schema:
type: string
example: a1b2c3d4e5
- name: reference
in: path
required: true
description: Person reference (ref) from the AML Monitoring result set.
schema:
type: string
example: ref_001
- name: news_category
in: query
required: true
description: News category to filter media events.
schema:
type: string
example: financial_crime
enum:
- arms_trafficking
- credit_update
- environmental_crime
- financial_crime
- human_rights_violation
- leadership_change
- legal_risk
- location_change
- narcotics
- other
- other_crime
- ownership_change
- product_change
- regulatory
- sexual_crime
- technology_event
- terrorism
- violent_crime
- name: page
in: query
required: false
description: Results page number. Defaults to 1. Maximum is 100.
schema:
type: integer
minimum: 1
maximum: 100
default: 1
example: 1
- name: limit
in: query
required: false
description: Number of items per page. Defaults to 25. Maximum is 100.
schema:
type: integer
minimum: 1
maximum: 100
default: 25
example: 25
- name: SmileID-Source-SDK
in: header
required: false
description: Source SDK identifier.
schema:
type: string
example: android
- name: SmileID-Source-SDK-Version
in: header
required: false
description: Source SDK version.
schema:
type: string
example: 10.4.2
- name: SmileID-Timestamp
in: header
required: false
x-smile-sdk-exclude: true
description: >-
ISO 8601 timestamp used as the salt when computing SmileID-Request-Signature. Required
when your Smile ID account is configured to use SDK/partner secret HMAC authentication.
schema:
type: string
format: date-time
example: '2026-03-10T12:00:00.000Z'
- name: SmileID-Request-Signature
in: header
required: false
x-smile-sdk-exclude: true
description: >-
HMAC signature of the raw HTTP request payload, computed with your SDK/partner secret
and the value of SmileID-Timestamp as salt. Required when your Smile ID account is
configured to use SDK/partner secret HMAC authentication.
schema:
type: string
example: 4f2d9c6b8a7e3f1c0d5e4b3a2c1f9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AmlMonitoringNewsResponse'
examples:
success:
value:
job_id: a1b2c3d4e5
product: aml_monitoring_news
user_id: user_123
meta:
current_page: 1
limit: 25
total_count: 1
news:
- body: Sample adverse-media content.
published_date: '2026-01-15T12:00:00.000Z'
publisher: Example News Publisher
publisher_country_code: NG
title: Sample AML Monitoring News Item
url: https://example.com/news/sample-aml-monitoring
'400':
description: Bad Request — request validation error.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
missingNewsCategory:
summary: Missing required news_category query parameter
value:
status: Bad Request
message: news_category is required
invalidNewsCategory:
summary: Unsupported news_category value
value:
status: Bad Request
message: >-
news_category must be one of: arms_trafficking, credit_update,
environmental_crime, financial_crime, human_rights_violation,
leadership_change, legal_risk, location_change, narcotics, other, other_crime,
ownership_change, product_change, regulatory, sexual_crime, technology_event,
terrorism, violent_crime
'401':
description: Unauthorized — invalid or missing authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
status: Unauthorized
message: Invalid authentication credentials.
'403':
description: Forbidden — partner does not have access to this resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
status: Forbidden
message: Product not enabled for this partner.
'404':
description: Not Found — AML job or reference not found for this partner scope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
jobNotFound:
summary: Job does not exist for this partner or token user
value:
status: Not Found
message: No AML job found for this partner
referenceNotFound:
summary: Reference does not exist in AML result set for this job
value:
status: Not Found
message: REF not found for this AML job
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
status: Internal Server Error
message: An unexpected error occurred. Please try again or contact support.
'502':
description: Bad Gateway — upstream provider returned a permanent client-side failure.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
status: Bad Gateway
message: Unable to complete request due to upstream provider error.
'503':
description: Service Unavailable — upstream provider is temporarily unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
status: Service Unavailable
message: Upstream provider is temporarily unavailable. Please try again later.
/v3/authentication:
post:
summary: Submit biometric authentication
Expand Down Expand Up @@ -3511,6 +3725,76 @@
type: string
description: Human-readable error message.
example: Invalid request.
AmlMonitoringNewsResponse:
type: object
required:
- job_id
- product
- user_id
- meta
- news
properties:
job_id:
type: string
description: Partner job identifier.
example: a1b2c3d4e5
product:
type: string
description: Product identifier for this endpoint.
enum:
- aml_monitoring_news
user_id:
type: string
description: Partner user identifier tied to the monitoring job.
example: user_123
meta:
type: object
required:
- current_page
- limit
- total_count
properties:
current_page:
type: integer
example: 1
limit:
type: integer
example: 25
total_count:
type: integer
example: 2
news:
type: array
items:
$ref: '#/components/schemas/AmlMonitoringNewsItem'
AmlMonitoringNewsItem:
type: object
required:
- body
- published_date
- publisher
- publisher_country_code
- title
- url
properties:
body:
type: string
example: Sample adverse-media content.
published_date:
type: string
example: '2023-01-01'
publisher:
type: string
example: Publisher 1
publisher_country_code:
type: string
example: NG
title:
type: string
example: Sample AML Monitoring News Item
url:
type: string
example: www.example.com/article1
Comment on lines +3783 to +3797

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: The bundled spec carries the same inconsistent examples as the standalone spec; keep both in sync and add format: date-time / format: uri so generated clients type these fields correctly. [general, importance: 5]

Suggested change
published_date:
type: string
example: '2023-01-01'
publisher:
type: string
example: Publisher 1
publisher_country_code:
type: string
example: NG
title:
type: string
example: Sample AML Monitoring News Item
url:
type: string
example: www.example.com/article1
published_date:
type: string
format: date-time
example: '2026-01-15T12:00:00.000Z'
publisher:
type: string
example: Example News Publisher
publisher_country_code:
type: string
description: ISO 3166-1 alpha-2 country code of the publisher.
example: NG
title:
type: string
example: Sample AML Monitoring News Item
url:
type: string
format: uri
example: https://example.com/news/sample-aml-monitoring

BiometricAuthenticationRequest:
type: object
required:
Expand Down
Loading
Loading