com.plaid.client.model

Enum DocumentAuthenticityMatchCode

java.lang.Object

java.lang.Enum<DocumentAuthenticityMatchCode>

com.plaid.client.model.DocumentAuthenticityMatchCode

All Implemented Interfaces:

Serializable, Comparable<DocumentAuthenticityMatchCode>

public enum DocumentAuthenticityMatchCode
extends Enum<DocumentAuthenticityMatchCode>

High level summary of whether the document in the provided image matches the formatting rules and security checks for the associated jurisdiction. For example, most identity documents have formatting rules like the following: The image of the person's face must have a certain contrast in order to highlight skin tone The subject in the document's image must remove eye glasses and pose in a certain way The informational fields (name, date of birth, ID number, etc.) must be colored and aligned according to specific rules Security features like watermarks and background patterns must be present So a `match` status for this field indicates that the document in the provided image seems to conform to the various formatting and security rules associated with the detected document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentAuthenticityMatchCode.Adapter

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENUM_UNKNOWN
MATCH
NO_DATA
NO_MATCH
PARTIAL_MATCH

Method Summary

Modifier and Type	Method and Description
static DocumentAuthenticityMatchCode	fromValue(String value)
String	getValue()
String	toString()
static DocumentAuthenticityMatchCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentAuthenticityMatchCode[]	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

MATCH

public static final DocumentAuthenticityMatchCode MATCH

PARTIAL_MATCH

public static final DocumentAuthenticityMatchCode PARTIAL_MATCH

NO_MATCH

public static final DocumentAuthenticityMatchCode NO_MATCH

NO_DATA

public static final DocumentAuthenticityMatchCode NO_DATA

ENUM_UNKNOWN

public static final DocumentAuthenticityMatchCode ENUM_UNKNOWN

Method Detail

values

public static DocumentAuthenticityMatchCode[] 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 (DocumentAuthenticityMatchCode c : DocumentAuthenticityMatchCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocumentAuthenticityMatchCode 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<DocumentAuthenticityMatchCode>

fromValue

public static DocumentAuthenticityMatchCode fromValue(String value)