From d43750d16919dcb5ce0c60f415b34e57703ca6e1 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Thu, 15 Oct 2026 14:22:51 +0000
Subject: [PATCH] chore: update v3 OpenAPI specs to v3.1020.0

---
 CHANGELOG.md              |  7 +++++++
 specs/v3/openapi.yaml     | 25 ++++++++++++++++++++++++-
 specs/v3/v3-services.yaml | 21 ++++++++++++++++++++-
 3 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e341ad9..09c5ffc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -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
diff --git a/specs/v3/openapi.yaml b/specs/v3/openapi.yaml
index e7b412b..b557d21 100644
--- a/specs/v3/openapi.yaml
+++ b/specs/v3/openapi.yaml
@@ -3166,6 +3166,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: []
@@ -3184,6 +3187,21 @@ 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.
@@ -3214,6 +3232,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:
@@ -3222,7 +3245,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.
diff --git a/specs/v3/v3-services.yaml b/specs/v3/v3-services.yaml
index c260743..9698e2b 100644
--- a/specs/v3/v3-services.yaml
+++ b/specs/v3/v3-services.yaml
@@ -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: []
@@ -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.
@@ -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:
@@ -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.