Skip to main content

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​

FieldTypeRequiredDescription
selfServiceUserIdlongYesThe SelfServiceUser.Id (database ID) of the customer to blacklist
reasonstringNoReason 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​

FieldTypeRequiredDescription
selfServiceUserIdlongYesThe SelfServiceUser.Id of the customer to reinstate
reasonstringNoReason 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 customer's channel account (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.

Retrieving Blacklisted Customers​

There is no dedicated command to list blacklisted customers. To retrieve them, use the standard customer list query and filter by userStatus:

{
  "cmd": "GetSelfServiceUserListQuery",
  "data": {
    "userStatus": "BlackListed",
    "userClassification": "CUSTOMER",
    "pageSize": 20,
    "currentSelectedPage": 0
  }
}

This returns a paginated list of all channel customers currently in BlackListed status.

Channel profile only

These commands affect the customer's self-service channel access only. They do not freeze or restrict the core banking account. To restrict the core banking account, use the Account PND commands.