Package io.scanbot.sdk.documentdata

Class DocumentVerificationReport

java.lang.Object

io.scanbot.sdk.documentdata.DocumentVerificationReport

public class DocumentVerificationReport
extends Object

Report of the document verification.

Constructor Summary

Constructors

Constructor	Description
DocumentVerificationReport(DocumentVerificationStatus overallVerificationStatus, ConsistencyVerificationReport consistencyVerificationReport, SemanticsVerificationReport semanticsVerificationReport, SuspiciousDataVerificationReport suspiciousDataVerificationReport, InvalidDataVerificationReport invalidDataVerificationReport)	Constructs DocumentVerificationReport with the given params.

Method Summary

Modifier and Type	Method	Description
ConsistencyVerificationReport	getConsistencyVerificationReport()	Getter for consistencyVerificationReport field.
InvalidDataVerificationReport	getInvalidDataVerificationReport()	Getter for invalidDataVerificationReport field.
DocumentVerificationStatus	getOverallVerificationStatus()	Getter for overallVerificationStatus field.
SemanticsVerificationReport	getSemanticsVerificationReport()	Getter for semanticsVerificationReport field.
SuspiciousDataVerificationReport	getSuspiciousDataVerificationReport()	Getter for suspiciousDataVerificationReport field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentVerificationReport

public DocumentVerificationReport(DocumentVerificationStatus overallVerificationStatus,
 ConsistencyVerificationReport consistencyVerificationReport,
 SemanticsVerificationReport semanticsVerificationReport,
 SuspiciousDataVerificationReport suspiciousDataVerificationReport,
 InvalidDataVerificationReport invalidDataVerificationReport)

Constructs DocumentVerificationReport with the given params.

Parameters:

overallVerificationStatus - Overall status of the document verification.

consistencyVerificationReport - Report of the document consistency verification. Shows whether information in the fields that correspond to the same logical field and is present in different parts of the document is consistent.

semanticsVerificationReport - Report of the semantics verification. Shows whether the values in the fields are semantically correct.

suspiciousDataVerificationReport - Shows whether the data in the document is suspicious, e.g. contains word "Sample" in the name.

invalidDataVerificationReport - Some fields in the documents allow validation, for example, MRZ contains check digits to verify the data. This report shows whether there are any invalid fields in the document.

Method Details

getOverallVerificationStatus

public DocumentVerificationStatus getOverallVerificationStatus()

Getter for overallVerificationStatus field. See constructor documentation for more information about the field.

Returns:

overallVerificationStatus

getConsistencyVerificationReport

public ConsistencyVerificationReport getConsistencyVerificationReport()

Getter for consistencyVerificationReport field. See constructor documentation for more information about the field.

Returns:

consistencyVerificationReport

getSemanticsVerificationReport

public SemanticsVerificationReport getSemanticsVerificationReport()

Getter for semanticsVerificationReport field. See constructor documentation for more information about the field.

Returns:

semanticsVerificationReport

getSuspiciousDataVerificationReport

public SuspiciousDataVerificationReport getSuspiciousDataVerificationReport()

Getter for suspiciousDataVerificationReport field. See constructor documentation for more information about the field.

Returns:

suspiciousDataVerificationReport

getInvalidDataVerificationReport

public InvalidDataVerificationReport getInvalidDataVerificationReport()

Getter for invalidDataVerificationReport field. See constructor documentation for more information about the field.

Returns:

invalidDataVerificationReport