provider POST /v1/identity/verification_sessions
@utdk/stripe /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="/docs/identity/verify-identity-documents">Verify your users’ identity documents</a></p>

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postidentityverificationsessions
POST/v1/identity/verification_sessions
<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="/docs/identity/verify-identity-documents">Verify your users’ identity documents</a></p>

Input

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.

Specifies which fields in the response should be expanded.

Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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 `metadata`.

A set of options for the session’s verification checks.

Details provided about the user being verified. These details might be shown to the user.

Customer ID

The ID of the Account representing a customer.

Tokens referencing a Person resource and its associated account.

The URL that the user will be redirected to upon completing the verification flow.

The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.

The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postidentityverificationsessions()