plaid2.model.entity_watchlist_screening_hit module

class plaid2.model.entity_watchlist_screening_hit.EntityWatchlistScreeningHit(*, id: str, review_status: str, first_active: str, historical_since: Optional[str] = None, plaid_uid: str, analysis: Optional[EntityScreeningHitAnalysis] = None, inactive_since: Optional[str] = None, list_code: str, source_uid: Optional[str] = None, data: Optional[EntityScreeningHitData] = None)[source]

Bases: BaseModel

analysis: Optional[EntityScreeningHitAnalysis]: Analysis information describing why a screening hit matched the provided entity information

data: Optional[EntityScreeningHitData]: Information associated with the entity watchlist hit

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

first_active: str: An ISO8601 formatted timestamp.

historical_since: Optional[str]: An ISO8601 formatted timestamp.

id: str: ID of the associated entity screening hit.

inactive_since: Optional[str]: An ISO8601 formatted timestamp.

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

list_code: str: Shorthand identifier for a specific screening list for entities.

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

plaid_uid: str: A universal identifier for a watchlist individual that is stable across searches and updates.

review_status: str: The current state of review. All watchlist screening hits begin in a pending_review state but can be changed by creating a review. When a hit is in the pending_review state, it will always show the latest version of the watchlist data Plaid has available and be compared against the latest customer information saved in the watchlist screening. Once a hit has been marked as confirmed or dismissed it will no longer be updated so that the state is as it was when the review was first conducted.

source_uid: Optional[str]: The identifier provided by the source sanction or watchlist. When one is not provided by the source, this is null.