National ID (With Image)
Verify a Kenyan national ID and return demographics plus photo and fingerprint asset URLs when available. id_number must be numeric and 6β10 digits.
Test data
Sandbox test data
Use these values against the sandbox host. Click a value to copy it.
National ID numbers
Request
POST/api/v1/national-id-image
{{baseUrl}}/api/v1/national-id-imageHeader
Body Parameters
Response
200 OKSample dataExample response
{
"success": true,
"response_code": 200,
"message": "National ID with Image Details Fetched Successfully",
"data": {
"full_name": "JOHN SAMPLE DOE",
"first_name": "JOHN",
"last_name": "DOE",
"other_name": "SAMPLE",
"id_number": "12345678",
"serial_number": "100000001",
"date_of_birth": "1990-01-01",
"gender": "M",
"citizenship": "Kenyan",
"verification_status": "Valid",
"clan": "SAMPLE CLAN",
"ethnic_group": "SAMPLE ETHNIC GROUP",
"family": "SAMPLE FAMILY",
"occupation": "Software Engineer",
"pin": "A000000000A",
"place_of_birth": "SAMPLE DISTRICT - SAMPLE",
"place_of_death": "",
"place_of_live": "SAMPLE LOCATION - SAMPLE DIVISION - SAMPLE DISTRICT",
"reg_office": "SAMPLE REGISTRATION OFFICE",
"date_of_death": "N/A",
"date_of_issue": "2010-01-01",
"photo_url": "https://example.com/photos/12345678.jpg",
"fingerprint_url": "https://example.com/fps/12345678.png",
"signature_url": "https://example.com/signatures/12345678.png",
"has_photo": true,
"has_fingerprint": true,
"has_signature": true,
"is_valid": true
},
"request_id": "550e8400-e29b-41d4-a716-446655440001"
}Response Fields
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.
