com.plaid.client.model

Class PhysicalDocumentExtractedData

java.lang.Object

com.plaid.client.model.PhysicalDocumentExtractedData

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class PhysicalDocumentExtractedData
extends Object

Data extracted from a user-submitted document.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ADDRESS
static String	SERIALIZED_NAME_CATEGORY
static String	SERIALIZED_NAME_DATE_OF_BIRTH
static String	SERIALIZED_NAME_EXPIRATION_DATE
static String	SERIALIZED_NAME_ID_NUMBER
static String	SERIALIZED_NAME_ISSUING_COUNTRY
static String	SERIALIZED_NAME_ISSUING_REGION

Constructor Summary

Constructors

Constructor and Description
PhysicalDocumentExtractedData()

Method Summary

Modifier and Type	Method and Description
PhysicalDocumentExtractedData	address(IdentityVerificationDocumentAddressResponse address)
PhysicalDocumentExtractedData	category(PhysicalDocumentCategory category)
PhysicalDocumentExtractedData	dateOfBirth(LocalDate dateOfBirth)
boolean	equals(Object o)
PhysicalDocumentExtractedData	expirationDate(LocalDate expirationDate)
IdentityVerificationDocumentAddressResponse	getAddress() Get address
PhysicalDocumentCategory	getCategory() Get category
LocalDate	getDateOfBirth() A date extracted from the document in the format YYYY-MM-DD (RFC 3339 Section 5.6).
LocalDate	getExpirationDate() A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
String	getIdNumber() Alpha-numeric ID number extracted via OCR from the user's document image.
String	getIssuingCountry() Valid, capitalized, two-letter ISO code representing the country of this object.
String	getIssuingRegion() An ISO 3166-2 subdivision code.
int	hashCode()
PhysicalDocumentExtractedData	idNumber(String idNumber)
PhysicalDocumentExtractedData	issuingCountry(String issuingCountry)
PhysicalDocumentExtractedData	issuingRegion(String issuingRegion)
void	setAddress(IdentityVerificationDocumentAddressResponse address)
void	setCategory(PhysicalDocumentCategory category)
void	setDateOfBirth(LocalDate dateOfBirth)
void	setExpirationDate(LocalDate expirationDate)
void	setIdNumber(String idNumber)
void	setIssuingCountry(String issuingCountry)
void	setIssuingRegion(String issuingRegion)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ID_NUMBER

public static final String SERIALIZED_NAME_ID_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRATION_DATE

public static final String SERIALIZED_NAME_EXPIRATION_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUING_COUNTRY

public static final String SERIALIZED_NAME_ISSUING_COUNTRY

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUING_REGION

public static final String SERIALIZED_NAME_ISSUING_REGION

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_ADDRESS

public static final String SERIALIZED_NAME_ADDRESS

See Also:

Constant Field Values

Constructor Detail

PhysicalDocumentExtractedData

public PhysicalDocumentExtractedData()

Method Detail

idNumber

public PhysicalDocumentExtractedData idNumber(String idNumber)

getIdNumber

@Nullable
public String getIdNumber()

Alpha-numeric ID number extracted via OCR from the user's document image.

Returns:

idNumber

setIdNumber

public void setIdNumber(String idNumber)

category

public PhysicalDocumentExtractedData category(PhysicalDocumentCategory category)

getCategory

public PhysicalDocumentCategory getCategory()

Get category

Returns:

category

setCategory

public void setCategory(PhysicalDocumentCategory category)

expirationDate

public PhysicalDocumentExtractedData expirationDate(LocalDate expirationDate)

getExpirationDate

@Nullable
public LocalDate getExpirationDate()

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(LocalDate expirationDate)

issuingCountry

public PhysicalDocumentExtractedData issuingCountry(String issuingCountry)

getIssuingCountry

public String getIssuingCountry()

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Returns:

issuingCountry

setIssuingCountry

public void setIssuingCountry(String issuingCountry)

issuingRegion

public PhysicalDocumentExtractedData issuingRegion(String issuingRegion)

getIssuingRegion

@Nullable
public String getIssuingRegion()

An ISO 3166-2 subdivision code. Related terms would be \"state\", \"province\", \"prefecture\", \"zone\", \"subdivision\", etc.

Returns:

issuingRegion

setIssuingRegion

public void setIssuingRegion(String issuingRegion)

dateOfBirth

public PhysicalDocumentExtractedData dateOfBirth(LocalDate dateOfBirth)

getDateOfBirth

@Nullable
public LocalDate getDateOfBirth()

A date extracted from the document in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Returns:

dateOfBirth

setDateOfBirth

public void setDateOfBirth(LocalDate dateOfBirth)

address

public PhysicalDocumentExtractedData address(IdentityVerificationDocumentAddressResponse address)

getAddress

@Nullable
public IdentityVerificationDocumentAddressResponse getAddress()

Get address

Returns:

address

setAddress

public void setAddress(IdentityVerificationDocumentAddressResponse address)

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