com.plaid.client.model

Class DocumentMetadata

java.lang.Object

com.plaid.client.model.DocumentMetadata

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class DocumentMetadata
extends Object

An object representing metadata from the end user's uploaded document.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_DOC_ID
static String	SERIALIZED_NAME_DOC_TYPE
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_STATUS

Constructor Summary

Constructors

Constructor and Description
DocumentMetadata()

Method Summary

Modifier and Type	Method and Description
DocumentMetadata	docId(String docId)
DocumentMetadata	docType(DocType docType)
boolean	equals(Object o)
String	getDocId() An identifier of the document that is also present in the paystub response.
DocType	getDocType() Get docType
String	getName() The name of the document.
String	getStatus() The processing status of the document.
int	hashCode()
DocumentMetadata	name(String name)
void	setDocId(String docId)
void	setDocType(DocType docType)
void	setName(String name)
void	setStatus(String status)
DocumentMetadata	status(String status)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_DOC_ID

public static final String SERIALIZED_NAME_DOC_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DOC_TYPE

public static final String SERIALIZED_NAME_DOC_TYPE

See Also:

Constant Field Values

Constructor Detail

DocumentMetadata

public DocumentMetadata()

Method Detail

name

public DocumentMetadata name(String name)

getName

@Nullable
public String getName()

The name of the document.

Returns:

name

setName

public void setName(String name)

status

public DocumentMetadata status(String status)

getStatus

@Nullable
public String getStatus()

The processing status of the document. `PROCESSING_COMPLETE`: The document was successfully processed. `DOCUMENT_ERROR`: The document could not be processed. Possible causes include: The document was an unacceptable document type such as an offer letter or bank statement, the document image was cropped or blurry, or the document was corrupted. `UNKNOWN` or `null`: An internal error occurred. If this happens repeatedly, contact support or your Plaid account manager.

Returns:

status

setStatus

public void setStatus(String status)

docId

public DocumentMetadata docId(String docId)

getDocId

@Nullable
public String getDocId()

An identifier of the document that is also present in the paystub response.

Returns:

docId

setDocId

public void setDocId(String docId)

docType

public DocumentMetadata docType(DocType docType)

getDocType

@Nullable
public DocType getDocType()

Get docType

Returns:

docType

setDocType

public void setDocType(DocType docType)

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