Update Contact
Overview
The Update Contact API allows financial institutions to modify existing customer contact information. This operation updates customer details while maintaining data integrity and audit trails for compliance purposes.
Command Details
Command Name: UpdateContactCommand
Operation Type: Command (Write Operation)
Use Cases
- Customer Information Updates: Modify contact details when customers relocate or change phone numbers
- Data Corrections: Fix errors in customer records
- Compliance Updates: Update KYC information to maintain regulatory compliance
- Profile Management: Keep customer profiles current and accurate
API Endpoint
POST /api/bpm/cmd
Content-Type: application/json
Authorization: Bearer {access_token}
Request Structure
Request Body
{
"commandName": "UpdateContactCommand",
"data": {
"contactEncodedKey": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"emailAddress": "string",
"phoneNumber": "string",
"address": "string",
"city": "string",
"state": "string",
"country": "string"
}
}
Request Fields
| Field Name | Type | Mandatory | Description |
|---|---|---|---|
contactEncodedKey | String | Yes | Unique identifier of the contact to update |
firstName | String | No | Updated first name |
lastName | String | No | Updated last name |
middleName | String | No | Updated middle name |
emailAddress | String | No | Updated email address |
phoneNumber | String | No | Updated phone number |
address | String | No | Updated residential address |
city | String | No | Updated city |
state | String | No | Updated state |
country | String | No | Updated country |
Sample Requests
1. Update Contact Details
{
"commandName": "UpdateContactCommand",
"data": {
"contactEncodedKey": "8a8e87e87d1234567890abcd",
"phoneNumber": "+234 987 654 3210",
"emailAddress": "newemail@example.com",
"address": "456 New Street, Apt 10C",
"city": "Abuja",
"state": "FCT"
}
}
Response Structure
Success Response
{
"isSuccessful": true,
"statusCode": "00",
"message": "Contact updated successfully.",
"data": {
"contactEncodedKey": "8a8e87e87d1234567890abcd",
"lastModifiedDate": "2025-12-18T10:30:00Z"
}
}
Error Handling
| Status Code | Message | Cause |
|---|---|---|
CBS_400 | Validation error | Invalid field values |
CBS_404 | Contact not found | Invalid contact encoded key |
CBS_409 | Duplicate email | Email already exists for another customer |
CBS_500 | Internal server error | System error occurred |
Notes
- Only provided fields will be updated
- Email addresses must remain unique
- Changes are logged for audit purposes
- Contact encoded key is required