BankSA · OAuth Scopes

BankSA OAuth Scopes

OAuth 2.0 searched

BankSA publishes 9 OAuth 2.0 scopes via the authorizationCode flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the BankSA API on a user’s behalf.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

FinancialBanksOpen BankingCDRConsumer Data RightConsumer BankingAustraliaProduct Reference Data

Scopes: 9 Flows: authorizationCode Method: searched

Scopes (9)

Scope	Description	Flows
openid	OpenID Connect authentication of the consumer.	authorizationCode
profile	Basic OpenID Connect profile claims for the consenting consumer.	authorizationCode
bank:accounts.basic:read	Read the consumer's account list and basic account attributes.
bank:accounts.detail:read	Read full detail for a specific account (features, rates, terms).
bank:transactions:read	Read transactions for the consumer's accounts.
bank:regular_payments:read	Read direct debits, scheduled payments and instalment plans on the consumer's accounts.
bank:payees:read	Read the consumer's saved payees.
common:customer.basic:read	Read the consumer's basic customer/contact information.
common:customer.detail:read	Read the consumer's detailed customer information.

📄 Provider scope reference: https://consumerdatastandardsaustralia.github.io/standards/#authorisation-scopes

Source

OAuth Scopes

generated: '2026-07-20'
method: searched
source: >-
  https://consumerdatastandardsaustralia.github.io/standards/#authorisation-scopes
  — the Consumer Data Right banking authorisation scopes. The harvested spec
  declares no oauth2 securitySchemes (auth is defined by the separate CDR
  Security Profile), so scopes are captured from the DSB Consumer Data Standards
  that BankSA's data-holder host conforms to. The public Product Reference Data
  endpoints require NO scope; every other endpoint in the spec requires the CDR
  scope mapped below, granted only through a consumer's consent to an accredited
  data recipient.
docs: https://consumerdatastandardsaustralia.github.io/standards/#authorisation-scopes
schemes:
- name: CDRConsumerDataSharing
  source: openapi/banksa-cds-banking-products-openapi.yml
  profile: FAPI 1.0 Advanced (CDR Security Profile)
  flows:
  - flow: authorizationCode
    note: >-
      Authorization/token endpoints are per-data-holder and discovered by
      accredited data recipients through the CDR Register, not published on a
      public BankSA host.
scopes:
- scope: openid
  description: OpenID Connect authentication of the consumer.
  flows: [authorizationCode]
- scope: profile
  description: Basic OpenID Connect profile claims for the consenting consumer.
  flows: [authorizationCode]
- scope: bank:accounts.basic:read
  description: Read the consumer's account list and basic account attributes.
  endpoints:
  - GET /banking/accounts
  - GET /banking/accounts/balances
  - GET /banking/accounts/{accountId}/balance
- scope: bank:accounts.detail:read
  description: Read full detail for a specific account (features, rates, terms).
  endpoints:
  - GET /banking/accounts/{accountId}
- scope: bank:transactions:read
  description: Read transactions for the consumer's accounts.
  endpoints:
  - GET /banking/accounts/{accountId}/transactions
  - GET /banking/accounts/{accountId}/transactions/{transactionId}
- scope: bank:regular_payments:read
  description: >-
    Read direct debits, scheduled payments and instalment plans on the
    consumer's accounts.
  endpoints:
  - GET /banking/accounts/{accountId}/direct-debits
  - GET /banking/accounts/{accountId}/payments/scheduled
  - GET /banking/accounts/{accountId}/payments/plans
- scope: bank:payees:read
  description: Read the consumer's saved payees.
  endpoints:
  - GET /banking/payees
  - GET /banking/payees/{payeeId}
- scope: common:customer.basic:read
  description: Read the consumer's basic customer/contact information.
- scope: common:customer.detail:read
  description: Read the consumer's detailed customer information.
public_endpoints_no_scope:
- GET /banking/products
- GET /banking/products/{productId}