POST /v1/identity/verification_sessions/{session}
Updates a VerificationSession object.
When the session status is requires_input, you can use this method to update the
verification check and options.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
session |
String | Yes |
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 |
|---|---|---|---|
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. Possible values:
|
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.