An object specifying information about the end user who will be linking their account.
| Name | Type | Description | Notes |
|---|---|---|---|
| client_user_id | str | 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. | |
| legal_name | str | The user's full legal name, used for micro-deposit based verification flows. For a small number of customers on legacy flows, providing this field is required to enable micro-deposit-based flows. For all other customers, this field is optional, but providing the user's name in this field when using micro-deposit-based verification will enable certain risk checks and can reduce micro-deposit fraud. | [optional] |
| name | LinkTokenCreateRequestUserName | [optional] | |
| phone_number | str | The user's phone number in E.164 format. This field is optional, but required to enable the returning user experience. Can also be used to prefill Link fields when used with Identity Verification. | [optional] |
| phone_number_verified_time | datetime, none_type | The date and time the phone number was verified in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`). This was previously an optional field used in the returning user experience. This field is no longer required to enable the returning user experience. 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` | [optional] |
| email_address | str | The user's email address. This field is optional, but required to enable the pre-authenticated returning user flow. Can also be used to prefill Link fields when used with Identity Verification. | [optional] |
| email_address_verified_time | datetime, none_type | The date and time the email address was verified in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`). This was previously an optional field used in the returning user experience. This field is no longer required to enable the returning user experience. 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` | [optional] |
| ssn | str | Deprecated and not currently used, use the `id_number` field instead. | [optional] |
| date_of_birth | date, none_type | To be provided in the format "yyyy-mm-dd". Can be used to prefill Link fields when used with Identity Verification. | [optional] |
| address | LinkTokenCreateRequestUserAddress | [optional] | |
| id_number | LinkTokenCreateRequestUserIdNumber | [optional] | |
| any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |