class

Plaid::IncomeVerificationRiskSignalsStatusWebhook

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

Fired when risk signals have been processed for documents uploaded via Document Income. It will typically take a minute or two for this webhook to fire after the end user has uploaded their documents in the Document Income flow. Once this webhook has fired, /credit/payroll_income/risk_signals/get may then be called to determine whether the documents were successfully processed and to retrieve risk data.

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, webhook_type : String | Nil = nil, webhook_code : String | Nil = nil, item_id : String | Nil = nil, environment : Plaid::WebhookEnvironmentValues | Nil = nil, user_id : String | Nil = nil, risk_signals_status : String | Nil = nil)

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

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

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

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

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.

item_id=(new_value : String | Nil)

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

list_invalid_properties

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

risk_signals_status

RISK_SIGNALS_PROCESSING_COMPLETE: The income verification fraud detection processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the /credit/payroll_income/risk_signals/get endpoint to get all risk signal data.

risk_signals_status=(new_value : String | Nil)

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

user_id

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

user_id=(new_value : String | Nil)

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

valid?

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

webhook_code

INCOME_VERIFICATION_RISK_SIGNALS

webhook_code=(new_value : String | Nil)

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

webhook_type

\"INCOME\"

webhook_type=(new_value : String | Nil)

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