Search Group Customer

This API endpoint allows users to search for a customer's business/corporate account. by providing a unique id or customerID of the account you want to use to request a query. GET /api/Account/v1/SearchGroupCustomers It retrieves information about customers in a specific group (business/corporate), facilitating efficient group management and customer relationship tracking within the banking system.

Headers

NameValue

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Query Parameter

NameData Type Description

name

string

Name of the business or entity

id

string

Unique identifier for the entity (UUID format)

customerID

string

Unique identifier for the customer

oldCustomerID

string

Previous customer identifier, if applicable

customerType

string

Type of customer (e.g., individual, business)

email

string

Email address of the business or entity

description

string

Description of the business or entity

OfficialAddress

string

Official address of the business

LGA

string

Local Government Area (LGA)

BusinessPhoneNumber

string

Business phone number

NatureOfBusiness

string

Nature of the business

IndustrialSector

string

Code representing the industrial sector

RegistrationDate

date

Date of business registration

IncorporationDate

date

Date of business incorporation

RegistrationNumber

string

Business registration number

ContactPersonName

string

Name of the contact person

ContactPersonPhoneNumber

string

Phone number of the contact person

CountryOfOperation

string

Country where the business operates

StateOfOperation

string

State where the business operates

StartDate

date

Start date for the business or activity

EndDate

date

End date for the business or activity

PageNumber

integer

Page number for pagination purposes

PageSize

integer

Number of items per page for pagination

SortColumn

string

Column by which you want to sort the results: (e.g., email, stateOfOperation)

Direction

string

Direction of the sort (e.g., ascending, descending)

Sample Request
curl --location -g '{{baseurl}}/api/Account/v1/SearchGroupCustomers?Name=Bell%20Cuisine' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer ' \
--header 'request-reference;'
Response : 200
//request successful

Last updated