Confirm Extracted ID Number

Confirm the ID number extracted through OCR

How It Works

When an OCR is performed on an ID document, Appruve extracts the primary ID identifier (ID number, document number) and uses it to do a lookup for the ID record from the Government ID database. A successful query results in a positive ID score which contributes to the overall Confidence Score. If the OCR fails to extract the primary ID identifier (this could be due to a blurry, low quality image) the lookup will fail and this will affect the Confidence Score. You can call this endpoint after the OCR is performed to allow the user to manually confirm the correctness of the primary ID identifier extracted from the document. A new lookup will be performed if the previous lookup failed.

Confirm ID Number

POST https://api.appruve.co/v1/verifications/id_actions/update_id_number

Confirm the ID number extracted through OCR

Headers

Name	Type	Description
Authorization*	String	Bearer <token>

Request Body

Name	Type	Description
id_number*	String	The ID number to confirm
transaction_reference*	String	The verification reference ID

200: OK Successful confirmation

{
  "id": "0e2e59cf-2c96-4cc9-b0c2-c8922429b379",
  "confidence_score": 95,
  "id_type": "voter",
  "country_code": "ng",
  "status": "success",
  "face_on_id_document": "url",
  "face_match_percent": 90,
  "id_match_percent": 100,
  "selfie_face_url": "url",
  "selfie_image_submitted": "url",
  "id_face_sharpness": 99,
  "id_face_brightness": 89,
  "selfie_face_sharpness": 97,
  "selfie_face_brightness": 91,
  "id_details": {},
  "created_at": "2020-05-11",
  "custom_params": {}
}