com.plaid.client.model

Class LinkTokenCreateRequestIncomeVerification

java.lang.Object

com.plaid.client.model.LinkTokenCreateRequestIncomeVerification

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

Specifies options for initializing Link for use with the Income product. This field is required if `income_verification` is included in the `products` array.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCESS_TOKENS
static String	SERIALIZED_NAME_ASSET_REPORT_ID
static String	SERIALIZED_NAME_BANK_INCOME
static String	SERIALIZED_NAME_INCOME_SOURCE_TYPES
static String	SERIALIZED_NAME_INCOME_VERIFICATION_ID
static String	SERIALIZED_NAME_PAYROLL_INCOME
static String	SERIALIZED_NAME_STATED_INCOME_SOURCES

Constructor Summary

Constructors

Constructor and Description
LinkTokenCreateRequestIncomeVerification()

Method Summary

Modifier and Type	Method and Description
LinkTokenCreateRequestIncomeVerification	accessTokens(List<String> accessTokens)
LinkTokenCreateRequestIncomeVerification	addAccessTokensItem(String accessTokensItem)
LinkTokenCreateRequestIncomeVerification	addIncomeSourceTypesItem(IncomeVerificationSourceType incomeSourceTypesItem)
LinkTokenCreateRequestIncomeVerification	addStatedIncomeSourcesItem(LinkTokenCreateRequestUserStatedIncomeSource statedIncomeSourcesItem)
LinkTokenCreateRequestIncomeVerification	assetReportId(String assetReportId)
LinkTokenCreateRequestIncomeVerification	bankIncome(LinkTokenCreateRequestIncomeVerificationBankIncome bankIncome)
boolean	equals(Object o)
List<String>	getAccessTokens() An array of access tokens corresponding to Items that a user has previously connected with.
String	getAssetReportId() The `asset_report_id` of an asset report associated with the user, as provided by `/asset_report/create`.
LinkTokenCreateRequestIncomeVerificationBankIncome	getBankIncome() Get bankIncome
List<IncomeVerificationSourceType>	getIncomeSourceTypes() The types of source income data that users will be permitted to share.
String	getIncomeVerificationId() The `income_verification_id` of the verification instance, as provided by `/income/verification/create`.
LinkTokenCreateRequestIncomeVerificationPayrollIncome	getPayrollIncome() Get payrollIncome
List<LinkTokenCreateRequestUserStatedIncomeSource>	getStatedIncomeSources() A list of user stated income sources
int	hashCode()
LinkTokenCreateRequestIncomeVerification	incomeSourceTypes(List<IncomeVerificationSourceType> incomeSourceTypes)
LinkTokenCreateRequestIncomeVerification	incomeVerificationId(String incomeVerificationId)
LinkTokenCreateRequestIncomeVerification	payrollIncome(LinkTokenCreateRequestIncomeVerificationPayrollIncome payrollIncome)
void	setAccessTokens(List<String> accessTokens)
void	setAssetReportId(String assetReportId)
void	setBankIncome(LinkTokenCreateRequestIncomeVerificationBankIncome bankIncome)
void	setIncomeSourceTypes(List<IncomeVerificationSourceType> incomeSourceTypes)
void	setIncomeVerificationId(String incomeVerificationId)
void	setPayrollIncome(LinkTokenCreateRequestIncomeVerificationPayrollIncome payrollIncome)
void	setStatedIncomeSources(List<LinkTokenCreateRequestUserStatedIncomeSource> statedIncomeSources)
LinkTokenCreateRequestIncomeVerification	statedIncomeSources(List<LinkTokenCreateRequestUserStatedIncomeSource> statedIncomeSources)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_INCOME_VERIFICATION_ID

public static final String SERIALIZED_NAME_INCOME_VERIFICATION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ASSET_REPORT_ID

public static final String SERIALIZED_NAME_ASSET_REPORT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ACCESS_TOKENS

public static final String SERIALIZED_NAME_ACCESS_TOKENS

See Also:

Constant Field Values

SERIALIZED_NAME_INCOME_SOURCE_TYPES

public static final String SERIALIZED_NAME_INCOME_SOURCE_TYPES

See Also:

Constant Field Values

SERIALIZED_NAME_BANK_INCOME

public static final String SERIALIZED_NAME_BANK_INCOME

See Also:

Constant Field Values

SERIALIZED_NAME_PAYROLL_INCOME

public static final String SERIALIZED_NAME_PAYROLL_INCOME

See Also:

Constant Field Values

SERIALIZED_NAME_STATED_INCOME_SOURCES

public static final String SERIALIZED_NAME_STATED_INCOME_SOURCES

See Also:

Constant Field Values

Constructor Detail

LinkTokenCreateRequestIncomeVerification

public LinkTokenCreateRequestIncomeVerification()

Method Detail

incomeVerificationId

public LinkTokenCreateRequestIncomeVerification incomeVerificationId(String incomeVerificationId)

getIncomeVerificationId

@Nullable
public String getIncomeVerificationId()

The `income_verification_id` of the verification instance, as provided by `/income/verification/create`. Replaced by the user token.

Returns:

incomeVerificationId

setIncomeVerificationId

public void setIncomeVerificationId(String incomeVerificationId)

assetReportId

public LinkTokenCreateRequestIncomeVerification assetReportId(String assetReportId)

getAssetReportId

@Nullable
public String getAssetReportId()

The `asset_report_id` of an asset report associated with the user, as provided by `/asset_report/create`. Providing an `asset_report_id` is optional and can be used to verify the user through a streamlined flow. If provided, the bank linking flow will be skipped.

Returns:

assetReportId

setAssetReportId

public void setAssetReportId(String assetReportId)

accessTokens

public LinkTokenCreateRequestIncomeVerification accessTokens(List<String> accessTokens)

addAccessTokensItem

public LinkTokenCreateRequestIncomeVerification addAccessTokensItem(String accessTokensItem)

getAccessTokens

@Nullable
public List<String> getAccessTokens()

An array of access tokens corresponding to Items that a user has previously connected with. Data from these institutions will be cross-referenced with document data received during the Document Income flow to help verify that the uploaded documents are accurate. If the `transactions` product was not initialized for these Items during link, it will be initialized after this Link session. This field should only be used with the `payroll` income source type.

Returns:

accessTokens

setAccessTokens

public void setAccessTokens(List<String> accessTokens)

incomeSourceTypes

public LinkTokenCreateRequestIncomeVerification incomeSourceTypes(List<IncomeVerificationSourceType> incomeSourceTypes)

addIncomeSourceTypesItem

public LinkTokenCreateRequestIncomeVerification addIncomeSourceTypesItem(IncomeVerificationSourceType incomeSourceTypesItem)

getIncomeSourceTypes

@Nullable
public List<IncomeVerificationSourceType> getIncomeSourceTypes()

The types of source income data that users will be permitted to share. Options include `bank` and `payroll`. Currently you can only specify one of these options.

Returns:

incomeSourceTypes

setIncomeSourceTypes

public void setIncomeSourceTypes(List<IncomeVerificationSourceType> incomeSourceTypes)

bankIncome

public LinkTokenCreateRequestIncomeVerification bankIncome(LinkTokenCreateRequestIncomeVerificationBankIncome bankIncome)

getBankIncome

@Nullable
public LinkTokenCreateRequestIncomeVerificationBankIncome getBankIncome()

Get bankIncome

Returns:

bankIncome

setBankIncome

public void setBankIncome(LinkTokenCreateRequestIncomeVerificationBankIncome bankIncome)

payrollIncome

public LinkTokenCreateRequestIncomeVerification payrollIncome(LinkTokenCreateRequestIncomeVerificationPayrollIncome payrollIncome)

getPayrollIncome

@Nullable
public LinkTokenCreateRequestIncomeVerificationPayrollIncome getPayrollIncome()

Get payrollIncome

Returns:

payrollIncome

setPayrollIncome

public void setPayrollIncome(LinkTokenCreateRequestIncomeVerificationPayrollIncome payrollIncome)

statedIncomeSources

public LinkTokenCreateRequestIncomeVerification statedIncomeSources(List<LinkTokenCreateRequestUserStatedIncomeSource> statedIncomeSources)

addStatedIncomeSourcesItem

public LinkTokenCreateRequestIncomeVerification addStatedIncomeSourcesItem(LinkTokenCreateRequestUserStatedIncomeSource statedIncomeSourcesItem)

getStatedIncomeSources

@Nullable
public List<LinkTokenCreateRequestUserStatedIncomeSource> getStatedIncomeSources()

A list of user stated income sources

Returns:

statedIncomeSources

setStatedIncomeSources

public void setStatedIncomeSources(List<LinkTokenCreateRequestUserStatedIncomeSource> statedIncomeSources)

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