Package com.stripe.model.identity

Class VerificationReport

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.identity.VerificationReport

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class VerificationReport
extends ApiResource
implements HasId

A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie.

Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.

Related guide: Accessing verification results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VerificationReport.Document	Result from a document check.
static class	VerificationReport.Email	Result from a email check.
static class	VerificationReport.IdNumber	Result from an id_number check.
static class	VerificationReport.Options	For more details about Options, please refer to the API Reference.
static class	VerificationReport.Phone	Result from a phone check.
static class	VerificationReport.Selfie	Result from a selfie check.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
VerificationReport()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getClientReferenceId()	A string to reference this user.
Long	getCreated()	Time at which the object was created.
VerificationReport.Document	getDocument()	Result from a document check.
VerificationReport.Email	getEmail()	Result from a email check.
String	getId()	Unique identifier for the object.
VerificationReport.IdNumber	getIdNumber()	Result from an id_number check.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getObject()	String representing the object's type.
VerificationReport.Options	getOptions()
VerificationReport.Phone	getPhone()	Result from a phone check.
VerificationReport.Selfie	getSelfie()	Result from a selfie check.
String	getType()	Type of report.
String	getVerificationFlow()	The configuration token of a verification flow from the dashboard.
String	getVerificationSession()	ID of the VerificationSession that created this report.
int	hashCode()
static VerificationReportCollection	list(VerificationReportListParams params)	List all verification reports.
static VerificationReportCollection	list(VerificationReportListParams params, RequestOptions options)	List all verification reports.
static VerificationReportCollection	list(Map<String,Object> params)	List all verification reports.
static VerificationReportCollection	list(Map<String,Object> params, RequestOptions options)	List all verification reports.
static VerificationReport	retrieve(String report)	Retrieves an existing VerificationReport.
static VerificationReport	retrieve(String report, RequestOptions options)	Retrieves an existing VerificationReport.
static VerificationReport	retrieve(String report, VerificationReportRetrieveParams params, RequestOptions options)	Retrieves an existing VerificationReport.
static VerificationReport	retrieve(String report, Map<String,Object> params, RequestOptions options)	Retrieves an existing VerificationReport.
void	setClientReferenceId(String clientReferenceId)	A string to reference this user.
void	setCreated(Long created)	Time at which the object was created.
void	setDocument(VerificationReport.Document document)	Result from a document check.
void	setEmail(VerificationReport.Email email)	Result from a email check.
void	setId(String id)	Unique identifier for the object.
void	setIdNumber(VerificationReport.IdNumber idNumber)	Result from an id_number check.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setObject(String object)	String representing the object's type.
void	setOptions(VerificationReport.Options options)
void	setPhone(VerificationReport.Phone phone)	Result from a phone check.
void	setResponseGetter(StripeResponseGetter responseGetter)	A human-readable message giving the reason for the failure.
void	setSelfie(VerificationReport.Selfie selfie)	Result from a selfie check.
void	setType(String type)	Type of report.
void	setVerificationFlow(String verificationFlow)	The configuration token of a verification flow from the dashboard.
void	setVerificationSession(String verificationSession)	ID of the VerificationSession that created this report.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

VerificationReport

public VerificationReport()

Method Details

list

public static VerificationReportCollection list(Map<String,Object> params)
                                         throws StripeException

List all verification reports.

Throws:

StripeException

list

public static VerificationReportCollection list(Map<String,Object> params,
 RequestOptions options)
                                         throws StripeException

List all verification reports.

Throws:

StripeException

list

public static VerificationReportCollection list(VerificationReportListParams params)
                                         throws StripeException

List all verification reports.

Throws:

StripeException

list

public static VerificationReportCollection list(VerificationReportListParams params,
 RequestOptions options)
                                         throws StripeException

List all verification reports.

Throws:

StripeException

retrieve

public static VerificationReport retrieve(String report)
                                   throws StripeException

Retrieves an existing VerificationReport.

Throws:

StripeException

retrieve

public static VerificationReport retrieve(String report,
 RequestOptions options)
                                   throws StripeException

Retrieves an existing VerificationReport.

Throws:

StripeException

retrieve

public static VerificationReport retrieve(String report,
 Map<String,Object> params,
 RequestOptions options)
                                   throws StripeException

Retrieves an existing VerificationReport.

Throws:

StripeException

retrieve

public static VerificationReport retrieve(String report,
 VerificationReportRetrieveParams params,
 RequestOptions options)
                                   throws StripeException

Retrieves an existing VerificationReport.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

A human-readable message giving the reason for the failure. These messages can be shown to your users.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getClientReferenceId

public String getClientReferenceId()

A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getDocument

public VerificationReport.Document getDocument()

Result from a document check.

getEmail

public VerificationReport.Email getEmail()

Result from a email check.

getIdNumber

public VerificationReport.IdNumber getIdNumber()

Result from an id_number check.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to identity.verification_report.

getOptions

public VerificationReport.Options getOptions()

getPhone

public VerificationReport.Phone getPhone()

Result from a phone check.

getSelfie

public VerificationReport.Selfie getSelfie()

Result from a selfie check.

getType

public String getType()

Type of report.

One of document, id_number, or verification_flow.

getVerificationFlow

public String getVerificationFlow()

The configuration token of a verification flow from the dashboard.

getVerificationSession

public String getVerificationSession()

ID of the VerificationSession that created this report.

setClientReferenceId

public void setClientReferenceId(String clientReferenceId)

A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setDocument

public void setDocument(VerificationReport.Document document)

Result from a document check.

setEmail

public void setEmail(VerificationReport.Email email)

Result from a email check.

setId

public void setId(String id)

Unique identifier for the object.

setIdNumber

public void setIdNumber(VerificationReport.IdNumber idNumber)

Result from an id_number check.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to identity.verification_report.

setOptions

public void setOptions(VerificationReport.Options options)

setPhone

public void setPhone(VerificationReport.Phone phone)

Result from a phone check.

setSelfie

public void setSelfie(VerificationReport.Selfie selfie)

Result from a selfie check.

setType

public void setType(String type)

Type of report.

One of document, id_number, or verification_flow.

setVerificationFlow

public void setVerificationFlow(String verificationFlow)

The configuration token of a verification flow from the dashboard.

setVerificationSession

public void setVerificationSession(String verificationSession)

ID of the VerificationSession that created this report.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId