Find Client

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 Name	Type	Required	Description
email	string	FALSE	The email of the client
mobileNo	string	FALSE	The mobile number of the client
nin	string	FALSE	the NIN of the client
bvn	string	FALSE	the BVN of the client

Response

Field Name	Type	Description
firstname	string	Client's first name
lastname	string	Client's last name
email	string	Client's email address
mobileNo	string	Client's mobile phone number
clientId	integer	Unique identifier for the client
subLedgerActivated	boolean	Indicates if sub-ledger is activated
dateOrBirth	string	Client's date of birth (DD-MM-YYYY format)
kycLevel	integer	KYC verification level of the client

Responses

🟢200Success

application/json

Body

string

optional

client email

mobileNo

string

optional

client phone number

clientId

integer

optional

client identifier

kycLevel

integer

optional

client KYC level

Example

{
    "email": "johndoe@gmail.com",
    "mobileNo": "08016800000",
    "clientId": 5,
    "kycLevel": 0
}

Request#

Response#

Request

Request samples

Responses

Request

Response