IdentityVerificationCreateRequestUser (com.plaid:plaid-java 29.0.0 API)

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

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class IdentityVerificationCreateRequestUser
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. If you are not using the shareable URL feature, you can optionally provide these fields via `/link/token/create` instead; both `/identity_verification/create` and `/link/token/create` are valid ways to provide this information. Note that if you provide a non-`null` user data object via `/identity_verification/create`, any user data fields entered via `/link/token/create` for the same `client_user_id` will be ignored when prefilling Link.

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_ID_NUMBER`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_PHONE_NUMBER`

Constructor Summary

Constructors
Constructor and Description

IdentityVerificationCreateRequestUser()

Constructors
Constructor and Description
`IdentityVerificationCreateRequestUser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentityVerificationCreateRequestUser`	`address(UserAddress address)`
`IdentityVerificationCreateRequestUser`	`clientUserId(String clientUserId)`
`IdentityVerificationCreateRequestUser`	`dateOfBirth(LocalDate dateOfBirth)`
`IdentityVerificationCreateRequestUser`	`emailAddress(String emailAddress)`
`boolean`	`equals(Object o)`
`UserAddress`	`getAddress()` Get address
`String`	`getClientUserId()` Specifying `user.client_user_id` is deprecated.
`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 valid phone number in E.164 format.
`int`	`hashCode()`
`IdentityVerificationCreateRequestUser`	`idNumber(UserIDNumber idNumber)`
`IdentityVerificationCreateRequestUser`	`name(IdentityVerificationRequestUserName name)`
`IdentityVerificationCreateRequestUser`	`phoneNumber(String phoneNumber)`
`void`	`setAddress(UserAddress address)`
`void`	`setClientUserId(String clientUserId)`
`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
- SERIALIZED_NAME_CLIENT_USER_ID
```
public static final String SERIALIZED_NAME_CLIENT_USER_ID
```
  See Also:
  
  Constant Field Values

Constructor Detail
- IdentityVerificationCreateRequestUser
```
public IdentityVerificationCreateRequestUser()
```

Method Detail

emailAddress

public IdentityVerificationCreateRequestUser emailAddress(String emailAddress)

getEmailAddress
```
@Nullable
public String getEmailAddress()
```
A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see [RFC 3696](https://datatracker.ietf.org/doc/html/rfc3696).

Returns:

emailAddress

setEmailAddress

public void setEmailAddress(String emailAddress)

phoneNumber

public IdentityVerificationCreateRequestUser phoneNumber(String phoneNumber)

getPhoneNumber
```
@Nullable
public String getPhoneNumber()
```
A valid phone number in E.164 format.

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

dateOfBirth

public IdentityVerificationCreateRequestUser 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 IdentityVerificationCreateRequestUser name(IdentityVerificationRequestUserName name)

getName

@Nullable
public IdentityVerificationRequestUserName getName()

Get name

Returns:: name

setName

public void setName(IdentityVerificationRequestUserName name)

address

public IdentityVerificationCreateRequestUser address(UserAddress address)

getAddress

@Nullable
public UserAddress getAddress()

Get address

Returns:: address

setAddress

public void setAddress(UserAddress address)

idNumber

public IdentityVerificationCreateRequestUser idNumber(UserIDNumber idNumber)

getIdNumber

@Nullable
public UserIDNumber getIdNumber()

Get idNumber

Returns:: idNumber

setIdNumber

public void setIdNumber(UserIDNumber idNumber)

clientUserId

public IdentityVerificationCreateRequestUser clientUserId(String clientUserId)

getClientUserId
```
@Nullable
public String getClientUserId()
```
Specifying `user.client_user_id` is deprecated. Please provide `client_user_id` at the root level instead.

Returns:

clientUserId

setClientUserId

public void setClientUserId(String clientUserId)

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 IdentityVerificationCreateRequestUser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_EMAIL_ADDRESS

SERIALIZED_NAME_PHONE_NUMBER

SERIALIZED_NAME_DATE_OF_BIRTH

SERIALIZED_NAME_NAME

SERIALIZED_NAME_ADDRESS

SERIALIZED_NAME_ID_NUMBER

SERIALIZED_NAME_CLIENT_USER_ID

Constructor Detail

IdentityVerificationCreateRequestUser

Method Detail

emailAddress

getEmailAddress

setEmailAddress

phoneNumber

getPhoneNumber

setPhoneNumber

dateOfBirth

getDateOfBirth

setDateOfBirth

name

getName

setName

address

getAddress

setAddress

idNumber

getIdNumber

setIdNumber

clientUserId

getClientUserId

setClientUserId

equals

hashCode

toString