Orum · OAuth Scopes

Orum OAuth Scopes

OAuth 2.0 searched

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

Tokens are issued from https://api-sandbox.orum.io/oauth/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.

CompanyPaymentsFintechBankingInstant PaymentsACHMoney MovementBank Account Verification

Scopes: 29 Flows: clientCredentials Method: searched

OAuth endpoints

Token URL
https://api-sandbox.orum.io/oauth/token

Flows
clientCredentials

Scopes (29)

Scope	Description	Flows
invoke:webhook	Invoke webhook	clientCredentials
read:balances	Read balances	clientCredentials
read:booktransfers	Read book transfers	clientCredentials
read:businesses	Read businesses	clientCredentials
read:cards	Read cards	clientCredentials
read:external-accounts	Read external accounts	clientCredentials
read:persons	Read persons	clientCredentials
read:reports	Read reports	clientCredentials
read:routing-number-eligibility	Read routing number eligibility	clientCredentials
read:schedules	Read schedules	clientCredentials
read:subledgers	Read subledgers	clientCredentials
read:transfer-groups	Read transfer groups	clientCredentials
read:transfers	Read transfers	clientCredentials
read:verify-accounts	Read verify accounts	clientCredentials
read:webhook-configurations	Read webhook configurations	clientCredentials
read:webhook-secret	Read webhook secret	clientCredentials
write:booktransfers	Write book transfers	clientCredentials
write:businesses	Write businesses	clientCredentials
write:cards	Write cards	clientCredentials
write:external-accounts	Write external accounts	clientCredentials
write:persons	Write persons	clientCredentials
write:reports	Write reports	clientCredentials
write:schedules	Write schedules	clientCredentials
write:subledgers	Write subledgers	clientCredentials
write:transfer-groups	Write transfer groups	clientCredentials
write:transfers	Write transfers	clientCredentials
write:verify-accounts	Write verify accounts	clientCredentials
write:webhook-configurations	Write webhook configurations	clientCredentials
write:webhook-secret	Write webhook secret	clientCredentials

📄 Provider scope reference: https://docs.orum.io/guides/api-authentication

Source

OAuth Scopes

generated: '2026-07-20'
method: searched
source: openapi/orum-openapi-original.yml
docs: https://docs.orum.io/guides/api-authentication
schemes:
- name: oauth2
  source: openapi/orum-openapi-original.yml
  flows:
  - flow: clientCredentials
    tokenUrl: https://api-sandbox.orum.io/oauth/token
scopes:
- scope: invoke:webhook
  description: Invoke webhook
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:balances
  description: Read balances
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:booktransfers
  description: Read book transfers
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:businesses
  description: Read businesses
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:cards
  description: Read cards
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:external-accounts
  description: Read external accounts
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:persons
  description: Read persons
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:reports
  description: Read reports
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:routing-number-eligibility
  description: Read routing number eligibility
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:schedules
  description: Read schedules
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:subledgers
  description: Read subledgers
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:transfer-groups
  description: Read transfer groups
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:transfers
  description: Read transfers
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:verify-accounts
  description: Read verify accounts
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:webhook-configurations
  description: Read webhook configurations
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: read:webhook-secret
  description: Read webhook secret
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:booktransfers
  description: Write book transfers
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:businesses
  description: Write businesses
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:cards
  description: Write cards
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:external-accounts
  description: Write external accounts
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:persons
  description: Write persons
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:reports
  description: Write reports
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:schedules
  description: Write schedules
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:subledgers
  description: Write subledgers
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:transfer-groups
  description: Write transfer groups
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:transfers
  description: Write transfers
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:verify-accounts
  description: Write verify accounts
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:webhook-configurations
  description: Write webhook configurations
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml
- scope: write:webhook-secret
  description: Write webhook secret
  flows:
  - clientCredentials
  sources:
  - openapi/orum-openapi-original.yml