Register
API Explorer 1041 endpoints
https://apisandbox.openbankproject.com

Get Entitlements for One Bank

GET /obp/v7.0.0/banks/BANK_ID/entitlements

OBPv4.0.0-getEntitlementsForBank Roles: CanGetEntitlementsForOneBank(per bank),CanGetEntitlementsForAnyBank RoleEntitlementUser

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields (5)
bank_id
gh.29.uk
entitlement_id
list
role_name
user_id
9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
Example success response 
{
  "list": [
    {
      "entitlement_id": "",
      "role_name": "",
      "bank_id": "gh.29.uk",
      "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 getEntitlementsForBank Originally /obp/v4.0.0/banks/BANK_ID/entitlements