plaid2.model.income_verification_precheck_response module

class plaid2.model.income_verification_precheck_response.IncomeVerificationPrecheckResponse(*, precheck_id: str, request_id: str, confidence: str)

Bases: BaseModel

confidence: str

The confidence that Plaid can support the user in the digital income verification flow instead of requiring a manual paystub upload. One of the following:

“HIGH”: It is very likely that this user can use the digital income verification flow.

“LOW”: It is unlikely that this user can use the digital income verification flow.

“UNKNOWN”: It was not possible to determine if the user is supportable with the information passed.

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

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

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

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

precheck_id: str

ID of the precheck. Provide this value when calling /link/token/create in order to optimize Link conversion.

request_id: str

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