Introducing VIDA Identity Stack: All of VIDA, in one place šŸŽ‰
For the complete documentation index, see llms.txt. This page is also available as Markdown.

IQA & Card-Classification

The Image Quality Assessment (IQA) and Card Classification steps are pre-processing operations executed before performing any requested tasks.

If these steps fail, the execution stops, and an error is returned in the response body.


Card-Classification

Purpose: Determines the type of card being processed and includes these details in the response.

Sample Card Classification Response
"card": {
    "country": "Country Name Of Which the Card Belongs To",
    "type": "Name of the card type that was sent, ex - MyKad , KTP, etc",
    "isoAlpha3CountryCode": "iso Alpha 3 Country Code of the country the card belongs to",
    "isoAlpha2CountryCode": "iso Alpha 2 Country Code of the country the card belongs to"
},

Note: If an error occurs during processing, the card classification details will not be included in the response.


Image Quality Assessment

Purpose: Evaluates the idFrontSideImage and idBackSideImage (if enabled) quality based on different parameters like: āœ” Glare – Checks if glare affects the captured image. āœ” Blurriness – Detects if the image is blurry. āœ” Low Light – Ensures the image is not underexposed.

Response:

  • Success: If the image passes all quality checks, an imageQualityResult object is included in the response.

  • Failure: If any check fails, the request errors out.

Sample Success Response :

Success Response
Success Response for Front Side and Back Side

Note:

šŸ”¹ Glare models are currently only available for MyKad (Front Side Only) and KTP cards. šŸ”¹ Glare detection will only return high scores if the glare obscures essential fields such as Name, ID Number, or Portrait Image.

Sample Failure Response:

In this case no image quality results are provided in the response, the request errors out.

Failure Response

Note:

  1. Image Quality Assessment (IQA) responses are currently only available for Malaysian and KTP cards.

  2. For other document types, such as passports, these details will not be included in the response.

Last updated