Jiko · OAuth Scopes

Jiko OAuth Scopes

OAuth 2.0 searched

Jiko publishes 25 OAuth 2.0 scopes via the authorizationCode and clientCredentials flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the Jiko API on a user’s behalf.

Tokens are issued from https://authentication-portal.sandbox-api.jikoservices.com/api/oauth2/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.

CompanyBankingPaymentsTreasuryEmbedded FinanceFintechCardsSettlementBroker-DealerBanking as a Service
Scopes: 25 Flows: authorizationCode, clientCredentials Method: searched

OAuth endpoints

Authorization URL
https://authentication-portal.sandbox-api.jikoservices.com/api/oauth2/authorize
Token URL
https://authentication-portal.sandbox-api.jikoservices.com/api/oauth2/token
Flows
authorizationCodeclientCredentials

Scopes (25)

ScopeDescriptionFlows
openid OpenID Connect scope.
profile Read information for the current logged-in user.
email Read email for the current logged-in user.
phone Read phone number for the current logged-in user.
pockets.read Read pocket information for a given customer.
pockets.write Manage pocket information for a given customer.
transfers.read Read transfer and transfer request information for a given customer.
transfers.write Create transfers and/or transfer requests.
customer.read Read customer info for a given customer.
customer.write Write customer info.
team.read Read team information for a given customer.
team.write Manage teams and team members for a given customer.
onboarding.read Read onboarding information for a given customer.
onboarding.write Manage onboarding information for a given customer.
agreements.read Read agreement information for a given customer.
subscriptions.read Read webhook subscription information (from OIDC discovery; not listed on the scopes doc page).
subscriptions.write Manage webhook subscriptions (from OIDC discovery).
notifications.read Read notifications (from OIDC discovery).
notifications.write Manage notifications (from OIDC discovery).
reports.read Read reports (from OIDC discovery).
reports.write Generate/manage reports (from OIDC discovery).
approval_rules.read Read dual-authorization approval rules (from OIDC discovery).
approval_rules.write Manage dual-authorization approval rules (from OIDC discovery).
authorization_requests.read Read authorization requests (from OIDC discovery).
authorization_requests.write Manage authorization requests (from OIDC discovery).

Source

OAuth Scopes

jiko-scopes.yml Raw ↑
generated: '2026-07-19'
method: searched
source: https://authentication-portal.sandbox-api.jikoservices.com/.well-known/openid-configuration
docs: https://docs.jiko.io/products/customer-api/guides/oauth/scopes
api: jiko:jiko-customer-api
schemes:
- name: CustomerOAuth2
  flows:
  - flow: authorizationCode
    authorizationUrl: https://authentication-portal.sandbox-api.jikoservices.com/api/oauth2/authorize
    tokenUrl: https://authentication-portal.sandbox-api.jikoservices.com/api/oauth2/token
  - flow: clientCredentials
    tokenUrl: https://authentication-portal.sandbox-api.jikoservices.com/api/oauth2/token
scopes:
- scope: openid
  description: OpenID Connect scope.
- scope: profile
  description: Read information for the current logged-in user.
- scope: email
  description: Read email for the current logged-in user.
- scope: phone
  description: Read phone number for the current logged-in user.
- scope: pockets.read
  description: Read pocket information for a given customer.
- scope: pockets.write
  description: Manage pocket information for a given customer.
- scope: transfers.read
  description: Read transfer and transfer request information for a given customer.
- scope: transfers.write
  description: Create transfers and/or transfer requests.
- scope: customer.read
  description: Read customer info for a given customer.
- scope: customer.write
  description: Write customer info.
- scope: team.read
  description: Read team information for a given customer.
- scope: team.write
  description: Manage teams and team members for a given customer.
- scope: onboarding.read
  description: Read onboarding information for a given customer.
- scope: onboarding.write
  description: Manage onboarding information for a given customer.
- scope: agreements.read
  description: Read agreement information for a given customer.
- scope: subscriptions.read
  description: Read webhook subscription information (from OIDC discovery; not listed
    on the scopes doc page).
- scope: subscriptions.write
  description: Manage webhook subscriptions (from OIDC discovery).
- scope: notifications.read
  description: Read notifications (from OIDC discovery).
- scope: notifications.write
  description: Manage notifications (from OIDC discovery).
- scope: reports.read
  description: Read reports (from OIDC discovery).
- scope: reports.write
  description: Generate/manage reports (from OIDC discovery).
- scope: approval_rules.read
  description: Read dual-authorization approval rules (from OIDC discovery).
- scope: approval_rules.write
  description: Manage dual-authorization approval rules (from OIDC discovery).
- scope: authorization_requests.read
  description: Read authorization requests (from OIDC discovery).
- scope: authorization_requests.write
  description: Manage authorization requests (from OIDC discovery).