plaid2.model.link_token_create_request_user module
- class plaid2.model.link_token_create_request_user.LinkTokenCreateRequestUser(*, name: Optional[UserName] = None, date_of_birth: Optional[str] = None, client_user_id: str, address: Optional[UserAddress] = None, phone_number_verified_time: Optional[str] = None, id_number: Optional[UserIdNumber] = None, legal_name: Optional[str] = None, email_address_verified_time: Optional[str] = None, phone_number: Optional[str] = None, ssn: Optional[str] = None, email_address: Optional[str] = None)[source]
Bases:
BaseModel- address: Optional[UserAddress]
Home address for the user.
- 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.
- date_of_birth: Optional[str]
To be provided in the format “yyyy-mm-dd”. Not currently used.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- email_address: Optional[str]
//plaid.com/docs/link/returning-user/#enabling-the-returning-user-experience).
- Type
The user’s email address. This field is optional, but required to enable the [pre-authenticated returning user flow](https
- email_address_verified_time: Optional[str]
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
- Type
The date and time the email address was verified in [ISO 8601](https
- Type
//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh
- id_number: Optional[UserIdNumber]
ID number submitted by the user, currently used only for the Identity Verification product. If the user has not submitted this data yet, this field will be null. Otherwise, both fields are guaranteed to be filled.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- legal_name: Optional[str]
The user’s full legal name. Currently used only to support certain legacy flows.
- name_: Optional[UserName]
//plaid.com/docs/api/products/identity-verification) product; if not using Identity Verification, this field is not allowed. Users will not be asked for their name when this field is provided.
- Type
The user’s full name. Optional if using the [Identity Verification](https
- classmethod parse_obj(data: Any) LinkTokenCreateRequestUser[source]
Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj
- classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) LinkTokenCreateRequestUser[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- phone_number: Optional[str]
//plaid.com/docs/link/returning-user).
- Type
The user’s phone number in [E.164](https
- Type
//en.wikipedia.org/wiki/E.164) format. This field is optional, but required to enable the [returning user experience](https
- phone_number_verified_time: Optional[str]
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
- Type
The date and time the phone number was verified in [ISO 8601](https
- Type
//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh
- ssn: Optional[str]
To be provided in the format “ddd-dd-dddd”. Not currently used.