Description of results

This page covers the description of the DocumentReaderResults class

Results

After scanning process is completed, DocumentReaderResults instance will be received. Result contains different result types:

documentReaderResults
└── documentType
└── textResult
└── graphicResult
└── documentPosition
└── barcodePosition
└── mrzPosition
└── imageQualityGroup
└── overallResult
└── authenticityResults
└── rfidSessionData
└── chipPage
└── resolutionType
└── barcodeResult
└── processingFinishedStatus
└── morePagesAvailable
└── elapsedTime
└── elapsedTimeRFID
└── rawResult
  • documentType - document type result;

  • textResult - text results;

  • graphicResult - graphic results;

  • documentPosition - position of document blank result;

  • barcodePosition - position of found Barcode result;

  • mrzPosition - position of the MRZ area;

  • imageQualityGroup - image quality result;

  • overallResult - it's a summary of all results, one of RGLCheckResult enumeration values. If at least one result status was negative, overall result will be negative;

  • authenticityResults - authenticity results;

  • rfidSessionData - results of work with the SDK within the context of the current communication session with electronic document;

  • chipPage indicates the presence and location of an RFID chip in a document. 0 - no rfid chip; 1 - chip is located in the document data page; 2 - chip is located in the back page or inlay of the document;

    resolutionType - it's an image resolution, one of ResolutionType enumeration values;

  • barcodeResult - barcode results;

  • elapsedTime indicates how much time has been required for document processing, milliseconds;

  • elapsedTimeRFID indicates how much time has been required for RFID chip processing, milliseconds;

  • rawResult - contains results in the initial view, i.e. the raw view.

Document Type Result

These parameters are presented in DocumentReaderDocumentType class.

documentType
└── name
└── documentID
└── ICAOCode
└── FDSID
└── dType
└── dFormat
└── dMRZ
└── dDescription
└── dYear
└── dCountryName
└── pageIndex

Parameter

Description

name

Document type name

documentID

Document type numeric code

ICAOCode

Document issuing country ICAO Code

FDSID

Array of IRS document identifiers

dType

Document type, one of DiDocType enumeration values

dFormat

Document format, one of RGLDocFormat enumeration values

dMRZ

Flag for MRZ presence on document

dDescription

Document description text

dYear

Document issue year

dCountryName

Document issuing country name

pageIndex

Indicates an index of the document page, whence the result is received

Text Result

These parameters are presented in DocumentReaderTextResult class.

textResult
└── fields
| └── fieldType
| └── fieldName
| └── lcid
| └── values
| | └── sourceType
| | └── value
| | └── originalValue
| | └── boundRect
| | └── validity
| | └── comparison
| | └── pageIndex
| | └── probability
| └── status
| └── getValue
| └── lcidName
└── status

Parameter

Description

fieldType

Field logical type, one of FieldType values. Enumeration contains identifiers determining the logical type of the text data obtained while reading MRZ, document filling fields and barcodes

fieldName

Title of the fieldType

lcid

ID of language-culture to differentiate one field of the same type from another (for example Belarus Passport Page # 31 – Belarusian and Russian fields of the same type). LCID enumeration contains available enumeration values

sourceType

Identifies zone whence data was extracted. RGLResultType enumeration contains enumeration values

value

Value which was obtained

originalValue

Checks whether a value has been modified or not and returns the original value

boundRect

Field rectangular area coordinates on the image (for document filling fields reading results visualOCRExtended (RGLResultType enumeration))

validity

Identifies verification result. RGLFieldVerificationResult enumeration contains possible conditions

comparison

Contains a comparison result of the field value, which is received from several zones, where the key is one of the RGLResultType enumeration values and the value is one of the RGLFieldVerificationResult enumeration values

pageIndex

Indicates an index of the document page, whence the result is received

probability

Symbol recognition probability (0–100, %)

status

Stores one of RGLCheckResult enumeration which contains identifiers determining the result of a single document security check

lcidName

Title of the lcid

Graphic Result

These parameters are presented in DocumentReaderGraphicResult class.

graphicResult
└── fields
| └── sourceType
| └── fieldType
| └── fieldName
| └── boundRect
| └── value
| └── lightType
| └── lightName
| └── pageIndex

Parameter

Description

sourceType

Identifies zone whence data was extracted. RGLResultType class contains enumeration values

fieldType

Field logical type, one of RGLGraphicFieldType values. Enumeration contains identifiers determining the logical type of the graphic data obtained while reading document filling fields or barcodes

fieldName

Title of the fieldType

boundRect

Field rectangular area coordinates on the image (for document filling fields reading results visualOCRExtended (RGLResultType enumeration))

value

Value which was obtained

lightType

Light type, one of RGLGraphicFieldLight values. Enumeration contains a set of identifiers used for identifying document reader possibilities, specifying lighting schemes for scanning etc.

lightName

Title of the lightType

pageIndex

Indicates an index of the document page, whence the result is received

Image Quality Group

These parameters are presented in ImageQualityGroup class.

imageQuality
└── count
└── result
└── imageQualityList
| └── type
| └── result
| └── featureType
| └── boundRects

Parameter

Description

count

Number of results in the list

result

Overall check result, one of RGLCheckResult enumeration values

imageQualityList

Array of single check result pointers, which contains:

Barcode Result

These parameters are presented in DocumentReaderBarcodeResult class.

barcodeResult
└── fields
| └── barcodeType
| └── status
| └── pdf417Info
| | └── errorLevel
| | └── columns
| | └── rows
| └── data
| └── pageIndex

Parameter

Description

barcodeType

Decoded barcode type, one of RGLBarcodeType enumeration values

status

Indicates barcode reading result, one of RGLBarcodeResult enumeration values or another value, which is SDK internal error code

pdf417Info

Contains the information about the PDF417 barcode, which includes the following parameters:

  • errorLevel - barcode error correction level

  • columns - number of columns in a barcode

  • rows - number of rows in a barcode

data

Results of reading data from barcode modules

pageIndex

Indicates an index of the document page, whence the result is received

Document, MRZ, Barcode position

These parameters are presented in Position class.

documentPosition / mrzPosition / barcodePosition
└── size
| └── width
| └── height
└── center
| └── x
| └── y
└── leftTop
| └── x
| └── y
└── leftBottom
| └── x
| └── y
└── rightTop
| └── x
| └── y
└── rightBottom
| └── x
| └── y
└── angle
└── perspectiveTr
└── objArea
└── objIntAngleDev
└── resultStatus
└── docFormat
└── pageIndex
└── dpi
└── inverse

Parameter

Description

size

Document width and height

center

Document center coordinates

leftTop

Document left top corner coordinates

leftBottom

Document left bottom corner coordinates

rightTop

Document right top corner coordinates

rightBottom

Document right bottom corner coordinates

angle

Document rotation angle

perspectiveTr

Internal use parameter

objArea

Internal use parameter

objIntAngleDev

Internal use parameter

resultStatus

Internal use parameter, one of RGLCheckResult enumeration values

docFormat

Document format, one of RGLDocFormat enumeration values

pageIndex

Index of the document page, whence the result is received

dpi

Resolution in dots per inch

inverse

Internal use parameter

Authenticity Result

These parameters are presented in RGLDocumentReaderAuthenticityResult class.

authenticityResults
└── status
└── checks
| └── type
| └── typeName
| └── status
| └── elements
| | └── status
| | └── elementType
| | └── elementTypeName
| | └── elementDiagnose
| | └── elementDiagnoseName
| └── pageIndex

Parameter

Description

status

Overall check result, one of RGLCheckResult enumeration values

checks

Stores the result of document authenticity check using the images for different lighting schemes

type

Type of the performed check, one of RGLAuthenticity enumeration values

typeName

Title of the type

elementType

Element type, one of SecurityFeatureType enumeration values

elementTypeName

Title of the elementType

elementDiagnose

Element diagnose, one of RGLCheckDiagnose enumeration values

elementDiagnoseName

Title of the elementDiagnose

pageIndex

Index of the document page, whence the result is received

RFID Result

These parameters are presented in RFIDSessionData class.

rfidSessionData
└── accessControls
| └── activeOptionIdx
| └── notifications
| └── status
| └── type
└── applications
| └── applicationID
| └── dataHashAlgorithm
| └── files
| | └── fileData
| | | └── data
| | | └── length
| | | └── status
| | | └── type
| | └── fileID
| | └── notifications
| | └── pAStatus
| | └── readingStatus
| | └── readingTime
| | └── type
| | └── typeName
| | └── docFieldsText
| | └── docFieldsGraphics
| | └── docFieldsOriginals
| | └── certificates
| | | └── securityObject
| | | | └── data
| | | | └── length
| └── type
| └── status
| └── unicodeVersion
| └── version
└── securityObjects
| └── fileReference
| └── objectType
| └── version
| └── signerInfos
| | └── dataToHash
| | └── digestAlgorithm
| | └── paStatus
| | └── signatureAlgorithm
| | └── version
| | └── issuer
| | | └── attributes
| | | | └── type
| | | | └── value
| | | | | └── data
| | | | | └── length
| | | | | └── status
| | | | | └── type
| | | | | └── format
| | | └── data
| | | └── friendlyName
| | | | └── data
| | | | └── length
| | | | └── status
| | | | └── type
| | | | └── format
| | └── serialNumber
| | | └── data
| | | └── length
| | | └── status
| | | └── type
| | | └── format
| | └── signature
| | | └── data
| | | └── length
| | | └── status
| | | └── type
| | | └── format
| | └── signedAttributes
| | | └── data
| | | └── type
| | └── subjectKeyIdentifier
| | | └── data
| | | └── length
| | | └── status
| | | └── type
| | | └── format
| | └── certificateChain
| | | └── extensions
| | | | └── data
| | | | └── type
| | | └── fileName
| | | | └── data
| | | | └── length
| | | | └── status
| | | | └── type
| | | | └── format
| | | └── issuer
| | | | └── attributes
| | | | | └── type
| | | | | └── value
| | | | | | └── data
| | | | | | └── length
| | | | | | └── status
| | | | | | └── type
| | | | | | └── format
| | | | └── data
| | | | └── friendlyName
| | | | | └── data
| | | | | └── length
| | | | | └── status
| | | | | └── type
| | | | | └── format
| | | └── notifications
| | | └── origin
| | | └── paStatus
| | | └── serialNumber
| | | └── signatureAlgorithm
| | | └── subject
| | | | └── attributes
| | | | | └── type
| | | | | └── value
| | | | | | └── data
| | | | | | └── length
| | | | | | └── status
| | | | | | └── type
| | | | | | └── format
| | | | └── data
| | | | └── friendlyName
| | | | | └── data
| | | | | └── length
| | | | | └── status
| | | | | └── type
| | | | | └── format
| | | └── subjectPKAlgorithm
| | | └── type
| | | └── validity
| | | | └── notAfter
| | | | | └── data
| | | | | └── length
| | | | | └── status
| | | | | └── type
| | | | | └── format
| | | | └── notBefore
| | | | | └── data
| | | | | └── length
| | | | | └── status
| | | | | └── type
| | | | | └── format
| | | └── version
| | └── notifications
| └── notifications
└── cardProperties
| └── aTQA
| └── aTQB
| └── aTR
| └── baudrate1
| └── baudrate2
| └── bitRateR
| └── bitRateS
| └── chipTypeA
| └── mifareMemory
| └── rfidType
| └── sAK
| └── support4
| └── supportMifare
| └── uID
└── totalBytesReceived
└── totalBytesSent
└── status
└── extLeSupport
└── processTime
└── sessionDataStatus
| └── AA
| └── BAC
| └── CA
| └── PA
| └── PACE
| └── TA
| └── overallStatus

Parameter

Description

accessControls

list of containers to store information about the supported procedures of authentication and secure data access within the context of the session

activeOptionIdx

index of the active variant of the procedure

notifications

list of remarks arisen during the procedure

status

procedure status (RFID_Error_NotPerformed, RFID_Error_NotAvailable, RFID_Error_NoError or the error code from eRFID_NotificationAndErrorCodes enumeration

type

procedure type (one of eRFID_AccessControl_ProcedureType enumeration values)

applications

list of containers to store information about the involved applications of electronic document

applicationID

application identifier

dataHashAlgorithm

algorithm for calculating hash values for files for the procedure of PA

files

list of containers to store information about the read files of the application

unicodeVersion

Unicode version for application

securityObjects

list of containers to store information about the detected document security objects

fileReference

reference to the source file of the security object data

objectType

security object identifier

signerInfos

list of containers to store information about digital signature objects contained in the SO

digestAlgorithm

digital signature hash-function algorithm identifier

paStatus

result of the digital signature verification (RFID_Error_NotPerformed, RFID_Error_NoError or RFID_Error_Failed);

signatureAlgorithm

digital signature algorithm identifier

issuer

identifier of the necessary certificate issuer

serialNumber

serial number of the necessary certificate

signature

binary data of the verified digital signature

signedAttributes

list of the signed attributes

subjectKeyIdentifier

signature object identifier of the necessary certificate

certificateChain

certificate chain, used for the digital signature verification

cardProperties

set of electronic document chip characteristics

aTQA

numeric ATQ_A value in hexadecimal format (e.g. "0x0000")

aTQB

ATQ_B contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. "50 F9 4F 41 60 00 00 00 00 77 81 81")

aTR

pAtr contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. "3B 88 81 11 FC 00 00 00 00 77 81 81 00 93")

baudrate1

numeric Baudrate1 value in hexadecimal format (e.g. "0x0000000F")

baudrate2

numeric Baudrate2 value in hexadecimal format

bitRateR

numeric BitRateR value in hexadecimal format (e.g. "0x04")

bitRateS

numeric BitRateS value in hexadecimal format (e.g. "0x04")

chipTypeA

text abbreviation of ChipType_A value

mifareMemory

numeric MifareMemory value

rfidType

text abbreviation of RFID_Type value

sAK

numeric SAK value in hexadecimal format (e.g. "0x00")

support4

boolean Support_4 value

supportMifare

boolean Support_Mifare value

uID

UID contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. "F9 4F 41 60")

totalBytesReceived

total number of bytes received from the RFID-chip during the whole session

totalBytesSent

total number of bytes transmitted to the RFID-chip during the whole session

extLeSupport

sign of support of RFID-chip for extended length commands of reading (RFID_Error_NotPerformed, RFID_Error_NotAvailable or RFID_Error_NoError)

processTime

total time of all operations performed during the session, ms

AA

AA status, one of RGLCheckResult values

BAC

BAC status, one of RGLCheckResult values

CA

CA status, one of RGLCheckResult values

PA

PA status, one of RGLCheckResult values

PACE

PACE status, one of RGLCheckResult values

TA

TA status, one of RGLCheckResult values

overallStatus

overall status, one of RGLCheckResult values