Create Account

Create an individual customer account by passing the required parameters along with the account settings.

POST /api/account/v1/createaccount

Upon successful request, the customer's account number will be generated and included in the response payload.

The createaccount endpoint creates a customer account only without adding additional customer profile information.

Headers

Name	Value
Content-Type*	application/json
Authorization*	Bearer <token>
Request-Reference	{unique-reference}

Body

Name	Data Type (length)	Required	Description
customerID	string		The identifier of an existing customer Individual. This is not the customers Guid
accountName	string		The customer's account name
referenceNumber	string		Reference number for the account. This should be passed as a unique value which can be mapped to the customer's account number on the CBA an external account.
accountType	integer		Type of account. The enumerations are: 1 = Saving (Default), 2 = Current
accountStatus	integer		Status of the account. The enumerations are: 1 = Active (Default), 2 = Dormant, 3 = Closed, 4 = PND (Post No Debit), 5 = PNC (Post No Credit), 6 = Inactive, 7 = Frozen
branchCode	string		The customer's bank account branch code. The branch code must be active and exist on the CBA Portal.
productCode	string		The customer's savings/current account product code. The product code must be active and exist on the CBA Portal.
accountOfficerStaffID	string		Account officer's staff ID. The account officer code must be active and exist on the CBA Portal. CBA setup already comes with a default account officer if you don't have one.
accountTierLevel	integer		Account tier level. The enumerations are: 1 = Tier 1 (default), 2 = Tier 2, 3 = Tier 3
accessLevel	integer		The customer's access level enables restriction of balance and transaction amounts when viewed by users with lower access levels on the CBA portal. Access levels range from 1 to 5
enableEmailNotification	boolean		This enable the system to send email notifications to customers
enableSMSNotification	boolean		This enable the system to send SMS notifications to customers
statementDeliveryMode	integer		Mode of statement delivery (e.g., 1 for email) The enumerations are: 1 = Handpicked, 2 = Email, 3 = Postage
statementDeliveryFrequency	integer		Frequency of statement delivery (e.g., 1 for monthly) The enumerations are: 1 = Weekly 2 = Monthly
minimumBalanceRequired	integer		Minimum balance required for the account
categoryOfAccount	integer		Category of account. The enumerations are: 1 = Bank Staff, 2 = Bank Director, 3 = Other Customers, 4 = Private, 5 = Public
sectorCode	string		Sector code of customer's work type. 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
refereeInformation.referee1CustomerID	string (8)		Referee 1's customer ID: This is an individual customer's ID already in the system.
refereeInformation.referee2CustomerID	string (8)		Referee 2's customer ID: This is an individual customer's ID already in the system.

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/createaccount' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--data '{
    "customerID": "00002109",
    "accountName": " ",
    "referenceNumber": "",
    "accountType": 1,
    "accountStatus": 1,
    "branchCode": "101",
    "productCode": "301",
    "accountOfficerStaffID": "ST1311",
    "accountTierLevel": 2,
    "accessLevel": 5,
    "enableEmailNotification": true,
    "enableSMSNotification": true,
    "statementDeliveryMode": 1,
    "statementDeliveryFrequency": 1,
    "minimumBalanceRequired": 0,
    "categoryOfAccount": 3,
    "sectorCode": "40100",
    "refereeInformation": {
        "referee1CustomerID": "00002110",
        "referee2CustomerID": "00002111"
    }
}'

Response

200

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