Phone Number
Verify a Kenyan phone number via POST /api/v1/phone-number/ke. Send phone_number only (plus consent). Accepts 07… / 01…, +254, or 254 formats (normalized to local 10 digits). Returns name, account, institution, and validity flags.
Sandbox test data
Use these values against the sandbox host. Click a value to copy it.
Request
{{baseUrl}}/api/v1/phone-number/keHeader
Body Parameters
Sample request & response
Request payload for Sample request & response:
{
"phone_number": "0712845631",
"consent": true
}Expected response for Sample request & response:
{
"success": true,
"response_code": 200,
"message": "Phone Number Details Fetched Successfully",
"data": {
"name": "joe doe",
"account": "254712845631",
"is_active": true,
"institution": "Safaricom",
"phone_number": "254712845631"
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}Response Fields
Error codes
Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.
400 — validation
{
"success": false,
"response_code": 400,
"message": "Validation Error",
"errors": {
"phone_number": ["The phone number must be 10 digits starting with 07 or 01 (e.g., 0712845631 or 0112345678). +254 / 254 prefixes are accepted."]
}
}400 — consent required
{
"success": false,
"response_code": 400,
"message": "Validation Error",
"errors": {
"consent": ["Consent must be true to perform identity verification"]
}
}404 — not found
{
"success": false,
"response_code": 404,
"message": "Phone Number Not Found",
"errors": {
"phone_number": ["The provided phone number does not exist in our records."]
}
}503 — service unavailable
{
"success": false,
"response_code": 503,
"message": "Phone number verification service is temporarily unavailable. Please try again later.",
"errors": {
"phone_number": ["Verification service unavailable"]
}
}Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.
