Stripe/getIdentityVerificationSessionsSession

Preview only · details below

StripeStripe Identity verification API

GET/v1/identity/verification_sessions/{session}

Retrieve a VerificationSession

<p>Retrieves the details of a VerificationSession that was previously created.</p> <p>When the session status is <code>requires_input</code>, you can use this method to retrieve a valid <code>client_secret</code> or <code>url</code> to allow re-submission.</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
getIdentityVerificationSessionsSession
Server
https://api.stripe.com
Authentication
bearerAuth

Request parameters

expand

queryarray

Specifies which fields in the response should be expanded.

session

pathstringrequired

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