Verify Phone Number
Phone Number Verification
POST
{{baseurl}}/v2/api/identity/ke/phone
Headers
Name
Type
Description
token*
String
API secret token
Request Body
Name
Type
Description
id*
String
Candidates identity number
isSubjectConsent*
Boolean
Indicate subject has given consent. Must be true
idtype*
String
Identity number type this can be one of the following national-id, passport, service-id and alien-registration
Phone Number Verification
Address information verification retrieves the addressing information on a provided Kenyan National ID or Passport number.
{
"id": "1234567",
"idType": "national-id"|"passport",
"isSubjectConsent": true
}
{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"id": "64ec17d9c79f7a16971c65b9",
"parentId": null,
"status": "found",
"reason": null,
"dataValidation": false,
"selfieValidation": false,
"dateOfBirth": "1999-12-31T21:00:00Z",
"identityType": "national-id",
"isConsent": true,
"idNumber": "1234567",
"businessId": "628b38f03ae28a14f52d4bf7",
"firstName": "Kangethe",
"middleName": "Kariuki",
"lastName": "Simon",
"fullName": "Kangethe Kariuki Simon",
"gender": "Male",
"maritalStatus": "Married",
"email": "[email protected]",
"homeTelephoneNumber": "+8761234567",
"mobileTelephoneNumber": "254723818284",
"workTelephoneNumber": "040-3203308",
"type": "keCreditInfoPhone",
"allValidationPassed": true,
"requestedAt": "2023-08-28T03:43:23.360Z",
"requestedById": "628b38f03ae28a5a122d4bf3",
"country": "KE",
"createdAt": "2023-08-28T03:43:23.585Z",
"lastModifiedAt": "2023-08-28T03:43:23.585Z",
"metadata": {},
"requestedBy": {
"firstName": "API",
"lastName": "User",
"middleName": "",
"id": "628b38f03ae28a5a122d4bf3"
}
},
"links": []
}
{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"id": "64db6940563aa72892176950",
"parentId": null,
"status": "not_found",
"reason": "Person Not Found",
"dataValidation": false,
"selfieValidation": false,
"dateOfBirth": null,
"identityType": "national-id",
"isConsent": true,
"idNumber": "00000000",
"businessId": "628b38f03ae28a14f52d4bf7",
"email":null,
"homeTelephoneNumber": null,
"mobileTelephoneNumber": null,
"workTelephoneNumber": null,
"type": "keCreditInfoPhone",
"allValidationPassed": true,
"requestedAt": "2023-08-15T12:02:09.602Z",
"requestedById": "628b38f03ae28a5a122d4bf3",
"country": "KE",
"createdAt": "2023-08-15T12:02:09.767Z",
"lastModifiedAt": "2023-08-15T12:02:09.767Z",
"metadata": {},
"requestedBy": {
"firstName": "Onyeka",
"lastName": "Ijeh",
"middleName": "",
"id": "628b38f13ae28a7b742d4bf9"
}
},
"links": []
}
{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}
Last updated
Was this helpful?