plaid2.model.income_verification_refresh_response module

class plaid2.model.income_verification_refresh_response.IncomeVerificationRefreshResponse(*, request_id: str, verification_refresh_status: str)[source]

Bases: BaseModel

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

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

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) IncomeVerificationRefreshResponse[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) IncomeVerificationRefreshResponse[source]

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

request_id: str

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

verification_refresh_status: str

The verification refresh status. One of the following:

“VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED” User presence is required to refresh an income verification. “VERIFICATION_REFRESH_SUCCESSFUL” The income verification refresh was successful. “VERIFICATION_REFRESH_NOT_FOUND” No new data was found after the income verification refresh.