StripeStripe Identity verification API
POST/v1/identity/verification_sessions
Create a VerificationSession
<p>Creates a VerificationSession object.</p> <p>After the VerificationSession is created, display a verification modal using the session <code>client_secret</code> or send your users to the session’s <code>url</code>.</p> <p>If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.</p> <p>Related guide: <a href="https://docs.stripe.com/identity/verify-identity-documents">Verify your users’ identity documents</a></p>
Create, retrieve, update, cancel, and redact Stripe Identity verification sessions, and retrieve verification reports. The collection covers all 8 Endpoints under the official Identity path boundary; the Hub provides documentation and a local SDK/CLI only.
Request
- operationId
postIdentityVerificationSessions- Server
https://api.stripe.com- Authentication
- bearerAuth
Request parameters
No URL, query, or header parameters.
Request body
object
Content-Type: application/x-www-form-urlencoded
Properties: client_reference_idexpandmetadataoptionsprovided_detailsrelated_customerrelated_customer_accountrelated_personreturn_urltypeverification_flow
{
"expand": [
{}
],
"metadata": {},
"options": {},
"provided_details": {},
"related_person": {}
}Responses
200
stripe_identity_verification_sessionapplication/json
Successful response.
Properties: client_reference_idclient_secretcreatedidlast_errorlast_verification_reportlivemodemetadataobjectoptionsprovided_detailsredactionrelated_customerrelated_customer_accountrelated_personstatustypeurlverification_flowverified_outputs
default
stripe_errorapplication/json
Error response.
Properties: error
{
"created": 0,
"livemode": false,
"metadata": {}
}