The endpoint is constructed as follows.
https://api.appruve.co/v1/ocr_jobs/ke/{id_type}
id_type
should be replaced with the specific ID type. Supported ID types are passport
and national_id
curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ke/passport' \
--header 'Authorization: Bearer TOKEN' \
--form 'id_image=@"/path/ke_passport.jpg"'
An example response is given below.
{
"id_details": {
"front_id": {
"id_number": "12345678",
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"date_of_birth": "1993-05-02",
"gender": "M",
"issue_date": "2020-03-11",
"expiry_date": "2025-05-02",
},
"back_id": null
},
"front_id_submitted": "URL",
"back_id_submitted": null,
"front_id_face_photo": "URL",
"document_analyses": [
{
"type": "TEMPLATE_MATCHING",
"is_check_successful": true,
"data": null
},
{
"type": "MRZ_CHECK",
"is_check_successful": true,
"data": {
"is_first_name_match": true,
"is_last_name_match": true,
"first_name": "John",
"last_name": "Doe",
"country": "KEN",
"nationality": "KEN"
}
}
],
"id_confidence_score": 100
}