Get OpenAPI 3.1 documentation
GET /obp/v7.0.0/resource-docs/API_VERSION/openapi
OBPv1.4.0-getResourceDocsOpenAPI31 No role required DocumentationAPI
Returns documentation about the RESTful resources on this server in OpenAPI 3.1 format.
API_VERSION is the version you want documentation about e.g. v6.0.0
Query Parameters
You may filter this endpoint using the following optional query parameters:
tags - Filter by endpoint tags (comma-separated list) • Example: ?tags=Account,Bank or ?tags=Account-Firehose • All endpoints are given one or more tags which are used for grouping • Empty values will return error OBP-10053
functions - Filter by function names (comma-separated list) • Example: ?functions=getBanks,bankById • Each endpoint is implemented in the OBP Scala code by a 'function' • Empty values will return error OBP-10054
content - Filter by endpoint type • Values: static, dynamic, all (case-insensitive) • static: Only show static/core API endpoints • dynamic: Only show dynamic/custom endpoints • all: Show both static and dynamic endpoints (default) • Invalid values will return error OBP-10052
locale - Language for localized documentation • Example: ?locale=en_GB or ?locale=es_ES • Supported locales: en_GB, es_ES, ro_RO • Invalid locales will return error OBP-10041
api-collection-id - Filter by API collection UUID • Example: ?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221 • Returns only endpoints belonging to the specified collection • Empty values will return error OBP-10055
This endpoint generates OpenAPI 3.1 compliant documentation with modern JSON Schema support.
For YAML format, use the corresponding endpoint: /resource-docs/API_VERSION/openapi.yaml
See the Resource Doc endpoint for more information.
Note: Resource Docs are cached, TTL is 3600 seconds
Examples
Basic usage: https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi
Filter by tags: https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account-Firehose
Filter by content type: https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=dynamic
Filter by functions: https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?functions=getBanks,bankById
Combine multiple parameters: https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&tags=Account-Firehose https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank,PSD2&functions=getBanks,bankById https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&locale=en_GB&tags=Account
Filter by API collection: https://obp-api-sandbox.nmbbank.co.tz/obp/v6.0.0/resource-docs/v6.0.0/openapi?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
User Authentication is Optional. The User need not be logged in.
URL Parameters:
API_VERSION:
JSON response body fields (0)
Possible errors (8)
- OBP-00027: Invalid API Version string. We could not find the version specified.
- OBP-00008: The API version you called is not enabled on this server. Please contact your API administrator or use another version.
- OBP-10041: This locale is not supported. Only the following can be used: en_GB, es_ES, ro_RO.
- OBP-10052: Invalid content parameter. Valid values are: static, dynamic, all
- OBP-10053: Invalid tags parameter. Tags cannot be empty when provided
- OBP-10054: Invalid functions parameter. Functions cannot be empty when provided
- OBP-10055: Invalid api-collection-id parameter. API collection ID cannot be empty when provided
- OBP-50000: Unknown Error.