Upward Financial · OAuth Scopes

Upward Financial OAuth Scopes

OAuth 2.0 searched

Upward Financial publishes 9 OAuth 2.0 scopes via the clientCredentials and token-exchange (urn:ietf:params:oauth:grant-type:token-exchange) flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the Upward Financial API on a user’s behalf.

Tokens are issued from https://auth.upwardli.com/auth/token/.

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.

CompanyFinTechCreditCredit BuildingPaymentsCardsEmbedded FinanceBill PayBankingKYC

Scopes: 9 Flows: clientCredentials, token-exchange (urn:ietf:params:oauth:grant-type:token-exchange) Method: searched

OAuth endpoints

Token URL
https://auth.upwardli.com/auth/token/ https://auth.upwardli.com/auth/token/exchange/

Flows
clientCredentialstoken-exchange (urn:ietf:params:oauth:grant-type:token-exchange)

Scopes (9)

Scope	Description	Flows
api:read	Perform read-only operations for machine to machine (M2M) scenarios.	clientCredentials, token-exchange
api:write	Perform full CRUD operations for machine to machine (M2M) scenarios.	clientCredentials, token-exchange
ui:client-onboarding	Used for the Onboarding Client Component in combination with api:read and api:write.	clientCredentials, token-exchange
api:credit-insights:read	Access to read Credit Insights data.	clientCredentials, token-exchange
api:profile:read	Access to read Profile data.	clientCredentials, token-exchange
api:trade-line:read	Access to read Credit Line (trade line) data.	clientCredentials, token-exchange
api:rewards:read	Access to read Cashback Rewards configurations, enrollments, and offers.	clientCredentials
api:rewards:write	Access to enroll a card in Cashback Rewards.	clientCredentials
consumer:	Dynamic scope granted via token exchange only — read and write data for a specific consumer. The resulting limited token is safe to send to the client application/web browser.	token-exchange

📄 Provider scope reference: https://developers.upwardli.com/concepts/authentication/o-auth-2-0

Source

OAuth Scopes

generated: '2026-07-21'
method: searched
source: https://developers.upwardli.com/concepts/authentication/o-auth-2-0
docs: https://developers.upwardli.com/concepts/authentication/o-auth-2-0
description: >-
  OAuth 2.0 scopes for the Upward (Upwardli) Credit Suite API, captured from
  the developer portal's authentication and token-exchange documentation. The
  OpenAPI itself only declares the resulting Bearer scheme, so this scope
  reference is sourced from the docs. Partner (M2M) tokens are requested via
  client_credentials; consumer-scoped tokens are minted via RFC 8693 token
  exchange using the dynamic consumer:<upward_consumer_id> scope.
schemes:
- name: oauth2ClientCredentials
  source: https://developers.upwardli.com/concepts/authentication/o-auth-2-0
  flows:
  - flow: clientCredentials
    tokenUrl: https://auth.upwardli.com/auth/token/
- name: oauth2TokenExchange
  source: https://developers.upwardli.com/concepts/authentication/token-exchange
  flows:
  - flow: token-exchange (urn:ietf:params:oauth:grant-type:token-exchange)
    tokenUrl: https://auth.upwardli.com/auth/token/exchange/
scopes:
- scope: api:read
  description: Perform read-only operations for machine to machine (M2M) scenarios.
  flows: [clientCredentials, token-exchange]
- scope: api:write
  description: Perform full CRUD operations for machine to machine (M2M) scenarios.
  flows: [clientCredentials, token-exchange]
- scope: ui:client-onboarding
  description: >-
    Used for the Onboarding Client Component in combination with api:read and
    api:write.
  flows: [clientCredentials, token-exchange]
- scope: api:credit-insights:read
  description: Access to read Credit Insights data.
  flows: [clientCredentials, token-exchange]
- scope: api:profile:read
  description: Access to read Profile data.
  flows: [clientCredentials, token-exchange]
- scope: api:trade-line:read
  description: Access to read Credit Line (trade line) data.
  flows: [clientCredentials, token-exchange]
- scope: api:rewards:read
  description: >-
    Access to read Cashback Rewards configurations, enrollments, and offers.
  flows: [clientCredentials]
- scope: api:rewards:write
  description: Access to enroll a card in Cashback Rewards.
  flows: [clientCredentials]
- scope: consumer:<upward_consumer_id>
  description: >-
    Dynamic scope granted via token exchange only — read and write data for a
    specific consumer. The resulting limited token is safe to send to the
    client application/web browser.
  flows: [token-exchange]