Alien ID Verification for Kenya
This endpoint is used to verify the details of an alien ID. It requires the alien ID number, along with other identifying details.
Endpoint: POST {baseurl}/v1/api/verification/alien-id
Request Body
Field Name | Type | Required | Description |
---|---|---|---|
country |
string | Yes | The country code of the alien ID. |
reference |
string | Yes | A unique reference for the verification request. |
identity |
string | Yes | A unique identifier for the user. |
verificationLevel |
string | Yes | The level of verification to perform. |
alienId |
string | Yes | The alien ID number to verify. |
Example Request Body
{
"country": "KEN",
"reference": "0122333444455555",
"identity": "6791457be570f7f292f1fe23",
"verificationLevel": "basic",
"alienId": "123456789"
}
Sample Request
curl -X POST "{baseurl}/v1/api/verification/alien-id" \
-H "Content-Type: application/json" \
-H "x-api-key: {API-KEY}" \
-d '{
"country": "KEN",
"reference": "0122333444455555",
"identity": "6791457be570f7f292f1fe23",
"verificationLevel": "basic",
"alienId": "123456789"
}'
Sample Response
{
"status": true,
"responseCode": "00",
"statusCode": "200",
"message": "Alien Id verification successful",
"data": {
"alienId": "123456789",
"gender": "Male",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"dateOfBirth": "1990-01-01",
"placeOfBirth": "New York",
"placeOfResidence": "Nairobi",
"serialNumber": "AL123456",
"address": "123 Test Street, Nairobi",
"phoneNumber": "+254712345678",
"photo": "base64encodedimage",
"signature": "base64encodedsignature",
"expiryDate": "2030-01-01",
"issueDate": "2020-01-01"
},
"meta": {
"statusCode": "200",
"isValid": true,
"timeStamp": "Thu Apr 24 2025 12:38:19 GMT+0000 (Coordinated Universal Time)"
}
}