Phone Number

Verify that a Kenyan phone number is linked to a given national ID. Accepts 07… / 01… or +254 formats.

Request

POST/api/v1/phone-number

{{baseUrl}}/api/v1/phone-number

Header

Header	Type	Description
Authorization	string	`Bearer YOUR_ACCESS_TOKEN` from the OAuth client-credentials flow
Content-Type	string	application/json

Body Parameters

Parameter	Type	Description	Required
phone_number	string	MSISDN (07…, 01…, or +254…)	required
national_id	string	National ID expected to be linked to the phone	required
customer_number	string	Optional reference for your own tracking (max 255 characters)	optional

Response

200 OKSample dataExample response

{
  "success": true,
  "response_code": 200,
  "message": "Phone number verified successfully",
  "data": {
    "phone_number": "0712845631",
    "national_id": "1028845317",
    "linked": true,
    "carrier": "Safaricom"
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
response_code	number	Application response code (typically mirrors HTTP)
message	string	Human-readable status message
data	object	Payload for the verified resource
request_id	string	UUID for support and audit trails

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.