Struct IncomeVerificationStatusWebhook

pub struct IncomeVerificationStatusWebhook {
    pub environment: WebhookEnvironmentValues,
    pub item_id: String,
    pub user_id: Option<String>,
    pub verification_status: String,
    pub webhook_code: String,
    pub webhook_type: String,
}

Fired when the status of an income verification instance has changed. This webhook is fired for both the Document and Payroll Income flows, but not the Bank Income flow. It will typically take several minutes for this webhook to fire after the end user has uploaded their documents in the Document Income flow.

Fields

environment: WebhookEnvironmentValues

The Plaid environment the webhook was sent from

item_id: String

The Item ID associated with the verification.

user_id: Option<String>

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

verification_status: String

VERIFICATION_STATUS_PROCESSING_COMPLETE: The income verification processing has completed. This indicates that the documents have been parsed successfully or that the documents were not parsable. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the /credit/payroll_income/get endpoint and check the document metadata to see which documents were successfully parsed.

VERIFICATION_STATUS_PROCESSING_FAILED: An unexpected internal error occurred when attempting to process the verification documentation.

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

webhook_code: String

INCOME_VERIFICATION

webhook_type: String

"INCOME"

Trait Implementations

impl Clone for IncomeVerificationStatusWebhook

fn clone(&self) -> IncomeVerificationStatusWebhook

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IncomeVerificationStatusWebhook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IncomeVerificationStatusWebhook

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IncomeVerificationStatusWebhook

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for IncomeVerificationStatusWebhook

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.