class

Plaid::EntityScreeningHitAnalysis

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

Analysis information describing why a screening hit matched the provided entity information

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, search_terms_version : Int32 | Nil = nil, documents : Plaid::MatchSummaryCode | Nil = nil, email_addresses : Plaid::MatchSummaryCode | Nil = nil, locations : Plaid::MatchSummaryCode | Nil = nil, names : Plaid::MatchSummaryCode | Nil = nil, phone_numbers : Plaid::MatchSummaryCode | Nil = nil, urls : Plaid::MatchSummaryCode | 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

documents
Source
documents=(new_value : Plaid::MatchSummaryCode | Nil)

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

Source
email_addresses
Source
email_addresses=(new_value : Plaid::MatchSummaryCode | Nil)

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

list_invalid_properties

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

Source
locations
Source
locations=(new_value : Plaid::MatchSummaryCode | Nil)

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

Source
names
Source
names=(new_value : Plaid::MatchSummaryCode | Nil)

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

Source
phone_numbers
Source
phone_numbers=(new_value : Plaid::MatchSummaryCode | Nil)

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

Source
search_terms_version

The version of the entity screening's search_terms that were compared when the entity screening hit was added. entity screening hits are immutable once they have been reviewed. If changes are detected due to updates to the entity screening's search_terms, the associated entity program, or the list's source data prior to review, the entity screening hit will be updated to reflect those changes.

Source
search_terms_version=(new_value : Int32 | Nil)

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

Source
urls
Source
urls=(new_value : Plaid::MatchSummaryCode | Nil)

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