The endpoint is constructed as follows.
Copy https://api.appruve.co/v1/ocr_jobs/cm/{id_type}
id_type
should be replaced with the specific ID type. Only national_id
is supported at this time.
Copy curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/cm/national_id' \
--header 'Authorization: Bearer TOKEN' \
--form 'front_id_image=@"/path/cm_national_id_front.jpg"' \
--form 'back_id_image=@"/path/cm_national_id_back.jpg"'
An example response is given below.
Copy {
"id_details": {
"id_type": "national_id",
"front_id": {
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1993-05-11",
"gender": "M",
"place_of_birth": "Douala",
"height": "1,61",
"profession": "Etudiant"
},
"back_id": {
"fathers_name": "Senior Doe",
"mothers_name": "Mama Doe",
"address": "",
"expiry_date": "2029-02-05",
"issue_date": "2019-02-05",
"document_number": "123456789"
},
"is_id_valid": true
},
"document_country": "cm",
"front_id_submitted": "URL",
"back_id_submitted": "URL",
"front_id_face_photo": "URL",
"transaction_reference": "c8f6952c-77ea-443d-b46f-86415fd1f78d",
"document_analyses": [
{
"type": "TEMPLATE_MATCHING",
"is_check_successful": true,
"data": null
}
],
"id_confidence_score": 100,
"face_sharpness": 38.9,
"face_brightness": 58.99,
"is_reenrollment": false
}