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.
Name | Type | Description | Notes |
---|---|---|---|
score | int, none_type | Match score for name. 100 is a perfect score, 85-99 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. | [optional] |
is_first_name_or_last_name_match | bool, none_type | first or last name completely matched, likely a family member | [optional] |
is_nickname_match | bool, none_type | nickname matched, example Jennifer and Jenn. | [optional] |
is_business_name_detected | bool, none_type | 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. | [optional] |
any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |