plaid2.model.signal_person_name module

class plaid2.model.signal_person_name.SignalPersonName(*, suffix: Optional[str] = None, family_name: Optional[str] = None, prefix: Optional[str] = None, given_name: Optional[str] = None, middle_name: Optional[str] = None)[source]

Bases: BaseModel

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

family_name: Optional[str]: The user’s family name / surname

given_name: Optional[str]: The user’s given name. If the user has a one-word name, it should be provided in this field.

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

middle_name: Optional[str]: The user’s middle name

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

prefix: Optional[str]: The user’s name prefix (e.g. “Mr.”)

suffix: Optional[str]: The user’s name suffix (e.g. “II”)