Package io.scanbot.sdk.documentdata

Class DocumentDataExtractor

java.lang.Object

io.scanbot.sdk.documentdata.DocumentDataExtractor

All Implemented Interfaces:

AutoCloseable

public class DocumentDataExtractor
extends Object
implements AutoCloseable

API for extracting data from documents.

Constructor Summary

Constructors

Constructor	Description
DocumentDataExtractor(DocumentDataExtractorConfiguration configuration)	Constructs DocumentDataExtractor with the given params.

Method Summary

Modifier and Type	Method	Description
void	clearResult()	Clears the accumulated results.
void	close()	Closes native resources held by the object.
protected void	finalize()
DocumentDataExtractionResult	run(ImageRef image)	Recognize the document in the given image.
DocumentVerificationReport	verifyDocument(List<GenericDocument> documentParts)	Verify whether the extracted document has signs of forgery or tampering.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentDataExtractor

public DocumentDataExtractor(DocumentDataExtractorConfiguration configuration)
                      throws LicenseException

Constructs DocumentDataExtractor with the given params.

Parameters:

configuration - The configuration to use for the recognizer.

Throws:

LicenseException - If license requirements for the API are not met

Method Details

run

public DocumentDataExtractionResult run(ImageRef image)
                                 throws InvalidImageRefException,
LicenseException

Recognize the document in the given image.

Parameters:

image - The image to recognize.

Returns:

The recognition result.

Throws:

InvalidImageRefException - If an invalid image reference is used

LicenseException - If license requirements for the API are not met

clearResult

public void clearResult()

Clears the accumulated results. Should be called after a document has been recognized to the customers satisfaction to prevent a poisoned cache.

verifyDocument

public DocumentVerificationReport verifyDocument(List<GenericDocument> documentParts)
                                          throws InvalidImageRefException,
LicenseException

Verify whether the extracted document has signs of forgery or tampering.

Parameters:

documentParts - The document parts to verify. For example, the front and back of an ID card.

Returns:

The verification report.

Throws:

InvalidImageRefException - If an invalid image reference is used

LicenseException - If license requirements for the API are not met

close

public void close()

Closes native resources held by the object.

Specified by:

close in interface AutoCloseable

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable