java.lang.Object
- com.mindee.parsing.common.Prediction
- - com.mindee.product.internationalid.InternationalIdV2Document

public class InternationalIdV2Document
extends Prediction

International ID API version 2.1 document data.

Field Summary

Fields
Modifier and Type	Field	Description
`protected StringField`	`address`	The physical address of the document holder.
`protected DateField`	`birthDate`	The date of birth of the document holder.
`protected StringField`	`birthPlace`	The place of birth of the document holder.
`protected StringField`	`countryOfIssue`	The country where the document was issued.
`protected StringField`	`documentNumber`	The unique identifier assigned to the document.
`protected ClassificationField`	`documentType`	The type of personal identification document.
`protected DateField`	`expiryDate`	The date when the document becomes invalid.
`protected List<StringField>`	`givenNames`	The list of the document holder's given names.
`protected DateField`	`issueDate`	The date when the document was issued.
`protected StringField`	`mrzLine1`	The Machine Readable Zone, first line.
`protected StringField`	`mrzLine2`	The Machine Readable Zone, second line.
`protected StringField`	`mrzLine3`	The Machine Readable Zone, third line.
`protected StringField`	`nationality`	The country of citizenship of the document holder.
`protected StringField`	`personalNumber`	The unique identifier assigned to the document holder.
`protected StringField`	`sex`	The biological sex of the document holder.
`protected StringField`	`stateOfIssue`	The state or territory where the document was issued.
`protected List<StringField>`	`surnames`	The list of the document holder's family names.

Constructor Summary

Constructors
Constructor Description

InternationalIdV2Document()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`StringField`	`getAddress()`	The physical address of the document holder.
`DateField`	`getBirthDate()`	The date of birth of the document holder.
`StringField`	`getBirthPlace()`	The place of birth of the document holder.
`StringField`	`getCountryOfIssue()`	The country where the document was issued.
`StringField`	`getDocumentNumber()`	The unique identifier assigned to the document.
`ClassificationField`	`getDocumentType()`	The type of personal identification document.
`DateField`	`getExpiryDate()`	The date when the document becomes invalid.
`List<StringField>`	`getGivenNames()`	The list of the document holder's given names.
`DateField`	`getIssueDate()`	The date when the document was issued.
`StringField`	`getMrzLine1()`	The Machine Readable Zone, first line.
`StringField`	`getMrzLine2()`	The Machine Readable Zone, second line.
`StringField`	`getMrzLine3()`	The Machine Readable Zone, third line.
`StringField`	`getNationality()`	The country of citizenship of the document holder.
`StringField`	`getPersonalNumber()`	The unique identifier assigned to the document holder.
`StringField`	`getSex()`	The biological sex of the document holder.
`StringField`	`getStateOfIssue()`	The state or territory where the document was issued.
`List<StringField>`	`getSurnames()`	The list of the document holder's family names.
`int`	`hashCode()`
`boolean`	`isEmpty()`	Returns `true` if there are no predictions values.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - address
```
protected StringField address
```
    The physical address of the document holder.
  - birthDate
```
protected DateField birthDate
```
    The date of birth of the document holder.
  - birthPlace
```
protected StringField birthPlace
```
    The place of birth of the document holder.
  - countryOfIssue
```
protected StringField countryOfIssue
```
    The country where the document was issued.
  - documentNumber
```
protected StringField documentNumber
```
    The unique identifier assigned to the document.
  - documentType
```
protected ClassificationField documentType
```
    The type of personal identification document.
  - expiryDate
```
protected DateField expiryDate
```
    The date when the document becomes invalid.
  - givenNames
```
protected List<StringField> givenNames
```
    The list of the document holder's given names.
  - issueDate
```
protected DateField issueDate
```
    The date when the document was issued.
  - mrzLine1
```
protected StringField mrzLine1
```
    The Machine Readable Zone, first line.
  - mrzLine2
```
protected StringField mrzLine2
```
    The Machine Readable Zone, second line.
  - mrzLine3
```
protected StringField mrzLine3
```
    The Machine Readable Zone, third line.
  - nationality
```
protected StringField nationality
```
    The country of citizenship of the document holder.
  - personalNumber
```
protected StringField personalNumber
```
    The unique identifier assigned to the document holder.
  - sex
```
protected StringField sex
```
    The biological sex of the document holder.
  - stateOfIssue
```
protected StringField stateOfIssue
```
    The state or territory where the document was issued.
  - surnames
```
protected List<StringField> surnames
```
    The list of the document holder's family names.
- Constructor Detail
  - InternationalIdV2Document
```
public InternationalIdV2Document()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from class: Prediction
    
    Returns true if there are no predictions values. Accessing prediction values when this is true may result in a NullPointerException
    
    Specified by:
    
    isEmpty in class Prediction
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAddress
```
public StringField getAddress()
```
    The physical address of the document holder.
  - getBirthDate
```
public DateField getBirthDate()
```
    The date of birth of the document holder.
  - getBirthPlace
```
public StringField getBirthPlace()
```
    The place of birth of the document holder.
  - getCountryOfIssue
```
public StringField getCountryOfIssue()
```
    The country where the document was issued.
  - getDocumentNumber
```
public StringField getDocumentNumber()
```
    The unique identifier assigned to the document.
  - getDocumentType
```
public ClassificationField getDocumentType()
```
    The type of personal identification document.
  - getExpiryDate
```
public DateField getExpiryDate()
```
    The date when the document becomes invalid.
  - getGivenNames
```
public List<StringField> getGivenNames()
```
    The list of the document holder's given names.
  - getIssueDate
```
public DateField getIssueDate()
```
    The date when the document was issued.
  - getMrzLine1
```
public StringField getMrzLine1()
```
    The Machine Readable Zone, first line.
  - getMrzLine2
```
public StringField getMrzLine2()
```
    The Machine Readable Zone, second line.
  - getMrzLine3
```
public StringField getMrzLine3()
```
    The Machine Readable Zone, third line.
  - getNationality
```
public StringField getNationality()
```
    The country of citizenship of the document holder.
  - getPersonalNumber
```
public StringField getPersonalNumber()
```
    The unique identifier assigned to the document holder.
  - getSex
```
public StringField getSex()
```
    The biological sex of the document holder.
  - getStateOfIssue
```
public StringField getStateOfIssue()
```
    The state or territory where the document was issued.
  - getSurnames
```
public List<StringField> getSurnames()
```
    The list of the document holder's family names.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class InternationalIdV2Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

address

birthDate

birthPlace

countryOfIssue

documentNumber

documentType

expiryDate

givenNames

issueDate

mrzLine1

mrzLine2

mrzLine3

nationality

personalNumber

sex

stateOfIssue

surnames

Constructor Detail

InternationalIdV2Document

Method Detail

isEmpty

toString

getAddress

getBirthDate

getBirthPlace

getCountryOfIssue

getDocumentNumber

getDocumentType

getExpiryDate

getGivenNames

getIssueDate

getMrzLine1

getMrzLine2

getMrzLine3

getNationality

getPersonalNumber

getSex

getStateOfIssue

getSurnames

equals

canEqual

hashCode