Interface ProcessParams

This option can be enabled if you know for sure that the image you provide contains already cropped document by its edges. This was designed to process on the server side images captured and cropped on mobile. Disabled by default.

This parameter is used to enable authenticity checks

This parameter is used to enable document liveness check.

When enabled, each field in template will be checked for value presence and if the field is marked as required, but has no value, it will have 'error' in validity status. Disabled by default.

This option allows setting additional custom configuration per document type. If recognized document has ID specified in config, processing adjusts according to designated configuration.

This option allows passing custom processing parameters that can be implemented in future without changing API.

This option allows you to set dates format so that solution will return dates in this format. For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, you will get '07/09/2020' as a result. By default it is set to system locale default (where the service is running).

When enabled, all personal data will be forcibly removed from the logs. Disabled by default.

This parameter is used to specify the document reader device type from which input images were captured. Default 0.

This parameter is used to specify the document reader device type from which input images were captured. Default 0.

This parameter is used to specify the document reader device type from which input images were captured

When enabled, OCR of perforated fields in the document template will not be performed. Disabled by default.

Set the types of barcodes to process.

List of specific eligible document types from DocumentType enum to recognize from. You may, for example, specify only passports to be recognized by setting this property. Empty by default.

List of the document ID's to process. All documents will be processed, if empty.

This parameter allows enabling the CAN (Card Access Number) detection and recognition when using scenarios with document location and MRZ reading, such as the MrzAndLocate scenario.

Enable this option if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or some others. Disabled by default.

When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds. Enabled by default.

List of text field types to extract. If empty, all text fields from template will be extracted. Narrowing the list can shorten processing time. Empty by default.

Force use of specific template ID and skip document type identification step.

When enabled, make sure that in series processing MRZ is located fully inside the result document image, if present on the document. Enabling this option may add extra processing time, by disabling optimizations, but allows more stability in output image quality. Disabled by default.

When enabled together with "doublePageSpread" and there is a passport with two pages spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured on a flatbed scanner. Disabled by default.

This parameter is used to generate separate DTC-VC data container from RFID session data.

This parameter is used to generate numeric representation for issuing state and nationality codes

This parameter is used to tell the processing engine to ignore any parameters saved in the image when scanned from the document reader device. Default false

This parameter controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi for all scenarios except FullAuth. In FullAuth scenario this limit is 1000 dpi by default.

This parameter allows setting maximum height in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0.

This parameter allows setting maximum width in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0.

The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default.

The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default.

When enabled, results will contain transaction processing log. Disabled by default

When disabled, text field OCR will be done as is and then the recognized value will be matched to the field mask for validity. If enabled, we are trying to read a field value with maximum efforts to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask in the template. Enabled by default.

This options allows specifying the minimal age in years of the document holder for the document to be considered valid.

This option allows limiting MRZ formats to be recognized by specifying them in array.

This option allows locating and cropping multiple documents from one image if enabled. Disabled by default.

When enabled, no graphic fields will be cropped from document image. Disabled by default.

This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person's face

This option can be disabled to stop parsing after barcode is read. Enabled by default.

Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default.

Types of results to return in response. See 'Result' enum for available options

When enabled, returns cropped barcode images for unknown documents. Disabled by default.

When enabled, returns input images in output. Disabled by default.

Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc.

This option allows shifting the date of expiry into the future or past for number of months specified. This is useful, for example, in some cases when document might be still valid for some period after original expiration date to prevent negative validity status for such documents. Or by shifting the date to the past will set negative validity for the documents that is about to expire in a specified number of months. 0 by default

When enabled, the Surname and GivenNames fields from MRZ will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default.

This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed.

Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases.

When enabled, the image quality check status affects the document optical and overall status. Disabled by default.

When enabled, fail OCR field validity, if there is a glare over the text field on the image. Disabled by default.

This parameter allows comparing faces on Regula Face Web Service