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:
1
documentReaderResults
2
└── chipPage
3
└── overallResult
4
└── elapsedTime
5
└── elapsedTimeRFID
6
└── processingFinishedStatus
7
└── morePagesAvailable
8
└── rfidResult
9
└── graphicResult
10
└── textResult
11
└── documentPosition
12
└── barcodePosition
13
└── mrzPosition
14
└── imageQuality
15
└── documentType
16
└── rawResult
17
└── documentReaderNotification
18
└── rfidSessionData
19
└── authenticityResult
20
└── barcodeResult
Copied!
  • chipPage indicates which page of the document contains RFID chip (0 if there's no page containing). Requires Document Type recognition, otherwise 1 by default;
  • overallResult - it's a summary of all results, one of eCheckResult enumeration values. If at least one result status was negative, overall result will be negative;
  • 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;
  • morePagesAvailable indicates, if document has more pages (count) to be processed (e.g. ID card's front and back side). Requires Document Type recognition, otherwise 0 by default;
  • rfidResult - result of RFID reading process, one of eRFID_NotificationAndErrorCodes;
  • highResolution indicates, if document is needed with high resolution, false by default;
  • graphicResult - graphic results;
  • textResult - text results;
  • documentPosition - position of document blank result;
  • barcodePosition - position of found Barcode result;
  • mrzPosition - position of the MRZ area;
  • imageQualityGroup - image quality result;
  • documentType - document type result;
  • rawResult - contains results in the initial view, i.e. the raw view;
  • documentReaderNotification - notification data about reading process. Used when RFID chip is read;
  • rfidSessionData - results of work with the SDK within the context of the current communication session with electronic document;
  • authenticityResult - authenticity results;
  • barcodeResult - barcode results;

Graphic Result

These parameters are presented in DocumentReaderGraphicResult class.
1
graphicResult
2
└── fields
3
| └── sourceType
4
| └── fieldType
5
| └── fieldName
6
| └── lightType
7
| └── lightName
8
| └── fieldRect
9
| | └── bottom
10
| | └── left
11
| | └── right
12
| | └── top
13
| └── pageIndex
Copied!
Parameter
Description
sourceType
Identifies zone whence data was extracted. eRPRM_ResultType class contains enumeration values
fieldType
Field logical type, one of eGraphicFieldType 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
lightType
Indicates lightning scheme of the graphic field was taken in, one of eRPRM_Lights
lightName
Title of the lightType
fieldRect
Field rectangular area coordinates on the image (for document filling fields reading results RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED)
pageIndex
Indicates an index of the document page, whence the result is received

Text Result

These parameters are presented in DocumentReaderTextResult class.
1
textResult
2
└── fields
3
| └── fieldType
4
| └── fieldName
5
| └── lcid
6
| └── lcidName
7
| └── values
8
| | └── sourceType
9
| | └── value
10
| | └── originalValue
11
| | └── pageIndex
12
| | └── boundRect
13
| | | └── left
14
| | | └── top
15
| | | └── right
16
| | | └── bottom
17
| | └── validity
18
| | └── comparison
19
| | └── probability
20
| └── status
21
└── status
Copied!
Parameter
Description
fieldType
Field logical type, one of eVisualFieldType 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
lcidName
Title of the lcid
sourceType
Identifies zone whence data was extracted. eRPRM_ResultType enumeration contains enumeration values
value
Value which was obtained
originalValue
Checks whether a value has been modified or not and returns the original value
pageIndex
Indicates an index of the document page, whence the result is received
boundRect
Field rectangular area coordinates on the image (for document filling fields reading results RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED)
validity
Identifies verification result. eRPRM_FieldVerificationResult enumeration contains possible conditions
comparison
Contains a comparison result of all values of the same text field, where the key is one of the eRPRM_ResultType enumeration values and the value is one of the eRPRM_FieldVerificationResult enumeration values
probability
Symbol recognition probability (0–100, %)
status
Stores one of eCheckResult enumeration which indicates verification result of the field

Image Quality Group

These parameters are presented in ImageQualityGroup class.
1
imageQuality
2
└── count
3
└── result
4
└── imageQualityList
5
| └── featureType
6
| └── result
7
| └── type
8
| └── boundRects
Copied!
Parameter
Description
count
Number of results in the list
result
Overall check result, one of eCheckResult
imageQualityList
Array of single check result pointers, which contains:

Document Type Result

These parameters are presented in DocumentReaderDocumentType class.
1
documentType
2
└── name
3
└── documentID
4
└── ICAOCode
5
└── dType
6
└── FDSID
7
└── dFormat
8
└── dMRZ
9
└── dDescription
10
└── dYear
11
└── dCountryName
12
└── pageIndex
Copied!
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. Identifiers determine document geometric format according ISO/IEC 7810
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

Barcode Result

These parameters are presented in DocumentReaderBarcodeResult class.
1
barcodeResult
2
└── fields
3
| └── barcodeType
4
| └── status
5
| └── pdf417Info
6
| | └── errorLevel
7
| | └── columns
8
| | └── rows
9
| └── data
10
| └── pageIndex
Copied!
Parameter
Description
barcodeType
Decoded barcode type, one of BarcodeType enumeration values
status
Indicates barcode reading result, one of BarcodeResult enumeration values or another value, which is SDK internal error code
pdf417Info
Contains the information about the PDF417 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

1
documentPosition / mrzPosition / barcodePosition
2
└── docFormat
3
└── width
4
└── height
5
└── angle
6
└── dpi
7
└── inverse
8
└── perspectiveTr
9
└── objArea
10
└── objIntAngleDev
11
└── resultStatus
12
└── center
13
| └── x
14
| └── y
15
└── leftTop
16
| └── x
17
| └── y
18
└── leftBottom
19
| └── x
20
| └── y
21
└── rightTop
22
| └── x
23
| └── y
24
└── rightBottom
25
| └── x
26
| └── y
27
└── pageIndex
Copied!
Parameter
Description
docFormat
Document format, one of DocFormat enumeration values
width
Document width
height
Document height
angle
Document rotation angle
dpi
Resolution in dots per inch
inverse
Internal use parameter
perspectiveTr
Internal use parameter
objArea
Internal use parameter
objIntAngleDev
Internal use parameter
resultStatus
Internal use parameter, one of eCheckResult enumeration values
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
pageIndex
Index of the document page, whence the result is received

Authenticity Result

These parameters are presented in DocumentReaderAuthenticityResult class.
1
authenticityResult
2
└── checks
3
| └── type
4
| └── typeName
5
| └── elements
6
| | └── status
7
| | └── elementType
8
| | └── elementTypeName
9
| | └── elementDiagnose
10
| | └── elementDiagnoseName
11
| └── pageIndex
12
| └── status
13
└── status
Copied!
Parameter
Description
checks
Stores the result of document authenticity check using the images for different lighting schemes
type
Type of the performed check, one of eRPRM_Authenticity enumeration values
elementType
Element type, one of eRPRM_SecurityFeatureType enumeration values
elementDiagnose
Element diagnose, one of eCheckDiagnose enumeration values
pageIndex
Index of the document page, whence the result is received
status
Overall check result, one of eCheckResult enumeration values

RFID Result

These parameters are presented in RFIDSessionData class.
1
rfidSessionData
2
└── accessControls
3
| └── activeOptionIdx
4
| └── notifications
5
| └── status
6
| └── type
7
└── applications
8
| └── applicationID
9
| └── dataHashAlgorithm
10
| └── files
11
| | └── fileData
12
| | | └── data
13
| | | └── length
14
| | | └── status
15
| | | └── type
16
| | └── fileID
17
| | └── notifications
18
| | └── pAStatus
19
| | └── readingStatus
20
| | └── readingTime
21
| | └── type
22
| | └── docFieldsText
23
| | └── docFieldsGraphics
24
| | └── docFieldsOriginals
25
| | └── certificates
26
| | | └── securityObject
27
| | | | └── data
28
| | | | └── length
29
| └── status
30
| └── type
31
| └── unicodeVersion
32
| └── version
33
└── securityObjects
34
| └── fileReference
35
| └── objectType
36
| └── version
37
| └── signerInfos
38
| | └── dataToHash
39
| | └── digestAlgorithm
40
| | └── paStatus
41
| | └── signatureAlgorithm
42
| | └── version
43
| | └── issuer
44
| | | └── attributes
45
| | | | └── type
46
| | | | └── value
47
| | | | | └── data
48
| | | | | └── length
49
| | | | | └── status
50
| | | | | └── type
51
| | | | | └── format
52
| | | └── data
53
| | | └── friendlyName
54
| | | | └── data
55
| | | | └── length
56
| | | | └── status
57
| | | | └── type
58
| | | | └── format
59
| | └── serialNumber
60
| | | └── data
61
| | | └── length
62
| | | └── status
63
| | | └── type
64
| | | └── format
65
| | └── signature
66
| | | └── data
67
| | | └── length
68
| | | └── status
69
| | | └── type
70
| | | └── format
71
| | └── signedAttributes
72
| | | └── data
73
| | | └── type
74
| | └── subjectKeyIdentifier
75
| | | └── data
76
| | | └── length
77
| | | └── status
78
| | | └── type
79
| | | └── format
80
| | └── certificateChain
81
| | | └── extensions
82
| | | | └── data
83
| | | | └── type
84
| | | └── fileName
85
| | | | └── data
86
| | | | └── length
87
| | | | └── status
88
| | | | └── type
89
| | | | └── format
90
| | | └── issuer
91
| | | | └── attributes
92
| | | | | └── type
93
| | | | | └── value
94
| | | | | | └── data
95
| | | | | | └── length
96
| | | | | | └── status
97
| | | | | | └── type
98
| | | | | | └── format
99
| | | | └── data
100
| | | | └── friendlyName
101
| | | | | └── data
102
| | | | | └── length
103
| | | | | └── status
104
| | | | | └── type
105
| | | | | └── format
106
| | | └── notifications
107
| | | └── origin
108
| | | └── paStatus
109
| | | └── serialNumber
110
| | | └── signatureAlgorithm
111
| | | └── subject
112
| | | | └── attributes
113
| | | | | └── type
114
| | | | | └── value
115
| | | | | | └── data
116
| | | | | | └── length
117
| | | | | | └── status
118
| | | | | | └── type
119
| | | | | | └── format
120
| | | | └── data
121
| | | | └── friendlyName
122
| | | | | └── data
123
| | | | | └── length
124
| | | | | └── status
125
| | | | | └── type
126
| | | | | └── format
127
| | | └── subjectPKAlgorithm
128
| | | └── type
129
| | | └── validity
130
| | | | └── notAfter
131
| | | | | └── data
132
| | | | | └── length
133
| | | | | └── status
134
| | | | | └── type
135
| | | | | └── format
136
| | | | └── notBefore
137
| | | | | └── data
138
| | | | | └── length
139
| | | | | └── status
140
| | | | | └── type
141
| | | | | └── format
142
| | | └── version
143
| | └── notifications
144
| └── notifications
145
└── cardProperties
146
| └── aTQA
147
| └── aTQB
148
| └── aTR
149
| └── baudrate1
150
| └── baudrate2
151
| └── bitRateR
152
| └── bitRateS
153
| └── chipTypeA
154
| └── mifareMemory
155
| └── rfidType
156
| └── sAK
157
| └── support4
158
| └── supportMifare
159
| └── uID
160
└── totalBytesReceived
161
└── totalBytesSent
162
└── status
163
└── extLeSupport
164
└── processTime
165
└── sessionDataStatus
166
| └── AA
167
| └── BAC
168
| └── CA
169
| └── PA
170
| └── PACE
171
| └── TA
172
| └── overallStatus
Copied!
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 eCheckResult values
BAC
BAC status, one of eCheckResult values
CA
CA status, one of eCheckResult values
PA
PA status, one of eCheckResult values
PACE
PACE status, one of eCheckResult values
TA
TA status, one of eCheckResult values
overallStatus
overall status, one of eCheckResult values
Last modified 1mo ago