Create a VerificationSession
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
Parameters
- client_
reference_ idstring 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.
- metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - optionsobject
A set of options for the session’s verification checks.
- provided_
detailsobject Details provided about the user being verified. These details may be shown to the user.
- return_
urlstring The URL that the user will be redirected to upon completing the verification flow.
- typeenum
The type of verification check to be performed. You must provide a
type
if not passingverification_flow
. - verification_
flowstring The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
Returns
Returns the created VerificationSession object
Update a VerificationSession
Updates a VerificationSession object.
When the session status is requires_input
, you can use this method to update the verification check and options.
Parameters
- metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - optionsobject
A set of options for the session’s verification checks.
- provided_
detailsobject Details provided about the user being verified. These details may be shown to the user.
- typeenum
The type of verification check to be performed.
Returns
Returns the updated VerificationSession object
Retrieve a VerificationSession
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.
Parameters
No parameters.
Returns
Returns a VerificationSession object
List VerificationSessions
Returns a list of VerificationSessions
Parameters
- client_
reference_ idstring 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.
- createdobject
Only return VerificationSessions that were created during the given date interval.
- statusenum
Only return VerificationSessions with this status. Learn more about the lifecycle of sessions.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
List of VerificationSession objects that match the provided filter criteria.
Cancel a VerificationSession
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.
Parameters
No parameters.
Returns
Returns the canceled VerificationSession object