com.plaid.client.model

Class IdentityVerificationDocumentAddressResponse

java.lang.Object

com.plaid.client.model.IdentityVerificationDocumentAddressResponse

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

The address extracted from the document. The address must at least contain the following fields to be a valid address: `street`, `city`, `country`. If any are missing or unable to be extracted, the address will be null. `region`, and `postal_code` may be null based on the addressing system. For example: Addresses from the United Kingdom will not include a region Addresses from Hong Kong will not include postal code Note: Optical Character Recognition (OCR) technology may sometimes extract incorrect data from a document.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CITY
static String	SERIALIZED_NAME_COUNTRY
static String	SERIALIZED_NAME_POSTAL_CODE
static String	SERIALIZED_NAME_REGION
static String	SERIALIZED_NAME_STREET

Constructor Summary

Constructors

Constructor and Description
IdentityVerificationDocumentAddressResponse()

Method Summary

Modifier and Type	Method and Description
IdentityVerificationDocumentAddressResponse	city(String city)
IdentityVerificationDocumentAddressResponse	country(String country)
boolean	equals(Object o)
String	getCity() City extracted from the document.
String	getCountry() Valid, capitalized, two-letter ISO code representing the country extracted from the document.
String	getPostalCode() The postal code extracted from the document.
String	getRegion() An ISO 3166-2 subdivision code extracted from the document.
String	getStreet() The full street address extracted from the document.
int	hashCode()
IdentityVerificationDocumentAddressResponse	postalCode(String postalCode)
IdentityVerificationDocumentAddressResponse	region(String region)
void	setCity(String city)
void	setCountry(String country)
void	setPostalCode(String postalCode)
void	setRegion(String region)
void	setStreet(String street)
IdentityVerificationDocumentAddressResponse	street(String street)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_STREET

public static final String SERIALIZED_NAME_STREET

See Also:

Constant Field Values

SERIALIZED_NAME_CITY

public static final String SERIALIZED_NAME_CITY

See Also:

Constant Field Values

SERIALIZED_NAME_REGION

public static final String SERIALIZED_NAME_REGION

See Also:

Constant Field Values

SERIALIZED_NAME_POSTAL_CODE

public static final String SERIALIZED_NAME_POSTAL_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_COUNTRY

public static final String SERIALIZED_NAME_COUNTRY

See Also:

Constant Field Values

Constructor Detail

IdentityVerificationDocumentAddressResponse

public IdentityVerificationDocumentAddressResponse()

Method Detail

street

public IdentityVerificationDocumentAddressResponse street(String street)

getStreet

public String getStreet()

The full street address extracted from the document.

Returns:

street

setStreet

public void setStreet(String street)

city

public IdentityVerificationDocumentAddressResponse city(String city)

getCity

public String getCity()

City extracted from the document.

Returns:

city

setCity

public void setCity(String city)

region

public IdentityVerificationDocumentAddressResponse region(String region)

getRegion

@Nullable
public String getRegion()

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

Returns:

region

setRegion

public void setRegion(String region)

postalCode

public IdentityVerificationDocumentAddressResponse postalCode(String postalCode)

getPostalCode

@Nullable
public String getPostalCode()

The postal code extracted from the document. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.

Returns:

postalCode

setPostalCode

public void setPostalCode(String postalCode)

country

public IdentityVerificationDocumentAddressResponse country(String country)

getCountry

public String getCountry()

Valid, capitalized, two-letter ISO code representing the country extracted from the document. Must be in ISO 3166-1 alpha-2 form.

Returns:

country

setCountry

public void setCountry(String country)

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