plaid2.model.watchlist_screening_search_terms module

class plaid2.model.watchlist_screening_search_terms.WatchlistScreeningSearchTerms(*, watchlist_program_id: str, document_number: Optional[str] = None, version: float, date_of_birth: Optional[str] = None, country: Optional[str] = None, legal_name: str)[source]

Bases: BaseModel

country: Optional[str]

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

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 legal name of the individual being screened.

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

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

watchlist_program_id: str: ID of the associated program.