Package com.stripe.service.identity

Class VerificationSessionService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.identity.VerificationSessionService

public final class VerificationSessionService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
VerificationSessionService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
VerificationSession	cancel(String session)	A VerificationSession object can be canceled when it is in requires_input status.
VerificationSession	cancel(String session, RequestOptions options)	A VerificationSession object can be canceled when it is in requires_input status.
VerificationSession	cancel(String session, VerificationSessionCancelParams params)	A VerificationSession object can be canceled when it is in requires_input status.
VerificationSession	cancel(String session, VerificationSessionCancelParams params, RequestOptions options)	A VerificationSession object can be canceled when it is in requires_input status.
VerificationSession	create()	Creates a VerificationSession object.
VerificationSession	create(RequestOptions options)	Creates a VerificationSession object.
VerificationSession	create(VerificationSessionCreateParams params)	Creates a VerificationSession object.
VerificationSession	create(VerificationSessionCreateParams params, RequestOptions options)	Creates a VerificationSession object.
StripeCollection<VerificationSession>	list()	Returns a list of VerificationSessions.
StripeCollection<VerificationSession>	list(RequestOptions options)	Returns a list of VerificationSessions.
StripeCollection<VerificationSession>	list(VerificationSessionListParams params)	Returns a list of VerificationSessions.
StripeCollection<VerificationSession>	list(VerificationSessionListParams params, RequestOptions options)	Returns a list of VerificationSessions.
VerificationSession	redact(String session)	Redact a VerificationSession to remove all collected information from Stripe.
VerificationSession	redact(String session, RequestOptions options)	Redact a VerificationSession to remove all collected information from Stripe.
VerificationSession	redact(String session, VerificationSessionRedactParams params)	Redact a VerificationSession to remove all collected information from Stripe.
VerificationSession	redact(String session, VerificationSessionRedactParams params, RequestOptions options)	Redact a VerificationSession to remove all collected information from Stripe.
VerificationSession	retrieve(String session)	Retrieves the details of a VerificationSession that was previously created.
VerificationSession	retrieve(String session, RequestOptions options)	Retrieves the details of a VerificationSession that was previously created.
VerificationSession	retrieve(String session, VerificationSessionRetrieveParams params)	Retrieves the details of a VerificationSession that was previously created.
VerificationSession	retrieve(String session, VerificationSessionRetrieveParams params, RequestOptions options)	Retrieves the details of a VerificationSession that was previously created.
VerificationSession	update(String session)	Updates a VerificationSession object.
VerificationSession	update(String session, RequestOptions options)	Updates a VerificationSession object.
VerificationSession	update(String session, VerificationSessionUpdateParams params)	Updates a VerificationSession object.
VerificationSession	update(String session, VerificationSessionUpdateParams params, RequestOptions options)	Updates a VerificationSession object.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VerificationSessionService

public VerificationSessionService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<VerificationSession> list(VerificationSessionListParams params)
                                           throws StripeException

Returns a list of VerificationSessions.

Throws:

StripeException

list

public StripeCollection<VerificationSession> list(RequestOptions options)
                                           throws StripeException

Returns a list of VerificationSessions.

Throws:

StripeException

list

public StripeCollection<VerificationSession> list()
                                           throws StripeException

Returns a list of VerificationSessions.

Throws:

StripeException

list

public StripeCollection<VerificationSession> list(VerificationSessionListParams params,
 RequestOptions options)
                                           throws StripeException

Returns a list of VerificationSessions.

Throws:

StripeException

create

public 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’s url.

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 VerificationSession create(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’s url.

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 VerificationSession create()
                           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’s url.

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 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’s url.

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 VerificationSession retrieve(String session,
 VerificationSessionRetrieveParams params)
                             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 valid client_secret or url to allow re-submission.

Throws:

StripeException

retrieve

public VerificationSession retrieve(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 valid client_secret or url to allow re-submission.

Throws:

StripeException

retrieve

public VerificationSession retrieve(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 valid client_secret or url to allow re-submission.

Throws:

StripeException

retrieve

public VerificationSession retrieve(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 valid client_secret or url to allow re-submission.

Throws:

StripeException

update

public VerificationSession update(String session,
 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(String session,
 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

update

public VerificationSession update(String session)
                           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(String session,
 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

cancel

public VerificationSession cancel(String session,
 VerificationSessionCancelParams params)
                           throws StripeException

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

Throws:

StripeException

cancel

public VerificationSession cancel(String session,
 RequestOptions options)
                           throws StripeException

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

Throws:

StripeException

cancel

public VerificationSession cancel(String session)
                           throws StripeException

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

Throws:

StripeException

cancel

public VerificationSession cancel(String session,
 VerificationSessionCancelParams params,
 RequestOptions options)
                           throws StripeException

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

Throws:

StripeException

redact

public VerificationSession redact(String session,
 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 or verified status. Redacting a VerificationSession in requires_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 to processing; when the process is finished, it will change to redacted and an identity.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. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

Throws:

StripeException

redact

public VerificationSession redact(String session,
 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 or verified status. Redacting a VerificationSession in requires_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 to processing; when the process is finished, it will change to redacted and an identity.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. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

Throws:

StripeException

redact

public VerificationSession redact(String session)
                           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 or verified status. Redacting a VerificationSession in requires_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 to processing; when the process is finished, it will change to redacted and an identity.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. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

Throws:

StripeException

redact

public VerificationSession redact(String session,
 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 or verified status. Redacting a VerificationSession in requires_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 to processing; when the process is finished, it will change to redacted and an identity.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. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

Throws:

StripeException