Package com.onfido.model

Class ExtractionExtractedData

java.lang.Object

com.onfido.model.ExtractionExtractedData

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.9.0")
public class ExtractionExtractedData
extends Object

ExtractionExtractedData

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtractionExtractedData.CustomTypeAdapterFactory
static class	ExtractionExtractedData.GenderEnum	Gender (Valid values are Male and Female).

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ADDRESS1
static String	SERIALIZED_NAME_ADDRESS2
static String	SERIALIZED_NAME_ADDRESS3
static String	SERIALIZED_NAME_ADDRESS4
static String	SERIALIZED_NAME_ADDRESS5
static String	SERIALIZED_NAME_ALIAS_NAME
static String	SERIALIZED_NAME_DATE_OF_BIRTH
static String	SERIALIZED_NAME_DATE_OF_EXPIRY
static String	SERIALIZED_NAME_DOCUMENT_NUMBER
static String	SERIALIZED_NAME_DOCUMENT_TYPE
static String	SERIALIZED_NAME_EXPIRY_DATE
static String	SERIALIZED_NAME_FIRST_NAME
static String	SERIALIZED_NAME_FULL_NAME
static String	SERIALIZED_NAME_GENDER
static String	SERIALIZED_NAME_ISSUING_AUTHORITY
static String	SERIALIZED_NAME_ISSUING_COUNTRY
static String	SERIALIZED_NAME_ISSUING_DATE
static String	SERIALIZED_NAME_ISSUING_STATE
static String	SERIALIZED_NAME_LAST_NAME
static String	SERIALIZED_NAME_MRZ_LINE1
static String	SERIALIZED_NAME_MRZ_LINE2
static String	SERIALIZED_NAME_MRZ_LINE3
static String	SERIALIZED_NAME_NATIONALITY
static String	SERIALIZED_NAME_PERSONAL_NUMBER
static String	SERIALIZED_NAME_PLACE_OF_BIRTH
static String	SERIALIZED_NAME_SPOUSE_NAME
static String	SERIALIZED_NAME_WIDOW_NAME

Constructor Summary

Constructors

Constructor	Description
ExtractionExtractedData()

Method Summary

Modifier and Type	Method	Description
ExtractionExtractedData	address1(String address1)
ExtractionExtractedData	address2(String address2)
ExtractionExtractedData	address3(String address3)
ExtractionExtractedData	address4(String address4)
ExtractionExtractedData	address5(String address5)
ExtractionExtractedData	aliasName(String aliasName)
ExtractionExtractedData	dateOfBirth(LocalDate dateOfBirth)
ExtractionExtractedData	dateOfExpiry(LocalDate dateOfExpiry)
ExtractionExtractedData	documentNumber(String documentNumber)
ExtractionExtractedData	documentType(DocumentTypes documentType)
boolean	equals(Object o)
ExtractionExtractedData	expiryDate(LocalDate expiryDate)
ExtractionExtractedData	firstName(String firstName)
static ExtractionExtractedData	fromJson(String jsonString)	Create an instance of ExtractionExtractedData given an JSON string
ExtractionExtractedData	fullName(String fullName)
ExtractionExtractedData	gender(ExtractionExtractedData.GenderEnum gender)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
String	getAddress1()	Line 1 of the address.
String	getAddress2()	Line 2 of the address.
String	getAddress3()	Line 3 of the address.
String	getAddress4()	Line 4 of the address.
String	getAddress5()	Line 5 of the address.
String	getAliasName()	Alias name (French documents only).
LocalDate	getDateOfBirth()	Date of birth in YYYY-MM-DD format.
LocalDate	getDateOfExpiry()	Date of expiry in YYYY-MM-DD format.
String	getDocumentNumber()	The official document number.
DocumentTypes	getDocumentType()	Type of document.
LocalDate	getExpiryDate()	Date of expiry in YYYY-MM-DD format.
String	getFirstName()	First name.
String	getFullName()	Full name.
ExtractionExtractedData.GenderEnum	getGender()	Gender (Valid values are Male and Female).
String	getIssuingAuthority()	Issuing authority.
CountryCodes	getIssuingCountry()	Document country in 3-letter ISO code.
LocalDate	getIssuingDate()	Issuing date in YYYY-MM-DD format.
String	getIssuingState()	The state that issued the document.
String	getLastName()	Last name.
String	getMrzLine1()	Line 1 of the MRZ code.
String	getMrzLine2()	Line 2 of the MRZ code.
String	getMrzLine3()	Line 3 of the MRZ code.
String	getNationality()	Nationality in 3-letter ISO code.
String	getPersonalNumber()	The owner's unique identification number.
String	getPlaceOfBirth()	Place of birth.
String	getSpouseName()	Spouse name (French documents only).
String	getWidowName()	Widow name (French documents only).
int	hashCode()
ExtractionExtractedData	issuingAuthority(String issuingAuthority)
ExtractionExtractedData	issuingCountry(CountryCodes issuingCountry)
ExtractionExtractedData	issuingDate(LocalDate issuingDate)
ExtractionExtractedData	issuingState(String issuingState)
ExtractionExtractedData	lastName(String lastName)
ExtractionExtractedData	mrzLine1(String mrzLine1)
ExtractionExtractedData	mrzLine2(String mrzLine2)
ExtractionExtractedData	mrzLine3(String mrzLine3)
ExtractionExtractedData	nationality(String nationality)
ExtractionExtractedData	personalNumber(String personalNumber)
ExtractionExtractedData	placeOfBirth(String placeOfBirth)
ExtractionExtractedData	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAddress1(String address1)
void	setAddress2(String address2)
void	setAddress3(String address3)
void	setAddress4(String address4)
void	setAddress5(String address5)
void	setAliasName(String aliasName)
void	setDateOfBirth(LocalDate dateOfBirth)
void	setDateOfExpiry(LocalDate dateOfExpiry)
void	setDocumentNumber(String documentNumber)
void	setDocumentType(DocumentTypes documentType)
void	setExpiryDate(LocalDate expiryDate)
void	setFirstName(String firstName)
void	setFullName(String fullName)
void	setGender(ExtractionExtractedData.GenderEnum gender)
void	setIssuingAuthority(String issuingAuthority)
void	setIssuingCountry(CountryCodes issuingCountry)
void	setIssuingDate(LocalDate issuingDate)
void	setIssuingState(String issuingState)
void	setLastName(String lastName)
void	setMrzLine1(String mrzLine1)
void	setMrzLine2(String mrzLine2)
void	setMrzLine3(String mrzLine3)
void	setNationality(String nationality)
void	setPersonalNumber(String personalNumber)
void	setPlaceOfBirth(String placeOfBirth)
void	setSpouseName(String spouseName)
void	setWidowName(String widowName)
ExtractionExtractedData	spouseName(String spouseName)
String	toJson()	Convert an instance of ExtractionExtractedData to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found
ExtractionExtractedData	widowName(String widowName)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_DOCUMENT_NUMBER

public static final String SERIALIZED_NAME_DOCUMENT_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_FIRST_NAME

public static final String SERIALIZED_NAME_FIRST_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_LAST_NAME

public static final String SERIALIZED_NAME_LAST_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_FULL_NAME

public static final String SERIALIZED_NAME_FULL_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_SPOUSE_NAME

public static final String SERIALIZED_NAME_SPOUSE_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_WIDOW_NAME

public static final String SERIALIZED_NAME_WIDOW_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_ALIAS_NAME

public static final String SERIALIZED_NAME_ALIAS_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_GENDER

public static final String SERIALIZED_NAME_GENDER

See Also:

Constant Field Values

SERIALIZED_NAME_DATE_OF_BIRTH

public static final String SERIALIZED_NAME_DATE_OF_BIRTH

See Also:

Constant Field Values

SERIALIZED_NAME_DATE_OF_EXPIRY

public static final String SERIALIZED_NAME_DATE_OF_EXPIRY

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRY_DATE

public static final String SERIALIZED_NAME_EXPIRY_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_NATIONALITY

public static final String SERIALIZED_NAME_NATIONALITY

See Also:

Constant Field Values

SERIALIZED_NAME_MRZ_LINE1

public static final String SERIALIZED_NAME_MRZ_LINE1

See Also:

Constant Field Values

SERIALIZED_NAME_MRZ_LINE2

public static final String SERIALIZED_NAME_MRZ_LINE2

See Also:

Constant Field Values

SERIALIZED_NAME_MRZ_LINE3

public static final String SERIALIZED_NAME_MRZ_LINE3

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS1

public static final String SERIALIZED_NAME_ADDRESS1

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS2

public static final String SERIALIZED_NAME_ADDRESS2

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS3

public static final String SERIALIZED_NAME_ADDRESS3

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS4

public static final String SERIALIZED_NAME_ADDRESS4

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS5

public static final String SERIALIZED_NAME_ADDRESS5

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUING_AUTHORITY

public static final String SERIALIZED_NAME_ISSUING_AUTHORITY

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUING_COUNTRY

public static final String SERIALIZED_NAME_ISSUING_COUNTRY

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_TYPE

public static final String SERIALIZED_NAME_DOCUMENT_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_PLACE_OF_BIRTH

public static final String SERIALIZED_NAME_PLACE_OF_BIRTH

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUING_STATE

public static final String SERIALIZED_NAME_ISSUING_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUING_DATE

public static final String SERIALIZED_NAME_ISSUING_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_PERSONAL_NUMBER

public static final String SERIALIZED_NAME_PERSONAL_NUMBER

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

ExtractionExtractedData

public ExtractionExtractedData()

Method Detail

documentNumber

public ExtractionExtractedData documentNumber(String documentNumber)

getDocumentNumber

@Nullable
public String getDocumentNumber()

The official document number.

Returns:

documentNumber

setDocumentNumber

public void setDocumentNumber(String documentNumber)

firstName

public ExtractionExtractedData firstName(String firstName)

getFirstName

@Nullable
public String getFirstName()

First name.

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

lastName

public ExtractionExtractedData lastName(String lastName)

getLastName

@Nullable
public String getLastName()

Last name.

Returns:

lastName

setLastName

public void setLastName(String lastName)

fullName

public ExtractionExtractedData fullName(String fullName)

getFullName

@Nullable
public String getFullName()

Full name.

Returns:

fullName

setFullName

public void setFullName(String fullName)

spouseName

public ExtractionExtractedData spouseName(String spouseName)

getSpouseName

@Nullable
public String getSpouseName()

Spouse name (French documents only).

Returns:

spouseName

setSpouseName

public void setSpouseName(String spouseName)

widowName

public ExtractionExtractedData widowName(String widowName)

getWidowName

@Nullable
public String getWidowName()

Widow name (French documents only).

Returns:

widowName

setWidowName

public void setWidowName(String widowName)

aliasName

public ExtractionExtractedData aliasName(String aliasName)

getAliasName

@Nullable
public String getAliasName()

Alias name (French documents only).

Returns:

aliasName

setAliasName

public void setAliasName(String aliasName)

gender

public ExtractionExtractedData gender(ExtractionExtractedData.GenderEnum gender)

getGender

@Nullable
public ExtractionExtractedData.GenderEnum getGender()

Gender (Valid values are Male and Female).

Returns:

gender

setGender

public void setGender(ExtractionExtractedData.GenderEnum gender)

dateOfBirth

public ExtractionExtractedData dateOfBirth(LocalDate dateOfBirth)

getDateOfBirth

@Nullable
public LocalDate getDateOfBirth()

Date of birth in YYYY-MM-DD format.

Returns:

dateOfBirth

setDateOfBirth

public void setDateOfBirth(LocalDate dateOfBirth)

dateOfExpiry

public ExtractionExtractedData dateOfExpiry(LocalDate dateOfExpiry)

getDateOfExpiry

@Nullable
public LocalDate getDateOfExpiry()

Date of expiry in YYYY-MM-DD format.

Returns:

dateOfExpiry

setDateOfExpiry

public void setDateOfExpiry(LocalDate dateOfExpiry)

expiryDate

public ExtractionExtractedData expiryDate(LocalDate expiryDate)

getExpiryDate

@Nullable
public LocalDate getExpiryDate()

Date of expiry in YYYY-MM-DD format.

Returns:

expiryDate

setExpiryDate

public void setExpiryDate(LocalDate expiryDate)

nationality

public ExtractionExtractedData nationality(String nationality)

getNationality

@Nullable
public String getNationality()

Nationality in 3-letter ISO code.

Returns:

nationality

setNationality

public void setNationality(String nationality)

mrzLine1

public ExtractionExtractedData mrzLine1(String mrzLine1)

getMrzLine1

@Nullable
public String getMrzLine1()

Line 1 of the MRZ code.

Returns:

mrzLine1

setMrzLine1

public void setMrzLine1(String mrzLine1)

mrzLine2

public ExtractionExtractedData mrzLine2(String mrzLine2)

getMrzLine2

@Nullable
public String getMrzLine2()

Line 2 of the MRZ code.

Returns:

mrzLine2

setMrzLine2

public void setMrzLine2(String mrzLine2)

mrzLine3

public ExtractionExtractedData mrzLine3(String mrzLine3)

getMrzLine3

@Nullable
public String getMrzLine3()

Line 3 of the MRZ code.

Returns:

mrzLine3

setMrzLine3

public void setMrzLine3(String mrzLine3)

address1

public ExtractionExtractedData address1(String address1)

getAddress1

@Nullable
public String getAddress1()

Line 1 of the address.

Returns:

address1

setAddress1

public void setAddress1(String address1)

address2

public ExtractionExtractedData address2(String address2)

getAddress2

@Nullable
public String getAddress2()

Line 2 of the address.

Returns:

address2

setAddress2

public void setAddress2(String address2)

address3

public ExtractionExtractedData address3(String address3)

getAddress3

@Nullable
public String getAddress3()

Line 3 of the address.

Returns:

address3

setAddress3

public void setAddress3(String address3)

address4

public ExtractionExtractedData address4(String address4)

getAddress4

@Nullable
public String getAddress4()

Line 4 of the address.

Returns:

address4

setAddress4

public void setAddress4(String address4)

address5

public ExtractionExtractedData address5(String address5)

getAddress5

@Nullable
public String getAddress5()

Line 5 of the address.

Returns:

address5

setAddress5

public void setAddress5(String address5)

issuingAuthority

public ExtractionExtractedData issuingAuthority(String issuingAuthority)

getIssuingAuthority

@Nullable
public String getIssuingAuthority()

Issuing authority.

Returns:

issuingAuthority

setIssuingAuthority

public void setIssuingAuthority(String issuingAuthority)

issuingCountry

public ExtractionExtractedData issuingCountry(CountryCodes issuingCountry)

getIssuingCountry

@Nullable
public CountryCodes getIssuingCountry()

Document country in 3-letter ISO code.

Returns:

issuingCountry

setIssuingCountry

public void setIssuingCountry(CountryCodes issuingCountry)

documentType

public ExtractionExtractedData documentType(DocumentTypes documentType)

getDocumentType

@Nullable
public DocumentTypes getDocumentType()

Type of document.

Returns:

documentType

setDocumentType

public void setDocumentType(DocumentTypes documentType)

placeOfBirth

public ExtractionExtractedData placeOfBirth(String placeOfBirth)

getPlaceOfBirth

@Nullable
public String getPlaceOfBirth()

Place of birth.

Returns:

placeOfBirth

setPlaceOfBirth

public void setPlaceOfBirth(String placeOfBirth)

issuingState

public ExtractionExtractedData issuingState(String issuingState)

getIssuingState

@Nullable
public String getIssuingState()

The state that issued the document.

Returns:

issuingState

setIssuingState

public void setIssuingState(String issuingState)

issuingDate

public ExtractionExtractedData issuingDate(LocalDate issuingDate)

getIssuingDate

@Nullable
public LocalDate getIssuingDate()

Issuing date in YYYY-MM-DD format.

Returns:

issuingDate

setIssuingDate

public void setIssuingDate(LocalDate issuingDate)

personalNumber

public ExtractionExtractedData personalNumber(String personalNumber)

getPersonalNumber

@Nullable
public String getPersonalNumber()

The owner's unique identification number.

Returns:

personalNumber

setPersonalNumber

public void setPersonalNumber(String personalNumber)

putAdditionalProperty

public ExtractionExtractedData putAdditionalProperty(String key,
                                                     Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the ExtractionExtractedData instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to ExtractionExtractedData

fromJson

public static ExtractionExtractedData fromJson(String jsonString)
                                        throws IOException

Create an instance of ExtractionExtractedData given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ExtractionExtractedData

Throws:

IOException - if the JSON string is invalid with respect to ExtractionExtractedData

toJson

public String toJson()

Convert an instance of ExtractionExtractedData to an JSON string

Returns:

JSON string