Bank First · OAuth Scopes

Bank First OAuth Scopes

OAuth 2.0 searched

Bank First publishes 7 OAuth 2.0 scopes. Scopes are the fine-grained permissions an application requests at authorization time to act against the Bank First 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 BankingAustraliaMutual BankProduct Reference Data

Scopes: 7 Flows: Method: searched

Scopes (7)

Scope	Description	Flows
bank:accounts.basic:read	Read basic account information (masked account numbers, product category, balances context).
bank:accounts.detail:read	Read detailed account information including account numbers and terms.
bank:transactions:read	Read account transactions.
bank:payees:read	Read saved payees.
bank:regular_payments:read	Read direct debits and scheduled/regular payments.
common:customer.basic:read	Read basic customer identity (name, organisation).
common:customer.detail:read	Read detailed customer identity (contact details).

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

Source

OAuth Scopes

generated: '2026-07-20'
method: searched
source: openapi/bank-first-cds-banking-products-openapi.yml
docs: https://consumerdatastandardsaustralia.github.io/standards/#authorisation-scopes
note: >-
  The public PRD API requires NO scopes (unauthenticated). These scopes govern the
  CDR consumer data sharing surface, which only Accredited Data Recipients may
  request via the CDR consent flow. The scope set below is the CDR banking + common
  scope family referenced by the x-scopes extension on the standard's operations.
schemes:
  - name: CDR-OAuth2-OIDC
    type: oauth2
    flow: authorizationCode
    authorizationUrl: (per-holder, discovered via CDR Register / OIDC configuration)
    tokenUrl: (per-holder, discovered via CDR Register / OIDC configuration)
    source: openapi/bank-first-cds-banking-products-openapi.yml
scopes:
  - scope: bank:accounts.basic:read
    description: Read basic account information (masked account numbers, product category, balances context).
    sources: [openapi/bank-first-cds-banking-products-openapi.yml]
  - scope: bank:accounts.detail:read
    description: Read detailed account information including account numbers and terms.
    sources: [openapi/bank-first-cds-banking-products-openapi.yml]
  - scope: bank:transactions:read
    description: Read account transactions.
    sources: [openapi/bank-first-cds-banking-products-openapi.yml]
  - scope: bank:payees:read
    description: Read saved payees.
    sources: [openapi/bank-first-cds-banking-products-openapi.yml]
  - scope: bank:regular_payments:read
    description: Read direct debits and scheduled/regular payments.
    sources: [openapi/bank-first-cds-banking-products-openapi.yml]
  - scope: common:customer.basic:read
    description: Read basic customer identity (name, organisation).
    sources: [Consumer Data Standards]
  - scope: common:customer.detail:read
    description: Read detailed customer identity (contact details).
    sources: [Consumer Data Standards]