Getting results

This page covers the description of how to get various kinds of results

Text Results

If you know exactly what text data are needed, the fastest way to get information is to use special functions.

Getting values

Getting values of text fields indicating fieldType:

Java

// Get full name
String surnameAndGivenNames = results.getTextFieldValueByType(eVisualFieldType.FT_SURNAME_AND_GIVEN_NAMES);
// Get date of birth
String dateOfBirth = results.getTextFieldValueByType(eVisualFieldType.FT_DATE_OF_BIRTH);
// Get document number
String documentNumber = results.getTextFieldValueByType(eVisualFieldType.FT_DOCUMENT_NUMBER);

Kotlin

Getting values of text fields indicating fieldType, lcid:

Java

// Get full name
String surnameAndGivenNames = results.getTextFieldValueByType(eVisualFieldType.FT_SURNAME_AND_GIVEN_NAMES, LCID.BELARUSIAN);
// Get place of birth
String placeOfBirth = results.getTextFieldValueByType(eVisualFieldType.FT_PLACE_OF_BIRTH, LCID.GERMAN_GERMANY);

Kotlin

Getting values of text fields indicating fieldType, lcid, source:

Java

// Get full name
String surnameAndGivenNames = results.getTextFieldValueByType(eVisualFieldType.FT_SURNAME_AND_GIVEN_NAMES, LCID.BELARUSIAN, eRPRM_ResultType.RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED);
// Get address
String address = results.getTextFieldValueByType(eVisualFieldType.FT_ADDRESS, LCID.LATIN, eRPRM_ResultType.RPRM_RESULT_TYPE_BAR_CODES_TEXT_DATA);

Kotlin

Getting values of text fields indicating fieldType, lcid, source, original:

Java

// Get surname
String surname = results.getTextFieldValueByType(eVisualFieldType.FT_SURNAME, LCID.BELARUSIAN, eRPRM_ResultType.RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED, true);
// Get address
String address = results.getTextFieldValueByType(eVisualFieldType.FT_ADDRESS, LCID.LATIN, eRPRM_ResultType.RPRM_RESULT_TYPE_BAR_CODES_TEXT_DATA, true);

Kotlin

Getting values of text fields indicating fieldType, source:

Java

// Get surname
String surname = results.getTextFieldValueByTypeAndSource(eVisualFieldType.FT_SURNAME, eRPRM_ResultType.RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED);

Kotlin

Getting values of text fields indicating fieldType, source, original:

Java

// Get surname
String surname = results.getTextFieldValueByTypeAndSource(eVisualFieldType.FT_SURNAME, eRPRM_ResultType.RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED, true);

Kotlin

You can also go through all instances of text fields and obtain the desired information, e.g.:

Java

for(DocumentReaderTextField textField : results.textResult.fields) {
    String value = results.getTextFieldValueByType(textField.fieldType, textField.lcid);
    Log.d("MainActivity", value + "\n");
}

Kotlin

Getting statuses

Getting statuses of text fields indicating fieldType (one of eCheckResult values):

Java

// Get status of FT_SURNAME_AND_GIVEN_NAMES
int surnameAndGivenNames = results.getTextFieldStatusByType(eVisualFieldType.FT_SURNAME_AND_GIVEN_NAMES);
// Get status of FT_DATE_OF_BIRTH
int dateOfBirth = results.getTextFieldStatusByType(eVisualFieldType.FT_DATE_OF_BIRTH);

Kotlin

Getting statuses of text fields indicating fieldType, lcid (one of eCheckResult values):

Java

// Get status of FT_SURNAME_AND_GIVEN_NAMES
int surnameAndGivenNames = results.getTextFieldStatusByType(eVisualFieldType.FT_SURNAME_AND_GIVEN_NAMES, LCID.BELARUSIAN);
// Get status of FT_DATE_OF_BIRTH
int dateOfBirth = results.getTextFieldStatusByType(eVisualFieldType.FT_DATE_OF_BIRTH, LCID.LATIN);

Kotlin

Getting instances

Getting instances of text fields indicating fieldType:

Java

DocumentReaderTextField textField = results.getTextFieldByType(eVisualFieldType.FT_SURNAME);

Kotlin

Getting instances of graphic fields indicating fieldType, lcid:

Java

DocumentReaderTextField textField = results.getTextFieldByType(eVisualFieldType.FT_SURNAME, LCID.BELARUSIAN);

Kotlin

Graphic Results

Getting values

Getting values of graphic fields indicating fieldType:

Java

// Get document image
Bitmap documentImage = results.getGraphicFieldImageByType(eGraphicFieldType.GF_DOCUMENT_IMAGE);
// Get portrait image
Bitmap portrait = results.getGraphicFieldImageByType(eGraphicFieldType.GF_PORTRAIT);

Kotlin

Getting values of graphic fields indicating fieldType, source:

Java

// Get document image
Bitmap documentImage = results.getGraphicFieldImageByType(eGraphicFieldType.GF_DOCUMENT_IMAGE, eRPRM_ResultType.RPRM_RESULT_TYPE_RAW_IMAGE);
// Get document image (uncropped)
Bitmap documentImageUncropped = results.getGraphicFieldImageByType(eGraphicFieldType.GF_DOCUMENT_IMAGE, eRPRM_ResultType.RPRM_RESULT_TYPE_RAW_UNCROPPED_IMAGE);
// Get portrait image
Bitmap portrait = results.getGraphicFieldImageByType(eGraphicFieldType.GF_PORTRAIT, eRPRM_ResultType.RPRM_RESULT_TYPE_GRAPHICS);

Kotlin

Getting values of graphic fields indicating fieldType, source, pageIndex:

Java

// Get document image from the second page
Bitmap documentImage = results.getGraphicFieldImageByType(eGraphicFieldType.GF_DOCUMENT_IMAGE, eRPRM_ResultType.RPRM_RESULT_TYPE_RAW_IMAGE, 1);
// Get portrait image from the first page
Bitmap portrait = results.getGraphicFieldImageByType(eGraphicFieldType.GF_PORTRAIT, eRPRM_ResultType.RPRM_RESULT_TYPE_GRAPHICS, 0);

Kotlin

Getting values of graphic fields indicating fieldType, source, pageIndex, light:

Java

// Get document image from the first page with white light
Bitmap documentImageWhite = results.getGraphicFieldImageByType(eGraphicFieldType.GF_DOCUMENT_IMAGE, eRPRM_ResultType.RPRM_RESULT_TYPE_RAW_IMAGE, 0, eRPRM_Lights.RPRM_LIGHT_WHITE_FULL);
// Get document image from the first page with UV light
Bitmap documentImageUV = results.getGraphicFieldImageByType(eGraphicFieldType.GF_DOCUMENT_IMAGE, eRPRM_ResultType.RPRM_RESULT_TYPE_RAW_IMAGE, 0, eRPRM_Lights.RPRM_LIGHT_UV);

Kotlin

Getting statuses

Getting statuses of graphic fields indicating imageQualityCheckType (one of eCheckResult values):

Java

// Get status of an image's focus
int imageFocus = results.getQualityResult(eImageQualityCheckType.IQC_IMAGE_FOCUS);
// Get status of images' glares
int imageGlares = results.getQualityResult(eImageQualityCheckType.IQC_IMAGE_GLARES);

Kotlin

Getting statuses of graphic fields indicating imageQualityCheckType, securityFeature (one of eCheckResult values):

Java

// Get status of images' glares
int blank = results.getQualityResult(eImageQualityCheckType.IQC_IMAGE_GLARES, eRPRM_SecurityFeatureType.SECURITY_FEATURE_TYPE_BLANK);
int mrz = results.getQualityResult(eImageQualityCheckType.IQC_IMAGE_GLARES, eRPRM_SecurityFeatureType.SECURITY_FEATURE_TYPE_MRZ);

Kotlin

Getting instances

Getting instances of graphic fields indicating fieldType, source:

Java

DocumentReaderGraphicField graphicField = results.getGraphicFieldByType(eGraphicFieldType.GF_SIGNATURE, eRPRM_ResultType.RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED);

Kotlin

Getting instances of text fields indicating fieldType, source, pageIndex:

Java

DocumentReaderGraphicField graphicField = results.getGraphicFieldByType(eGraphicFieldType.GF_SIGNATURE, eRPRM_ResultType.RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED, 0);

Kotlin

Getting instances of text fields indicating fieldType, source, pageIndex, light:

Java

DocumentReaderGraphicField graphicField = results.getGraphicFieldByType(eGraphicFieldType.GF_SIGNATURE, eRPRM_ResultType.RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED, 0, eRPRM_Lights.RPRM_LIGHT_WHITE_FULL);

Kotlin