{"resource_docs":[{"operation_id":"OBPv2.0.0-publicAccountsAllBanks","implemented_by":{"version":"OBPv2.0.0","function":"publicAccountsAllBanks"},"request_verb":"GET","request_url":"/obp/v2.0.0/accounts/public","summary":"Get Public Accounts at all Banks","description":"
Get public accounts at all banks (Anonymous access).
\nReturns accounts that contain at least one public view (a view where is_public is true)
\nFor each account the API returns the ID and the available views.
Authentication is Optional
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\n","description_markdown":"Get public accounts at all banks (Anonymous access).\nReturns accounts that contain at least one public view (a view where is_public is true)\nFor each account the API returns the ID and the available views.\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-30066: Could not get accounts.","OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/accounts/public","connector_methods":[]},{"operation_id":"OBPv2.0.0-publicAccountsAtOneBank","implemented_by":{"version":"OBPv2.0.0","function":"publicAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/public","summary":"Get Public Accounts at Bank","description":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\n","description_markdown":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/public","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getPrivateAccountsAtOneBank","implemented_by":{"version":"OBPv4.0.0","function":"getPrivateAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts","summary":"Get Accounts at Bank","description":"Returns the list of accounts at BANK_ID that the user has access to.
\nFor each account the API returns the account ID and the views available to the user..
\nEach account must have at least one private View.
optional request parameters for filter with attributes
\nURL params example: /banks/some-bank-id/accounts?manager=John&count=8
Authentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: true
\nlabel: My Account
\n\n\n","description_markdown":"Returns the list of accounts at BANK_ID that the user has access to.\nFor each account the API returns the account ID and the views available to the user..\nEach account must have at least one private View.\n\noptional request parameters for filter with attributes\nURL params example: /banks/some-bank-id/accounts?manager=John&count=8\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): true\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["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."],"tags":["Account","PrivateData","PublicData"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts","connector_methods":["obp.getBankAccounts"]}]}