Update Customer Information
Update an existing customer account information by providing the unique id or customerID of the customer account you want to update to request body.
The id of the customer is the GUID returned when creating a customer or when running the Search Account API request. This id is different from the 8-digit Customer ID.
PUT /api/account/v1/UpdateCustomerInformation
Other fields are optional, allowing for a partial update. If optional fields are not included in the payload or are passed as null, they will not be updated.
Headers
Content-Type*
application/json
Authorization*
Bearer <token>
Request-Reference
{unique-reference}
Body Parameters
id
string
Unique identifier for the customer's account (GUID format)
customerID
string (8)
The unique 8 digit customer ID of the customer's account
firstName
string (150)
Customer's first name
lastName
string (150)
Customer's last name or surname
otherNames
string (150)
The customer's other names
gender
integer
The customer's gender.
The enumerations are:
1 = Female,
2 = Male
title
string (20)
Customer's title (e.g., Mr, Mrs, Miss)
address
string (300)
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 (150)
The customer's maiden name (if applicable)
religion
integer
The customer's religion. The enumerations are:
1 = Christianity,
2 = Islamic,
3 = Others
phoneNumber
string (50)
Customer's phone number.
email
string (150)
Customer's email address
hometown
string (100)
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 (100)
Customer's nationality
state
string (100)
Customer's state of origin
lga
string (200)
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 (100)
ID number of the chosen identification
nokName
string (100)
Next of kin's full name
nokAddress
string (150)
Next of kin's residential address
nokGender
integer
Next of kin's gender. The enumerations are:
1 = Female,
2 = Male
nokRelationship
string (50)
Relationship to next of kin (e.g., Sister, Brother, Mother...)
nokPhoneNumber
string (100)
Next of kin's phone number
nokEmail
string (150)
Next of kin's email address
occupation
string (150)
Customer's occupation
employerName
string (150)
Employer's name
employerAddress
string (300)
Employer's residential address
officePhoneNumber
string (100)
The customer's office phone number
accountName
string (250)
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 (3)
The customer's bank account branch code. The branch code must be active and exist on the CBA Portal.
productCode
string (3)
The customer's savings/current account product code. The product code must be active and exist on the CBA Portal.
accountOfficerStaffID
string (3)
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 (10)
Tax Identification Number (TIN)
pep
boolean
Politically Exposed Person (PEP). Set True for yes and False for now.
bvn
string (11)
Bank Verification Number (BVN)
nin
string (11)
National Idenfication Number
Here is an example request and response with a sample payload sent to the endpoint in Curl format.
Response
Last updated