API Explorer

v5.1.0 filtered by tag: PublicData (3 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Accounts at Bank

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"gh.29.uk", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getPrivateAccountsAtOneBank, operation_id: OBPv4.0.0-getPrivateAccountsAtOneBank Tags: Account, PrivateData, PublicData,

Get Public Accounts at Bank

Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"gh.29.uk", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by publicAccountsAtOneBank, operation_id: OBPv2.0.0-publicAccountsAtOneBank Tags: Account-Public, Account, PublicData,

Get Public Accounts at all Banks

Get public accounts at all banks (Anonymous access).
Returns accounts that contain at least one public view (a view where is_public is true)
For each account the API returns the ID and the available views.

Authentication is Optional

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"gh.29.uk", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30066: Could not get accounts.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by publicAccountsAllBanks, operation_id: OBPv2.0.0-publicAccountsAllBanks Tags: Account-Public, Account, PublicData,