class

Plaid::NameMatchScore

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

Score found by matching name provided by the API with the name on the account at the financial institution. If the account contains multiple owners, the maximum match score is filled.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, score : Int32 | Nil = nil, is_first_name_or_last_name_match : Bool | Nil = nil, is_nickname_match : Bool | Nil = nil, is_business_name_detected : Bool | 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

hash(hasher)

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

is_business_name_detected

Is true if the name on either of the names that was matched for the score contained strings indicative of a business name, such as "CORP", "LLC", "INC", or "LTD". A true result generally indicates the entity is a business. However, a false result does not mean the entity is not a business, as some businesses do not use these strings in the names used for their financial institution accounts.

Source
is_business_name_detected=(new_value : Bool | Nil)

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

Source
is_business_name_detected_present=(is_business_name_detected_present : Bool)
Source
is_business_name_detected_present?
Source
is_first_name_or_last_name_match

first or last name completely matched, likely a family member

Source
is_first_name_or_last_name_match=(new_value : Bool | Nil)

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

Source
is_first_name_or_last_name_match_present=(is_first_name_or_last_name_match_present : Bool)
Source
is_first_name_or_last_name_match_present?
Source
is_nickname_match

nickname matched, example Jennifer and Jenn.

Source
is_nickname_match=(new_value : Bool | Nil)

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

Source
is_nickname_match_present=(is_nickname_match_present : Bool)
Source
is_nickname_match_present?
Source
list_invalid_properties

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

Source
score

Match score for name. 100 is a perfect score, 99-85 means a strong match, 84-70 is a partial match, any score less than 70 is a mismatch. Typically, the match threshold should be set to a score of 70 or higher. If the name is missing from either the API or financial institution, this is null.

Source
score=(new_value : Int32 | Nil)

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

Source
score_present=(score_present : Bool)
Source
score_present?
Source
valid?

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

Source