Learn how to authenticate your application and securely access SingleView API services
SingleView Open Banking APIs use a robust authentication and authorization framework to ensure secure access to API services and financial data. This framework verifies the identity of the client application and ensures that only authorized requests can interact with the platform.
Before accessing any SingleView Open Banking API, the client application must authenticate itself and obtain authorization credentials. These credentials must be included in API requests to validate the request and allow the system to process it securely.
This section explains the key authentication components and credentials required to successfully interact with the SingleView APIs.
SingleView Open Banking APIs can be accessed in two environments using their corresponding domain endpoints:
Environment | Domain |
|---|---|
| |
| To be provided upon successful onboarding to the LIVE environment |
SingleView Open Banking platform currently supports Open Banking services in the Kingdom of Saudi Arabia (KSA).
These services operate under the regulatory framework established by the Saudi Central Bank (SAMA) and follow the Saudi Open Banking Framework.
SingleView integrates with participating banks within this ecosystem to enable secure financial data sharing through standardized APIs.
SingleView supports Mutual TLS authentication for enhanced security.. Mutual Transport Layer Security (mTLS) is a mutual authentication method that verifies the parties at each end of a network connection by using a private key.
mTLS Setup Process
The following steps are involved while creating an mTLS protocol:
To make API calls to the SingleView Open Banking platform, the client must provide the following credentials as part of the request.
clientId is a unique identifier assigned to every registered client application. It is used to identify the application making the API request.
Each application created in the SingleView Console is assigned a distinct clientId.
To retrieve your clientId, navigate to:
Console → App Settings → Credentials → Client ID
clientCode, also referred to as the Client Secret, is a confidential credential associated with the client application. It is used along with the clientId to authenticate the client when requesting an access token.
The clientCode must be stored securely and never exposed in public environments.
To view your clientCode, navigate to:
Console → App Settings → Credentials → Client Code
The Access Token is a security credential used to authorize API requests to the SingleView platform. It is generated through the Access Token API using the client’s credentials.
Once issued, the access token must be included in the Authorization header of all protected API requests.
A valid access token is required to access SingleView API services. Requests made with an invalid, expired, or missing token will be rejected.
For details on generating an access token, refer to the Access Token page.
To successfully interact with the SingleView APIs, follow the steps below:
clientId and clientCodeNote that any Data API service can only be accessed only through an active consent
This process ensures that all API interactions are secure, authenticated, and authorized.