Up · OAuth Scopes

Up OAuth Scopes

OAuth 2.0 searched

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

Scopes: 10 Flows: Method: searched

Scopes (10)

Scope	Description	Flows
openid	OpenID Connect authentication; issue an ID token.	authorization_code
profile	Access to basic OpenID profile claims (name, given_name, etc.).	authorization_code
bank:accounts.basic:read	CDR — read basic banking account data (masked account numbers, balances).	authorization_code
bank:accounts.detail:read	CDR — read detailed banking account data (full account numbers, features).	authorization_code
bank:transactions:read	CDR — read banking transaction data.	authorization_code
bank:payees:read	CDR — read saved payees.	authorization_code
bank:regular_payments:read	CDR — read direct debits and scheduled/regular payments.	authorization_code
common:customer.basic:read	CDR — read basic customer data (name, occupation / organisation basics).	authorization_code
common:customer.detail:read	CDR — read detailed customer data (contact details).	authorization_code
cdr:registration	CDR dynamic client registration management.	client_credentials

📄 Provider scope reference: https://consumerdatastandardsaustralia.github.io/standards/#security-profile

Source

OAuth Scopes

generated: '2026-07-20'
method: searched
source: https://api.up.com.au/.well-known/openid-configuration
docs: https://consumerdatastandardsaustralia.github.io/standards/#security-profile
context: >-
  These OAuth2 / OpenID Connect scopes are advertised by Up's Consumer Data
  Right (CDR) OpenID Provider metadata at
  https://api.up.com.au/.well-known/openid-configuration. They govern the CDR
  data-sharing flow used by ACCREDITED DATA RECIPIENTS (not the personal
  developer API, which uses a Personal Access Token). Access follows the CDR /
  FAPI security profile: pushed authorization requests (required),
  private_key_jwt client authentication, mTLS-bound access tokens, and the
  authorization_code + client_credentials grants. The scope semantics are the
  Australian CDR standard scopes defined by the Data Standards Body.
schemes:
  - name: CDR-OIDC
    type: openIdConnect
    openIdConnectUrl: https://api.up.com.au/.well-known/openid-configuration
    issuer: https://api.up.com.au
    authorizationUrl: https://api.up.com.au/oidc/authorize
    tokenUrl: https://secure.api.up.com.au/oidc/token
    grant_types: [authorization_code, refresh_token, client_credentials]
    source: https://api.up.com.au/.well-known/openid-configuration
scopes:
  - scope: openid
    description: OpenID Connect authentication; issue an ID token.
    flows: [authorization_code]
  - scope: profile
    description: Access to basic OpenID profile claims (name, given_name, etc.).
    flows: [authorization_code]
  - scope: bank:accounts.basic:read
    description: CDR — read basic banking account data (masked account numbers, balances).
    flows: [authorization_code]
  - scope: bank:accounts.detail:read
    description: CDR — read detailed banking account data (full account numbers, features).
    flows: [authorization_code]
  - scope: bank:transactions:read
    description: CDR — read banking transaction data.
    flows: [authorization_code]
  - scope: bank:payees:read
    description: CDR — read saved payees.
    flows: [authorization_code]
  - scope: bank:regular_payments:read
    description: CDR — read direct debits and scheduled/regular payments.
    flows: [authorization_code]
  - scope: common:customer.basic:read
    description: CDR — read basic customer data (name, occupation / organisation basics).
    flows: [authorization_code]
  - scope: common:customer.detail:read
    description: CDR — read detailed customer data (contact details).
    flows: [authorization_code]
  - scope: cdr:registration
    description: CDR dynamic client registration management.
    flows: [client_credentials]