plaid2.model.application module

class plaid2.model.application.Application(*, country_code: Optional[str] = None, join_date: str, name: str, application_id: str, logo_url: Optional[str] = None, company_legal_name: Optional[str] = None, city: Optional[str] = None, region: Optional[str] = None, reason_for_access: Optional[str] = None, postal_code: Optional[str] = None, display_name: Optional[str] = None, application_url: Optional[str] = None, use_case: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()

allow_population_by_field_name = True

application_id: str: This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.

application_url: Optional[str]: The URL for the application’s website

city: Optional[str]: A string representing the city of the client’s headquarters.

company_legal_name: Optional[str]: A string representing the name of client’s legal entity.

country_code: Optional[str]: A string representing the country code of the client’s headquarters.

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

display_name: Optional[str]: A human-readable name of the application for display purposes

join_date: str

//wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.

Type: The date this application was granted production access at Plaid in [ISO 8601](https

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

logo_url: Optional[str]: A URL that links to the application logo image.

name_: str: The name of the application

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

postal_code: Optional[str]: A string representing the postal code of the client’s headquarters.

reason_for_access: Optional[str]: A string provided by the connected app stating why they use their respective enabled products.

region: Optional[str]: A string representing the region of the client’s headquarters.

use_case: Optional[str]: A string representing client’s broad use case as assessed by Plaid.