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.

https://api.appruve.co/v1/ocr_jobs/ci/{id_type}

id_type should be replaced with the specific ID type. Supported ID types are passport, national_id, embassy_id, foreign_id, 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

curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ci/national_id' \
--header 'Authorization: Bearer TOKEN' \
--form 'front_id_image=@"/path/ci_national_id_front.jpg"' \
--form 'back_id_image=@"/path/ci_national_id_back.jpg"'

Example Passport Request

curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ci/passport' \
--header 'Authorization: Bearer TOKEN' \
--form 'front_id_image=@"/path/ci_passport.jpg"'

Example Residence Permit Request

curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ci/residence_permit' \
--header 'Authorization: Bearer TOKEN' \
--form 'front_id_image=@"/path/residence_permit_front.jpg"' \
--form 'back_id_image=@"/path/residence_permit_back.jpg"'

Example Identity Certificate Request

curl --location --request POST 'https://api.appruve.co/v1/ocr_jobs/ci/identity_certificate' \
--header 'Authorization: Bearer TOKEN' \
--form 'front_id_image=@"/path/identity_certificate.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": {
            "fathers_name": "Senior Doe",
            "mothers_name": "Mama Doe",
            "fathers_date_of_birth": "ND",
            "mothers_date_of_birth": "ND",
            "home_address": "",
            "profession": "Architecte",
            "serial_number": ""
        }
    },
    "front_id_submitted": "URL",
    "back_id_submitted": "URL",
    "front_id_face_photo": "URL",
    "document_analyses": [
        {
            "type": "TEMPLATE_MATCHING",
            "is_check_successful": true,
            "data": null
        },
    ],
    "id_confidence_score": 100
}