Nigeria 🇳🇬

Extract PII data from Nigerian ID documents

How It Works

Appruve's OCR API allows you to extract the Personally identifiable information from a Nigeria ID document including the ID face photo. The endpoint is constructed as follows.

https://api.appruve.co/v1/verifications/selfie_image/ocr/ng/{id_type}

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

curl --location --request POST 'https://api.appruve.co/v1/verifications/selfie_image/ocr/ng/driver_license' \
--header 'Authorization: Bearer TOKEN' \
--form 'id_image=@"/path/ng_driver_license_1.jpg"'

An example response is given below.

{
  "id_details": {
      "id_number": "12345678",
      "first_name": "John",
      "middle_name": "Doe",
      "date_of_birth": "2017-07-21",
      "gender": "M",
      "id_photo": "Signed URL of the extracted id face photo"
  },
  "transaction_reference": "faf2b8d7-0699-4102-8ee8-c83150a7cadd",
  "face_sharpness": 38.9,
  "face_brightness": 65.23
}

The returned transaction_reference value should be used for the Upload Selfie endpoint.