Phone Number Verification

Kenyan Phone Number Verification API

To perform verification on a Kenyan National ID Number, make a POST request to the following endpoint;

https://api.korapay.com/merchant/api/v1/identities/ke/get-phone

The request body should have the following parameters:

{
   "id": "0723456789",
   "type": "national_id",
   "verification_consent": true
}

The fields in this request include:

Field	Data Type	Description
`id`	String	Required - the ID number
`type`	String	Required - this is the identity type against which the phone number data is checked. It can either be `national_id` or `passport`.
`verification_consent`	Boolean	Required - this indicates that subject has given consent to perform this verification. This must be `true` for the check to be performed.

The response to this request would look like this:

{
   "status": true,
   "message": "Phone verified successfully",
   "data": {
       "reference": "VR-YgbI3ABSU9WqB3U1h",
       "id": "0723818211",
       "id_type": "ke_phone",
       "first_name": "Nabilai",
       "middle_name": "Vincent",
       "last_name": "Senaji",
       "full_name": "Nabilai Vincent Senaji",
       "date_of_birth": "1999-12-28",
       "gender": "Male",
       "marital_status": "Married",
       "email": "[email protected]",
       "home_telephone_number": "+8761234566",
       "mobile_telephone_number": "254723818211",
       "work_telephone_number": "040-3203307",
       "identity_type": "national_id",
       "requested_by": "API User"
   }
}