plaid2.model.employer module

class plaid2.model.employer.Employer(*, address: Optional[AddressData] = None, confidence_score: float, employer_id: str, name: str)

Bases: BaseModel

class Config

Bases: object

alias_generator()

allow_population_by_field_name = True

address: Optional[AddressData]

Data about the components comprising an address.

confidence_score: float

A number from 0 to 1 indicating Plaid’s level of confidence in the pairing between the employer and the institution (not yet implemented).

dict(**kwargs: Any) → Dict[str, Any]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer_id: str

Plaid’s unique identifier for the employer.

json(**kwargs: Any) → str

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The name of the employer

classmethod parse_obj(data: Any) → Employer

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Employer

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw