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

Create Platform App

POST /obp/v7.0.0/management/platform-apps

OBPv7.0.0-createPlatformApp Roles: CanCreatePlatformApp ConsumerScope

Mark a Consumer as a Platform App, with the name administrators will know it by (label, 1 to 100 characters). Once marked, the app can declare the Scopes it needs with Update Current Consumer Platform App.

A Platform App is a Consumer an installation runs as part of its own deployment, for example the Portal or the API Manager, which calls OBP with its own application token. An administrator marks the Consumer as a Platform App; the app then declares, as itself, the Scopes it needs and what they are needed for, and the administrator can see which of them its Consumer holds.

For more information see here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields (2)
consumer_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
label
My Account
JSON response body fields (14)
bank_id
gh.29.uk
consumer_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
consumer_name
consumer_name
held
held
label
My Account
marked_at
marked_at
marked_by_user_id
marked_by_user_id
needed_for
needed_for
optional
optional
required_scopes
required_scopes
role_name
state
declared_at
declared_at
version
Example request body 
{
  "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "label": "Portal"
}
Example success response 
{
  "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "consumer_name": "obp-portal-client",
  "label": "Portal",
  "marked_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "marked_at": "2026-10-21T01:45:41Z",
  "declared_at": "2026-10-21T01:45:41Z",
  "version": "1.1.0",
  "state": "missing",
  "required_scopes": [
    {
      "role_name": "CanGetDynamicEntityRecord_obp_portal_page",
      "bank_id": "SYS",
      "needed_for": "Showing the pages published with App Studio at /pages, to every visitor.",
      "optional": false,
      "held": false
    }
  ]
}
Possible errors (7)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-35047: Invalid Platform App. label must be between 1 and 100 characters.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-35045: This Consumer is already a Platform App.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 createPlatformApp