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.1020.0] - 2026-10-15

### Changed
- Updated `openapi`
- Updated `v3-services`


## [v3.1015.0] - 2026-10-14

### Changed
Expand Down
25 changes: 24 additions & 1 deletion specs/v3/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,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 345 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 @@ -3166,6 +3166,9 @@
Returns the current availability and success rate for a specific ID type
in a given country, based on uptime data from the last hour.

In sandbox there is no uptime data. The endpoint returns `online` by default,
or the state named in `sandbox_status`, so you can test how your flow handles each one.

Requires authentication via JWT token.
security:
- SmileIDToken: []
Expand All @@ -3184,6 +3187,21 @@
schema:
type: string
example: BVN
- name: sandbox_status
in: query
required: false
description: |
Sandbox only. The state to return: `online` (100% success rate), `interruption` (75%),
`offline` (0%), or `no_data` (the 400 no-data error). Defaults to `online`.
Production ignores the value but still rejects anything not on this list.
schema:
type: string
enum:
- online
- interruption
- offline
- no_data
default: online
responses:
'200':
description: ID status retrieved successfully.
Expand Down Expand Up @@ -3214,6 +3232,11 @@
value:
message: Invalid country
status: Bad Request
invalidSandboxStatus:
summary: sandbox_status not one of the allowed values
value:
message: '"sandbox_status" must be one of [online, interruption, offline, no_data]'
status: Bad Request
invalidIdType:
summary: ID type not valid for country
value:
Expand All @@ -3222,7 +3245,7 @@
noData:
summary: No uptime data in the last hour
value:
message: No data found. Check that NG and BVN are valid inputs
message: No availability data recorded for BVN in NG in the last hour
status: Bad Request
'401':
description: Authentication failed.
Expand Down
21 changes: 20 additions & 1 deletion specs/v3/v3-services.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,9 @@ paths:
Returns the current availability and success rate for a specific ID type
in a given country, based on uptime data from the last hour.

In sandbox there is no uptime data. The endpoint returns `online` by default,
or the state named in `sandbox_status`, so you can test how your flow handles each one.

Requires authentication via JWT token.
security:
- SmileIDToken: []
Expand All @@ -431,6 +434,17 @@ paths:
schema:
type: string
example: BVN
- name: sandbox_status
in: query
required: false
description: |
Sandbox only. The state to return: `online` (100% success rate), `interruption` (75%),
`offline` (0%), or `no_data` (the 400 no-data error). Defaults to `online`.
Production ignores the value but still rejects anything not on this list.
schema:
type: string
enum: [online, interruption, offline, no_data]
default: online
responses:
'200':
description: ID status retrieved successfully.
Expand Down Expand Up @@ -461,6 +475,11 @@ paths:
value:
message: Invalid country
status: Bad Request
invalidSandboxStatus:
summary: sandbox_status not one of the allowed values
value:
message: '"sandbox_status" must be one of [online, interruption, offline, no_data]'
status: Bad Request
invalidIdType:
summary: ID type not valid for country
value:
Expand All @@ -469,7 +488,7 @@ paths:
noData:
summary: No uptime data in the last hour
value:
message: 'No data found. Check that NG and BVN are valid inputs'
message: No availability data recorded for BVN in NG in the last hour
status: Bad Request
'401':
description: Authentication failed.
Expand Down
Loading