plaid2.model.document_risk_signals_object module

class plaid2.model.document_risk_signals_object.DocumentRiskSignalsObject(*, multi_document_risk_signals: List[MultiDocumentRiskSignal], account_id: Optional[str] = None, single_document_risk_signals: List[SingleDocumentRiskSignal])

Bases: BaseModel

account_id: Optional[str]

ID of the payroll provider account.

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

multi_document_risk_signals: List[MultiDocumentRiskSignal]

Array of risk signals computed from a set of uploaded documents and the associated documents’ metadata

classmethod parse_obj(data: Any) → DocumentRiskSignalsObject

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

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

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

single_document_risk_signals: List[SingleDocumentRiskSignal]

Array of document metadata and associated risk signals per document