How to get non-standard values for the SEX field

Summary

By default, the SEX field can contain values of M (male) or F (female). If another symbol is detected in this field during document scanning, it is automatically assigned the value of M or F.

For example, we replaced the value in the SEX field with the letter A. You can also use this image to test the described functionality.

When scanning a document with default settings, we will get:

Prerequirements

Access to the demo version of Regula Forensics: https://api.regulaforensics.com/

Required Actions

To obtain the correct value for the SEX field, even if it differs from the standard M or F, you need to change the recognition settings. To do this, follow these steps:

• Open Settings

  First, open the document recognition settings.

  

• Disabling Match Text Field Mask

  Find the setting Match Text Field Mask and ensure it is disabled. This setting checks if the field value matches a specified mask (M or F). Disabling this check allows the system to recognize any symbols in the SEX field.

  

• Using Custom Parameters

  As an alternative to disabling the Match Text Field Mask setting through the interface, you can use the parameter "matchTextFieldMask": false in the Custom Parameters field or include it in your API request.

  

  In this case, the request will look like this:

  
  {
    "processParam": {
      "scenario": "FullProcess",
      "customParams": {
        "matchTextFieldMask": false
      }
    }
  }
      

Result Verification

After making changes, verify the recognition result. If done correctly, the SEX field will display the original symbol as indicated in the document:

Common Errors and Fixes

If you still receive M or F instead of the expected value, make sure that Match Text Field Mask is indeed disabled or that the parameter "matchTextFieldMask": false is correctly specified in Custom Parameters.