Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Developer tools
Get started
Payments
Finance automation
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
OverviewExplore all products
Start building
Start developing
Sample projects
About the APIs
Building with LLMs
Use Stripe without code
Set up Stripe
Create an account
Products and prices
Web Dashboard
Mobile Dashboard
Migrate to Stripe
Migrate customer data
Migrate payment data
Migrate subscriptions
Manage fraud risk
Understand fraud
Radar fraud protection
Manage disputes
Verify identities
    Overview
    Get started
    Verify identity documents
    Handle verification outcomes
    Access verification results
    Review verification results
    Verification Flows
    More verification checks
    Verification checks
    Adding selfie checks
    About the APIs
    Verification Sessions
    Go live
    Before going live
    Supported use cases
    Explaining Identity
Regulatory support
HomeGet startedVerify identities

Verification flows

Apply a reusable configuration across your integration.

Copy page

Flows provide a way to save and reuse the same configuration across all of your integration interfaces. You can use each flow to create verification sessions through the API, in the Dashboard, or through the flow’s static link. Flows support the management of different verification use cases and can help ensure consistency across your integration.

Create flows

To set up your Identity integration, first create a flow to store your desired configuration:

  1. Visit the Verification flows page in your Dashboard.
  2. Name the flow.
  3. Configure the verification behavior you want.
  4. Click Save.

Manage flows

The Verification flows page displays all of your flows. You can create distinct flows for different use-cases, such as:

  • Marketing campaigns
  • High-value versus low-value transactions
  • Known high-risk users versus trusted users
  • Any other relevant use case

After you create a flow, you can visit the details page to:

  • View details and edit the flow
  • View a list of all the verifications created from the flow
  • Activate or deactivate the flow’s static link

Update flows

You can use flows to deploy a new configuration to production. For example, if you want to add selfie checks to your document verifications, you can edit the flow in the Dashboard to add selfie verification. Any future verifications you create with this flow automatically adopt the updated configuration, so make sure to only apply changes that you want to adopt for future verifications.

Use flows to verify users

After you create a flow, you have two options for how to initiate an identity verification using it.

To use flows in your API integration, copy the flow ID from the details page and pass it in the verification_flow parameter when you create a verification session.

Command Line
cURL
curl https://api.stripe.com/v1/identity/verification_sessions \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d verification_flow=
{{VERIFICATION_FLOW_ID}}

Include user-specific details

As with any verification session that you create with the API, you can attach user-specific data with the metadata and provided_details parameters. The client_reference_id parameter provides a reference to a user in your system that you can look up later.

For example, here’s how you can attach a user-specific phone number, email address, and client_reference_id to a verification session:

Command Line
cURL
curl https://api.stripe.com/v1/identity/verification_sessions \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d verification_flow=
{{VERIFICATION_FLOW_ID}}
\ -d "provided_details[phone]"=5555551212 \ --data-urlencode "provided_details[email]"="user@domain.com" \ -d client_reference_id=reference-token
Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc