Creates a VerificationSession object.
After the VerificationSession is created, display a verification modal using the session client_ 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.
- metadatamap
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 might be shown to the user.
- related_
customerstring Customer ID
- related_
customer_ accountstring The ID of the Account representing a customer.
- related_
personobject Tokens referencing a Person resource and its associated account.
- 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
typeif not passingverification_.flow Possible enum valuesdocumentid_number - verification_
flowstring The ID of a verification flow from the Dashboard. See /identity/verification-flows.
Returns
Returns the created VerificationSession object
{ "id": "vs_1NuN4zLkdIwHu7ixleE6HvkI", "object": "identity.verification_session", "client_secret": "...", "created": 1695680197, "last_error": null, "last_verification_report": null, "livemode": false, "metadata": {}, "options": {}, "redaction": null, "status": "requires_input", "type": "document", "url": "..."}Updates a VerificationSession object.
When the session status is requires_, you can use this method to update the verification check and options.
Parameters
- metadatamap
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.
Possible enum valuesdocumentid_number
Returns
Returns the updated VerificationSession object
curl https://api.stripe.com/v1/identity/verification_sessions/{{VERIFICATION_SESSION_ID}} \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:" \ -d type=id_number{ "id": "vs_1NuN9WLkdIwHu7ix597AR9uz", "object": "identity.verification_session", "client_secret": "...", "created": 1695680478, "last_error": null, "last_verification_report": null, "livemode": false, "metadata": {}, "options": {}, "redaction": null, "status": "requires_input", "type": "id_number", "url": "..."}Retrieves the details of a VerificationSession that was previously created.
When the session status is requires_, you can use this method to retrieve a valid client_ or url to allow re-submission.
Parameters
No parameters.
Returns
Returns a VerificationSession object
curl https://api.stripe.com/v1/identity/verification_sessions/{{VERIFICATION_SESSION_ID}} \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:"{ "id": "vs_1NuNAILkdIwHu7ixh7OtGMLw", "object": "identity.verification_session", "client_secret": "...", "created": 1695680526, "last_error": null, "last_verification_report": null, "livemode": false, "metadata": {}, "options": { "document": { "require_matching_selfie": true } }, "redaction": null, "status": "requires_input", "type": "document", "url": "..."}