plaid2.model.identity_verification_user_data module

class plaid2.model.identity_verification_user_data.IdentityVerificationUserData(*, name: Optional[UserName] = None, address: Optional[IdentityVerificationUserAddress] = None, id_number: Optional[UserIdNumber] = None, ip_address: Optional[str] = None, date_of_birth: Optional[str] = None, phone_number: Optional[str] = None, email_address: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()

allow_population_by_field_name = True

address: Optional[IdentityVerificationUserAddress]

Addresses from the United Kingdom will not include a region * Addresses from Hong Kong will not include postal code

Type: Even if an address has been collected, some fields may be null depending on the region’s addressing system. For example

date_of_birth: Optional[str]: A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

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]

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.

ip_address: Optional[str]: An IPv4 or IPV6 address.

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[UserName]: The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.

classmethod parse_obj(data: Any) → IdentityVerificationUserData[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) → IdentityVerificationUserData[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]: A phone number in E.164 format.