Update Current Consumer Platform App
PUT /obp/v7.0.0/consumers/current/platform-app
OBPv7.0.0-updateCurrentConsumerPlatformApp No role required ConsumerScope
Declare the Scopes the calling Consumer needs, as a Platform App: for each, the Role, its bank_id
(a bank id, SYS for the system space of Dynamic Entities, or empty for a system Role), what it is
needed_for (1 to 1000 characters, written for the administrator deciding whether
to grant it) and whether it is optional. The declaration replaces the previous one. version is
the app's own version, if it wants to report it.
No Role is required, and an Application on its own may call it (client credentials or a Consumer Key), so an app can declare its needs at startup. The Consumer must first be marked as a Platform App by an administrator, otherwise the call gets OBP-35046: This Consumer is not a Platform App. An administrator marks a Consumer as a Platform App first (POST /management/platform-apps).
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 Optional. The User need not be logged in.
This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.
This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.
This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.
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
{
"version": "1.1.0",
"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
}
]
}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 (5)
- OBP-20200: The application cannot be identified.
- OBP-10001: Incorrect json format.
- OBP-35046: This Consumer is not a Platform App. An administrator marks a Consumer as a Platform App first (POST /management/platform-apps).
- OBP-35048: Invalid Platform App declaration. Send at most 100 required_scopes, each with a known role_name, a bank_id that suits the Role (empty for a system Role), and needed_for between 1 and 1000 characters; version is at most 100 characters.
- OBP-50000: Unknown Error.