Create A Group Customer Information

The "create group of customer information" endpoint enables the creation of corporate or business account profiles and grouping already existing customer accounts on the CBA. Members can be added by passing customerID and isSignatory along with other required parameters. POST /api/Account/v1/CreateGroupCustomerInformation

Headers

NameValue

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Body

NameData Type (length)RequiredDescription

name

string

Name of the business

address

string

Business residential address

businessPhoneNumber

string

Business phone number

contactPersonName

string

Name of the contact person

contactPersonPhoneNumber

string

Phone number of the contact person

countryOfOperation

string

Country where the business operates

description

string

Brief description of the business

industrialSector

integer

Code representing the industrial sector The enumerations are:

40100 = Agriculture, Forestry, and Fishing

40200 = Mining and Quarrying 40300 = Manufacturing

40500 = Real Estate Activities 40700 = General Commerce 40800 = Transportation and Storage

40900 = Finance and Insurance 41000 = General

41200 = Governments

41300 = Water Supply, Sewage, Waste Management, and Remediation Activities

41400 = Construction

41500 = Information and Communication

41600 = Professional, Scientific, and Technical Activities

41700 = Administrative and Support Service Activities

41800 = Education

41900 = Human Health and Social Work Activities

42000 = Arts, Entertainment, and Recreation

42100 = Activities of Extra-Territorial Organizations and Bodies

42200 = Power and Energy 42300 = Capital Market

42400 = Oil and Gas

lga

string

Local Government Area (LGA)

natureOfBusiness

string

Nature of the business (e.g., Manufacturing)

stateOfOperation

string

State where the business operates

customerType

integer

Type of customer (e.g., 5 for corporate)

The enumerations are: 1 = Individual, 2 = Group, 3 = Corporate, 4 = GroupJoint, 5 = GroupSME

registrationDate

string

Date of business registration (e.g., 2023-02-27)

incorporationDate

string

Date of business incorporation (e.g., 2023-02-27)

registrationNumber

string

Business registration number

email

string

Business email address

tin

string

Tax Identification Number (TIN)

groupMembers.customerID

string (8)

Customer ID of a group member

groupMembers.isSignatory

boolean

Set true if the group member is a signatory and false if it's not

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request
curl --location -g '{{baseurl}}/api/Account/v1/CreateGroupCustomerInformation' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer ' \
--header 'request-reference;' \
--data-raw '{
    "address": "6, Kano street, Egbeda",
    "businessPhoneNumber": "09034852395",
    "contactPersonName": "07036866841",
    "contactPersonPhoneNumber": "08025725265",
    "countryOfOperation": "Nigeria",
    "description": "Making sure you stay healthy",
    "industrialSector": 40100,
    "lga": "Kosofe",
    "name": "Nuels_Health",
    "natureOfBusiness": "Manufacturing",
    "stateOfOperation": "Oyo",
    "customerType": 5,
    "registrationDate": "2023-02-27",
    "incorporationDate": "2023-02-27",
    "registrationNumber": "1097367902398",
    "email": "nuelshealth@gmail.com",
    "tin": "049874985",
    "groupMembers": [
        {
            "customerID": "00002112",
            "isSignatory": true
        },
        {
            "customerID": "00002113",
            "isSignatory": true
        }
    ]
}'

Response

{
  "status": true,
  "message": "string",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumber": "string",
    "customerID": "string",
    "customerInformationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "documentIdentifier": "string"
  }
}

Last updated