Creating a Flow

Rate this article:

X

Select all that apply:

The content is confusing or hard to follow.

There is missing information or code.

There is inaccurate or outdated information.

This page did not solve my problem.

I would like to speak with someone about this.

Email:

Submit Feedback

Creating a Flow

1. Log into the IPQS dashboard.

2. In the navbar on the left, select Fraud Flows.

3. Click New Flow.

4. In the Flow Title field, enter a title for your Flow.

5. From the Flow Delivery Mode menu, select how the Flow will be delivered to the user:

   • Link will provide you with a URL you can link to through your own website, API, or other tools.
   • Text will send a link to the URL to a phone number.
   • Email will send a link to the URL to an email address.

6. By default, your Flow will start with a Form Page Step that already has a "Submit" button. We recommend starting your Flow with a Form Page Step. You can use this first Form Page to explain the verification process to the user.

7. Most Steps do not require any configuration. However, the Form Page Step requires you to design the form.

   1. Click Add Element.
   2. Select the type of element (e.g., "Display Text", "Phone Number").
   3. If applicable, enter a name for the field and a placeholder value. For example, you could name an email field "Your email address" and give it a default value of "user@example.com".

   Additionally, the ID Verification Step includes some optional configurations. You can optionally customize the ID Verification Step to:

   • Ask for a selfie.
   • Ask for the back of the user's ID card.
   • Show a rectangle guide for framing their ID card in the photos.
   • If they performing this verification check on a phone, allow them to manually switch between the front and rear cameras.

8. Click Add Step to add additional Steps to your Flow:

   • Form Page
   • Proxy/VPN
   • Device Fingerprint
   • Phone Validation
   • ID Verification

   Steps are performed in order from top to bottom.

9. We recommend using a Form Page as the final Step. This allows you to display some text to the user stating they have completed the verification process.

10. When you are finished creating the Flow, click Save.

Flow Settings

You can customize some settings of your Flow by clicking on Settings. In the "Settings" menu, you can:

• Add a header image.
• Change the title of your Flow.
• Change the delivery method of your Flow (e.g., "Link", "Text", or "Email").
• Add a footer at the bottom of your Flow.
• Add links to your Flow, such as links to your Terms of Service or to your Customer Support portal.
• Add a webhook URL. When the Flow is completed, the data will be automatically sent to the webhook URL. This allows you to programattically use the data in your own tools and system without needing to separately retrieve the results from the /status API endpoint or the Fraud Flows Reports page.

Styling a Flow

You can customize the appearance of your Flow by clicking Styles. This menu allows you to select from various default styles, or create your own by entering your own CSS.

Creating a New Style

Click Create Blank Style.

Duplicating a Style

You can duplicate an existing style by clicking Clone below the style.

Editing a Style

You can edit a style by clicking Edit below the style.

From here, you change the name of the style by editing the "Style Name" field, or edit the style itself by editing the "Stylesheet CSS" field.

Duplicating a Flow

You can duplicate an existing Flow by clicking Clone to the right of a Flow.

Editing a Flow

Click directly on the Flow you want to edit.

Deleting a Flow

Click Delete to the right of the Flow you want to delete. You will be asked to confirm deletion of the Flow. Flows can't be recovered once deleted.

Previewing a Flow

You can preview your Flow by clicking the Preview button. This will let you go through the Flow yourself and confirm everything is working as you designed.

Finishing a Flow

When the user has completed a Flow, you will need to redirect them to somewhere else, such as back to your own website. This is done through Branching.