com.plaid.client.model

Class IdentityDocumentUploadRiskSignal

java.lang.Object

com.plaid.client.model.IdentityDocumentUploadRiskSignal

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

Risk signals tied to the document

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_HAS_FRAUD_RISK
static String	SERIALIZED_NAME_PAGE_NUMBER
static String	SERIALIZED_NAME_SIGNAL_DESCRIPTION
static String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor and Description
IdentityDocumentUploadRiskSignal()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getHasFraudRisk() Indicates whether fraud risk was detected on the field.
Integer	getPageNumber() The relevant page associated with the risk signal.
String	getSignalDescription() A human-readable explanation providing more detail about the specific risk signal.
String	getType() The type of risk found.
IdentityDocumentUploadRiskSignal	hasFraudRisk(Boolean hasFraudRisk)
int	hashCode()
IdentityDocumentUploadRiskSignal	pageNumber(Integer pageNumber)
void	setHasFraudRisk(Boolean hasFraudRisk)
void	setPageNumber(Integer pageNumber)
void	setSignalDescription(String signalDescription)
void	setType(String type)
IdentityDocumentUploadRiskSignal	signalDescription(String signalDescription)
String	toString()
IdentityDocumentUploadRiskSignal	type(String type)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_HAS_FRAUD_RISK

public static final String SERIALIZED_NAME_HAS_FRAUD_RISK

See Also:

Constant Field Values

SERIALIZED_NAME_SIGNAL_DESCRIPTION

public static final String SERIALIZED_NAME_SIGNAL_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_PAGE_NUMBER

public static final String SERIALIZED_NAME_PAGE_NUMBER

See Also:

Constant Field Values

Constructor Detail

IdentityDocumentUploadRiskSignal

public IdentityDocumentUploadRiskSignal()

Method Detail

type

public IdentityDocumentUploadRiskSignal type(String type)

getType

@Nullable
public String getType()

The type of risk found.

Returns:

type

setType

public void setType(String type)

hasFraudRisk

public IdentityDocumentUploadRiskSignal hasFraudRisk(Boolean hasFraudRisk)

getHasFraudRisk

@Nullable
public Boolean getHasFraudRisk()

Indicates whether fraud risk was detected on the field.

Returns:

hasFraudRisk

setHasFraudRisk

public void setHasFraudRisk(Boolean hasFraudRisk)

signalDescription

public IdentityDocumentUploadRiskSignal signalDescription(String signalDescription)

getSignalDescription

@Nullable
public String getSignalDescription()

A human-readable explanation providing more detail about the specific risk signal.

Returns:

signalDescription

setSignalDescription

public void setSignalDescription(String signalDescription)

pageNumber

public IdentityDocumentUploadRiskSignal pageNumber(Integer pageNumber)

getPageNumber

@Nullable
public Integer getPageNumber()

The relevant page associated with the risk signal. If the risk signal is not associated with a specific page, the value will be 0.

Returns:

pageNumber

setPageNumber

public void setPageNumber(Integer pageNumber)

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