plaid2.model.kyc_check_name_summary module

class plaid2.model.kyc_check_name_summary.KycCheckNameSummary(*, summary: str)

Bases: BaseModel

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

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

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) → KycCheckNameSummary

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

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

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

summary: 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.