plaid2.model.entity_watchlist_program module

class plaid2.model.entity_watchlist_program.EntityWatchlistProgram(*, name: str, created_at: str, lists_enabled: List[str], name_sensitivity: str, id: str, audit_trail: WatchlistScreeningAuditTrail, is_archived: bool, is_rescanning_enabled: bool)

Bases: BaseModel

class Config

Bases: object

alias_generator()

allow_population_by_field_name = True

audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

created_at: str

An ISO8601 formatted timestamp.

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

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

id: str

ID of the associated entity program.

is_archived: bool

Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.

is_rescanning_enabled: bool

Indicator specifying whether the program is enabled and will perform daily rescans.

json(**kwargs: Any) → str

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

lists_enabled: List[str]

Watchlists enabled for the associated program

name_: str

A name for the entity program to define its purpose. For example, “High Risk Organizations” or “Applicants”.

name_sensitivity: str

The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every sensitivity.

coarse - See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review.

balanced - A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise.

strict - Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse and balanced settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations.

exact - Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.

classmethod parse_obj(data: Any) → EntityWatchlistProgram

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

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

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