Kenya 🇰🇪

Extract PII data from Kenyan ID documents

How It Works

Appruve's OCR API allows you to extract the Personally identifiable information from a Kenyan ID document including the ID face photo. The endpoint is constructed as follows.

https://api.appruve.co/v1/verifications/selfie_image/ocr/ke/{id_type}

id_type should be replaced with the specific ID type. Supported ID types are passport, and, national_id .

The request is a multipart POST request as shown in the example below. The id_image parameter is required and the value could be a File Object or a web URL.

curl --location --request POST 'https://api.appruve.co/v1/verifications/selfie_image/ocr/ke/national_id' \
--header 'Authorization: Bearer TOKEN' \
--form 'id_image=@"/path/ke_national_id.jpg"'

An example response is given below.

{
    "id_details": {
        "first_name": "John",
        "last_name": "Doe",
        "id_number": "1234567",
        "date_of_birth": "1991-06-14",
        "issue_date": "2016-12-20",
        "expiry_date": "",
        "gender": "F",
        "id_photo": "Signed URL of the extracted id face photo"
    },
    "transaction_reference": "dd8ad095-3f46-48d7-bdb6-adc5c8fc41cd",
    "face_sharpness": 46.03,
    "face_brightness": 34.77,
    "is_reenrollment": true
}

The returned transaction_reference value should be used for the Upload Selfie endpoint.