Package veryfi.enums

Enum Class Endpoint

java.lang.Object

java.lang.Enum<Endpoint>

veryfi.enums.Endpoint

All Implemented Interfaces:

Serializable, Comparable<Endpoint>, Constable

public enum Endpoint
extends Enum<Endpoint>

Enumeration of Veryfi API endpoints.

This enum defines all the available API endpoints for different document types and operations in the Veryfi API. Each endpoint represents a specific resource or operation that can be performed.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
anyDocuments	Endpoint for any document type processing.
bankStatements	Endpoint for bank statement processing.
businessCards	Endpoint for business card processing.
checks	Endpoint for check processing.
classify	Endpoint for document classification.
contracts	Endpoint for contract processing.
documents	Endpoint for general documents (receipts, invoices, etc.).
split	Endpoint for document splitting operations.
w2s	Endpoint for W2 form processing.
w8BenE	Endpoint for W-8BEN-E form processing.
w9s	Endpoint for W9 form processing.

Field Summary

Fields

Modifier and Type	Field	Description
final String	path	The API path for this endpoint.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

documents

public static final Endpoint documents

Endpoint for general documents (receipts, invoices, etc.). Path: /partner/documents/

anyDocuments

public static final Endpoint anyDocuments

Endpoint for any document type processing. Path: /partner/any-documents/

bankStatements

public static final Endpoint bankStatements

Endpoint for bank statement processing. Path: /partner/bank-statements/

businessCards

public static final Endpoint businessCards

Endpoint for business card processing. Path: /partner/business-cards/

checks

public static final Endpoint checks

Endpoint for check processing. Path: /partner/checks/

w2s

public static final Endpoint w2s

Endpoint for W2 form processing. Path: /partner/w2s/

w9s

public static final Endpoint w9s

Endpoint for W9 form processing. Path: /partner/w9s/

w8BenE

public static final Endpoint w8BenE

Endpoint for W-8BEN-E form processing. Path: /partner/w-8ben-e/

contracts

public static final Endpoint contracts

Endpoint for contract processing. Path: /partner/contracts/

classify

public static final Endpoint classify

Endpoint for document classification. Path: /partner/classify/

split

public static final Endpoint split

Endpoint for document splitting operations. Path: /partner/documents-set/

Field Details

path

public final String path

The API path for this endpoint.

Method Details

values

public static Endpoint[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Endpoint valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null