plaid2.model.entity_screening_hit_names module

class plaid2.model.entity_screening_hit_names.EntityScreeningHitNames(*, weak_alias_determination: str, full: str, is_primary: bool)

Bases: BaseModel

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

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

full: str

The full name of the entity.

is_primary: bool

Primary names are those most commonly used to refer to this entity. Only one name will ever be marked as primary.

json(**kwargs: Any) → str

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

classmethod parse_obj(data: Any) → EntityScreeningHitNames

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

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

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

weak_alias_determination: str

Names that are explicitly marked as low quality either by their source list, or by plaid by a series of additional checks done by Plaid. Plaid does not ever surface a hit as a result of a weak name alone. If a name has no quality issues, this value will be none.