Request Customer Approval
Overview​
The Request Customer Approval API initiates the approval workflow for new customer records. This command submits customer information for review and approval by authorized personnel before the customer can fully access banking services.
Command Details​
Command Name: RequestCustomerApprovalCommand
Operation Type: Command (Write Operation)
Use Cases​
- New Customer Onboarding: Submit new customer records for approval
- KYC Verification: Request approval after completing Know Your Customer checks
- Compliance Workflow: Ensure regulatory review before account activation
- Multi-Level Authorization: Implement maker-checker controls for customer creation
API Endpoint​
POST /api/bpm/cmd
Content-Type: application/json
Authorization: Bearer {access_token}
Request Structure​
Request Body​
{
"commandName": "RequestCustomerApprovalCommand",
"data": {
"contactEncodedKey": "string",
"notes": "string"
}
}
Request Fields​
| Field Name | Type | Mandatory | Description |
|---|---|---|---|
contactEncodedKey | String | Yes | Unique identifier of the customer |
notes | String | No | Additional notes for approvers |
Sample Requests​
1. Request Approval​
{
"commandName": "RequestCustomerApprovalCommand",
"data": {
"contactEncodedKey": "8a8e87e87d1234567890abcd",
"notes": "All KYC documents verified and uploaded. Ready for approval."
}
}
Response Structure​
Success Response​
{
"isSuccessful": true,
"statusCode": "00",
"message": "Customer approval requested successfully.",
"data": {
"contactEncodedKey": "8a8e87e87d1234567890abcd",
"approvalStatus": "Pending",
"requestDate": "2025-12-18T10:30:00Z"
}
}
Error Handling​
| Status Code | Message | Cause |
|---|---|---|
CBS_400 | Validation error | Invalid request data |
CBS_404 | Customer not found | Invalid contact encoded key |
CBS_409 | Already in approval | Customer is already pending approval |
CBS_500 | Internal server error | System error |
Notes​
- Customer must be in correct status to request approval
- Creates approval workflow task for authorized approvers
- Customer cannot access full services until approved
- Notifications sent to designated approvers