class

Plaid::IncomeVerificationStatusWebhook

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Fired when the status of an income verification instance has changed. It will typically take several minutes for this webhook to fire after the end user has uploaded their documents in the Document Income flow.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, webhook_type : String | Nil = nil, webhook_code : String | Nil = nil, item_id : String | Nil = nil, verification_status : String | Nil = nil, environment : Plaid::WebhookEnvironmentValues | Nil = nil, user_id : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

environment
Source
environment=(new_value : Plaid::WebhookEnvironmentValues | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] environment Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

item_id

The Item ID associated with the verification.

Source
item_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] item_id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
user_id

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

Source
user_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] user_id Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source
verification_status

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.

Source
verification_status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] verification_status Object to be assigned

Source
webhook_code

INCOME_VERIFICATION

Source
webhook_code=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] webhook_code Object to be assigned

Source
webhook_type

\"INCOME\"

Source
webhook_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] webhook_type Object to be assigned

Source