class

Plaid::DocumentRiskSignal

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

Details about a certain reason as to why a document could potentially be fraudulent.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, _type : String | Nil = nil, field : String | Nil = nil, has_fraud_risk : Bool | Nil = nil, institution_metadata : DocumentRiskSignalInstitutionMetadata | Nil = nil, expected_value : String | Nil = nil, actual_value : String | Nil = nil, signal_description : String | Nil = nil, page_number : Int32 | 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

_type

The result from the risk signal check.

Source
_type=(new_value : String | Nil)

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

Source
actual_value

The derived value obtained in the risk signal calculation process for this field

Source
actual_value=(new_value : String | Nil)

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

Source
expected_value

The expected value of the field, as seen on the document

Source
expected_value=(new_value : String | Nil)

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

Source
field

The field which the risk signal was computed for

Source
field=(new_value : String | Nil)

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

Source
has_fraud_risk

A flag used to quickly identify if the signal indicates that this field is authentic or fraudulent

Source
has_fraud_risk=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] has_fraud_risk 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

institution_metadata
Source
institution_metadata=(new_value : DocumentRiskSignalInstitutionMetadata | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] institution_metadata 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
page_number

The relevant page associated with the risk signal

Source
page_number=(new_value : Int32 | Nil)

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

Source
signal_description

A human-readable explanation providing more detail into the particular risk signal

Source
signal_description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] signal_description 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