Core Banking Services
    Core Banking Services
    • Introduction
    • Terminologies
    • Webhooks
    • Authentication
    • Account
      • Product List
        GET
      • Create Account
        POST
      • Find Client
        POST
      • Accounts
        GET
      • Create Additional Account
        POST
      • Account Details By BVN
        GET
      • Get Client Addresses
        GET
      • Get Account Details
        GET
      • Get Account Summary
        GET
      • Client Images
        GET
      • Update BVN
        POST
      • Update Transaction Limit
        POST
    • KYC
      • Get KYC Info
        POST
      • Update KYC
        POST
    • Transaction
      • Payment Types
        GET
      • Debit Account
        POST
      • Credit Account
        POST
      • Transaction History
        GET
      • Transaction Details
        GET
    • Transfer
      • Get Institutions
        GET
      • Name Inquiry
        POST
      • Interbank Transfer
        POST
      • InterBank Transfer Query
        GET
      • Transfer Details
        GET
      • IntraBank Transfer
        POST
      • Intrabank Transfer To Virtual Accounts
        POST
    • Reporting
      • Report Types
      • Get Report Parameters
      • Create Report
      • Report Details
      • Get Reports

    Authentication

    Overview#

    The Core Banking API uses OAuth 2.0 Client Authentication to ensure secure access and protect customer data. This authentication method allows authorized applications to interact with the API while preventing unauthorized access.
    OAuth 2.0 provides a robust, token-based authentication mechanism that enables secure communication between clients and the banking system without exposing sensitive credentials.

    Authentication Flow#

    The OAuth 2.0 authentication process follows these steps:

    1. Credentials#

    Before accessing the API, developers must obtain the following from the financial institution:
    1.
    Client ID
    2.
    Client Secret Key
    3.
    Host URL
    4.
    Token URL
    To request these credentials, contact the financial institution.

    2. Token Request#

    A POST request must be sent to the token URL to obtain an access token. Below is an example of a token request.



    3. Token Response#

    If authentication is successful, the API returns an Access Token, which is required for subsequent requests.
    The token has an expiration time, after which a new token must be requested.



    4. Authorized Requests#

    Once an OAuth 2.0 access token is obtained, it must be included in API requests to authenticate and authorize access to protected resources. The Authorization header in the request must contain the access token in the Bearer Token format.

    Modified at 2025-02-19 18:54:56
    Previous
    Webhooks
    Next
    Product List
    Built with