Main API Docs
Searchโ€ฆ
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.
1
https://api.appruve.co/v1/verifications/selfie_image/ocr/ke/{id_type}
Copied!
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.
1
curl --location --request POST 'https://api.appruve.co/v1/verifications/selfie_image/ocr/ke/national_id' \
2
--header 'Authorization: Bearer TOKEN' \
3
--form '[email protected]"/path/ke_national_id.jpg"'
Copied!
An example response is given below.
1
{
2
"id_details": {
3
"first_name": "John",
4
"last_name": "Doe",
5
"id_number": "1234567",
6
"date_of_birth": "1991-06-14",
7
"issue_date": "2016-12-20",
8
"expiry_date": "",
9
"gender": "F",
10
"id_photo": "Signed URL of the extracted id face photo"
11
},
12
"transaction_reference": "dd8ad095-3f46-48d7-bdb6-adc5c8fc41cd",
13
"face_sharpness": 46.03,
14
"face_brightness": 34.77,
15
"is_reenrollment": true
16
}
Copied!
The returned transaction_reference value should be used for the Upload Selfie endpoint.
Copy link