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
└── chipPage
└── getOverallResult
└── processingFinished
└── morePagesAvailable
└── rfidResult
└── graphicResult
└── textResult
└── documentPosition
└── barcodePosition
└── mrzPosition
└── imageQuality
└── documentType
└── jsonResult
└── documentReaderNotification
└── rfidSessionData
└── authenticityResult
└── barcodeResult

chip page index (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;
overall result (getOverallResult). 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;
count of pages result (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;
RFID result (rfidResult). Result of RFID reading process, one of eRFID_NotificationAndErrorCodes;
resolution result (highResolution). Indicates, if document is needed with high resolution, false by default;
graphic result (graphicResult);
text result (textResult);
position of document blank result (documentPosition);
position of found Barcode result (barcodePosition);
position of the MRZ area (mrzPosition);
image quality group result (imageQualityGroup);
document type result (documentType);
JSON result (jsonResult);
notification result (documentReaderNotification). Notification data about reading process. Used when reading RFID chip;
RFID session data result (rfidSessionData). Results of work with the SDK within the context of the current communication session with electronic document;
authenticity result (authenticityResult);
barcode result (barcodeResult).

Graphic Result

These parameters are presented in DocumentReaderGraphicResult class.

graphicResult
└── fields
|   └── sourceType
|   └── fieldType
|   └── getFieldName
|   └── light
|   └── pageIndex
|   └── getData
|   └── getRect
|   |   └── bottom
|   |   └── left
|   |   └── right
|   |   └── top
|   └── imageBase64
|   └── getBitmap

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

getFieldName

Title of the fieldType

light

Indicates lightning scheme of the graphic field was taken in, one of eRPRM_Lights

getRect

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.

textResult
└── fields
|   └── fieldType
|   └── getFieldName
|   └── lcid
|   └── getLcidName
|   └── values
|   |   └── sourceType
|   |   └── value
|   |   └── originalValue
|   |   └── pageIndex
|   |   └── boundRect
|   |   |   └── left
|   |   |   └── top
|   |   |   └── right
|   |   |   └── bottom
|   |   └── validity
|   |   └── comparison
|   └── status
└── status

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

getFieldName

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

getLcidName

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

status

Stores one of eCheckResult enumeration which indicates verification result of the field

Image Quality Group

These parameters are presented in ImageQualityGroup class.

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

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:

type - check result type, one of eImageQualityCheckType values
result - check result, one of eCheckResult values
featureType - one of eRPRM_SecurityFeatureType values indicating the area examined

Document Type Result

These parameters are presented in DocumentReaderDocumentType class.

documentType
└── name
└── documentID
└── ICAOCode
└── dType
└── FDSID
└── 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 DocFormat 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

JSON Result

These parameters are presented in DocumentReaderJsonResult class.

jsonResult
└── results
|   └── resultType
|   └── lightType
|   └── pageIdx
|   └── jsonResult

Parameter

Description

resultType

One of eRPRM_ResultType enumeration values

lightType

Light scheme

pageIdx

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

jsonResult

Entire results in JSON format

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 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

These parameters are presented in ElementPosition class.

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

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.

authenticityResult
└── checks
|   └── type
|   └── elements
|   |   └── status
|   |   └── elementType
|   |   └── elementDiagnose
|   |   └── getElementTypeName
|   |   └── getElementDiagnoseName
|   └── pageIndex
|   └── getTypeName
|   └── getStatus
└── getStatus

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

getStatus

Overall check result, one of eCheckResult enumeration values

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
|   |   └── docFieldsText
|   |   └── docFieldsGraphics
|   |   └── docFieldsOriginals
|   |   └── certificates
|   |   |   └── securityObject
|   |   |   |   └── data
|   |   |   |   └── length
|   └── status
|   └── type
|   └── 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 status, one of eCheckResult values

BAC

BAC status, one of eCheckResult values

CA status, one of eCheckResult values

PA status, one of eCheckResult values

PACE

PACE status, one of eCheckResult values

TA status, one of eCheckResult values

overallStatus

overall status, one of eCheckResult values

PreviousResults NextGetting results

Last updated 4 years ago