Maisha Number

Verify a Kenyan Maisha Number (new-generation national ID) via POST /api/v1/maisha-number. Available on production and sandbox (https://sandbox.peleza.com). Sandbox uses seeded test data only — sample ID: 1028845319. Required body: id_number (6–10 digits) and consent (must be true). Successful responses include demographics and serial_no when available. HTTP 200 and 404 (not found) are billable; validation 400 is not. Billing slug: maisha-number.

Loading sandbox test IDs…

Request

POST/api/v1/maisha-number

{{baseUrl}}/api/v1/maisha-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
id_number	string	Maisha Number to verify (numeric, 6–10 digits). Sandbox sample: 1028845319	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

{
  "id_number": "12345678",
  "consent": true
}

Response

200 OKSample dataExample response

{
  "success": true,
  "response_code": 200,
  "message": "Maisha Number Details Fetched Successfully",
  "data": {
    "first_name": "JAMES",
    "last_name": "KAMAU",
    "other_name": "OTIENO",
    "name": "JAMES OTIENO KAMAU",
    "gender": "Male",
    "dob": "1988-03-15",
    "citizenship": "Kenyan",
    "id_number": "1028845319",
    "serial_no": "2489156370",
    "valid": true
  },
  "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
data.first_name	string	Given name(s)
data.last_name	string	Surname
data.other_name	string	Other / middle name
data.name	string	Full display name
data.gender	string	Gender
data.dob	string	Date of birth (YYYY-MM-DD)
data.citizenship	string	Citizenship
data.id_number	string	Maisha Number verified
data.serial_no	string	ID serial number when available
data.valid	boolean	Whether the Maisha Number record is valid

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	Maisha Number details returned successfully	Yes
400	Validation — missing/invalid id_number (6–10 digits) or consent (must be true)	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	Maisha Number 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

400 — validation

400Sample data400 — validation

{
  "success": false,
  "response_code": 400,
  "message": "The ID number must be 6 to 10 digits",
  "errors": {
    "id_number": "The ID number must be 6 to 10 digits"
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440030"
}

404 — not found

404Sample data404 — not found

{
  "success": false,
  "response_code": 404,
  "message": "Maisha Number Not Found",
  "description": "There is no information for requested search parameters",
  "request_id": "550e8400-e29b-41d4-a716-446655440031"
}

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.