Skip to content

Output Data

  • You can change the format of dates displayed in the results. The mask examples are "dd/mm/yyyy", "mm/dd/yyyy", "dd-mm-yyyy", "mm-dd-yyyy", "dd/mm/yy":
DocumentReader.setConfig({
    processParams: {
        dateFormat: "dd-mm-yy"
    }
});
  • Change the measure system:
DocumentReader.setConfig({
    processParams: {
        measureSystem: Enum.RGLMeasureSystem.METRIC
    }
});
  • If a document contains Visual zone, you can set the list of field types to extract. In this case, other fields are skipped during the processing, i.e. document recognition becomes faster. If the fieldTypesFilter is empty, all fields are extracted:

Info

This filter is not applicable to the MRZ.

DocumentReader.setConfig({
    processParams: {
        fieldTypesFilter: [Enum.eVisualFieldType.FT_DATE_OF_EXPIRY]
    }
});
  • In case the required fields are not read, their values are returned as empty:
DocumentReader.setConfig({
    processParams: {
        checkRequiredTextFields: true
    }
});
  • Set the parameter to send the original (uncropped) image to Core for processing:
DocumentReader.setConfig({
    processParams: {
        returnUncroppedImage: true
    }
});
  • Build an integral image taking into account the quality of fixation of each of the individual images:
DocumentReader.setConfig({
    processParams: {
        integralImage: true
    }
});
  • Return an image with a cropped barcode:
DocumentReader.setConfig({
    processParams: {
        returnCroppedBarcode: true
    }
});
  • Specify the types of results to return:
DocumentReader.setConfig({
    processParams: {
        resultTypeOutput: [
            eRPRM_ResultType.RPRM_RESULT_TYPE_MRZ_OCR_EXTENDED,
            eRPRM_ResultType.RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED
        ]
    }
});
  • Return two aligned and straighten passport pages from an input image as if it was captured from the flatbed scanner:
DocumentReader.setConfig({
    processParams: {
        generateDoublePageSpreadImage: true
    }
});
  • Set the maximum DPI for an output image (if set to zero, the image is not resized):
DocumentReader.setConfig({
    processParams: {
        imageDpiOutMax: 300
    }
});
  • Do not crop graphic fields from a document image:
DocumentReader.setConfig({
    processParams: {
        noGraphics: true
    }
});
  • Shift the date of expiry into the future or past for the specified number of months:
DocumentReader.setConfig({
    processParams: {
        shiftExpiryDate: 1
    }
});
  • Get the OCR validity failed if there is a glare over the text field on the image:
DocumentReader.setConfig({
    processParams: {
        updateOCRValidityByGlare: true
    }
});
  • Specify the minimal age of the document holder (in years):
DocumentReader.setConfig({
    processParams: {
        minimalHolderAge: 18
    }
});
  • When set to true, the rawResults property of DocumentReaderResults will contain the encrypted containers of the scanning results that may be used for later reprocessing.
DocumentReader.setConfig({
    processParams: {
        shouldReturnPackageForReprocess: true
    }
});

Next Steps