{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v5.1.0"},"host":"api3.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v5.1.0/banks/{BANK_ID}/accounts":{"get":{"tags":["Account","PrivateData","PublicData"],"summary":"Get Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the views available to the user..
Each account must have at least one private View.
optional request parameters for filter with attributes
URL params example: /banks/some-bank-id/accounts?manager=John&count=8
Authentication is Mandatory
","operationId":"getPrivateAccountsAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.1.0/my/accounts":{"get":{"tags":["Account","Account Information Service (AIS)","PrivateData","PSD2"],"summary":"Get Accounts at all Banks (private)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the list of accounts containing private views for the user.
Each account lists the views available to the user.
optional request parameters:
whole url example:
/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
","operationId":"corePrivateAccountsAllBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CoreAccountsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"BasicAccountJSON":{"required":["id","label","bank_id","views_available"],"properties":{"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"label":{"type":"string","example":"NoneLabel"},"bank_id":{"type":"string","example":"gh.29.uk"},"views_available":{"type":"array","items":{"$ref":"#/definitions/BasicViewJson"}}}},"CoreAccountJson":{"required":["account_routings","label","account_type","bank_id","id","views"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"String"},"account_type":{"type":"string","example":"330"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"views":{"type":"array","items":{"$ref":"#/definitions/ViewBasicV300"}}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"AccountNumber"},"address":{"type":"string","example":"4930396"}}},"BasicViewJson":{"required":["id","short_name","is_public"],"properties":{"id":{"type":"string","example":"1"},"short_name":{"type":"string","example":"HHH"},"is_public":{"type":"boolean","example":"true"}}},"BasicAccountsJSON":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/BasicAccountJSON"}}}},"ViewBasicV300":{"required":["id","short_name","description","is_public"],"properties":{"id":{"type":"string","example":"owner"},"short_name":{"type":"string","example":"Owner"},"description":{"type":"string","example":"This view is for the owner for the account."},"is_public":{"type":"boolean","example":"false"}}},"CoreAccountsJsonV300":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/CoreAccountJson"}}}}}}