io.scanbot.genericdocument.entity

Class MRZ

GenericDocumentWrapper

io.scanbot.genericdocument.entity.MRZ

public class MRZ
extends GenericDocumentWrapper

MRZ part of the document

Field Detail

DOCUMENT_TYPE

@NotNull
public static java.lang.String DOCUMENT_TYPE

Generic document type name of this document wrapper.

See Also:

Constant Field Values

DOCUMENT_NORMALIZED_TYPE

@NotNull
public static java.lang.String DOCUMENT_NORMALIZED_TYPE

Normalized document type name of this document wrapper.

See Also:

Constant Field Values

Companion

public static io.scanbot.genericdocument.entity.MRZ.Companion Companion

Constructor Detail

MRZ

public MRZ(@NotNull
           GenericDocument document)

MRZ part of the document

Method Detail

getRequiredDocumentType

@NotNull
protected java.lang.String getRequiredDocumentType()

The required type of the wrapped document. Null if this wrapper can wrap more than one type of document

getBirthDate

@NotNull
public ValidatedTextFieldWrapper getBirthDate()

Birth date

getCheckDigits

@NotNull
public java.util.List<io.scanbot.genericdocument.entity.ValidatedTextFieldWrapper> getCheckDigits()

Check digit

getDocumentNumber

@NotNull
public ValidatedTextFieldWrapper getDocumentNumber()

Document number

getExpiryDate

@NotNull
public ValidatedTextFieldWrapper getExpiryDate()

Expiry date

getGender

@NotNull
public TextFieldWrapper getGender()

Gender

getGivenNames

@NotNull
public TextFieldWrapper getGivenNames()

Given names

getIssuingAuthority

@NotNull
public TextFieldWrapper getIssuingAuthority()

Issuing authority

getNationality

@NotNull
public TextFieldWrapper getNationality()

Nationality

getOptional1

@Nullable
public ValidatedTextFieldWrapper getOptional1()

Optional field 1

getOptional2

@Nullable
public ValidatedTextFieldWrapper getOptional2()

Optional field 2

getSurname

@NotNull
public TextFieldWrapper getSurname()

Surname

getTravelDocType

@NotNull
public TextFieldWrapper getTravelDocType()

Travel document type

getTravelDocTypeVariant

@NotNull
public TextFieldWrapper getTravelDocTypeVariant()

Travel document type variant