Alien ID
Verify a Kenyan alien / immigration card and retrieve holder demographics and document assets.
Test data
Sandbox test data
Use these values against the sandbox host. Click a value to copy it.
Alien ID numbers
Sample identity
Request
POST/api/v1/alien-id
{{baseUrl}}/api/v1/alien-idHeader
Body Parameters
Response
200 OKSample dataExample response
{
"success": true,
"response_code": 200,
"message": "Alien ID Details Fetched Successfully",
"data": {
"first_name": "JANE",
"last_name": "DOE",
"other_name": "SAMPLE",
"name": "JANE SAMPLE DOE",
"gender": "F",
"dob": "1985-01-01",
"citizenship": "Alien",
"id_number": "10000001",
"serial_no": "B1000001",
"valid": true,
"clan": "SAMPLE CLAN",
"ethnic_group": "SAMPLE ETHNIC GROUP",
"family": "SAMPLE FAMILY",
"occupation": "Teacher",
"pin": "A000000000B",
"place_of_birth": "SAMPLE COUNTRY",
"place_of_live": "SAMPLE CITY",
"reg_office": "SAMPLE IMMIGRATION OFFICE",
"date_of_issue": "2015-06-01",
"date_of_expiry": "2025-06-01",
"photo_path": "https://example.com/photos/alien-10000001.jpg",
"fingerprint_path": "https://example.com/fps/alien-10000001.png",
"signature_path": "https://example.com/signatures/alien-10000001.png"
},
"request_id": "550e8400-e29b-41d4-a716-446655440002"
}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.
