com.plaid.client.model

Class IdentityVerificationRequestUser

java.lang.Object

com.plaid.client.model.IdentityVerificationRequestUser

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

User information collected outside of Link, most likely via your own onboarding process. Each of the following identity fields are optional: `email_address` `phone_number` `date_of_birth` `name` `address` `id_number` Specifically, these fields are optional in that they can either be fully provided (satisfying every required field in their subschema) or omitted from the request entirely by not providing the key or value. Providing these fields via the API will result in Link skipping the data collection process for the associated user. All verification steps enabled in the associated Identity Verification Template will still be run. Verification steps will either be run immediately, or once the user completes the `accept_tos` step, depending on the value provided to the `gave_consent` field.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ADDRESS
static String	SERIALIZED_NAME_DATE_OF_BIRTH
static String	SERIALIZED_NAME_EMAIL_ADDRESS
static String	SERIALIZED_NAME_ID_NUMBER
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_PHONE_NUMBER

Constructor Summary

Constructors

Constructor and Description
IdentityVerificationRequestUser()

Method Summary

Modifier and Type	Method and Description
IdentityVerificationRequestUser	address(UserAddress address)
IdentityVerificationRequestUser	dateOfBirth(LocalDate dateOfBirth)
IdentityVerificationRequestUser	emailAddress(String emailAddress)
boolean	equals(Object o)
UserAddress	getAddress() Get address
LocalDate	getDateOfBirth() A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
String	getEmailAddress() A valid email address.
UserIDNumber	getIdNumber() Get idNumber
IdentityVerificationRequestUserName	getName() Get name
String	getPhoneNumber() A phone number in E.164 format.
int	hashCode()
IdentityVerificationRequestUser	idNumber(UserIDNumber idNumber)
IdentityVerificationRequestUser	name(IdentityVerificationRequestUserName name)
IdentityVerificationRequestUser	phoneNumber(String phoneNumber)
void	setAddress(UserAddress address)
void	setDateOfBirth(LocalDate dateOfBirth)
void	setEmailAddress(String emailAddress)
void	setIdNumber(UserIDNumber idNumber)
void	setName(IdentityVerificationRequestUserName name)
void	setPhoneNumber(String phoneNumber)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_EMAIL_ADDRESS

public static final String SERIALIZED_NAME_EMAIL_ADDRESS

See Also:

Constant Field Values

SERIALIZED_NAME_PHONE_NUMBER

public static final String SERIALIZED_NAME_PHONE_NUMBER

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_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS

public static final String SERIALIZED_NAME_ADDRESS

See Also:

Constant Field Values

SERIALIZED_NAME_ID_NUMBER

public static final String SERIALIZED_NAME_ID_NUMBER

See Also:

Constant Field Values

Constructor Detail

IdentityVerificationRequestUser

public IdentityVerificationRequestUser()

Method Detail

emailAddress

public IdentityVerificationRequestUser emailAddress(String emailAddress)

getEmailAddress

@Nullable
public String getEmailAddress()

A valid email address.

Returns:

emailAddress

setEmailAddress

public void setEmailAddress(String emailAddress)

phoneNumber

public IdentityVerificationRequestUser phoneNumber(String phoneNumber)

getPhoneNumber

@Nullable
public String getPhoneNumber()

A phone number in E.164 format.

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

dateOfBirth

public IdentityVerificationRequestUser dateOfBirth(LocalDate dateOfBirth)

getDateOfBirth

@Nullable
public LocalDate getDateOfBirth()

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

Returns:

dateOfBirth

setDateOfBirth

public void setDateOfBirth(LocalDate dateOfBirth)

name

public IdentityVerificationRequestUser name(IdentityVerificationRequestUserName name)

getName

@Nullable
public IdentityVerificationRequestUserName getName()

Get name

Returns:

name

setName

public void setName(IdentityVerificationRequestUserName name)

address

public IdentityVerificationRequestUser address(UserAddress address)

getAddress

@Nullable
public UserAddress getAddress()

Get address

Returns:

address

setAddress

public void setAddress(UserAddress address)

idNumber

public IdentityVerificationRequestUser idNumber(UserIDNumber idNumber)

getIdNumber

@Nullable
public UserIDNumber getIdNumber()

Get idNumber

Returns:

idNumber

setIdNumber

public void setIdNumber(UserIDNumber idNumber)

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