ID Card OCR - Quality and Other Checks

The additional checks while performing OCR on documents are grouped into the following two categories:

1. Quality checks
2. Other checks

info

• "CMND" represents Chung Minh Nhan Dan (Vietnamese Identity Card)
• "CCCD" represents the Citizen ID Card in Vietnam

Quality Checks

The following table lists all the quality checks.
The details of the response values are also provided following the table. Click here to access the bookmark.

Type of Check	Supported Country	Supported Documents	Description	Parameter Name	Accepted Values	All Possible Response Values
Glare	All countries	All officially valid documents	Checks for glare in the image. We see an issue with glare when excessive light reflection obscures the document information, making it difficult to read and verify.	qualityChecks.glare	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"
Blur	All countries	All officially valid documents	Checks for blur in the image.	qualityChecks.blur	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"
Black And White	All countries	All officially valid documents	Checks if the image is a photocopy in black and white(or, grayscale).	qualityChecks.blackAndWhite	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"
captured From Screen	All countries	All officially valid documents	Checks if the image is not of a live document but has been captured from a screen instead.	qualityChecks.capturedFromScreen	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"
Partial ID	All countries	All officially valid documents	Checks if the image of the document is captured without any of its corners(or edges) cut off.	qualityChecks.partialId	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"
Face Not Clear	All countries	All officially valid documents	Checks if the face in the image is unclear. A "yes" value for this parameter suggests an unclear face in the image.	qualityChecks.faceNotClear	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"
Face	All countries	All officially valid documents	Checks if a face is present in the image of the document.	qualityChecks.face	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"
Obscured ID	All countries	All officially valid documents	Examines the document image for any obstruction that can be blocking information. A 'yes' parameter value indicates the presence of an obstruction in the image.	qualityChecks.obscuredId	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"
Cut ID	All countries	All officially valid documents	Checks if the document's image shows any signs of cutting.	qualityChecks.cutID	"yes" or "no"	The response can be any one of the following. "yes" "no" "not_applicable" "not_supported"

Details of the Response Values for the Quality Checks

The response for a quailty check parameter can be any one of the following.

• "yes" - The image of the document in the input file has failed the test.
• "no" - The image of the document in the input file has passed the test.
• "not_applicable" - The check is not applicable for the type of document in the input file.
• "not_supported" - This is the standard response when the check does not support the type of the document in the input file.

Other Checks

Type of Check	Supported Country	Supported Documents	Description	Parameter Name	Accepted Values	All Possible Response Values
Return No Limit DOE	Vietnam	Vietnam National ID	Enables the OCR to accept "No-limit" as a valid value for the date of expiry.	returnNoLimit	"yes" or "no"	"No-limit"
Extract Bar Code	India	Aadhaar	Enables the QR code scan feature for an Aadhaar input.	otherChecks.extractBarCode	"yes" or "no"	Not Applicable
Expected Document Side	All	All	Validates the displayed document side in the image against the specified parameter value before initiating optical character recognition (OCR). If there's a mismatch, the process is halted. Note The HyperVerge SDKs have this parameter enabled by default.	expectedDocumentSide	"front" or "back"	Not Applicable
Barcode String	All	All	Overrides the value extracted from the barcode in the barcode field and other relevant fields.	otherChecks.barcodeString	"barcode-string"	Not Applicable
Input Image URLs	All	All	Provides the links to access each of the input images in the response.	otherChecks.returnInputImageUrls	"yes" or "no"	Objects containing URLs
Enable Retakes on Success	All	All	Enables a customer to retake the identification journey even when the summary object in the response has the "pass" value.	otherChecks.enableRetakesOnSuccess	"yes" or "no"	Not Applicable
Mask Aadhaar - Image	India	Aadhaar	Masks the first 8 digits of Aadhaar ID from only the image.	maskAadhaar	"yes" or "no"	Not Applicable
Mask Aadhaar	India	Aadhaar	Masks the first 8 digits of Aadhaar ID from the text and image.	maskAadhaar	"yes" or "no"	Not Applicable
Bar Code Extraction	India	Aadhaar	Extracts details from barcode	extractBarCode	"yes" or "no"	Expands the information extracted from the QR.

Additional Configurations

Configuration Type	Supported Country	Supported Documents	Description	Parameter Name	Accepted Values	All Possible Response Values
Return Score	All	All	Returns an associated score ranging from 0-100 for relevant fields.	preferences.returnScore	"yes" or "no"	Range: 0-100
Return Confidence	All	All	Returns the associated confidence for relevant fields.	preferences.returnConfidence	"yes" or "no"	"high" or "low"
Success Retakes	All	All	Allows retakes even for green channels.	allowSuccessRetakes	"yes" or "no"	"high" or "low"