Undo Blacklist Customer
Overview
The Undo Blacklist Customer API allows authorized personnel to remove blacklist status from a customer account, restoring their ability to conduct transactions. This reverses a previous blacklist action.
Command Details
Command Name: UndoBlacklistCustomerCommand
Operation Type: Command (Write Operation)
Use Cases
- False Positive Resolution: Remove blacklist when customer was incorrectly flagged
- Issue Resolution: Restore access after customer resolves outstanding issues
- Administrative Correction: Fix errors in blacklist assignment
- Policy Updates: Reinstate customers based on updated policies
API Endpoint
POST /api/bpm/cmd
Content-Type: application/json
Authorization: Bearer {access_token}
Request Structure
Request Body
{
"commandName": "UndoBlacklistCustomerCommand",
"data": {
"contactEncodedKey": "string",
"reason": "string",
"notes": "string"
}
}
Request Fields
| Field Name | Type | Mandatory | Description |
|---|---|---|---|
contactEncodedKey | String | Yes | Unique identifier of the customer |
reason | String | Yes | Reason for removing blacklist |
notes | String | No | Additional notes or details |
Sample Requests
1. Undo Blacklist
{
"commandName": "UndoBlacklistCustomerCommand",
"data": {
"contactEncodedKey": "8a8e87e87d1234567890abcd",
"reason": "Customer verification completed - false positive",
"notes": "All documentation verified. Customer cleared for normal operations."
}
}
Response Structure
Success Response
{
"isSuccessful": true,
"statusCode": "00",
"message": "Customer blacklist removed successfully.",
"data": {
"contactEncodedKey": "8a8e87e87d1234567890abcd",
"isBlacklisted": false,
"unblacklistDate": "2025-12-18T10:30:00Z"
}
}
Error Handling
| Status Code | Message | Cause |
|---|---|---|
CBS_400 | Validation error | Missing required fields |
CBS_403 | Forbidden | Insufficient permissions |
CBS_404 | Customer not found | Invalid contact encoded key |
CBS_409 | Not blacklisted | Customer is not currently blacklisted |
CBS_500 | Internal server error | System error |
Notes
- Requires special permissions to remove blacklist
- Customer regains normal transaction capabilities
- Action is logged for audit purposes
- Should include clear justification for removal