Register
API Explorer 936 endpoints
https://obp-api-sandbox.nmbbank.co.tz

Get Scanned API Versions

GET /obp/v7.0.0/api/versions

OBPv6.0.0-getScannedApiVersions No role required DocumentationAPI

Get all scanned API versions available in this codebase.

This endpoint returns all API versions that have been discovered/scanned, along with their active status.

Response Fields (3)
Active Status
**
Use Cases
**
Note
** This differs from v4.0.0's `/api/versions` endpoint which shows all scanned versions without is_active status.
  • url_prefix: The URL prefix for the version (e.g., "obp", "berlin-group", "open-banking")
  • api_standard: The API standard name (e.g., "OBP", "BG", "UK", "STET")
  • api_short_version: The version number (e.g., "v4.0.0", "v1.3")
  • fully_qualified_version: The fully qualified version combining standard and version (e.g., "OBPv4.0.0", "BGv1.3")
  • is_active: Boolean indicating if the version is currently enabled and accessible
  • is_active=true: Version is enabled and can be accessed via its URL prefix
  • is_active=false: Version is scanned but disabled (via api_disabled_versions props)
  • Discover what API versions are available in the codebase
  • Check which versions are currently enabled
  • Verify that disabled versions configuration is working correctly
  • API documentation and discovery User Authentication is Optional. The User need not be logged in.
JSON response body fields (5)
api_short_version
api_short_version
api_standard
api_standard
fully_qualified_version
fully_qualified_version
is_active
false
url_prefix
url_prefix
Example success response 
{
  "scanned_api_versions": [
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v1.2.1",
      "fully_qualified_version": "OBPv1.2.1",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v1.3.0",
      "fully_qualified_version": "OBPv1.3.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v1.4.0",
      "fully_qualified_version": "OBPv1.4.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v2.0.0",
      "fully_qualified_version": "OBPv2.0.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v2.1.0",
      "fully_qualified_version": "OBPv2.1.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v2.2.0",
      "fully_qualified_version": "OBPv2.2.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v3.0.0",
      "fully_qualified_version": "OBPv3.0.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v3.1.0",
      "fully_qualified_version": "OBPv3.1.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v4.0.0",
      "fully_qualified_version": "OBPv4.0.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v5.0.0",
      "fully_qualified_version": "OBPv5.0.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v5.1.0",
      "fully_qualified_version": "OBPv5.1.0",
      "is_active": true
    },
    {
      "url_prefix": "obp",
      "api_standard": "OBP",
      "api_short_version": "v6.0.0",
      "fully_qualified_version": "OBPv6.0.0",
      "is_active": true
    },
    {
      "url_prefix": "berlin-group",
      "api_standard": "BG",
      "api_short_version": "v1.3",
      "fully_qualified_version": "BGv1.3",
      "is_active": false
    }
  ]
}
Possible errors (1)
  • OBP-50000: Unknown Error.
Implemented by OBPv6.0.0 getScannedApiVersions Originally /obp/v6.0.0/api/versions