Integration Guide

Overview

The 360View lookup service allows you to retrieve all the bank accounts linked to a BVN or phone 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 ➡

Step 1: Make a Lookup Request

To fetch the linked accounts, send a POST request to the following endpoint:

POST https://api.withmono.com/v1/lookup/360view

Request Body Parameters

mode (required): Specify the mode as either "BVN" or "PHONE" to indicate the lookup type.
number (required): Provide the 11-digit phone number or BVN for the lookup.

Include these two parameters in the request body to specify the lookup mode and the associated phone number or BVN.

Request Headers

Include the following header in your request for authentication:

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

cURL Sample Request

curl -X POST \
  -H "Content-Type: application/json" \
  -H "mono-sec-key: YOUR_MONO_SECRET_KEY" \
  -d '{
    "mode": "PHONE",
    "number": "XXXXXXXXXXX"
  }' \
  https://api.withmono.com/v1/lookup/360view

Step 2: Process the Response

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

{
  "message": "Successfully fetched linked accounts.",
  "data": [
    {
      "accountNumber": "005****331",
      "institution": {
        "_id": "5f2d08bf60b92e2888287703",
        "name": "Access Bank",
        "bankCode": "044",
        "icon": "https://mono-public-bucket.s3.eu-west-2.amazonaws.com/images/access-bank-icon.png"
      }
    },
    {
      "accountNumber": "015****747",
      "institution": {
        "_id": "5f2d08be60b92e2888287702",
        "name": "GTBank",
        "bankCode": "058",
        "icon": "https://mono-public-bucket.s3.eu-west-2.amazonaws.com/images/gtbank-icon.png"
      }
    },
    {
      "accountNumber": "080****534",
      "institution": {
        "_id": "5f6de706800d071e5566ef7d",
        "name": "Access Bank",
        "bankCode": "044",
        "icon": "https://mono-public-bucket.s3.eu-west-2.amazonaws.com/images/access-bank-icon.png"
      }
    },
    {
      "accountNumber": "200****577",
      "institution": {
        "_id": "5f2d08bf60b92e2888287704",
        "name": "KudaBank",
        "bankCode": "090267",
        "icon": "https://mono-public-bucket.s3.eu-west-2.amazonaws.com/images/kuda-bank-icon.png"
      }
    }
  ]
}

The response contains the message "Successfully fetched linked accounts" along with an array of objects representing the linked bank accounts. Each object includes the account number and information about the associated institution, including its ID, name, bank code, and icon URL.