Open BankingB2B SuiteERP Integration
GuidesChangelog
Menu

Categories

Open BankingB2B SuiteERP Integration


  • GENERAL INFORMATION

    • Documentation guide
    • Documentation guide
    • SingleView B2B Core APIs
    • SingleView Open Banking
    • Platform architecture
    • KSAOB standards
    • Security best practices
  • Getting started

    • Introduction
    • Become a User
    • Quick Lookup
  • GETTING STARTED

    • Integration guide
    • Become a user
    • Integration guide
    • Prerequisites for Sandbox
    • Developer console
    • Establishing secure connection
    • Establish secure connection
    • Authenticating your request
    • Generate access token
    • Making your first test api call
    • Make test raw data API call
    • Prerequisites for production
    • Make test data use case API call
    • Moving to production
  • Authentication

    • Generate Signature
  • ERP API Services

    • Configure API Account
    • Create Group & Company
    • Supplier Services
    • Account Services
    • Balance Enquiry
    • Statements
    • IBAN Validation
    • POS Transactions
  • CONSENT MANAGEMENT

    • Overview
    • Create a consent
    • Retrieve consent details
    • Revoke a consent
  • AUTHENTICATION

    • Header parameters
    • Obtain access token
    • Generate signature
  • Data APIs

    • Account statement
    • Balance enquiry
    • IBAN verification
    • POS transactions
    • Raw statement
  • Raw Data APIs

    • Introduction
    • View accounts
    • View balance
    • View transactions
    • Identify account holders (Parties)
    • Review direct debits
    • Review scheduled payments
    • Review standing orders
  • Payment APIs

  • DATA USE CASE APIS

  • SADAD

  • Plug-and-Play Integrations

    • Payly
  • RESOURCES

    • POR Details
    • Error codes
    • Errors & codes
    • Collections
    • API version management
    • Bank connectivity
  • API Archives


Consent overview

Manage customer authorization for secure access to financial data through Data APIs

Access to financial data through Data APIs is governed by a secure, consent-based authorization process. Before an application can retrieve any customer financial data, the customer must explicitly grant permission for the requested access.

Consent management ensures that customers remain in control of how their financial information is shared and used. Through the SingleView Open Banking platform, applications can create, retrieve, and revoke consent for accessing account information.

Consent Lifecycle

A consent follows a defined lifecycle within the Data API integration process.

Consent lifecycle
Consent lifecycle

 

This process ensures that financial data access remains transparent, secure, and user-controlled.

Security and Compliance

Consent management is designed to align with Open Banking security and regulatory requirements. Key principles include:

  • Explicit customer authorization before accessing financial data
  • Secure authentication through the customer’s bank
  • Time-bound consent validity
  • Ability for customers or applications to revoke consent

These safeguards ensure that data access remains secure, transparent, and compliant with Open Banking standards.

Consent Management Options

Consent management in Data APIs typically involves three core operations:

  • Create a consent
  • Retrieve consent details
  • Revoke a consent

Together, these operations allow applications to securely request, verify, and terminate access to customer financial data.

Consent Scope and Permissions

When creating a consent, the application must specify the scope and permissions that define the type of financial data it intends to access. These permissions determine which API services can be used after the customer authorizes the consent.

During consent creation, the request should include the appropriate permission values corresponding to the required services, such as accessing account details, balances, or transaction information. Only the APIs associated with the approved permissions will be accessible using the generated Consent ID.

Ensure that the correct permissions are included in the consent request based on the API services your application needs to access.

Scope

useCaseType

Permissions

To access all Raw Data API services:

  • Accounts
  • Balances
  • Transactions
  • Parties
  • Standing Orders
  • Scheduled Payments
  • Direct Debits

AISP

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadParty", 

"ReadPartyPSU", 

"ReadPartyPSUIdentity", 

"ReadBeneficiariesBasic", 

"ReadBeneficiariesDetail", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

"ReadScheduledPaymentsBasic", 

"ReadScheduledPaymentsDetail", 

"ReadDirectDebits", 

"ReadStandingOrdersBasic", 

"ReadStandingOrdersDetail"

To access Account Aggregation service under Data Use Case APIs

ACCOUNTAGGREGATION

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadParty", 

"ReadPartyPSU", 

"ReadPartyPSUIdentity", 

"ReadBeneficiariesBasic", 

"ReadBeneficiariesDetail", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

"ReadScheduledPaymentsBasic", 

"ReadScheduledPaymentsDetail", 

"ReadDirectDebits", 

"ReadStandingOrdersBasic", 

"ReadStandingOrdersDetail"

To access Account Check service under Data Use Case APIs

ACCOUNTCHECK

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadParty", 

"ReadPartyPSU", 

"ReadPartyPSUIdentity", 

To access Account Aggregation service under Data Use Case APIs

BALANCECHECK

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances",

To access Credit Check service under Data Use Case APIs

CREDITCHECK

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

To access Customer Verification service under Data Use Case APIs

CUSTOMERVERIFICATION

"ReadParty", 

"ReadPartyPSU", 

"ReadPartyPSUIdentity", 

To access Data Enrichment service under Data Use Case APIs

DATA-ENRICHMENT

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

To access E-Statement service under Data Use Case APIs

E-STMT

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

To access Expense Check service under Data Use Case APIs

EXPENSECHECK

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

To access IBAN Validation service under Data Use Case APIs

IBANVALIDATIONS

"ReadAccountsBasic", 

"ReadAccountsDetail", 

To access Income Check service under Data Use Case APIs

INCOMECHECK

"ReadAccountsBasic", 

"ReadAccountsDetail", 

"ReadBalances", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

To access KYC service under Data Use Case APIs

KYC

"ReadParty", 

"ReadPartyPSU", 

"ReadPartyPSUIdentity", 

"ReadTransactionsBasic", 

"ReadTransactionsDetail", 

"ReadTransactionsCredits", 

"ReadTransactionsDebits", 

Updated July 2, 2026

Was this helpful?