API Explorer 1 endpoints

Get My Banks

GET /obp/v7.0.0/my/banks

OBPv7.0.0-getMyBanks No role required Bank

Returns the banks belonging to the current User — created directly by the User, or created by an agent acting for the User under a Consent.

Delegation is resolved server-side from the Consent records: when the caller is a consent-based agent, the list shows the granting User's banks; when the caller is the User, the list includes banks created by any of their consent-based agents. Nothing is accepted from the caller to influence this resolution.

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

JSON response body fields (7)
bank_code
CGHZ
bank_id
gh.29.uk
bank_routings
bank routing in form of (scheme, address)
banks
full_name
full name string
logo
logo url
website
www.openbankproject.com
Example success response
{
  "banks": [
    {
      "bank_id": "granite-astra-falcon-4f2a",
      "bank_code": "",
      "full_name": "Granite Astra Falcon Bank",
      "logo": "",
      "website": "",
      "bank_routings": []
    }
  ]
}
Possible errors (2)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getMyBanks