StripeAPI.Operations.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>

Defines the object schema located at paths./v1/identity/verification_sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostIdentityVerificationSessionsRequestBody with all required fields.

Defines the object schema located at paths./v1/identity/verification_sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.options in the specification.

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

Create a new PostIdentityVerificationSessionsRequestBodyOptions' with all required fields.

Defines the object schema located at paths./v1/identity/verification_sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.options.properties.document.anyOf in the specification.

Create a new PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/identity/verification_sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.options.properties.document.anyOf.properties.allowed_types.items in the specification.

Defines the oneOf schema located at paths./v1/identity/verification_sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.options.properties.document.anyOf in the specification.

Defines the enum schema located at paths./v1/identity/verification_sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.type in the specification.

The type of verification check to be performed.

Represents a response of the operation postIdentityVerificationSessions.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostIdentityVerificationSessionsResponseError is used.