Class VerificationSession
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.identity.VerificationSession
-
- All Implemented Interfaces:
HasId
,MetadataStore<VerificationSession>
,StripeObjectInterface
public class VerificationSession extends ApiResource implements HasId, MetadataStore<VerificationSession>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VerificationSession.LastError
static class
VerificationSession.Options
static class
VerificationSession.Redaction
static class
VerificationSession.VerifiedOutputs
-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description VerificationSession()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description VerificationSession
cancel()
A VerificationSession object can be canceled when it is inrequires_input
status.VerificationSession
cancel(RequestOptions options)
A VerificationSession object can be canceled when it is inrequires_input
status.VerificationSession
cancel(VerificationSessionCancelParams params)
A VerificationSession object can be canceled when it is inrequires_input
status.VerificationSession
cancel(VerificationSessionCancelParams params, RequestOptions options)
A VerificationSession object can be canceled when it is inrequires_input
status.VerificationSession
cancel(java.util.Map<java.lang.String,java.lang.Object> params)
A VerificationSession object can be canceled when it is inrequires_input
status.VerificationSession
cancel(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
A VerificationSession object can be canceled when it is inrequires_input
status.protected boolean
canEqual(java.lang.Object other)
static VerificationSession
create(VerificationSessionCreateParams params)
Creates a VerificationSession object.static VerificationSession
create(VerificationSessionCreateParams params, RequestOptions options)
Creates a VerificationSession object.static VerificationSession
create(java.util.Map<java.lang.String,java.lang.Object> params)
Creates a VerificationSession object.static VerificationSession
create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Creates a VerificationSession object.boolean
equals(java.lang.Object o)
java.lang.String
getClientSecret()
The short-lived client secret used by Stripe.js to show a verification modal inside your app.java.lang.Long
getCreated()
Time at which the object was created.java.lang.String
getId()
Unique identifier for the object.VerificationSession.LastError
getLastError()
If present, this property tells you the last error encountered when processing the verification.java.lang.String
getLastVerificationReport()
Get ID of expandablelastVerificationReport
object.VerificationReport
getLastVerificationReportObject()
Get expandedlastVerificationReport
.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getObject()
String representing the object's type.VerificationSession.Options
getOptions()
VerificationSession.Redaction
getRedaction()
Redaction status of this VerificationSession.java.lang.String
getStatus()
Status of this VerificationSession.java.lang.String
getType()
The type of verification check to be performed.java.lang.String
getUrl()
The short-lived URL that you use to redirect a user to Stripe to submit their identity information.VerificationSession.VerifiedOutputs
getVerifiedOutputs()
The user’s verified data.int
hashCode()
static VerificationSessionCollection
list(VerificationSessionListParams params)
Returns a list of VerificationSessions.static VerificationSessionCollection
list(VerificationSessionListParams params, RequestOptions options)
Returns a list of VerificationSessions.static VerificationSessionCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of VerificationSessions.static VerificationSessionCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list of VerificationSessions.VerificationSession
redact()
Redact a VerificationSession to remove all collected information from Stripe.VerificationSession
redact(RequestOptions options)
Redact a VerificationSession to remove all collected information from Stripe.VerificationSession
redact(VerificationSessionRedactParams params)
Redact a VerificationSession to remove all collected information from Stripe.VerificationSession
redact(VerificationSessionRedactParams params, RequestOptions options)
Redact a VerificationSession to remove all collected information from Stripe.VerificationSession
redact(java.util.Map<java.lang.String,java.lang.Object> params)
Redact a VerificationSession to remove all collected information from Stripe.VerificationSession
redact(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Redact a VerificationSession to remove all collected information from Stripe.static VerificationSession
retrieve(java.lang.String session)
Retrieves the details of a VerificationSession that was previously created.static VerificationSession
retrieve(java.lang.String session, RequestOptions options)
Retrieves the details of a VerificationSession that was previously created.static VerificationSession
retrieve(java.lang.String session, VerificationSessionRetrieveParams params, RequestOptions options)
Retrieves the details of a VerificationSession that was previously created.static VerificationSession
retrieve(java.lang.String session, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the details of a VerificationSession that was previously created.void
setClientSecret(java.lang.String clientSecret)
The short-lived client secret used by Stripe.js to show a verification modal inside your app.void
setCreated(java.lang.Long created)
Time at which the object was created.void
setId(java.lang.String id)
Unique identifier for the object.void
setLastError(VerificationSession.LastError lastError)
If present, this property tells you the last error encountered when processing the verification.void
setLastVerificationReport(java.lang.String id)
void
setLastVerificationReportObject(VerificationReport expandableObject)
void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.void
setObject(java.lang.String object)
String representing the object's type.void
setOptions(VerificationSession.Options options)
void
setRedaction(VerificationSession.Redaction redaction)
Redaction status of this VerificationSession.void
setStatus(java.lang.String status)
Status of this VerificationSession.void
setType(java.lang.String type)
The type of verification check to be performed.void
setUrl(java.lang.String url)
The short-lived URL that you use to redirect a user to Stripe to submit their identity information.void
setVerifiedOutputs(VerificationSession.VerifiedOutputs verifiedOutputs)
The user’s verified data.VerificationSession
update(VerificationSessionUpdateParams params)
Updates a VerificationSession object.VerificationSession
update(VerificationSessionUpdateParams params, RequestOptions options)
Updates a VerificationSession object.VerificationSession
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates a VerificationSession object.VerificationSession
update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Updates a VerificationSession object.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
-
-
-
Method Detail
-
getLastVerificationReport
public java.lang.String getLastVerificationReport()
Get ID of expandablelastVerificationReport
object.
-
setLastVerificationReport
public void setLastVerificationReport(java.lang.String id)
-
getLastVerificationReportObject
public VerificationReport getLastVerificationReportObject()
Get expandedlastVerificationReport
.
-
setLastVerificationReportObject
public void setLastVerificationReportObject(VerificationReport expandableObject)
-
create
public static VerificationSession create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Creates a VerificationSession object.After the VerificationSession is created, display a verification modal using the session
client_secret
or send your users to the session’surl
.If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.
Related guide: Verify your users’ identity documents.
- Throws:
StripeException
-
create
public static VerificationSession create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Creates a VerificationSession object.After the VerificationSession is created, display a verification modal using the session
client_secret
or send your users to the session’surl
.If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.
Related guide: Verify your users’ identity documents.
- Throws:
StripeException
-
create
public static VerificationSession create(VerificationSessionCreateParams params) throws StripeException
Creates a VerificationSession object.After the VerificationSession is created, display a verification modal using the session
client_secret
or send your users to the session’surl
.If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.
Related guide: Verify your users’ identity documents.
- Throws:
StripeException
-
create
public static VerificationSession create(VerificationSessionCreateParams params, RequestOptions options) throws StripeException
Creates a VerificationSession object.After the VerificationSession is created, display a verification modal using the session
client_secret
or send your users to the session’surl
.If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.
Related guide: Verify your users’ identity documents.
- Throws:
StripeException
-
retrieve
public static VerificationSession retrieve(java.lang.String session) throws StripeException
Retrieves the details of a VerificationSession that was previously created.When the session status is
requires_input
, you can use this method to retrieve a validclient_secret
orurl
to allow re-submission.- Throws:
StripeException
-
retrieve
public static VerificationSession retrieve(java.lang.String session, RequestOptions options) throws StripeException
Retrieves the details of a VerificationSession that was previously created.When the session status is
requires_input
, you can use this method to retrieve a validclient_secret
orurl
to allow re-submission.- Throws:
StripeException
-
retrieve
public static VerificationSession retrieve(java.lang.String session, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves the details of a VerificationSession that was previously created.When the session status is
requires_input
, you can use this method to retrieve a validclient_secret
orurl
to allow re-submission.- Throws:
StripeException
-
retrieve
public static VerificationSession retrieve(java.lang.String session, VerificationSessionRetrieveParams params, RequestOptions options) throws StripeException
Retrieves the details of a VerificationSession that was previously created.When the session status is
requires_input
, you can use this method to retrieve a validclient_secret
orurl
to allow re-submission.- Throws:
StripeException
-
list
public static VerificationSessionCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of VerificationSessions.- Throws:
StripeException
-
list
public static VerificationSessionCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of VerificationSessions.- Throws:
StripeException
-
list
public static VerificationSessionCollection list(VerificationSessionListParams params) throws StripeException
Returns a list of VerificationSessions.- Throws:
StripeException
-
list
public static VerificationSessionCollection list(VerificationSessionListParams params, RequestOptions options) throws StripeException
Returns a list of VerificationSessions.- Throws:
StripeException
-
cancel
public VerificationSession cancel() throws StripeException
A VerificationSession object can be canceled when it is inrequires_input
status.Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
- Throws:
StripeException
-
cancel
public VerificationSession cancel(RequestOptions options) throws StripeException
A VerificationSession object can be canceled when it is inrequires_input
status.Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
- Throws:
StripeException
-
cancel
public VerificationSession cancel(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
A VerificationSession object can be canceled when it is inrequires_input
status.Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
- Throws:
StripeException
-
cancel
public VerificationSession cancel(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
A VerificationSession object can be canceled when it is inrequires_input
status.Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
- Throws:
StripeException
-
cancel
public VerificationSession cancel(VerificationSessionCancelParams params) throws StripeException
A VerificationSession object can be canceled when it is inrequires_input
status.Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
- Throws:
StripeException
-
cancel
public VerificationSession cancel(VerificationSessionCancelParams params, RequestOptions options) throws StripeException
A VerificationSession object can be canceled when it is inrequires_input
status.Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
- Throws:
StripeException
-
redact
public VerificationSession redact() throws StripeException
Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.A VerificationSession object can be redacted when it is in
requires_input
orverified
status. Redacting a VerificationSession inrequires_action
state will automatically cancel it.The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s
redaction.status
field will be set toprocessing
; when the process is finished, it will change toredacted
and anidentity.verification_session.redacted
event will be emitted.Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string
[redacted]
or a similar placeholder. Themetadata
field will also be erased. Redacted objects cannot be updated or used for any purpose.- Throws:
StripeException
-
redact
public VerificationSession redact(RequestOptions options) throws StripeException
Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.A VerificationSession object can be redacted when it is in
requires_input
orverified
status. Redacting a VerificationSession inrequires_action
state will automatically cancel it.The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s
redaction.status
field will be set toprocessing
; when the process is finished, it will change toredacted
and anidentity.verification_session.redacted
event will be emitted.Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string
[redacted]
or a similar placeholder. Themetadata
field will also be erased. Redacted objects cannot be updated or used for any purpose.- Throws:
StripeException
-
redact
public VerificationSession redact(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.A VerificationSession object can be redacted when it is in
requires_input
orverified
status. Redacting a VerificationSession inrequires_action
state will automatically cancel it.The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s
redaction.status
field will be set toprocessing
; when the process is finished, it will change toredacted
and anidentity.verification_session.redacted
event will be emitted.Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string
[redacted]
or a similar placeholder. Themetadata
field will also be erased. Redacted objects cannot be updated or used for any purpose.- Throws:
StripeException
-
redact
public VerificationSession redact(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.A VerificationSession object can be redacted when it is in
requires_input
orverified
status. Redacting a VerificationSession inrequires_action
state will automatically cancel it.The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s
redaction.status
field will be set toprocessing
; when the process is finished, it will change toredacted
and anidentity.verification_session.redacted
event will be emitted.Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string
[redacted]
or a similar placeholder. Themetadata
field will also be erased. Redacted objects cannot be updated or used for any purpose.- Throws:
StripeException
-
redact
public VerificationSession redact(VerificationSessionRedactParams params) throws StripeException
Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.A VerificationSession object can be redacted when it is in
requires_input
orverified
status. Redacting a VerificationSession inrequires_action
state will automatically cancel it.The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s
redaction.status
field will be set toprocessing
; when the process is finished, it will change toredacted
and anidentity.verification_session.redacted
event will be emitted.Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string
[redacted]
or a similar placeholder. Themetadata
field will also be erased. Redacted objects cannot be updated or used for any purpose.- Throws:
StripeException
-
redact
public VerificationSession redact(VerificationSessionRedactParams params, RequestOptions options) throws StripeException
Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.A VerificationSession object can be redacted when it is in
requires_input
orverified
status. Redacting a VerificationSession inrequires_action
state will automatically cancel it.The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s
redaction.status
field will be set toprocessing
; when the process is finished, it will change toredacted
and anidentity.verification_session.redacted
event will be emitted.Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string
[redacted]
or a similar placeholder. Themetadata
field will also be erased. Redacted objects cannot be updated or used for any purpose.- Throws:
StripeException
-
update
public VerificationSession update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates a VerificationSession object.When the session status is
requires_input
, you can use this method to update the verification check and options.- Specified by:
update
in interfaceMetadataStore<VerificationSession>
- Throws:
StripeException
-
update
public VerificationSession update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates a VerificationSession object.When the session status is
requires_input
, you can use this method to update the verification check and options.- Specified by:
update
in interfaceMetadataStore<VerificationSession>
- Throws:
StripeException
-
update
public VerificationSession update(VerificationSessionUpdateParams params) throws StripeException
Updates a VerificationSession object.When the session status is
requires_input
, you can use this method to update the verification check and options.- Throws:
StripeException
-
update
public VerificationSession update(VerificationSessionUpdateParams params, RequestOptions options) throws StripeException
Updates a VerificationSession object.When the session status is
requires_input
, you can use this method to update the verification check and options.- Throws:
StripeException
-
getClientSecret
public java.lang.String getClientSecret()
The short-lived client secret used by Stripe.js to show a verification modal inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on passing the client secret to the frontend to learn more.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getLastError
public VerificationSession.LastError getLastError()
If present, this property tells you the last error encountered when processing the verification.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
identity.verification_session
.
-
getOptions
public VerificationSession.Options getOptions()
-
getRedaction
public VerificationSession.Redaction getRedaction()
Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
-
getStatus
public java.lang.String getStatus()
Status of this VerificationSession. Learn more about the lifecycle of sessions.One of
canceled
,processing
,requires_input
, orverified
.
-
getType
public java.lang.String getType()
The type of verification check to be performed.One of
document
, orid_number
.
-
getUrl
public java.lang.String getUrl()
The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on verifying identity documents to learn how to redirect users to Stripe.
-
getVerifiedOutputs
public VerificationSession.VerifiedOutputs getVerifiedOutputs()
The user’s verified data.
-
setClientSecret
public void setClientSecret(java.lang.String clientSecret)
The short-lived client secret used by Stripe.js to show a verification modal inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on passing the client secret to the frontend to learn more.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setLastError
public void setLastError(VerificationSession.LastError lastError)
If present, this property tells you the last error encountered when processing the verification.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-
setObject
public void setObject(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
identity.verification_session
.
-
setOptions
public void setOptions(VerificationSession.Options options)
-
setRedaction
public void setRedaction(VerificationSession.Redaction redaction)
Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
-
setStatus
public void setStatus(java.lang.String status)
Status of this VerificationSession. Learn more about the lifecycle of sessions.One of
canceled
,processing
,requires_input
, orverified
.
-
setType
public void setType(java.lang.String type)
The type of verification check to be performed.One of
document
, orid_number
.
-
setUrl
public void setUrl(java.lang.String url)
The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on verifying identity documents to learn how to redirect users to Stripe.
-
setVerifiedOutputs
public void setVerifiedOutputs(VerificationSession.VerifiedOutputs verifiedOutputs)
The user’s verified data.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.- Specified by:
getMetadata
in interfaceMetadataStore<VerificationSession>
-
-