Response Schema

• Overview
• Containers
  • Status
  • Text
  • Images
  • Document Type
  • Image Quality
  • Authenticity
  • MRZ Position
  • Document Position
  • VDS. Visible Digital Seal
  • VDS-NC. Visible Digital Seal for Non-Constrained Environments
• Transaction Info

Overview

This page provides a description of results formed during document processing. The description is provided from the high to the low level.

├── ContainerList
├── ProcessingFinished
├── morePagesAvailable
├── ChipPage
├── elapsedTime
├── TransactionInfo
├── log
└── passBackObject

Parameter	Description
ContainerList	The list of containers that store results formed during the data scanning and processing cycle.
ProcessingFinished	The document processing finish status, one of the ProcessingStatus enumeration values.
morePagesAvailable	Indicates if a document has more pages to be processed, for example, ID card's front and back side. Requires the Document Type recognition, otherwise, it is 0 by default.
ChipPage	Indicates the presence and location of an RFID chip in a document, one of the RfidLocation enumeration values. Requires Document Type recognition, otherwise returns 1 by default.
elapsedTime	Time the document processing has taken, ms.
TransactionInfo	Stores the metadata of the environment and other machine system data.
log	Base64 encoded transaction processing log.
passBackObject	Free-form object provided in request.

Containers

The list of containers that stores results formed during the document processing.

ContainerList
├── Count
├── List
│   ├── Status
│   ├── Text
│   ├── Images
│   ├── OneCandidate
│   ├── ImageQualityCheckList
│   ├── AuthenticityCheckList
│   ├── MrzPosition
│   ├── DocumentPosition
│   ├── dftVDS
│   ├── dftVDS_NC
│   └── ...

Result name	Result type	Description
Status	33	The statuses of all verifications performed.
Text	36	The text data.
Images	37	The graphic data.
OneCandidate	9	The information about the document type.
ImageQualityCheckList	30	The results of image quality checks.
AuthenticityCheckList	20	The results of document authenticity checks.
MrzPosition	61	The information about the MRZ position.
DocumentPosition	85	The information about the document position.
dftVDS	125	The information about the Visible Digital Seal.
dftVDS_NC	124	The information about the Visible Digital Seal for Non-Constrained Environments.

Info

The extended list of all available kinds of results can be found in the Programmers Guide.

Status

This result type contains the statuses of all verifications performed.

Status
├── overallStatus
├── optical
├── rfid
├── detailsOptical
│   ├── overallStatus
│   ├── docType
│   ├── expiry
│   ├── imageQA
│   ├── mrz
│   ├── pagesCount
│   ├── security
│   ├── text
│   └── vds
├── detailsRFID
│   ├── overallStatus
│   ├── BAC
│   ├── PACE
│   ├── CA
│   ├── TA
│   ├── AA
│   └── PA
├── portrait
└── stopList

Parameter	Description
overallStatus	The summary of all checks, one of the CheckResult enumeration values.
optical	The summary of all optical checks. Same as detailsOptical.overallStatus, one of the CheckResult enumeration values.
rfid	The summary of all RFID checks. Same as detailsRFID.overallStatus, one of the CheckResult enumeration values.
detailsOptical.overallStatus	The summary of all optical checks. Same as optical, one of the CheckResult enumeration values.
detailsOptical.docType	The check status if document type was recognized or not, one of the CheckResult enumeration values.
detailsOptical.expiry	The document validity period verification status, one of the CheckResult enumeration values.
detailsOptical.imageQA	The input images quality verification status, one of the CheckResult enumeration values.
detailsOptical.mrz	MRZ verification: values validity, dates, checkdigits verification, one of the CheckResult enumeration values.
detailsOptical.pagesCount	The number of scanned document pages, integer.
detailsOptical.security	The authenticity verification status, one of the CheckResult enumeration values.
detailsOptical.text	Text fields status: values validity for specific fields, cross-comparison of values from different sources, dates & checkdigits verification, one of the CheckResult enumeration values.
detailsOptical.vds	The Visible Digital Seal verification status, one of the CheckResult enumeration values.
detailsRFID.overallStatus	The summary of all RFID checks. Same as rfid, one of the CheckResult enumeration values.
detailsRFID.BAC	The Basic Access Control status, one of the CheckResult enumeration values.
detailsRFID.PACE	The Password Authenticated Connection Establishment status, one of the CheckResult enumeration values.
detailsRFID.CA	The Chip Authentication status, one of the CheckResult enumeration values.
detailsRFID.TA	The Terminal Authentication status, one of the CheckResult enumeration values.
detailsRFID.AA	The Active Authentication status, one of the CheckResult enumeration values.
detailsRFID.PA	The Passive Authentication status, one of the CheckResult enumeration values.
portrait	The comparison status for portrait in the document against the live or external image, one of the CheckResult enumeration values.
stopList	The verification status for the document data against the database, one of the CheckResult enumeration values.

Text

Contains the text data.

Text
├── availableSourceList
│   ├── containerType
│   ├── source
│   └── validityStatus
├── comparisonStatus
├── dateFormat
├── fieldList
│   ├── comparisonList
│   ├── comparisonStatus
│   ├── fieldName
│   ├── fieldType
│   ├── lcid
│   ├── lcidName
│   ├── status
│   ├── validityList
│   │   ├── source
│   │   └── status
│   ├── validityStatus
│   ├── value
│   ├── valueList
│   │   ├── containerType
│   │   ├── fieldRect
│   │   │   ├── bottom
│   │   │   ├── left
│   │   │   ├── right
│   │   │   └── top
│   │   ├── originalSymbols
│   │   │   ├── code
│   │   │   ├── probability
│   │   │   ├── rect
│   │   │   │   ├── bottom
│   │   │   │   ├── left
│   │   │   │   ├── right
│   │   │   │   └── top
│   │   ├── originalValidity
│   │   ├── pageIndex
│   │   ├── probability
│   │   ├── source
│   │   └── value
├── status
└── validityStatus

Parameter	Description
availableSourceList	The list of available sources.
availableSourceList.containerType	The source type, integer representation, one of the Result enumeration values.
availableSourceList.source	The source name, string representation.
availableSourceList.validityStatus	The verification result, one of the CheckResult enumeration values.
comparisonStatus	The comparison result, one of the CheckResult enumeration values.
dateFormat	The date format.
fieldList	The list of available text fields.
fieldList.comparisonList	The list of available comparisons in the given text field.
fieldList.comparisonStatus	The comparison status in the given text field, one of the CheckResult enumeration values.
fieldList.fieldName	The text field name, string representation.
fieldList.fieldType	The text field type, integer representation, one of the TextFieldType enumeration values.
fieldList.lcid	The LCID type, integer representation, one of the LCID enumeration values.
fieldList.lcidName	The LCID name, string representation.
fieldList.status	The overall result of the given text field that combines comparsion and verification results, one of the CheckResult enumeration values.
fieldList.validityList	The list of verification results.
fieldList.validityStatus	The verification result of the text field, one of the CheckResult enumeration values.
fieldList.value	The single text field value.
fieldList.valueList	The list of all available values in the given text field.
fieldList.valueList.containerType	The source type of the value, integer representation, one of the Result enumeration values.
fieldList.valueList.fieldRect	The text field value rectangular area coordinates on the image.
fieldList.valueList.originalSymbols	Original symbols.
fieldList.valueList.originalValidity	Original validity.
fieldList.valueList.pageIndex	The page index.
fieldList.valueList.probability	The symbol recognition probability.
fieldList.valueList.source	The source name of the value, string representation.
fieldList.valueList.value	The single text field value.
status	The overall result of all available text fields that combines comparsion and verification results, one of the CheckResult enumeration values.
validityStatus	The overall verification result of all available text fields, one of the CheckResult enumeration values.

Images

Contains the graphic data.

Images
├── availableSourceList
│   ├── containerType
│   └── source
├── fieldList
│   ├── fieldName
│   ├── fieldType
│   ├── valueList
│   │   ├── value
│   │   ├── containerType
│   │   ├── source
│   │   ├── lightIndex
│   │   ├── fieldRect
│   │   │   ├── bottom
│   │   │   ├── left
│   │   │   ├── right
│   │   │   └── top
│   │   ├── originalPageIndex
│   │   └── pageIndex

Parameter	Description
availableSourceList	The list of available sources.
availableSourceList.containerType	The source type, integer representation, one of the Result enumeration values.
availableSourceList.source	The source name, string representation.
fieldList	The list of available graphic fields.
fieldList.fieldName	The graphic field name, string representation.
fieldList.fieldType	The graphic field type, integer representation, one of the GraphicFieldType enumeration values.
fieldList.valueList	The list of graphic field values.
fieldList.valueList.value	The image value, Base64 format.
fieldList.valueList.containerType	The source type which the value belongs to, integer representation, one of the Result enumeration values.
fieldList.valueList.source	The source name which the value belongs to, string representation.
fieldList.valueList.lightIndex	The lightning scheme, one of the Light enumeration values.
fieldList.valueList.fieldRect	The field rectangular area coordinates on the image.
fieldList.valueList.originalPageIndex	Original page index.
fieldList.valueList.pageIndex	The page index.

Document Type

Contains the information about the document type.

OneCandidate
├── AuthenticityNecessaryLights
├── CheckAuthenticity
├── DocumentName
├── FDSIDList
│   ├── Count
│   ├── ICAOCode
│   ├── List
│   ├── dCountryName
│   ├── dFormat
│   ├── dMRZ
│   ├── dType
│   └── dYear
├── ID
├── NecessaryLights
├── OVIExp
├── P
├── RFID_Presence
├── Rotated180
├── RotationAngle
└── UVExp

Parameter	Description
AuthenticityNecessaryLights	The combination of identifiers of necessary lighting schemes to perform authenticity check for the given document type.
CheckAuthenticity	Set of authenticity check options provided for the given document type.
DocumentName	The document type name.
FDSIDList	Additional document information and its link to IRS document(s).
FDSIDList.Count	Number of elements in the array.
FDSIDList.ICAOCode	The document issuing country ICAO Code.
FDSIDList.List	The array of IRS document identifiers.
FDSIDList.dCountryName	The name of the country that issued the document.
FDSIDList.dFormat	The document format.
FDSIDList.dMRZ	A flag for MRZ presence on the document.
FDSIDList.dType	The document type, one of the DocumentType enumeration values.
FDSIDList.dYear	The year the document was issued.
ID	The document type numeric code.
NecessaryLights	The combination of identifiers of necessary lighting schemes to perform OCR for the given document type.
OVIExp	The camera exposure value necessary when obtaining document images of the given type for AXIAL lighting scheme.
P	Estimation of correct recognition probability when analyzing the given document type.
RFID_Presence	Presence of RFID chip in the document.
Rotated180	true if the document of the given type is rotated by 180 degrees.
UVExp	The camera exposure value necessary when obtaining document images of the given type for UV lighting scheme.

Image Quality

Contains the results of image quality checks.

ImageQualityCheckList
├── Count
├── List
│   ├── type
│   ├── featureType
│   ├── result
│   ├── areas
│   │   ├── Count
│   │   ├── List
│   │   │   ├── bottom
│   │   │   ├── left
│   │   │   ├── right
│   │   │   └── top
│   │   └── Points
│   ├── mean
│   ├── probability
│   └── std_dev
└── result

Parameter	Description
Count	The number of results in the array.
List	The list of single check result pointers.
List.type	The check result type, one of the ImageQualityCheckType enumeration values.
List.featureType	The area examined, one of the SecurityFeatureType enumeration values.
List.result	The check result, one of the CheckResult enumeration values.
List.areas	Anomalous image areas.
List.mean	The check mean value.
List.probability	The check probability.
List.std_dev	The check deviation.
result	The overall check result, one of the CheckResult enumeration values.

Authenticity

Contains the results of document authenticity checks.

There are several groups of results within the Authenticity checks that differ in the structure:

• Security Feature Check. This group includes the following types of Authenticity checks:
  • UV luminescence check
  • IR B900
  • Axial protection
  • Photo embedding type
  • Photo area
  • Barcode format check
  • Extended OCR check
  • Extended MRZ check
• Ident Result. This group includes the following types of Authenticity checks:
  • Image patterns
  • IR visibility
  • OVI
  • Comparison of the portraits
  • Kinegram
  • LetterScreen check
  • Holograms
  • Comparison of the fingerprints
  • Liveness
• Fibers Check. This group includes the following types of Authenticity checks:
  • UV security fibers
• OCR Security Text Result. This group includes the following types of Authenticity checks:
  • OCR Security text
• Photo Ident Check. This group includes the following types of Authenticity checks:
  • IPI (invisible personal information)

Security Feature CheckIdent ResultFibers CheckOCR Security Text ResultPhoto Ident Check

AuthenticityCheckList
├── Type
├── Result
├── List
│   ├── ElementType
│   ├── ElementResult
│   ├── ElementDiagnose
│   ├── ElementRect
│   │   ├── left
│   │   ├── top
│   │   ├── right
│   │   └── bottom

Parameter	Description
Type	The type of the preforemed check, one of the AuthenticityResultType enumeration values.
Result	The overall result of all checked elements that are in the List, one of the CheckResult enumeration values.
List	The list of elements that are checked
ElementType	The type of security element checked, one of the SecurityFeatureType enumeration values.
ElementResult	The verification status of the element, one of the CheckResult enumeration values.
ElementDiagnose	Contains the reason why the verification failed, one of the CheckDiagnose enumeration values.
ElementRect	The element coordinates

AuthenticityCheckList
├── Type
├── Result
├── List
│   ├── ElementType
│   ├── ElementResult
│   ├── ElementDiagnose
│   ├── Image
│   ├── EtalonImage
│   ├── PercentValue
│   ├── LightIndex
│   ├── Area
│   │   ├── left
│   │   ├── top
│   │   ├── right
│   │   └── bottom

Parameter	Description
Type	The type of the preforemed check, one of the AuthenticityResultType enumeration values.
Result	The overall result of all checked elements that are in the List, one of the CheckResult enumeration values.
List	The list of elements that are checked
ElementType	The type of security element checked, one of the SecurityFeatureType enumeration values.
ElementResult	The verification status of the element, one of the CheckResult enumeration values.
ElementDiagnose	Contains the reason why the verification failed, one of the CheckDiagnose enumeration values.
Image	The image captured during document processing.
EtalonImage	The etalon image that stores in the database. This image compares with the Image.
PercentValue	The percent of the match of the etalon image and the captured one.
LightIndex	The lightning scheme, one of the Light enumeration values.
Area	The coordinates of the checked fragment.

AuthenticityCheckList
├── Type
├── Result
├── List
│   ├── ElementResult
│   ├── ElementDiagnose
│   ├── RectArray
│   │   ├── left
│   │   ├── top
│   │   ├── right
│   │   └── bottom

Parameter	Description
Type	The type of the preforemed check, one of the AuthenticityResultType enumeration values.
Result	The overall result of all checked elements that are in the List, one of the CheckResult enumeration values.
List	The list of elements that are checked
ElementResult	The verification status of the element, one of the CheckResult enumeration values.
ElementDiagnose	Contains the reason why the verification failed, one of the CheckDiagnose enumeration values.
Area	The coordinates of fibers.

AuthenticityCheckList
├── Type
├── Result
├── List
│   ├── ElementResult
│   ├── ElementDiagnose
│   ├── EtalonFieldType
│   ├── LightType
│   ├── FieldRect
│   │   ├── left
│   │   ├── top
│   │   ├── right
│   │   └── bottom

Parameter	Description
Type	The type of the preforemed check, one of the AuthenticityResultType enumeration values.
Result	The overall result of all checked elements that are in the List, one of the CheckResult enumeration values.
List	The list of elements that are checked
ElementResult	The verification status of the element, one of the CheckResult enumeration values.
ElementDiagnose	Contains the reason why the verification failed, one of the CheckDiagnose enumeration values.
EtalonFieldType	The etalon text field type, one of the TextFieldType enumeration values.
LightType	The lightning scheme, one of the Light enumeration values.
FieldRect	The coordinates of the checked fragment.

AuthenticityCheckList
├── Type
├── Result
├── List
│   ├── ElementResult
│   ├── ElementDiagnose
│   ├── ResultImages
│   ├── SourceImage
│   ├── LightIndex
│   ├── Area
│   │   ├── left
│   │   ├── top
│   │   ├── right
│   │   └── bottom

Parameter	Description
Type	The type of the preforemed check, one of the AuthenticityResultType enumeration values.
Result	The overall result of all checked elements that are in the List, one of the CheckResult enumeration values.
List	The list of elements that are checked
ElementResult	The verification status of the element, one of the CheckResult enumeration values.
ElementDiagnose	Contains the reason why the verification failed, one of the CheckDiagnose enumeration values.
ResultImages	The array of the output images.
SourceImage	The array of the source images.
LightIndex	The lightning scheme, one of the Light enumeration values.
Area	The coordinates of the checked fragment.

Info

The extended Authenticity results structure can be found in the Document Reader Web Open API specification.

MRZ Position

Contains the information about the MRZ position.

MrzPosition
├── Angle
├── Center
│   ├── x
│   └── y
├── Dpi
├── Height
├── Inverse
├── LeftBottom
│   ├── x
│   └── y
├── LeftTop
│   ├── x
│   └── y
├── ObjArea
├── ObjIntAngleDev
├── PerspectiveTr
├── ResultStatus
├── RightBottom
│   ├── x
│   └── y
├── RightTop
│   ├── x
│   └── y
├── Width
└── docFormat

Parameter	Description
Angle	The document rotation angle.
Center	The document center coordinates.
Dpi	Resolution in dots per inch.
Height	The document height.
Inverse	Internal use parameter.
LeftBottom	Document left bottom corner coordinates.
LeftTop	Document left top corner coordinates.
ObjArea	Internal use parameter.
ObjIntAngleDev	Internal use parameter.
PerspectiveTr	Internal use parameter.
ResultStatus	Internal use parameter.
RightBottom	The document right bottom corner coordinates.
RightTop	The document right top corner coordinates.
Width	The document width.
docFormat	The document format.

Document Position

Contains the information about the document position.

DocumentPosition
├── Angle
├── Center
│   ├── x
│   └── y
├── Dpi
├── Height
├── Inverse
├── LeftBottom
│   ├── x
│   └── y
├── LeftTop
│   ├── x
│   └── y
├── ObjArea
├── ObjIntAngleDev
├── PerspectiveTr
├── ResultStatus
├── RightBottom
│   ├── x
│   └── y
├── RightTop
│   ├── x
│   └── y
├── Width
└── docFormat

Parameter	Description
Angle	The document rotation angle.
Center	The document center coordinates.
Dpi	Resolution in dots per inch.
Height	The document height.
Inverse	Internal use parameter.
LeftBottom	The document left bottom corner coordinates.
LeftTop	The document left top corner coordinates.
ObjArea	Internal use parameter.
ObjIntAngleDev	Internal use parameter.
PerspectiveTr	Internal use parameter.
ResultStatus	Internal use parameter.
RightBottom	The document right bottom corner coordinates.
RightTop	The document right top corner coordinates.
Width	The document width.
docFormat	The document format.

VDSData. Visible Digital Seal

Contains the information about the Visible Digital Seal.

dftVDS
└── Type
└── DocType
└── FeatureRef
└── Version
└── Certificate
└── CertificateChain
└── DocIssueDate
└── DocFeatures
└── IssuingCountry
└── Notifications
└── Signature
└── SignatureDate
└── Signer

Parameter	Description
Type	Visible Digital Seal use case type. Type is set to icao.test for Proof of Testing (data defined by CAPSCA), icao.vacc for Proof of Vaccination (data defined by WHO). Other Types may be added in the future.
DocType	Type of the document associated with the seal.
FeatureRef	Reference to the document feature covered by the seal.
Version	Visible Digital Seal use case version.
Certificate	The binary data of the signer certificate.
CertificateChain	Certificate chain, used for the digital signature verification.
DocIssueDate	Document issuance date included in the seal.
DocFeatures	The list of features, available for the document.
IssuingCountry	Three letter code identifying the issuing state or organization.
Notifications	The list of remarks occured during the scanning procedure.
Signature	The binary data of the verified digital signature.
SignatureDate	Date when the VDS was signed.
Signer	Entity that generated and signed the seal.

VDSNCData. Visible Digital Seal for Non-Constrained Environments

Contains the information about the Visible Digital Seal for Non-Constrained Environments.

dftVDS_NC
└── Type
└── Version
└── IssuingCountry
└── Message
└── SignatureAlg
└── Signature
└── Certificate
└── CertificateChain
└── Notifications

Parameter	Description
Type	Visible Digital Seal use case type. Type is set to icao.test for Proof of Testing (data defined by CAPSCA), icao.vacc for Proof of Vaccination (data defined by WHO). Other Types may be added in the future.
Version	Visible Digital Seal use case version.
IssuingCountry	Three letter code identifying the issuing state or organization.
Message	The message field contains the actual data as a JSONObject.
SignatureAlg	The signature algorithm used to produce the signature. ECDSA scheme.
Signature	The binary data of the verified digital signature.
Certificate	The binary data of the signer certificate.
CertificateChain	The сertificate chain, used for the digital signature verification.
Notifications	The list of remarks occured during the scanning procedure.

Transaction Info

TransactionInfo
├── ComputerName
├── DateTime
├── SystemInfo
├── TransactionID
├── UserName
└── Version

Parameter	Description
ComputerName	The name, version and other details about the current machine and the operating system running on it.
DateTime	The date and time of the transaction.
SystemInfo	The system information of the current machine.
TransactionID	GUID of the transaction.
UserName	The name of the current machine.
Version	Version of the Document Reader SDK.