com.plaid.client.model

Class AddressMatchScore

java.lang.Object

com.plaid.client.model.AddressMatchScore

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class AddressMatchScore
extends Object

Score found by matching address provided by the API with the address on the account at the financial institution. The score can range from 0 to 100 where 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_IS_POSTAL_CODE_MATCH
static String	SERIALIZED_NAME_SCORE

Constructor Summary

Constructors

Constructor and Description
AddressMatchScore()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getIsPostalCodeMatch() postal code was provided for both and was a match
Integer	getScore() Match score for address.
int	hashCode()
AddressMatchScore	isPostalCodeMatch(Boolean isPostalCodeMatch)
AddressMatchScore	score(Integer score)
void	setIsPostalCodeMatch(Boolean isPostalCodeMatch)
void	setScore(Integer score)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_SCORE

public static final String SERIALIZED_NAME_SCORE

See Also:

Constant Field Values

SERIALIZED_NAME_IS_POSTAL_CODE_MATCH

public static final String SERIALIZED_NAME_IS_POSTAL_CODE_MATCH

See Also:

Constant Field Values

Constructor Detail

AddressMatchScore

public AddressMatchScore()

Method Detail

score

public AddressMatchScore score(Integer score)

getScore

@Nullable
public Integer getScore()

Match score for address. 100 is a perfect match, 99-90 is a strong match, 89-70 is a partial match, anything below 70 is considered a weak match. Typically, the match threshold should be set to a score of 70 or higher. If the address is missing from either the API or financial institution, this is null.

Returns:

score

setScore

public void setScore(Integer score)

isPostalCodeMatch

public AddressMatchScore isPostalCodeMatch(Boolean isPostalCodeMatch)

getIsPostalCodeMatch

@Nullable
public Boolean getIsPostalCodeMatch()

postal code was provided for both and was a match

Returns:

isPostalCodeMatch

setIsPostalCodeMatch

public void setIsPostalCodeMatch(Boolean isPostalCodeMatch)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object