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.

Query Params

Field Name	Type	Required	Description
accounts	Boolean	FALSE	Parameter to indicate whether all accounts should be included in response
transactions	Boolean	FALSE	Parameter to indicate if recent transactions should be included in response

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
nuban	string	FALSE	the NUBAN 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
accounts	Object	Account Numbers Of The client
transactions	Object	Recent Transactions Of the Client

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Query Params

Body Params application/json

Example

{
  "mobileNo": "08000000013"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Examples

Successful ResponseFull Details

{
  "email": "customer3@example.com",
  "mobileNo": "08000000014",
  "clientId": 5,
  "kycLevel": 0
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Query Params#

Request#

Response#

Request

Request Code Samples

Responses

Query Params

Request

Response