com.plaid.client.model

Enum ConsumerReportPermissiblePurpose

java.lang.Object

java.lang.Enum<ConsumerReportPermissiblePurpose>

com.plaid.client.model.ConsumerReportPermissiblePurpose

All Implemented Interfaces:

Serializable, Comparable<ConsumerReportPermissiblePurpose>

public enum ConsumerReportPermissiblePurpose
extends Enum<ConsumerReportPermissiblePurpose>

Describes the reason you are generating a Consumer Report for this user. `ACCOUNT_REVIEW_CREDIT`: In connection with a consumer credit transaction for the review or collection of an account pursuant to FCRA Section 604(a)(3)(A). `ACCOUNT_REVIEW_NON_CREDIT`: For a legitimate business need of the information to review a non-credit account provided primarily for personal, family, or household purposes to determine whether the consumer continues to meet the terms of the account pursuant to FCRA Section 604(a)(3)(F)(2). `EMPLOYMENT`: For employment purposes pursuant to FCRA 604(a)(3)(B), including hiring, retention and promotion purposes. `EXTENSION_OF_CREDIT`: In connection with a credit transaction initiated by and involving the consumer pursuant to FCRA Section 604(a)(3)(A). `LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING`: For a legitimate business need in connection with a business transaction initiated by the consumer primarily for personal, family, or household purposes in connection with a property rental assessment pursuant to FCRA Section 604(a)(3)(F)(i). `LEGITIMATE_BUSINESS_NEED_OTHER`: For a legitimate business need in connection with a business transaction made primarily for personal, family, or household initiated by the consumer pursuant to FCRA Section 604(a)(3)(F)(i). `WRITTEN_INSTRUCTION_PREQUALIFICATION`: In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), to evaluate an application’s profile to make an offer to the consumer. `WRITTEN_INSTRUCTION_OTHER`: In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), such as when an individual agrees to act as a guarantor or assumes personal liability for a consumer, business, or commercial loan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConsumerReportPermissiblePurpose.Adapter

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCOUNT_REVIEW_CREDIT
ACCOUNT_REVIEW_NON_CREDIT
EMPLOYMENT
ENUM_UNKNOWN
EXTENSION_OF_CREDIT
LEGITIMATE_BUSINESS_NEED_OTHER
LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING
WRITTEN_INSTRUCTION_OTHER
WRITTEN_INSTRUCTION_PREQUALIFICATION

Method Summary

Modifier and Type	Method and Description
static ConsumerReportPermissiblePurpose	fromValue(String value)
String	getValue()
String	toString()
static ConsumerReportPermissiblePurpose	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConsumerReportPermissiblePurpose[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACCOUNT_REVIEW_CREDIT

public static final ConsumerReportPermissiblePurpose ACCOUNT_REVIEW_CREDIT

ACCOUNT_REVIEW_NON_CREDIT

public static final ConsumerReportPermissiblePurpose ACCOUNT_REVIEW_NON_CREDIT

EMPLOYMENT

public static final ConsumerReportPermissiblePurpose EMPLOYMENT

EXTENSION_OF_CREDIT

public static final ConsumerReportPermissiblePurpose EXTENSION_OF_CREDIT

LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING

public static final ConsumerReportPermissiblePurpose LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING

LEGITIMATE_BUSINESS_NEED_OTHER

public static final ConsumerReportPermissiblePurpose LEGITIMATE_BUSINESS_NEED_OTHER

WRITTEN_INSTRUCTION_PREQUALIFICATION

public static final ConsumerReportPermissiblePurpose WRITTEN_INSTRUCTION_PREQUALIFICATION

WRITTEN_INSTRUCTION_OTHER

public static final ConsumerReportPermissiblePurpose WRITTEN_INSTRUCTION_OTHER

ENUM_UNKNOWN

public static final ConsumerReportPermissiblePurpose ENUM_UNKNOWN

Method Detail

values

public static ConsumerReportPermissiblePurpose[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConsumerReportPermissiblePurpose c : ConsumerReportPermissiblePurpose.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConsumerReportPermissiblePurpose valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<ConsumerReportPermissiblePurpose>

fromValue

public static ConsumerReportPermissiblePurpose fromValue(String value)