LinkTokenCreateRequestUser (com.plaid:plaid-java 13.3.0 API)

java.lang.Object
- com.plaid.client.model.LinkTokenCreateRequestUser

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T17:46:09.980340Z[Etc/UTC]")
public class LinkTokenCreateRequestUser
extends Object

An object specifying information about the end user who will be linking their account.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ADDRESS`
`static String`	`SERIALIZED_NAME_CLIENT_USER_ID`
`static String`	`SERIALIZED_NAME_DATE_OF_BIRTH`
`static String`	`SERIALIZED_NAME_EMAIL_ADDRESS`
`static String`	`SERIALIZED_NAME_EMAIL_ADDRESS_VERIFIED_TIME`
`static String`	`SERIALIZED_NAME_ID_NUMBER`
`static String`	`SERIALIZED_NAME_LEGAL_NAME`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_PHONE_NUMBER`
`static String`	`SERIALIZED_NAME_PHONE_NUMBER_VERIFIED_TIME`
`static String`	`SERIALIZED_NAME_SSN`

Constructor Summary

Constructors
Constructor and Description

LinkTokenCreateRequestUser()

Constructors
Constructor and Description
`LinkTokenCreateRequestUser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LinkTokenCreateRequestUser`	`address(UserAddress address)`
`LinkTokenCreateRequestUser`	`clientUserId(String clientUserId)`
`LinkTokenCreateRequestUser`	`dateOfBirth(LocalDate dateOfBirth)`
`LinkTokenCreateRequestUser`	`emailAddress(String emailAddress)`
`LinkTokenCreateRequestUser`	`emailAddressVerifiedTime(OffsetDateTime emailAddressVerifiedTime)`
`boolean`	`equals(Object o)`
`UserAddress`	`getAddress()` Get address
`String`	`getClientUserId()` A unique ID representing the end user.
`LocalDate`	`getDateOfBirth()` To be provided in the format \"yyyy-mm-dd\".
`String`	`getEmailAddress()` The user's email address.
`OffsetDateTime`	`getEmailAddressVerifiedTime()` The date and time the email address was verified in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh:mm:ssZ`).
`UserIDNumber`	`getIdNumber()` Get idNumber
`String`	`getLegalName()` The user's full legal name.
`UserName`	`getName()` Get name
`String`	`getPhoneNumber()` The user's phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
`OffsetDateTime`	`getPhoneNumberVerifiedTime()` The date and time the phone number was verified in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh:mm:ssZ`).
`String`	`getSsn()` To be provided in the format \"ddd-dd-dddd\".
`int`	`hashCode()`
`LinkTokenCreateRequestUser`	`idNumber(UserIDNumber idNumber)`
`LinkTokenCreateRequestUser`	`legalName(String legalName)`
`LinkTokenCreateRequestUser`	`name(UserName name)`
`LinkTokenCreateRequestUser`	`phoneNumber(String phoneNumber)`
`LinkTokenCreateRequestUser`	`phoneNumberVerifiedTime(OffsetDateTime phoneNumberVerifiedTime)`
`void`	`setAddress(UserAddress address)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setDateOfBirth(LocalDate dateOfBirth)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setEmailAddressVerifiedTime(OffsetDateTime emailAddressVerifiedTime)`
`void`	`setIdNumber(UserIDNumber idNumber)`
`void`	`setLegalName(String legalName)`
`void`	`setName(UserName name)`
`void`	`setPhoneNumber(String phoneNumber)`
`void`	`setPhoneNumberVerifiedTime(OffsetDateTime phoneNumberVerifiedTime)`
`void`	`setSsn(String ssn)`
`LinkTokenCreateRequestUser`	`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_LEGAL_NAME
```
public static final String SERIALIZED_NAME_LEGAL_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PHONE_NUMBER
```
public static final String SERIALIZED_NAME_PHONE_NUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PHONE_NUMBER_VERIFIED_TIME
```
public static final String SERIALIZED_NAME_PHONE_NUMBER_VERIFIED_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EMAIL_ADDRESS
```
public static final String SERIALIZED_NAME_EMAIL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EMAIL_ADDRESS_VERIFIED_TIME
```
public static final String SERIALIZED_NAME_EMAIL_ADDRESS_VERIFIED_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SSN
```
public static final String SERIALIZED_NAME_SSN
```
    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
  - SERIALIZED_NAME_ID_NUMBER
```
public static final String SERIALIZED_NAME_ID_NUMBER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LinkTokenCreateRequestUser
```
public LinkTokenCreateRequestUser()
```
- Method Detail
  - clientUserId
```
public LinkTokenCreateRequestUser clientUserId(String clientUserId)
```
  - getClientUserId
```
public String getClientUserId()
```
    A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`. It is currently used as a means of searching logs for the given user in the Plaid Dashboard.
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - legalName
```
public LinkTokenCreateRequestUser legalName(String legalName)
```
  - getLegalName
```
@Nullable
public String getLegalName()
```
    The user's full legal name. Currently used only to support certain legacy flows.
    
    Returns:
    
    legalName
  - setLegalName
```
public void setLegalName(String legalName)
```
  - name
```
public LinkTokenCreateRequestUser name(UserName name)
```
  - getName
```
@Nullable
public UserName getName()
```
    Get name
    
    Returns:
    
    name
  - setName
```
public void setName(UserName name)
```
  - phoneNumber
```
public LinkTokenCreateRequestUser phoneNumber(String phoneNumber)
```
  - getPhoneNumber
```
@Nullable
public String getPhoneNumber()
```
    The user's phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. This field is optional, but required to enable the [returning user experience](https://plaid.com/docs/link/returning-user).
    
    Returns:
    
    phoneNumber
  - setPhoneNumber
```
public void setPhoneNumber(String phoneNumber)
```
  - phoneNumberVerifiedTime
```
public LinkTokenCreateRequestUser phoneNumberVerifiedTime(OffsetDateTime phoneNumberVerifiedTime)
```
  - getPhoneNumberVerifiedTime
```
@Nullable
public OffsetDateTime getPhoneNumberVerifiedTime()
```
    The date and time the phone number was verified in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh:mm:ssZ`). This field is optional, but required to enable any [returning user experience](https://plaid.com/docs/link/returning-user). Only pass a verification time for a phone number that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch. Example: `2020-01-01T00:00:00Z`
    
    Returns:
    
    phoneNumberVerifiedTime
  - setPhoneNumberVerifiedTime
```
public void setPhoneNumberVerifiedTime(OffsetDateTime phoneNumberVerifiedTime)
```
  - emailAddress
```
public LinkTokenCreateRequestUser emailAddress(String emailAddress)
```
  - getEmailAddress
```
@Nullable
public String getEmailAddress()
```
    The user's email address. This field is optional, but required to enable the [pre-authenticated returning user flow](https://plaid.com/docs/link/returning-user/#enabling-the-returning-user-experience).
    
    Returns:
    
    emailAddress
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
  - emailAddressVerifiedTime
```
public LinkTokenCreateRequestUser emailAddressVerifiedTime(OffsetDateTime emailAddressVerifiedTime)
```
  - getEmailAddressVerifiedTime
```
@Nullable
public OffsetDateTime getEmailAddressVerifiedTime()
```
    The date and time the email address was verified in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh:mm:ssZ`). This is an optional field used in the [returning user experience](https://plaid.com/docs/link/returning-user). Only pass a verification time for an email address that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch. Example: `2020-01-01T00:00:00Z`
    
    Returns:
    
    emailAddressVerifiedTime
  - setEmailAddressVerifiedTime
```
public void setEmailAddressVerifiedTime(OffsetDateTime emailAddressVerifiedTime)
```
  - ssn
```
public LinkTokenCreateRequestUser ssn(String ssn)
```
  - getSsn
```
@Nullable
public String getSsn()
```
    To be provided in the format \"ddd-dd-dddd\". Not currently used.
    
    Returns:
    
    ssn
  - setSsn
```
public void setSsn(String ssn)
```
  - dateOfBirth
```
public LinkTokenCreateRequestUser dateOfBirth(LocalDate dateOfBirth)
```
  - getDateOfBirth
```
@Nullable
public LocalDate getDateOfBirth()
```
    To be provided in the format \"yyyy-mm-dd\". Not currently used.
    
    Returns:
    
    dateOfBirth
  - setDateOfBirth
```
public void setDateOfBirth(LocalDate dateOfBirth)
```
  - address
```
public LinkTokenCreateRequestUser address(UserAddress address)
```
  - getAddress
```
@Nullable
public UserAddress getAddress()
```
    Get address
    
    Returns:
    
    address
  - setAddress
```
public void setAddress(UserAddress address)
```
  - idNumber
```
public LinkTokenCreateRequestUser 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

Class LinkTokenCreateRequestUser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_USER_ID

SERIALIZED_NAME_LEGAL_NAME

SERIALIZED_NAME_NAME

SERIALIZED_NAME_PHONE_NUMBER

SERIALIZED_NAME_PHONE_NUMBER_VERIFIED_TIME

SERIALIZED_NAME_EMAIL_ADDRESS

SERIALIZED_NAME_EMAIL_ADDRESS_VERIFIED_TIME

SERIALIZED_NAME_SSN

SERIALIZED_NAME_DATE_OF_BIRTH

SERIALIZED_NAME_ADDRESS

SERIALIZED_NAME_ID_NUMBER

Constructor Detail

LinkTokenCreateRequestUser

Method Detail

clientUserId

getClientUserId

setClientUserId

legalName

getLegalName

setLegalName

name

getName

setName

phoneNumber

getPhoneNumber

setPhoneNumber

phoneNumberVerifiedTime

getPhoneNumberVerifiedTime

setPhoneNumberVerifiedTime

emailAddress

getEmailAddress

setEmailAddress

emailAddressVerifiedTime

getEmailAddressVerifiedTime

setEmailAddressVerifiedTime

ssn

getSsn

setSsn

dateOfBirth

getDateOfBirth

setDateOfBirth

address

getAddress

setAddress

idNumber

getIdNumber

setIdNumber

equals

hashCode

toString