plaid2.model.document_risk_signal module

class plaid2.model.document_risk_signal.DocumentRiskSignal(*, signal_description: Optional[str] = None, actual_value: Optional[str] = None, has_fraud_risk: Optional[bool] = None, institution_metadata: Optional[str] = None, field: Optional[str] = None, expected_value: Optional[str] = None, type: Optional[str] = None)[source]

Bases: BaseModel

actual_value: Optional[str]: The derived value obtained in the risk signal calculation process for this field

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

expected_value: Optional[str]: The expected value of the field, as seen on the document

field: Optional[str]: The field which the risk signal was computed for

has_fraud_risk: Optional[bool]: A flag used to quickly identify if the signal indicates that this field is authentic or fraudulent

institution_metadata: Optional[str]: An object which contains additional metadata about the institution used to compute the verification attribute

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

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

signal_description: Optional[str]: A human-readable explanation providing more detail into the particular risk signal

type: Optional[str]: The result from the risk signal check.