Front ID card configuration

How to customize the front ID card flow.

The front ID card flow starts with the end user taking a picture of the front side of their Thai national ID card. This image will be analyzed by our OCR services and data gets processed to conclude the result. Optionally, the user can make small corrections when they spot a mistake in the data.

These are the front ID card configuration options:

• isEditable
  boolean - default false
  Choose if the user can add corrections to the OCR result.
• threshold
  number - default 0.8
  Minimum score to pass the verifying process in decimal format. (0.8 = 80% match)
  If there are multiple scores calculated, all scores must be greater than the threshold.
• compareNonEssentialFields
  boolean - default true
  Choose if the front ID comparison validation should include fields that are not in the initial data.
• minimumAge
  number - default null
  Optional parameter to set a minimal age the subject of the ID should have.
• expiryThreshold
  text - default null
  Optional parameter to set a minimal lifetime before an expiry date can be met. Example, the ID card has to be valid for at least 6 months, then the value of this field should be "P6M".
  ISO 8601 duration format reference
• validations
  string array - default null
  Optionally provide a list of validations to perform on a process. By default all validations will run. Only possible on processes with multiple different validations.
  • expired - will validate if the expiry date has been exceeded.
  • aboutToExpire - will validate the expiry date and compare to the expiryThreshold config value.
  • restrictedAge - will validate if the ID card result belongs to someone older than the minimumAge config value.
  • comparison - will compare the initial verification data with the OCR and edits results.
  • mugshot - will validate if the face is clearly visible in the ID card image.
  • font - will validate if the font detected in the OCR result is authentic.
  • recapture - will validate if the id card is a copy
  • redLine - will validate if the red line is found in the image
  • microprint - will validate if the microprint is authentic (Coming Soon)
  • hologram - will validate if the hologram is found in the image (Coming Soon)

Example:

JSON

{
  "frontIdCardConfig": {
    "required": true,
    "attempts": 2,
    "isEditable": true,
    "threshHold": 0.8,
    "minimumAge": 21,
    "expiryDuration": "P6M",
    "validations": [
      "aboutToExpire",
      "comparison",
      "expired",
      "font",
      "mugshot",
      "recapture",
      "redLine",   
      "restrictedAge"
    ],
    "endFlowOnFailure": false
  }
}

📘

Currently supported

• aboutToExpire
• comparison
• expired
• font
• recapture
• redLine
• restrictedAge