Account Number Integration Guide

Overview

The Account Number lookup service allows you to retrieve information associated with a bank account number. Follow the steps below to integrate this functionality into your application.

Prerequisites

To get started, please ensure to:

• Sign up on the Mono Dashboard.
• Create an App and fetch the generated Secret Key.

Integration Steps

Step 1: Make a Lookup Request

Send a POST request to the following endpoint to initiate the account number lookup:

POST https://api.withmono.com/v3/lookup/account-number

Request Body Parameters

• nip_code (required): The nip code associated with the account. See the list of banks and their nip_codes here
• account_number (required): The 10-digit bank account number to lookup.

Include these two parameters in the request body to specify the bank and account number for the lookup.

Request Headers

Include the following header in your request:

• mono-sec-key (required): Your Mono secret key for authentication.

cURL Sample Request

curl -X POST \
  -H "Content-Type: application/json" \
  -H "mono-sec-key: YOUR_MONO_SECRET_KEY" \
  -d '{
    "nip_code": "000013",
    "account_number": "0000000"
  }' \
  https://api.withmono.com/v3/lookup/account-number

Step 2: Process the Response

If the request is successful, you will receive the following response:

{
    "status": "successful",
    "message": "Lookup Successful",
    "timestamp": "2024-02-28T15:00:20.917Z",
    "data": {
        "name": "SAMUEL OLAMIDE NOMO",
        "account_number": "0000000",
        "bvn": "0000000000",
        "bank": {
          "name": "GTBank",
          "code": "000013"
        }
    }
}

The response contains detailed information about the account, including the account holder's name, account number, associated BVN, and bank details such as the bank name and code.