Main API Docs
Search…
Côte d'Ivoire 🇨🇮
Extract PII data and perform analyses on Côte d'Ivoire ID documents

How It Works

The endpoint is constructed as follows.
1
https://api.appruve.co/v1/ocr_jobs/ci/{id_type}
Copied!
id_type should be replaced with the specific ID type. Supported ID types are passport, national_id, residence_permit, and identity_certificate (Attestation D'Identité )
The request is a multipart POST request as shown in the example below. The front_id_image and back_id_image parameters are required and their values could be a File Object or a web URL.
Example National ID Request
1
curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ci/national_id' \
2
--header 'Authorization: Bearer TOKEN' \
3
--form '[email protected]"/path/ci_national_id_front.jpg"' \
4
--form '[email protected]"/path/ci_national_id_back.jpg"'
Copied!
Example Passport Request
1
curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ci/passport' \
2
--header 'Authorization: Bearer TOKEN' \
3
--form '[email protected]"/path/ci_passport.jpg"'
Copied!
Example Residence Permit Request
1
curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ci/residence_permit' \
2
--header 'Authorization: Bearer TOKEN' \
3
--form '[email protected]"/path/residence_permit_front.jpg"' \
4
--form '[email protected]"/path/residence_permit_back.jpg"'
Copied!
Example Identity Certificate Request
1
curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ci/identity_certificate' \
2
--header 'Authorization: Bearer TOKEN' \
3
--form '[email protected]"/path/identity_certificate.jpg"'
Copied!
An example response is given below.
1
{
2
"id_details": {
3
"front_id": {
4
"id_number": "12345678",
5
"first_name": "John",
6
"middle_name": "",
7
"last_name": "Doe",
8
"date_of_birth": "1993-05-02",
9
"gender": "M",
10
"issue_date": "2020-03-11",
11
"expiry_date": "2025-05-02",
12
},
13
"back_id": {
14
"fathers_name": "Senior Doe",
15
"mothers_name": "Mama Doe",
16
"fathers_date_of_birth": "ND",
17
"mothers_date_of_birth": "ND",
18
"home_address": "",
19
"profession": "Architecte",
20
"serial_number": ""
21
}
22
},
23
"front_id_submitted": "URL",
24
"back_id_submitted": "URL",
25
"front_id_face_photo": "URL",
26
"document_analyses": [
27
{
28
"type": "TEMPLATE_MATCHING",
29
"is_check_successful": true,
30
"data": null
31
},
32
],
33
"id_confidence_score": 100
34
}
Copied!
Copy link