java.lang.Object
- com.onfido.model.DocumentProperties

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

DocumentProperties

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DocumentProperties.CustomTypeAdapterFactory`
`static class`	`DocumentProperties.HasIssuanceConfirmationEnum`	Gets or Sets hasIssuanceConfirmation
`static class`	`DocumentProperties.NistIdentityEvidenceStrengthEnum`	Gets or Sets nistIdentityEvidenceStrength
`static class`	`DocumentProperties.SecurityTierEnum`	Gets or Sets securityTier

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ADDRESS`
`static String`	`SERIALIZED_NAME_ADDRESS_LINES`
`static String`	`SERIALIZED_NAME_ALIAS_NAME`
`static String`	`SERIALIZED_NAME_BARCODE`
`static String`	`SERIALIZED_NAME_CATEGORISATION`
`static String`	`SERIALIZED_NAME_CIVIL_STATE`
`static String`	`SERIALIZED_NAME_DATE_OF_BIRTH`
`static String`	`SERIALIZED_NAME_DATE_OF_EXPIRY`
`static String`	`SERIALIZED_NAME_DOCUMENT_CLASSIFICATION`
`static String`	`SERIALIZED_NAME_DOCUMENT_NUMBERS`
`static String`	`SERIALIZED_NAME_DOCUMENT_SUBTYPE`
`static String`	`SERIALIZED_NAME_DOCUMENT_TYPE`
`static String`	`SERIALIZED_NAME_DRIVING_LICENCE_INFORMATION`
`static String`	`SERIALIZED_NAME_EXPATRIATION`
`static String`	`SERIALIZED_NAME_EXTRACTED_DATA`
`static String`	`SERIALIZED_NAME_FATHER_NAME`
`static String`	`SERIALIZED_NAME_FIRST_NAME`
`static String`	`SERIALIZED_NAME_GENDER`
`static String`	`SERIALIZED_NAME_HAS_ISSUANCE_CONFIRMATION`
`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_MIDDLE_NAME`
`static String`	`SERIALIZED_NAME_MOTHER_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_NFC`
`static String`	`SERIALIZED_NAME_NIST_IDENTITY_EVIDENCE_STRENGTH`
`static String`	`SERIALIZED_NAME_PERSONAL_NUMBER`
`static String`	`SERIALIZED_NAME_PLACE_OF_BIRTH`
`static String`	`SERIALIZED_NAME_PROFESSION`
`static String`	`SERIALIZED_NAME_REAL_ID_COMPLIANCE`
`static String`	`SERIALIZED_NAME_RELIGION`
`static String`	`SERIALIZED_NAME_REMARKS`
`static String`	`SERIALIZED_NAME_SECURITY_DOCUMENT_NUMBER`
`static String`	`SERIALIZED_NAME_SECURITY_TIER`
`static String`	`SERIALIZED_NAME_SPOUSE_NAME`
`static String`	`SERIALIZED_NAME_TAX_NUMBER`
`static String`	`SERIALIZED_NAME_TYPE_OF_PERMIT`
`static String`	`SERIALIZED_NAME_VERSION_NUMBER`
`static String`	`SERIALIZED_NAME_WIDOW_NAME`

Constructor Summary

Constructors
Constructor Description

DocumentProperties()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DocumentProperties`	`addBarcodeItem(DocumentPropertiesBarcodeInner barcodeItem)`
`DocumentProperties`	`addDocumentNumbersItem(DocumentPropertiesDocumentNumbersInner documentNumbersItem)`
`DocumentProperties`	`address(String address)`
`DocumentProperties`	`addressLines(DocumentPropertiesAddressLines addressLines)`
`DocumentProperties`	`aliasName(String aliasName)`
`DocumentProperties`	`barcode(List<DocumentPropertiesBarcodeInner> barcode)`
`DocumentProperties`	`categorisation(String categorisation)`
`DocumentProperties`	`civilState(String civilState)`
`DocumentProperties`	`dateOfBirth(LocalDate dateOfBirth)`
`DocumentProperties`	`dateOfExpiry(LocalDate dateOfExpiry)`
`DocumentProperties`	`documentClassification(DocumentPropertiesDocumentClassification documentClassification)`
`DocumentProperties`	`documentNumbers(List<DocumentPropertiesDocumentNumbersInner> documentNumbers)`
`DocumentProperties`	`documentSubtype(String documentSubtype)`
`DocumentProperties`	`documentType(String documentType)`
`DocumentProperties`	`drivingLicenceInformation(DocumentPropertiesDrivingLicenceInformation drivingLicenceInformation)`
`boolean`	`equals(Object o)`
`DocumentProperties`	`expatriation(String expatriation)`
`DocumentProperties`	`extractedData(DocumentPropertiesExtractedData extractedData)`
`DocumentProperties`	`fatherName(String fatherName)`
`DocumentProperties`	`firstName(String firstName)`
`static DocumentProperties`	`fromJson(String jsonString)`	Create an instance of DocumentProperties given an JSON string
`DocumentProperties`	`gender(String gender)`
`Map<String,Object>`	`getAdditionalProperties()`	Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)`	Return the additional (undeclared) property with the specified name.
`String`	`getAddress()`	Get address
`DocumentPropertiesAddressLines`	`getAddressLines()`	Get addressLines
`String`	`getAliasName()`	Get aliasName
`List<DocumentPropertiesBarcodeInner>`	`getBarcode()`	Get barcode
`String`	`getCategorisation()`	Get categorisation
`String`	`getCivilState()`	Get civilState
`LocalDate`	`getDateOfBirth()`	Get dateOfBirth
`LocalDate`	`getDateOfExpiry()`	Get dateOfExpiry
`DocumentPropertiesDocumentClassification`	`getDocumentClassification()`	Get documentClassification
`List<DocumentPropertiesDocumentNumbersInner>`	`getDocumentNumbers()`	Get documentNumbers
`String`	`getDocumentSubtype()`	Get documentSubtype
`String`	`getDocumentType()`	Get documentType
`DocumentPropertiesDrivingLicenceInformation`	`getDrivingLicenceInformation()`	Get drivingLicenceInformation
`String`	`getExpatriation()`	Get expatriation
`DocumentPropertiesExtractedData`	`getExtractedData()`	Get extractedData
`String`	`getFatherName()`	Get fatherName
`String`	`getFirstName()`	Get firstName
`String`	`getGender()`	Get gender
`DocumentProperties.HasIssuanceConfirmationEnum`	`getHasIssuanceConfirmation()`	Get hasIssuanceConfirmation
`String`	`getIssuingAuthority()`	Get issuingAuthority
`String`	`getIssuingCountry()`	Get issuingCountry
`LocalDate`	`getIssuingDate()`	Get issuingDate
`String`	`getIssuingState()`	Get issuingState
`String`	`getLastName()`	Get lastName
`String`	`getMiddleName()`	Get middleName
`String`	`getMotherName()`	Get motherName
`String`	`getMrzLine1()`	Get mrzLine1
`String`	`getMrzLine2()`	Get mrzLine2
`String`	`getMrzLine3()`	Get mrzLine3
`String`	`getNationality()`	Get nationality
`DocumentPropertiesNfc`	`getNfc()`	Get nfc
`DocumentProperties.NistIdentityEvidenceStrengthEnum`	`getNistIdentityEvidenceStrength()`	Get nistIdentityEvidenceStrength
`String`	`getPersonalNumber()`	Get personalNumber
`String`	`getPlaceOfBirth()`	Get placeOfBirth
`String`	`getProfession()`	Get profession
`Boolean`	`getRealIdCompliance()`	Get realIdCompliance
`String`	`getReligion()`	Get religion
`String`	`getRemarks()`	Get remarks
`String`	`getSecurityDocumentNumber()`	Get securityDocumentNumber
`DocumentProperties.SecurityTierEnum`	`getSecurityTier()`	Get securityTier
`String`	`getSpouseName()`	Get spouseName
`String`	`getTaxNumber()`	Get taxNumber
`String`	`getTypeOfPermit()`	Get typeOfPermit
`String`	`getVersionNumber()`	Get versionNumber
`String`	`getWidowName()`	Get widowName
`int`	`hashCode()`
`DocumentProperties`	`hasIssuanceConfirmation(DocumentProperties.HasIssuanceConfirmationEnum hasIssuanceConfirmation)`
`DocumentProperties`	`issuingAuthority(String issuingAuthority)`
`DocumentProperties`	`issuingCountry(String issuingCountry)`
`DocumentProperties`	`issuingDate(LocalDate issuingDate)`
`DocumentProperties`	`issuingState(String issuingState)`
`DocumentProperties`	`lastName(String lastName)`
`DocumentProperties`	`middleName(String middleName)`
`DocumentProperties`	`motherName(String motherName)`
`DocumentProperties`	`mrzLine1(String mrzLine1)`
`DocumentProperties`	`mrzLine2(String mrzLine2)`
`DocumentProperties`	`mrzLine3(String mrzLine3)`
`DocumentProperties`	`nationality(String nationality)`
`DocumentProperties`	`nfc(DocumentPropertiesNfc nfc)`
`DocumentProperties`	`nistIdentityEvidenceStrength(DocumentProperties.NistIdentityEvidenceStrengthEnum nistIdentityEvidenceStrength)`
`DocumentProperties`	`personalNumber(String personalNumber)`
`DocumentProperties`	`placeOfBirth(String placeOfBirth)`
`DocumentProperties`	`profession(String profession)`
`DocumentProperties`	`putAdditionalProperty(String key, Object value)`	Set the additional (undeclared) property with the specified name and value.
`DocumentProperties`	`realIdCompliance(Boolean realIdCompliance)`
`DocumentProperties`	`religion(String religion)`
`DocumentProperties`	`remarks(String remarks)`
`DocumentProperties`	`securityDocumentNumber(String securityDocumentNumber)`
`DocumentProperties`	`securityTier(DocumentProperties.SecurityTierEnum securityTier)`
`void`	`setAddress(String address)`
`void`	`setAddressLines(DocumentPropertiesAddressLines addressLines)`
`void`	`setAliasName(String aliasName)`
`void`	`setBarcode(List<DocumentPropertiesBarcodeInner> barcode)`
`void`	`setCategorisation(String categorisation)`
`void`	`setCivilState(String civilState)`
`void`	`setDateOfBirth(LocalDate dateOfBirth)`
`void`	`setDateOfExpiry(LocalDate dateOfExpiry)`
`void`	`setDocumentClassification(DocumentPropertiesDocumentClassification documentClassification)`
`void`	`setDocumentNumbers(List<DocumentPropertiesDocumentNumbersInner> documentNumbers)`
`void`	`setDocumentSubtype(String documentSubtype)`
`void`	`setDocumentType(String documentType)`
`void`	`setDrivingLicenceInformation(DocumentPropertiesDrivingLicenceInformation drivingLicenceInformation)`
`void`	`setExpatriation(String expatriation)`
`void`	`setExtractedData(DocumentPropertiesExtractedData extractedData)`
`void`	`setFatherName(String fatherName)`
`void`	`setFirstName(String firstName)`
`void`	`setGender(String gender)`
`void`	`setHasIssuanceConfirmation(DocumentProperties.HasIssuanceConfirmationEnum hasIssuanceConfirmation)`
`void`	`setIssuingAuthority(String issuingAuthority)`
`void`	`setIssuingCountry(String issuingCountry)`
`void`	`setIssuingDate(LocalDate issuingDate)`
`void`	`setIssuingState(String issuingState)`
`void`	`setLastName(String lastName)`
`void`	`setMiddleName(String middleName)`
`void`	`setMotherName(String motherName)`
`void`	`setMrzLine1(String mrzLine1)`
`void`	`setMrzLine2(String mrzLine2)`
`void`	`setMrzLine3(String mrzLine3)`
`void`	`setNationality(String nationality)`
`void`	`setNfc(DocumentPropertiesNfc nfc)`
`void`	`setNistIdentityEvidenceStrength(DocumentProperties.NistIdentityEvidenceStrengthEnum nistIdentityEvidenceStrength)`
`void`	`setPersonalNumber(String personalNumber)`
`void`	`setPlaceOfBirth(String placeOfBirth)`
`void`	`setProfession(String profession)`
`void`	`setRealIdCompliance(Boolean realIdCompliance)`
`void`	`setReligion(String religion)`
`void`	`setRemarks(String remarks)`
`void`	`setSecurityDocumentNumber(String securityDocumentNumber)`
`void`	`setSecurityTier(DocumentProperties.SecurityTierEnum securityTier)`
`void`	`setSpouseName(String spouseName)`
`void`	`setTaxNumber(String taxNumber)`
`void`	`setTypeOfPermit(String typeOfPermit)`
`void`	`setVersionNumber(String versionNumber)`
`void`	`setWidowName(String widowName)`
`DocumentProperties`	`spouseName(String spouseName)`
`DocumentProperties`	`taxNumber(String taxNumber)`
`String`	`toJson()`	Convert an instance of DocumentProperties to an JSON string
`String`	`toString()`
`DocumentProperties`	`typeOfPermit(String typeOfPermit)`
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)`	Validates the JSON Element and throws an exception if issues found
`DocumentProperties`	`versionNumber(String versionNumber)`
`DocumentProperties`	`widowName(String widowName)`

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

Field Detail

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_PERSONAL_NUMBER

public static final String SERIALIZED_NAME_PERSONAL_NUMBER

See Also:: Constant Field Values

SERIALIZED_NAME_DOCUMENT_NUMBERS

public static final String SERIALIZED_NAME_DOCUMENT_NUMBERS

See Also:: Constant Field Values

SERIALIZED_NAME_DOCUMENT_TYPE

public static final String SERIALIZED_NAME_DOCUMENT_TYPE

See Also:: Constant Field Values

SERIALIZED_NAME_FIRST_NAME

public static final String SERIALIZED_NAME_FIRST_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_MIDDLE_NAME

public static final String SERIALIZED_NAME_MIDDLE_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_GENDER

public static final String SERIALIZED_NAME_GENDER

See Also:: Constant Field Values

SERIALIZED_NAME_ISSUING_COUNTRY

public static final String SERIALIZED_NAME_ISSUING_COUNTRY

See Also:: Constant Field Values

SERIALIZED_NAME_NATIONALITY

public static final String SERIALIZED_NAME_NATIONALITY

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_CATEGORISATION

public static final String SERIALIZED_NAME_CATEGORISATION

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_ADDRESS

public static final String SERIALIZED_NAME_ADDRESS

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_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_ISSUING_AUTHORITY

public static final String SERIALIZED_NAME_ISSUING_AUTHORITY

See Also:: Constant Field Values

SERIALIZED_NAME_REMARKS

public static final String SERIALIZED_NAME_REMARKS

See Also:: Constant Field Values

SERIALIZED_NAME_CIVIL_STATE

public static final String SERIALIZED_NAME_CIVIL_STATE

See Also:: Constant Field Values

SERIALIZED_NAME_EXPATRIATION

public static final String SERIALIZED_NAME_EXPATRIATION

See Also:: Constant Field Values

SERIALIZED_NAME_FATHER_NAME

public static final String SERIALIZED_NAME_FATHER_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_MOTHER_NAME

public static final String SERIALIZED_NAME_MOTHER_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_RELIGION

public static final String SERIALIZED_NAME_RELIGION

See Also:: Constant Field Values

SERIALIZED_NAME_TYPE_OF_PERMIT

public static final String SERIALIZED_NAME_TYPE_OF_PERMIT

See Also:: Constant Field Values

SERIALIZED_NAME_VERSION_NUMBER

public static final String SERIALIZED_NAME_VERSION_NUMBER

See Also:: Constant Field Values

SERIALIZED_NAME_DOCUMENT_SUBTYPE

public static final String SERIALIZED_NAME_DOCUMENT_SUBTYPE

See Also:: Constant Field Values

SERIALIZED_NAME_PROFESSION

public static final String SERIALIZED_NAME_PROFESSION

See Also:: Constant Field Values

SERIALIZED_NAME_SECURITY_DOCUMENT_NUMBER

public static final String SERIALIZED_NAME_SECURITY_DOCUMENT_NUMBER

See Also:: Constant Field Values

SERIALIZED_NAME_TAX_NUMBER

public static final String SERIALIZED_NAME_TAX_NUMBER

See Also:: Constant Field Values

SERIALIZED_NAME_NIST_IDENTITY_EVIDENCE_STRENGTH

public static final String SERIALIZED_NAME_NIST_IDENTITY_EVIDENCE_STRENGTH

See Also:: Constant Field Values

SERIALIZED_NAME_HAS_ISSUANCE_CONFIRMATION

public static final String SERIALIZED_NAME_HAS_ISSUANCE_CONFIRMATION

See Also:: Constant Field Values

SERIALIZED_NAME_REAL_ID_COMPLIANCE

public static final String SERIALIZED_NAME_REAL_ID_COMPLIANCE

See Also:: Constant Field Values

SERIALIZED_NAME_SECURITY_TIER

public static final String SERIALIZED_NAME_SECURITY_TIER

See Also:: Constant Field Values

SERIALIZED_NAME_ADDRESS_LINES

public static final String SERIALIZED_NAME_ADDRESS_LINES

See Also:: Constant Field Values

SERIALIZED_NAME_BARCODE

public static final String SERIALIZED_NAME_BARCODE

See Also:: Constant Field Values

SERIALIZED_NAME_NFC

public static final String SERIALIZED_NAME_NFC

See Also:: Constant Field Values

SERIALIZED_NAME_DRIVING_LICENCE_INFORMATION

public static final String SERIALIZED_NAME_DRIVING_LICENCE_INFORMATION

See Also:: Constant Field Values

SERIALIZED_NAME_DOCUMENT_CLASSIFICATION

public static final String SERIALIZED_NAME_DOCUMENT_CLASSIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_EXTRACTED_DATA

public static final String SERIALIZED_NAME_EXTRACTED_DATA

See Also:: Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail
- DocumentProperties
```
public DocumentProperties()
```

Method Detail

dateOfBirth

public DocumentProperties dateOfBirth(LocalDate dateOfBirth)

getDateOfBirth

@Nullable
public LocalDate getDateOfBirth()

Get dateOfBirth

Returns:: dateOfBirth

setDateOfBirth

public void setDateOfBirth(LocalDate dateOfBirth)

dateOfExpiry

public DocumentProperties dateOfExpiry(LocalDate dateOfExpiry)

getDateOfExpiry

@Nullable
public LocalDate getDateOfExpiry()

Get dateOfExpiry

Returns:: dateOfExpiry

setDateOfExpiry

public void setDateOfExpiry(LocalDate dateOfExpiry)

personalNumber

public DocumentProperties personalNumber(String personalNumber)

getPersonalNumber
```
@Nullable
public String getPersonalNumber()
```
Get personalNumber

Returns:

personalNumber

setPersonalNumber

public void setPersonalNumber(String personalNumber)

documentNumbers

public DocumentProperties documentNumbers(List<DocumentPropertiesDocumentNumbersInner> documentNumbers)

addDocumentNumbersItem

public DocumentProperties addDocumentNumbersItem(DocumentPropertiesDocumentNumbersInner documentNumbersItem)

getDocumentNumbers

@Nullable
public List<DocumentPropertiesDocumentNumbersInner> getDocumentNumbers()

Get documentNumbers

Returns:: documentNumbers

setDocumentNumbers

public void setDocumentNumbers(List<DocumentPropertiesDocumentNumbersInner> documentNumbers)

documentType

public DocumentProperties documentType(String documentType)

getDocumentType
```
@Nullable
public String getDocumentType()
```
Get documentType

Returns:

documentType

setDocumentType

public void setDocumentType(String documentType)

firstName

public DocumentProperties firstName(String firstName)

getFirstName

@Nullable
public String getFirstName()

Get firstName

Returns:: firstName

setFirstName

public void setFirstName(String firstName)

middleName

public DocumentProperties middleName(String middleName)

getMiddleName

@Nullable
public String getMiddleName()

Get middleName

Returns:: middleName

setMiddleName

public void setMiddleName(String middleName)

lastName

public DocumentProperties lastName(String lastName)

getLastName
```
@Nullable
public String getLastName()
```
Get lastName

Returns:

lastName

setLastName

public void setLastName(String lastName)

gender

public DocumentProperties gender(String gender)

getGender
```
@Nullable
public String getGender()
```
Get gender

Returns:

gender

setGender

public void setGender(String gender)

issuingCountry

public DocumentProperties issuingCountry(String issuingCountry)

getIssuingCountry
```
@Nullable
public String getIssuingCountry()
```
Get issuingCountry

Returns:

issuingCountry

setIssuingCountry

public void setIssuingCountry(String issuingCountry)

nationality

public DocumentProperties nationality(String nationality)

getNationality
```
@Nullable
public String getNationality()
```
Get nationality

Returns:

nationality

setNationality

public void setNationality(String nationality)

issuingState

public DocumentProperties issuingState(String issuingState)

getIssuingState
```
@Nullable
public String getIssuingState()
```
Get issuingState

Returns:

issuingState

setIssuingState

public void setIssuingState(String issuingState)

issuingDate

public DocumentProperties issuingDate(LocalDate issuingDate)

getIssuingDate

@Nullable
public LocalDate getIssuingDate()

Get issuingDate

Returns:: issuingDate

setIssuingDate

public void setIssuingDate(LocalDate issuingDate)

categorisation

public DocumentProperties categorisation(String categorisation)

getCategorisation
```
@Nullable
public String getCategorisation()
```
Get categorisation

Returns:

categorisation

setCategorisation

public void setCategorisation(String categorisation)

mrzLine1

public DocumentProperties mrzLine1(String mrzLine1)

getMrzLine1
```
@Nullable
public String getMrzLine1()
```
Get mrzLine1

Returns:

mrzLine1

setMrzLine1

public void setMrzLine1(String mrzLine1)

mrzLine2

public DocumentProperties mrzLine2(String mrzLine2)

getMrzLine2
```
@Nullable
public String getMrzLine2()
```
Get mrzLine2

Returns:

mrzLine2

setMrzLine2

public void setMrzLine2(String mrzLine2)

mrzLine3

public DocumentProperties mrzLine3(String mrzLine3)

getMrzLine3
```
@Nullable
public String getMrzLine3()
```
Get mrzLine3

Returns:

mrzLine3

setMrzLine3

public void setMrzLine3(String mrzLine3)

address

public DocumentProperties address(String address)

getAddress
```
@Nullable
public String getAddress()
```
Get address

Returns:

address

setAddress

public void setAddress(String address)

placeOfBirth

public DocumentProperties placeOfBirth(String placeOfBirth)

getPlaceOfBirth
```
@Nullable
public String getPlaceOfBirth()
```
Get placeOfBirth

Returns:

placeOfBirth

setPlaceOfBirth

public void setPlaceOfBirth(String placeOfBirth)

spouseName

public DocumentProperties spouseName(String spouseName)

getSpouseName

@Nullable
public String getSpouseName()

Get spouseName

Returns:: spouseName

setSpouseName

public void setSpouseName(String spouseName)

widowName

public DocumentProperties widowName(String widowName)

getWidowName

@Nullable
public String getWidowName()

Get widowName

Returns:: widowName

setWidowName

public void setWidowName(String widowName)

aliasName

public DocumentProperties aliasName(String aliasName)

getAliasName

@Nullable
public String getAliasName()

Get aliasName

Returns:: aliasName

setAliasName

public void setAliasName(String aliasName)

issuingAuthority

public DocumentProperties issuingAuthority(String issuingAuthority)

getIssuingAuthority
```
@Nullable
public String getIssuingAuthority()
```
Get issuingAuthority

Returns:

issuingAuthority

setIssuingAuthority

public void setIssuingAuthority(String issuingAuthority)

remarks

public DocumentProperties remarks(String remarks)

getRemarks
```
@Nullable
public String getRemarks()
```
Get remarks

Returns:

remarks

setRemarks

public void setRemarks(String remarks)

civilState

public DocumentProperties civilState(String civilState)

getCivilState

@Nullable
public String getCivilState()

Get civilState

Returns:: civilState

setCivilState

public void setCivilState(String civilState)

expatriation

public DocumentProperties expatriation(String expatriation)

getExpatriation
```
@Nullable
public String getExpatriation()
```
Get expatriation

Returns:

expatriation

setExpatriation

public void setExpatriation(String expatriation)

fatherName

public DocumentProperties fatherName(String fatherName)

getFatherName

@Nullable
public String getFatherName()

Get fatherName

Returns:: fatherName

setFatherName

public void setFatherName(String fatherName)

motherName

public DocumentProperties motherName(String motherName)

getMotherName

@Nullable
public String getMotherName()

Get motherName

Returns:: motherName

setMotherName

public void setMotherName(String motherName)

religion

public DocumentProperties religion(String religion)

getReligion
```
@Nullable
public String getReligion()
```
Get religion

Returns:

religion

setReligion

public void setReligion(String religion)

typeOfPermit

public DocumentProperties typeOfPermit(String typeOfPermit)

getTypeOfPermit
```
@Nullable
public String getTypeOfPermit()
```
Get typeOfPermit

Returns:

typeOfPermit

setTypeOfPermit

public void setTypeOfPermit(String typeOfPermit)

versionNumber

public DocumentProperties versionNumber(String versionNumber)

getVersionNumber
```
@Nullable
public String getVersionNumber()
```
Get versionNumber

Returns:

versionNumber

setVersionNumber

public void setVersionNumber(String versionNumber)

documentSubtype

public DocumentProperties documentSubtype(String documentSubtype)

getDocumentSubtype
```
@Nullable
public String getDocumentSubtype()
```
Get documentSubtype

Returns:

documentSubtype

setDocumentSubtype

public void setDocumentSubtype(String documentSubtype)

profession

public DocumentProperties profession(String profession)

getProfession

@Nullable
public String getProfession()

Get profession

Returns:: profession

setProfession

public void setProfession(String profession)

securityDocumentNumber

public DocumentProperties securityDocumentNumber(String securityDocumentNumber)

getSecurityDocumentNumber
```
@Nullable
public String getSecurityDocumentNumber()
```
Get securityDocumentNumber

Returns:

securityDocumentNumber

setSecurityDocumentNumber

public void setSecurityDocumentNumber(String securityDocumentNumber)

taxNumber

public DocumentProperties taxNumber(String taxNumber)

getTaxNumber

@Nullable
public String getTaxNumber()

Get taxNumber

Returns:: taxNumber

setTaxNumber

public void setTaxNumber(String taxNumber)

nistIdentityEvidenceStrength

public DocumentProperties nistIdentityEvidenceStrength(DocumentProperties.NistIdentityEvidenceStrengthEnum nistIdentityEvidenceStrength)

getNistIdentityEvidenceStrength

@Nullable
public DocumentProperties.NistIdentityEvidenceStrengthEnum getNistIdentityEvidenceStrength()

Get nistIdentityEvidenceStrength

Returns:: nistIdentityEvidenceStrength

setNistIdentityEvidenceStrength

public void setNistIdentityEvidenceStrength(DocumentProperties.NistIdentityEvidenceStrengthEnum nistIdentityEvidenceStrength)

hasIssuanceConfirmation

public DocumentProperties hasIssuanceConfirmation(DocumentProperties.HasIssuanceConfirmationEnum hasIssuanceConfirmation)

getHasIssuanceConfirmation

@Nullable
public DocumentProperties.HasIssuanceConfirmationEnum getHasIssuanceConfirmation()

Get hasIssuanceConfirmation

Returns:: hasIssuanceConfirmation

setHasIssuanceConfirmation

public void setHasIssuanceConfirmation(DocumentProperties.HasIssuanceConfirmationEnum hasIssuanceConfirmation)

realIdCompliance

public DocumentProperties realIdCompliance(Boolean realIdCompliance)

getRealIdCompliance
```
@Nullable
public Boolean getRealIdCompliance()
```
Get realIdCompliance

Returns:

realIdCompliance

setRealIdCompliance

public void setRealIdCompliance(Boolean realIdCompliance)

securityTier

public DocumentProperties securityTier(DocumentProperties.SecurityTierEnum securityTier)

getSecurityTier

@Nullable
public DocumentProperties.SecurityTierEnum getSecurityTier()

Get securityTier

Returns:: securityTier

setSecurityTier

public void setSecurityTier(DocumentProperties.SecurityTierEnum securityTier)

addressLines

public DocumentProperties addressLines(DocumentPropertiesAddressLines addressLines)

getAddressLines

@Nullable
public DocumentPropertiesAddressLines getAddressLines()

Get addressLines

Returns:: addressLines

setAddressLines

public void setAddressLines(DocumentPropertiesAddressLines addressLines)

barcode

public DocumentProperties barcode(List<DocumentPropertiesBarcodeInner> barcode)

addBarcodeItem

public DocumentProperties addBarcodeItem(DocumentPropertiesBarcodeInner barcodeItem)

getBarcode

@Nullable
public List<DocumentPropertiesBarcodeInner> getBarcode()

Get barcode

Returns:: barcode

setBarcode

public void setBarcode(List<DocumentPropertiesBarcodeInner> barcode)

nfc

public DocumentProperties nfc(DocumentPropertiesNfc nfc)

getNfc

@Nullable
public DocumentPropertiesNfc getNfc()

Get nfc

Returns:: nfc

setNfc

public void setNfc(DocumentPropertiesNfc nfc)

drivingLicenceInformation

public DocumentProperties drivingLicenceInformation(DocumentPropertiesDrivingLicenceInformation drivingLicenceInformation)

getDrivingLicenceInformation

@Nullable
public DocumentPropertiesDrivingLicenceInformation getDrivingLicenceInformation()

Get drivingLicenceInformation

Returns:: drivingLicenceInformation

setDrivingLicenceInformation

public void setDrivingLicenceInformation(DocumentPropertiesDrivingLicenceInformation drivingLicenceInformation)

documentClassification

public DocumentProperties documentClassification(DocumentPropertiesDocumentClassification documentClassification)

getDocumentClassification

@Nullable
public DocumentPropertiesDocumentClassification getDocumentClassification()

Get documentClassification

Returns:: documentClassification

setDocumentClassification

public void setDocumentClassification(DocumentPropertiesDocumentClassification documentClassification)

extractedData

public DocumentProperties extractedData(DocumentPropertiesExtractedData extractedData)

getExtractedData

@Nullable
public DocumentPropertiesExtractedData getExtractedData()

Get extractedData

Returns:: extractedData

setExtractedData

public void setExtractedData(DocumentPropertiesExtractedData extractedData)

putAdditionalProperty
```
public DocumentProperties 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 DocumentProperties 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 DocumentProperties

fromJson
```
public static DocumentProperties fromJson(String jsonString)
                                   throws IOException
```
Create an instance of DocumentProperties given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DocumentProperties

Throws:

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

toJson
```
public String toJson()
```
Convert an instance of DocumentProperties to an JSON string

Returns:

JSON string

Class DocumentProperties