Create Customer Information And Account

POST /api/account/v1/createcustomeraccount

To create a new account with customer information, you must construct the complete endpoint by including the necessary URL path parameters. After that, you should make a POST request by passing additional required payloads in the request body, like firstName , lastName , productCode and branchCode. A successful request will return the accountNumber, customerID, and customerInformationID for reference and a success message in the response. This process will allow you to create both customer profiles and customer accounts.

Headers

Name Value

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

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Body Parameters

Name Data Type (length) Required Description

Name	Data Type (length)	Description
`firstName`	string	Customer's first name
`lastName`	string	Customer's last name or surname
`otherNames`	string	The customer's other names
`gender`	integer	The customer's gender. The enumerations are: `1` = Female, `2` = Male
`title`	string	Customer's title (e.g., Mr, Mrs, Miss)
`address`	string	The customer's residential address
`maritalStatus`	integer	The customer's marital status. The enumerations are: `1` = Married, `2` = Single, `3` = Divorced, `4` = Widow, `5` = Widower
`maidenName`	string	The customer's maiden name (if applicable)
`religion`	integer	The customer's religion. The enumerations are: `1` = Christianity, `2` = Islamic, `3` = Others
`phoneNumber`	string	Customer's phone number.
`email`	string	Customer's email address
`hometown`	string	Customer's hometown
`dateOfBirth`	Date	The customer's Date of birth. The format should be `YYYY`-`MM`-`DD` (e.g., `2025`-`30`-`12`)
`nationality`	string	Customer's nationality
`state`	string	Customer's state of origin
`lga`	string	Local government area
`meansOfIdentification`	integer	Means of identification (e.g., 1 for ID card) The enumerations are: `1` = Drivers License, `2` = Voters Card, `3` = International Passport
`meansOfIdentificationNumber`	string	ID number of the chosen identification
`nokName`	string	Next of kin's full name
`nokAddress`	string	Next of kin's residential address
`nokGender`	integer	Next of kin's gender. The enumerations are: `1` = Female, `2` = Male
`nokRelationship`	string	Relationship to next of kin (e.g., Sister, Brother, Mother...)
`nokPhoneNumber`	string	Next of kin's phone number
`nokEmail`	string	Next of kin's email address
`occupation`	string	Customer's occupation
`employerName`	string	Employer's name
`employerAddress`	string	Employer's residential address
`officePhoneNumber`	string	The customer's office phone number
`accountName`	string	The customer's account name
`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
`minimumBalanceRequired`	integer	Minimum balance required. The product settings will apply if not supplied.
`referee1CustomerID`	string	Referee 1's customer ID: This is an individual customer's ID already in the system.
`referee2CustomerID`	string	Referee 2's customer ID: This is an individual customer's ID already in the system.
`categoryOfAccount`	String	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
`tin`	string	Tax Identification Number (TIN)
`pep`	boolean	Politically Exposed Person (PEP). Set `True` for yes and `False` for now.
`bvn`	string	Bank Verification Number (BVN)
`nin`	string	National Idenfication Number

firstName

string

Customer's first name

lastName

string

Customer's last name or surname

otherNames

string

The customer's other names

gender

integer

The customer's gender.

The enumerations are:

1 = Female,

2 = Male

title

string

Customer's title (e.g., Mr, Mrs, Miss)

address

string

The customer's residential address

maritalStatus

integer

The customer's marital status. The enumerations are:

1 = Married,

2 = Single, 3 = Divorced, 4 = Widow, 5 = Widower

maidenName

string

The customer's maiden name (if applicable)

religion

integer

The customer's religion. The enumerations are:

1 = Christianity,

2 = Islamic, 3 = Others

phoneNumber

string

Customer's phone number.

email

string

Customer's email address

hometown

string

Customer's hometown

dateOfBirth

Date

The customer's Date of birth. The format should be YYYY-MM-DD (e.g., 2025-30-12)

nationality

string

Customer's nationality

state

string

Customer's state of origin

lga

string

Local government area

meansOfIdentification

integer

Means of identification (e.g., 1 for ID card) The enumerations are:

1 = Drivers License,

2 = Voters Card, 3 = International Passport

meansOfIdentificationNumber

string

ID number of the chosen identification

nokName

string

Next of kin's full name

nokAddress

string

Next of kin's residential address

nokGender

integer

Next of kin's gender. The enumerations are:

1 = Female,

2 = Male

nokRelationship

string

Relationship to next of kin (e.g., Sister, Brother, Mother...)

nokPhoneNumber

string

Next of kin's phone number

nokEmail

string

Next of kin's email address

occupation

string

Customer's occupation

employerName

string

Employer's name

employerAddress

string

Employer's residential address

officePhoneNumber

string

The customer's office phone number

accountName

string

The customer's account name

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

minimumBalanceRequired

integer

Minimum balance required. The product settings will apply if not supplied.

referee1CustomerID

string

Referee 1's customer ID: This is an individual customer's ID already in the system.

referee2CustomerID

string

Referee 2's customer ID: This is an individual customer's ID already in the system.

categoryOfAccount

String

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

tin

string

Tax Identification Number (TIN)

pep

boolean

Politically Exposed Person (PEP). Set True for yes and False for now.

bvn

string

Bank Verification Number (BVN)

nin

string

National Idenfication Number

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/createcustomeraccount' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--data '{
  "title": "string",
  "lastName": "string",
  "firstName": "string",
  "otherNames": "string",
  "gender": 1,
  "address": "string",
  "maritalStatus": 1,
  "maidenName": "string",
  "religion": 1,
  "phoneNumber": "string",
  "email": "string",
  "hometown": "string",
  "dateOfBirth": "2000-01-01",
  "nationality": "string",
  "state": "string",
  "lga": "string",
  "meansOfIdentification": 1,
  "meansOfIdentificationNumber": "string",
  "nokName": "string",
  "nokAddress": "string",
  "nokGender": 1,
  "nokRelationship": "string",
  "nokPhoneNumber": "string",
  "nokEmail": "string",
  "occupation": "string",
  "employerName": "string",
  "employerAddress": "string",
  "officePhoneNumber": "string",
  "accountName": "string",
  "accountType": 1,
  "accountStatus": 1,
  "branchCode": "string",
  "productCode": "string",
  "accountOfficerStaffID": "string",
  "accountTierLevel": 0,
  "accessLevel": 0,
  "enableEmailNotification": true,
  "enableSMSNotification": true,
  "minimumBalanceRequired": 0,
  "referee1CustomerID": "string",
  "referee2CustomerID": "string",
  "categoryOfAccount": "string",
  "sectorCode": "string",
  "tin": "string",
  "pep": true,
  "bvn": "string"
}'

Response

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

PreviousAccount API NextCreate Account

Last updated 2 months ago