plaid2.model.entity_watchlist_screening_search_terms module

class plaid2.model.entity_watchlist_screening_search_terms.EntityWatchlistScreeningSearchTerms(*, version: float, country: Optional[str] = None, url: Optional[str] = None, legal_name: str, document_number: Optional[str] = None, entity_watchlist_program_id: str, email_address: Optional[str] = None, phone_number: Optional[str] = None)[source]

Bases: BaseModel

country: Optional[str]
dict(**kwargs: Any) Dict[str, Any][source]

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

document_number: Optional[str]
email_address: Optional[str]
entity_watchlist_program_id: str

ID of the associated entity program.

json(**kwargs: Any) str[source]

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

legal_name: str

The name of the organization being screened.

classmethod parse_obj(data: Any) EntityWatchlistScreeningSearchTerms[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) EntityWatchlistScreeningSearchTerms[source]

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

phone_number: Optional[str]
url: Optional[str]
version: float

The current version of the search terms. Starts at 1 and increments with each edit to search_terms.