Stripe/postIdentityVerificationSessionsSession

Preview only · details below

StripeStripe Identity verification API

POST/v1/identity/verification_sessions/{session}

Update a VerificationSession

<p>Updates a VerificationSession object.</p> <p>When the session status is <code>requires_input</code>, you can use this method to update the verification check and options.</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
postIdentityVerificationSessionsSession
Server
https://api.stripe.com
Authentication
bearerAuth

Request parameters

session

pathstringrequired

Request body

object

Content-Type: application/x-www-form-urlencoded

Properties: expandmetadataoptionsprovided_detailstype

{
  "expand": [
    {}
  ],
  "metadata": {},
  "options": {},
  "provided_details": {},
  "type": "document"
}

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": {}
}