plaid2.model.entity_screening_hit_analysis module

class plaid2.model.entity_screening_hit_analysis.EntityScreeningHitAnalysis(*, locations: Optional[str] = None, documents: Optional[str] = None, urls: Optional[str] = None, phone_numbers: Optional[str] = None, email_addresses: Optional[str] = None, names: Optional[str] = None, search_terms_version: float)

Bases: BaseModel

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

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

documents: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

email_addresses: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

json(**kwargs: Any) → str

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

locations: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

names: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

classmethod parse_obj(data: Any) → EntityScreeningHitAnalysis

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

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

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

phone_numbers: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

search_terms_version: float

The version of the entity screening’s search_terms that were compared when the entity screening hit was added. entity screening hits are immutable once they have been reviewed. If changes are detected due to updates to the entity screening’s search_terms, the associated entity program, or the list’s source data prior to review, the entity screening hit will be updated to reflect those changes.

urls: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.