Response Schema
├── ChipPage
├── ContainerList
│ └── ...
├── ProcessingFinished
├── TransactionInfo
│ └── ...
├── elapsedTime
├── log
├── morePagesAvailable
└── passBackObject
| Parameter |
Description |
| ChipPage |
Indicates the presence and location of an RFID chip in a document.
0—no RFID chip; 1—the chip is located in the document data page; 2—the chip is located in the back page or inlay of the document. Requires Document Type recognition, otherwise returns 1 by default. |
| 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 values. |
| TransactionInfo |
Stores the metadata of the environment and other machine system data. |
| elapsedTime |
Time the document processing has taken, ms. |
| log |
Base64 encoded transaction processing log. |
| 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. |
| passBackObject |
Free-form object provided in request. |
ContainerList
The list of containers that stores results formed during the document processing.
ContainerList
├── Count
├── List
│ ├── Text
│ │ └── ...
│ ├── Images
│ │ └── ...
│ ├── Status
│ │ └── ...
│ ├── OneCandidate
│ │ └── ...
│ ├── MrzPosition
│ │ └── ...
│ ├── DocumentPosition
│ │ └── ...
│ ├── DocVisualExtendedInfo
│ │ └── ...
│ ├── DocBarCodeInfo
│ │ └── ...
│ ├── DocGraphicsInfo
│ │ └── ...
│ ├── ResultMRZDetector
│ │ └── ...
│ ├── MRZTestQuality
│ │ └── ...
│ ├── FaceDetection
│ │ └── ...
│ ├── AuthenticityCheckList
│ │ └── ...
│ ├── ImageQualityCheckList
│ │ └── ...
│ ├── ListVerifiedFields
│ │ └── ...
│ ├── RawImageContainer
│ │ └── ...
| Container |
Result type |
Description |
| Text |
36 |
Stores the text results. |
| Images |
37 |
Stores the graphic results. |
| Status |
33 |
Stores the statuses of the document verificatio. |
| OneCandidate |
9 |
Stores the document type information. |
| MrzPosition |
61 |
Stores the MRZ position information. |
| DocumentPosition |
85 |
Stores the document position information. |
| DocVisualExtendedInfo |
3 |
Stores text results of MRZ. |
| DocBarCodeInfo |
5 |
Stores results of barcodes areas search on the scanned document page and their reading in binary non-formatted code. |
| DocGraphicsInfo |
6 |
Stores graphic results of document filling area and barcodes reading. |
| MRZTestQuality |
7 |
Stores the information on document MRZ printing quality check results. |
| AuthenticityCheckList |
20 |
Stores the results of performing different document authenticity checks. |
| ImageQualityCheckList |
30 |
Stores the results of performing different image quality checks. |
| ListVerifiedFields |
15 |
Stores the results of comparing the MRZ text data, document filling area data, barcodes data and data retrieved from RFID-chip. |
Text
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. |
| availableSourceList.source |
The source name, string representation. |
| availableSourceList.validityStatus |
The verification result. |
| comparisonStatus |
The comparison result. |
| 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. |
| fieldList.fieldName |
The text field name, string representation. |
| fieldList.fieldType |
The text field type, integer representation. |
| fieldList.lcid |
The LCID type, integer representation. |
| fieldList.lcidName |
The LCID name, string representation. |
| fieldList.status |
The overall result of the given text field that combines comparsion and verification results. |
| fieldList.validityList |
The list of verification results. |
| fieldList.validityStatus |
The verification result of the text field. |
| 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 typ of the value, integer representation, one of the Result. |
| 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. |
| validityStatus |
The overall verification result of all available text fields. |
Images
Images
├── availableSourceList
│ ├── containerType
│ └── source
├── fieldList
│ ├── fieldName
│ ├── fieldType
│ ├── valueList
│ │ ├── containerType
│ │ ├── fieldRect
│ │ │ ├── bottom
│ │ │ ├── left
│ │ │ ├── right
│ │ │ └── top
│ │ ├── lightIndex
│ │ ├── originalPageIndex
│ │ ├── pageIndex
│ │ ├── source
│ │ └── value
| Parameter |
Description |
| availableSourceList |
The list of available sources. |
| availableSourceList.containerType |
The source type, integer representation, one of the Result. |
| 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. |
| fieldList.valueList |
The list of graphic field values. |
| fieldList.valueList.containerType |
The source type which the value belongs to, integer representation. |
| fieldList.valueList.fieldRect |
The field rectangular area coordinates on the image. |
| fieldList.valueList.lightIndex |
The lightning scheme. |
| fieldList.valueList.originalPageIndex |
Original page index. |
| fieldList.valueList.pageIndex |
The page index. |
| fieldList.valueList.source |
The source name which the value belongs to, string representation. |
| fieldList.valueList.value |
The image value, Base64 format. |
Status
Status
├── detailsOptical
│ ├── docType
│ ├── expiry
│ ├── imageQA
│ ├── mrz
│ ├── overallStatus
│ ├── pagesCount
│ ├── security
│ ├── text
│ └── vds
├── detailsRFID
│ ├── AA
│ ├── BAC
│ ├── CA
│ ├── PA
│ ├── PACE
│ ├── TA
│ └── overallStatus
├── optical
├── overallStatus
├── portrait
├── rfid
└── stopList
| Parameter |
Description |
| detailsOptical.docType |
The check status if document type was recognized or not. |
| detailsOptical.expiry |
The document validity period verification status. |
| detailsOptical.imageQA |
The input images quality verification status. |
| detailsOptical.mrz |
MRZ verification: values validity, dates, checkdigits verification. |
| detailsOptical.overallStatus |
The summary of all optical results. |
| detailsOptical.pagesCount |
The number of scanned document pages, integer. |
| detailsOptical.security |
The authenticity verification status. |
| detailsOptical.text |
Text fields valitity: values validity for specific fields, cross-comparison of values from different sources, dates & checkdigits verification. |
| detailsOptical.vds |
The Visible Digital Seal verification status. |
| detailsRFID.AA |
The active authentication status. |
| detailsRFID.BAC |
The basics access control status. |
| detailsRFID.CA |
The chip authentication status. |
| detailsRFID.PA |
The passive authentication status. |
| detailsRFID.PACE |
The password authenticated connection establishment status. |
| detailsRFID.TA |
The terminal authentication status. |
| detailsRFID.overallStatus |
The summary of all RFID results. |
| optical |
The summary of all optical results. Same as detailsOptical.overallStatus. |
| overallStatus |
The summary of all results. |
| portrait |
The comparison status for portrait in the document against the live or external image. |
| rfid |
The summary of all RFID results. Same as detailsRFID.overallStatus. |
| stopList |
The verification status for the document data against the database. |
OneCandidate
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. |
| 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. |
ImageQualityCheckList
ImageQualityCheckList
├── Count
├── List
│ ├── areas
│ │ ├── Count
│ │ ├── List
│ │ │ ├── bottom
│ │ │ ├── left
│ │ │ ├── right
│ │ │ └── top
│ │ └── Points
│ ├── featureType
│ ├── mean
│ ├── probability
│ ├── result
│ ├── std_dev
│ └── type
└── result
| Parameter |
Description |
| Count |
The number of results in the array. |
| List |
The list of single check result pointers. |
| List.areas |
Anomalous image areas. |
| List.featureType |
The area examined. |
| List.mean |
The check mean value. |
| List.probability |
The check probability. |
| List.result |
The check result. |
| List.std_dev |
The check deviation. |
| List.type |
The check result type. |
| result |
The overall check result. |
MrzPosition
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. |
DocumentPosition
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. |
TransactionInfo
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. |