Overview

The Flow API is designed to create customizable verification and onboarding workflows. Each flow is built from a sequence of steps that can be combined according to your business needs.

🏗️ Building a Flow

A flow consists of different types of steps, each responsible for a specific part of the process:

Step Type	Description
Identity Verification	Performs identity verification, analyzing identity documents and other relevant data for compliance.
Onboarding Individual	Used to collect detailed information about individuals, including personal data, proof of address, etc.
Onboarding Company	Used to collect detailed information about a company, including business data, legal representatives, and final beneficiaries.

Typical Use Case

The most typical use case is to combine the Identity Verification step with the Individual Onboarding step, ensuring that the end customer's document and the compliance data of the same person are valid.

How to Create a Flow

1️⃣ Design Your Flow

Define the sequence of steps you want to include (for example: identity verification → onboarding persona).

Decide the order of these steps and any specific configurations for each.

2️⃣ Configure Each Step

Each step requires specific configuration depending on its type (e.g., setting up required fields for onboarding forms, configuring verification providers).

3️⃣ Integrate with the SDK

Once your flow is defined, integrate it into your frontend or backend using the Rillis SDK.

Make sure to specify the webhook URLs to receive real-time updates for each step.

Visual Overview

Below is a screenshot from the Rillis platform, illustrating how you can drag and drop the available services to build your custom flow:

To integrate Rillis verification flows into your application, you can use the Rillis web component, a lightweight and customizable widget that displays a button to trigger a configured flow. Each flow can include one or more steps, such as identity verification, individual onboarding, or company onboarding, allowing you to tailor the process to your business needs.

✅ Installation Steps

Add the following script to your frontend:

2️⃣ Insert the Web Component

Use the custom element anywhere in your frontend. This renders a verification button with your desired configuration:

Attribute	Type	Description
client_id	string	Your Rillis client ID (optional if using propsByUrl).
flow	string	Flow ID to trigger (optional if using propsByUrl).
metadata	string	Optional metadata to associate with the session.
propsByUrl	boolean	If true, widget will read config from the URL instead of attributes.
fullpage	boolean	Keeps the verification button always visible.
environment	"test" or "production"	Controls which environment to connect to (default is production).
lang	string	Language of the widget UI ("en" for English, "es" for Spanish, etc.).
buttonStyles	string	Inline CSS to customize the button appearance.
buttonText	string	Custom text for the button (e.g., "Start Verification").
disableDefaultStyles	boolean	Removes default button styling if you want full control via CSS.

🎨 Example with Custom Styling

⚡ Emitted Events

onRillisSuccess: Emitted when the verification is successfully submitted.

onRillisError: Emitted when an error occurs during the verification process.

These are CustomEvent type events. They can be listened for from anywhere in your project, such as in your index.html file:

🧩 Framework Compatibility

Because it’s a native Web Component, the Rillis Widget works with all major frontend frameworks, including:

React (via dangerouslySetInnerHTML or custom wrappers)

Vue

Angular

Vanilla JS or static HTML

You can fully control when and how the widget appears and even dynamically inject it based on user interaction.

Overview

🏗️ Building a Flow

Typical Use Case

How to Create a Flow

Visual Overview

Integrating the Widget in the Frontend

✅ Installation Steps

1️⃣ Import the Widget Script

2️⃣ Insert the Web Component

⚙️ Widget Parameters

🎨 Example with Custom Styling

⚡ Emitted Events

🧩 Framework Compatibility

Overview

🏗️ Building a Flow#

Typical Use Case#

How to Create a Flow#

Visual Overview#

Integrating the Widget in the Frontend#

✅ Installation Steps#

1️⃣ Import the Widget Script#

2️⃣ Insert the Web Component#

⚙️ Widget Parameters#

🎨 Example with Custom Styling#

⚡ Emitted Events#

🧩 Framework Compatibility#

🏗️ Building a Flow

Typical Use Case

How to Create a Flow

Visual Overview

Integrating the Widget in the Frontend

✅ Installation Steps

1️⃣ Import the Widget Script

2️⃣ Insert the Web Component

⚙️ Widget Parameters

🎨 Example with Custom Styling

⚡ Emitted Events

🧩 Framework Compatibility