Customer Channel Blacklist

Overview

These commands blacklist or unblacklist a channel customer (SelfServiceUser with UserClassification == CUSTOMER).
A blacklisted customer cannot log in to the self-service portal or initiate any transactions.

Permission Required

ClientManagement.BlacklistCustomer

---

BlacklistCustomerBpmCommand

Blacklists a channel customer, preventing them from logging in or transacting.

Request

{
  "cmd": "BlacklistCustomerBpmCommand",
  "data": {
    "selfServiceUserId": 1024,
    "reason": "Suspicious activity — fraud investigation initiated"
  }
}

Request Fields

Field	Type	Required	Description
selfServiceUserId	long	Yes	The SelfServiceUser.Id (database ID) of the customer to blacklist
reason	string	No	Reason for blacklisting — stored for audit

Response

{
  "isSuccessful": true,
  "statusCode": "00",
  "message": "Customer 'john.doe@email.com' has been blacklisted.",
  "data": {
    "selfServiceUserId": 1024,
    "userId": "john.doe@email.com",
    "userStatus": "BlackListed"
  }
}

---

UndoBlacklistCustomerBpmCommand

Removes a blacklist restriction and restores the customer's access.

Request

{
  "cmd": "UndoBlacklistCustomerBpmCommand",
  "data": {
    "selfServiceUserId": 1024,
    "reason": "Investigation concluded — no fraud found"
  }
}

Request Fields

Field	Type	Required	Description
selfServiceUserId	long	Yes	The SelfServiceUser.Id of the customer to reinstate
reason	string	No	Reason for reinstating

Response

{
  "isSuccessful": true,
  "statusCode": "00",
  "message": "Customer 'john.doe@email.com' has been reinstated.",
  "data": {
    "selfServiceUserId": 1024,
    "userId": "john.doe@email.com",
    "userStatus": "Active"
  }
}

---

Finding the selfServiceUserId

The selfServiceUserId is the internal database ID of the SelfServiceUser record (not the customer's account number or BVN).
It can be found via the customer search screens in the admin portal, or from the response of any customer lookup query.

---

Developer Notes (Raji)

Item	Detail
Command file	CB.Administration.Api/Commands/BPM/Security/CustomerBlacklistBpmCommand.cs
Handler	CustomerBlacklistBpmCommandHandlers
Entity	SelfServiceUser where UserClassification == CUSTOMER
Status field	SelfServiceUser.UserStatus — set to UserStateEnum.BlackListed / UserStateEnum.Active
Permission	PermissionStandardCodes.ClientManagement.BlacklistCustomer ("bnk_blacklist_customer")
Not for CBS	This command targets the channel profile only. It does NOT freeze the core banking account. Use ActivatePndOnAccountBpmCommand to restrict the CBS account.