plaid2.model.asset_report_create_request_options module

class plaid2.model.asset_report_create_request_options.AssetReportCreateRequestOptions(*, webhook: Optional[str] = None, products: Optional[List[str]] = None, user: Optional[AssetReportUser] = None, client_report_id: Optional[str] = None, include_fast_report: Optional[bool] = None)

Bases: BaseModel

client_report_id: Optional[str]

Client-generated identifier, which can be used by lenders to track loan applications.

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

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

include_fast_report: Optional[bool]

true to return balance and identity earlier as a fast report. Defaults to false if omitted.

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

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

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

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

products: Optional[List[str]]

“investments”

Type

Additional information that can be included in the asset report. Possible values

user: Optional[AssetReportUser]

The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The first_name, last_name, and ssn fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.

webhook: Optional[str]

URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.