Phone + ID

Verify a Kenyan phone number together with a national ID via POST /api/v1/phone-id/ke. Other country codes are not supported yet. HTTP 200 and 404 are billable; validation 400 is not.

Request

POST/api/v1/phone-id/ke

{{baseUrl}}/api/v1/phone-id/ke

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 / 254 (normalized to local 10 digits)	required
national_id	string	National ID — 5–10 digits	required
consent	boolean	Must be true — confirms data-subject consent to perform this verification	required
customer_number	string	Optional reference for your own tracking (max 255 characters)	optional

Sample request body

All verification APIs require consent: true in the JSON body.

Sample dataSample request body

{
  "phone_number": "0712345678",
  "national_id": "12345678",
  "consent": true
}

Response

200 OKSample dataExample response

{
  "success": true,
  "response_code": 200,
  "message": "Phone + ID Verification Details Fetched Successfully",
  "country": "ke",
  "data": {
    "phone_number": {
      "name": "JOHN DOE KAMAU",
      "phone_number": "0712345678",
      "account": "0712345678",
      "institution": null,
      "verification_status": "Match",
      "is_valid": true
    },
    "national_id": {
      "id_number": "12345678",
      "name": "JOHN DOE KAMAU",
      "first_name": "JOHN",
      "last_name": "KAMAU",
      "other_name": "DOE",
      "gender": "Male",
      "date_of_birth": "1990-01-01",
      "citizenship": "Kenyan",
      "serial_number": "237314661",
      "is_valid": true,
      "photo_path": "https://cdn.example.com/id_card_images/12345678_photo.jpg",
      "fingerprint_path": null,
      "signature_path": null
    }
  },
  "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

Error codes

Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.

Code	When	Billed?
200	Phone and ID details returned	Yes
400	Validation — phone_number / national_id format	No
401	Missing or invalid Bearer token	No
402	Insufficient wallet balance or credit limit	No
403	No active wallet or billing profile (or service not enabled)	No
404	Phone number or national ID not found	Yes
408	Upstream timeout / service error	No
429	Rate limited	No
502	Upstream bad or unreadable response	No
503	Verification service unavailable or request timed out	No

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.