Customers

Overview

This comprehensive guide enables businesses to seamlessly manage customer onboarding within their application ecosystem using Mono's API. Our customer management endpoints serve as pivotal resources, enabling businesses to efficiently add users to their platform while ensuring compliance with regulatory requirements.

By leveraging these endpoints, businesses can capture essential user details and perform Know Your Customer (KYC) checks, facilitating a smooth onboarding process within Mono’s ecosystem.

Key Features

• Efficient Onboarding Process: The customer creation endpoint streamlines the onboarding process by allowing businesses to capture vital user information effortlessly.

• KYC Compliance: Businesses can perform Know Your Customer (KYC) checks, ensuring compliance with regulatory requirements and mitigating risks associated with fraudulent activities.

• Integration with Connect and Payment V2 Endpoints: The customer object/id serves as a crucial component for all calls to Connect and Payment V2 endpoints, enabling seamless integration across the Mono-product ecosystem.

Prerequisites

To get started, please ensure to:

• Sign up on the Mono Dashboard.
• Create an App and fetch the generated public and secret key.

To begin utilizing the customers’ endpoints and leverage its benefits for your business, refer to the detailed guide provided below. It includes information on request body parameters, successful response structures, and data types, enabling you to effectively implement customer onboarding within your application ecosystem.

Creating a Customer

The customer creation endpoint allows businesses to seamlessly onboard new users by capturing essential user details and performing Know Your Customer (KYC) checks. This process ensures compliance with regulatory requirements and facilitates the efficient addition of users to your platform.

To initiate a BVN lookup, send a POST request to the following endpoint:

POST https://api.withmono.com/v2/customers

Headers Parameters

• mono-sec-key (required): Your dashboard app secret key.

Request Body Parameters

cURL Sample Request

curl --request POST \
     --url https://api.withmono.com/v2/customers \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'mono-sec-key: string' \
     --data '
{
  "identity": {
    "type": "string",
    "number": "string"
  },
  "email": "string",
  "lastName": "string",
  "firstName": "string",
  "address": "string",
  "phone": "string"
}
'

Success Response

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

{
    "status": "successful",
    "message": "Created customer successfully",
    "data": {
        "id": "63f73564afc1d9fcc92daa0e",
        "name": "Mono Customer",
        "first_name": "Mono",
        "last_name": "Customer",
        "email": "mono@gmail.com",
        "address_line_1": "Some Address",
        "address_line_2": "Lagos State",
        "identification_no": "72232218030",
        "identification_type": "nin",
        "bvn": null
    }
}

Success Response Parameters

By utilizing this endpoint, businesses can efficiently use the customer ID returned in the response can be used for various actions on the Connect and Payment V2 endpoints in the Mono-product ecosystem.

Customer Operations

Other operations related to customers that a business can handle include:

1. Retrieve a Customer: This endpoint allows you to fetch details of a specific customer within your application ecosystem. By providing the customer ID, you can access their information, including personal details and transaction history.

API Reference

2. List all Customers: With this endpoint, you can retrieve a comprehensive list of all customers registered within your application ecosystem. It provides an overview of your customer base, facilitating efficient management and analysis.

API Reference

3. Get Customer Transactions: Utilize this endpoint to access transaction details associated with a specific customer. By specifying the customer ID, you can retrieve information such as transaction amounts, dates, and descriptions.

API Reference

4. Update a Customer: This endpoint enables you to modify the details of an existing customer within your application ecosystem. Whether it's updating contact information or addressing changes in personal details, you can seamlessly keep customer records up-to-date.

API Reference

5. Delete a Customer: With this endpoint, you can remove a customer from your application ecosystem. Whether due to account closure or other reasons, deleting a customer ensures their data is no longer accessible within your system.

API Reference

6. Fetch all Linked Accounts: Use this endpoint to retrieve a list of all linked accounts associated with a specific customer. It provides visibility into the financial accounts connected to the customer profile, enabling enhanced financial management and analysis.

API Reference