A unique identifier for the request, used for idempotency.

Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Bearer Auth

Validate BVN

Request Parameters

This endpoint enables you to validate a customer's Bank Verification Number (BVN).

Edge API Documentation

API Reference

Change History

Version

Get Started

Join The Community

Welcome to Edge API documentation. Let's get started by making Edge yours.

Introduction

Get started with Edge—your all-in-one API Banking platform. Follow these steps to quickly set up your account and start integrating financial services into your business.

Onboarding

To interact with the Edge API, you’ll need to authenticate your requests using a token. This token is generated from your API credentials and is required for all API calls.

Authentication

When interacting with the Edge API, understanding how data is secured is crucial. Depending on the environment—production or sandbox—the encryption protocols differ, affecting how you handle API requests and responses.

Data Encryption

When integrating with the Edge API, understanding the different environments available is crucial for smooth development and deployment. Edge provides two distinct environments—**Sandbox** and **Production**—each tailored for specific stages of your integration process. This guide will walk you through the purpose of each environment, how to use them effectively, and best practices for transitioning from testing to live operations.

Environment

When working with the Edge API, you will encounter various response codes that indicate the outcome of your requests. These codes follow the ISO 8583 standard, commonly used in financial transactions. Understanding these codes is essential for handling API responses effectively.

Response Codes

Webhooks are a powerful feature that allows your application to receive real-time notifications about specific events that occur within the Edge platform. By setting up webhooks, you can automate processes, update records, and trigger workflows in your application as soon as an event happens.

Webhook

Idempotency ensures that multiple identical requests to the Edge API have the same effect as making a single request. This is crucial for operations like payments or customer creation, where duplicate processing due to retries could cause unintended consequences, such as charging a customer multiple times.

Idempotency

Understand Edge's pricing structure and learn how to optimize your usage based on your business needs.

Pricing

Prepare your application to go live on Edge. Follow these pre-going live activities to ensure a smooth transition from sandbox to production.

Going Live on Edge

Follow this checklist to complete your onboarding on Edge, from signing up to linking your corporate bank account.

Onboarding Checklist

To use Edge, businesses must meet certain **compliance requirements** to ensure the security and integrity of the platform. Compliance is crucial for maintaining trust, adhering to regulatory standards, and ensuring the protection of both user and business data.

Compliance

Security is critical when integrating with Edge, ensuring that your data and the data of your users are protected at every step. Follow these security guidelines and best practices to safeguard your integration and maintain a secure connection with Edge.

Security

Overview

clientId:secretKey

Get Access Token

This endpoint is used to invalidate your current active bearer token

Revoke Token

The Customer Service offers a comprehensive solution for organizations to efficiently manage their customer relationships. This service is designed to enhance the customer onboarding process, provide seamless account creation, and ensure compliance with regulatory requirements through Know Your Customer (KYC) procedures.

This endpoint enables you to profile an individual.

Profile Individual

This endpoint enables you to profile a business.

Profile Business

This endpoint enables you to retrieve the details of a specific customer that you have generated on the Edge platform.

Get Customer

This endpoint enables you to retrieve all customers you have successfully created.

Get All Customers

This endpoint enables you to disable or enable any of your existing customer's profile.

Enable/Disable Customer

This endpoint enables you to update an existing customer's KYC tier.

Customer KYC Update

The Transfer Services API enables seamless money transfers between accounts within the same bank or to accounts in other banks.

This allows you to retrieve a list of active banks eligible for fund transfers.

Retrieve Active Banks

This endpoint allows you to validate the name on an account.

Name Enquiry

This endpoint allows you to initiate a transfer request on behalf of your customer.

Initiate Customer Transfer Request

This endpoint allows you to validate a transfer request using the provided OTP.

Validate Customer Transfer Request

This endpoint allows you to initiate a transfer request directly from one of your Edge collection accounts.

Collection Account Transfer

This allows you check the real-time status of a processed transaction

Check Status

This endpoint enables you to validate a customer's National Identity Number (NIN).

Validate NIN

This endpoint enables you to validate a customer's BVN against their NIN data.

Validate BVN against NIN data

This endpoint enables you to verify an identity document for authenticity.

Verify Identity Document

This endpoint enables you to verify an identity document against a selfie image for identity confirmation.

Verify Identity Document with Face

This endpoint enables you to verify a company's CAC (Corporate Affairs Commission) information.

Verify Company CAC

This endpoint enables you to verify a company's Tax Identification Number (TIN).

Verify Company TIN

This endpoint generates a One-Time Password (OTP) and sends it to the phone number linked to the provided account number.

API Documentation

​Validate BVN

​Request Parameters

Validate BVN

Request Parameters