Skip to main content
Logo
API Documentation Status page Submit a request
Sign in
  1. Bank Account Data
  2. Bank Account Data API
  3. Authentication

Defining data access scope

By default, GoCardless Bank Account Data API allows you to access 3 major data blocks via the platform - account details, account balances, and transactions. For some use cases, not all data blocks are needed, therefore, we have enabled a feature that allows our customers to define which data blocks they will be asking end users to give access to. This feature is currently available for specific banks only and will be rolled out for other integrations gradually based on prioritization and demand.

How to apply this feature 

To apply customised consent, you would need to define access scope when creating an end user agreement. 

POST /api/agreements/enduser/ endpoint includes example on how to pass values for access_scope. Refer to Quickstart Step 3 for more details and examples.

Note that Polish banks only allow creating combined consent for details and balances so both values needs to be passed in case one wants to access only details information but exclude transaction information. Once the access scope is defined, end user will be presented with the customised consent, and only specified data blocks will be available from a bank after successful authentication.

Was this article helpful?
  • Promoted articles

    • Bank Account Data API Usage - how is your usage number calculated
    • EEA 180-day access
    • Bank Account Data API Rate Limits
    • How to recognise and handle end user authentication errors
    • Account Endpoint Errors and Suspended Accounts
  • Recently Added Articles

  • Top Articles

Bank Account Data Quickstart Guide

Simple and streamlined guide to start using our Bank Accoun Data API

Quickstart Guide

Demo page of our Bank Account Data API

See the product in action with few easy clicks

Bank Account Data Demo

Need Support?

Contact us

We're available Monday to Friday, 9am-5pm GMT

Quick links

Knowledge base

About GoCardless

Legal
Privacy
Security
Blog

Support

Contact support
Complaints
Contact sales

API Documentation

Developer documents

GoCardless Ltd, Sutton Yard, 65 Goswell Road, London, EC1V 7EN, United Kingdom


GoCardless Ltd (company registration number 07495895) is authorised by the Financial Conduct Authority under the Payment Services Regulations 2017, registration number 597190, for the provision of payment services.





https://docs.google.com/spreadsheets/d/1EZ5n7QDGaRIot5M86dwqd5UFSGEDTeTRzEq3D9uEDkM/edit?gid=976380583#gid=976380583
/hc/theming_assets/01JVYEMDH4NW2KMNM8HG9Y2GXA
Detailed bank coverage
A detailed list of the available institutions and specifications.
custom
https://gocardless.com/stories/bondora/
/hc/theming_assets/01JKWXK6T8QZWQQSYYJAD0X703
Our latest customer story
Learn about how companies are using our technology.
custom
https://developer.gocardless.com/bank-account-data/overview
/hc/theming_assets/01JVYEMQ0208DBSNG2GPZRZ36T
Developer Docs
All the documentation you need to integrate with our API.
Rate Limits, Access expired, Requisition