POST /v1/identity/verification_sessions
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
Servers
- https://api.stripe.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
related_person |
Object | No |
Tokens referencing a Person resource and it's associated account. |
related_person.account |
String | Yes | |
related_person.person |
String | Yes | |
client_reference_id |
String | No |
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. |
options |
Object | No |
A set of options for the session’s verification checks. |
options.document |
No | ||
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
metadata |
Object | No |
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 |
type |
String | No |
The type of verification check to be performed. You must provide a Possible values:
|
verification_flow |
String | No |
The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. |
related_customer |
String | No |
Customer ID |
return_url |
String | No |
The URL that the user will be redirected to upon completing the verification flow. |
provided_details |
Object | No |
Details provided about the user being verified. These details may be shown to the user. |
provided_details.email |
String | No | |
provided_details.phone |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.