Core Banking Services
  1. Account
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
  1. Account

Find Client

POST
/core/account/find
This API allows users to retrieve client details using either an email address, mobile phone number, NIN or BVN. By providing one or more of these identifiers, the API returns relevant client information, including their name, contact details, and verification status.

Request#

Field NameTypeRequiredDescription
emailstringFALSEThe email of the client
mobileNostringFALSEThe mobile number of the client
ninstringFALSEthe NIN of the client
bvnstringFALSEthe BVN of the client

Response#

Field NameTypeDescription
firstnamestringClient's first name
lastnamestringClient's last name
emailstringClient's email address
mobileNostringClient's mobile phone number
clientIdintegerUnique identifier for the client
subLedgerActivatedbooleanIndicates if sub-ledger is activated
dateOrBirthstringClient's date of birth (DD-MM-YYYY format)
kycLevelintegerKYC verification level of the client

Request

Body Params application/json

Example
{
    "mobileNo":"08096800000"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/core/account/find' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mobileNo":"08096800000"
}'

Responses

🟢200Success
application/json
Body

Example
{
    "email": "johndoe@gmail.com",
    "mobileNo": "08016800000",
    "clientId": 5,
    "kycLevel": 0
}
Modified at 2025-03-19 15:01:38
Previous
Create Account
Next
Accounts
Built with