plaid2.model.sandbox_income_fire_webhook_request module

class plaid2.model.sandbox_income_fire_webhook_request.SandboxIncomeFireWebhookRequest(*, item_id: str, user_id: Optional[str] = None, webhook: str, verification_status: str)

Bases: BaseModel

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

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

item_id: str

The Item ID associated with the verification.

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

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

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

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

user_id: Optional[str]

The Plaid user_id of the User associated with this webhook, warning, or error.

verification_status: str

The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the /income/verification/paystubs/get endpoint and check the document metadata to see which documents were successfully parsed.

VERIFICATION_STATUS_PROCESSING_FAILED: A failure occurred when attempting to process the verification documentation.

VERIFICATION_STATUS_PENDING_APPROVAL: The income verification has been sent to the user for review.

Type

VERIFICATION_STATUS_PROCESSING_COMPLETE

webhook: str

The URL to which the webhook should be sent.