com.plaid.client.model

Class AssetReportUser

java.lang.Object

com.plaid.client.model.AssetReportUser

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

The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The `first_name`, `last_name`, and `ssn` fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CLIENT_USER_ID
static String	SERIALIZED_NAME_EMAIL
static String	SERIALIZED_NAME_FIRST_NAME
static String	SERIALIZED_NAME_LAST_NAME
static String	SERIALIZED_NAME_MIDDLE_NAME
static String	SERIALIZED_NAME_PHONE_NUMBER
static String	SERIALIZED_NAME_SSN

Constructor Summary

Constructors

Constructor and Description
AssetReportUser()

Method Summary

Modifier and Type	Method and Description
AssetReportUser	clientUserId(String clientUserId)
AssetReportUser	email(String email)
boolean	equals(Object o)
AssetReportUser	firstName(String firstName)
String	getClientUserId() An identifier you determine and submit for the user.
String	getEmail() The user's email address.
String	getFirstName() The user's first name.
String	getLastName() The user's last name.
String	getMiddleName() The user's middle name
String	getPhoneNumber() The user's phone number, in E.164 format: +{countrycode}{number}.
String	getSsn() The user's Social Security Number.
int	hashCode()
AssetReportUser	lastName(String lastName)
AssetReportUser	middleName(String middleName)
AssetReportUser	phoneNumber(String phoneNumber)
void	setClientUserId(String clientUserId)
void	setEmail(String email)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setMiddleName(String middleName)
void	setPhoneNumber(String phoneNumber)
void	setSsn(String ssn)
AssetReportUser	ssn(String ssn)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_CLIENT_USER_ID

public static final String SERIALIZED_NAME_CLIENT_USER_ID

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_SSN

public static final String SERIALIZED_NAME_SSN

See Also:

Constant Field Values

SERIALIZED_NAME_PHONE_NUMBER

public static final String SERIALIZED_NAME_PHONE_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_EMAIL

public static final String SERIALIZED_NAME_EMAIL

See Also:

Constant Field Values

Constructor Detail

AssetReportUser

public AssetReportUser()

Method Detail

clientUserId

public AssetReportUser clientUserId(String clientUserId)

getClientUserId

@Nullable
public String getClientUserId()

An identifier you determine and submit for the user.

Returns:

clientUserId

setClientUserId

public void setClientUserId(String clientUserId)

firstName

public AssetReportUser firstName(String firstName)

getFirstName

@Nullable
public String getFirstName()

The user's first name. Required for the Fannie Mae Day 1 Certainty™ program.

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

middleName

public AssetReportUser middleName(String middleName)

getMiddleName

@Nullable
public String getMiddleName()

The user's middle name

Returns:

middleName

setMiddleName

public void setMiddleName(String middleName)

lastName

public AssetReportUser lastName(String lastName)

getLastName

@Nullable
public String getLastName()

The user's last name. Required for the Fannie Mae Day 1 Certainty™ program.

Returns:

lastName

setLastName

public void setLastName(String lastName)

ssn

public AssetReportUser ssn(String ssn)

getSsn

@Nullable
public String getSsn()

The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program. Format: \"ddd-dd-dddd\"

Returns:

ssn

setSsn

public void setSsn(String ssn)

phoneNumber

public AssetReportUser phoneNumber(String phoneNumber)

getPhoneNumber

@Nullable
public String getPhoneNumber()

The user's phone number, in E.164 format: +{countrycode}{number}. For example: \"+14151234567\". Phone numbers provided in other formats will be parsed on a best-effort basis.

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

email

public AssetReportUser email(String email)

getEmail

@Nullable
public String getEmail()

The user's email address.

Returns:

email

setEmail

public void setEmail(String email)

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