Home
Home
  1. 🌊 Flow API
  • πŸš€ Getting Started
  • πŸ”Ž Screening API
    • Overview
    • Blacklist Matching Logic
    • Blockchain Analysis
      POST
    • Individuals Analysis
      POST
    • Organizations Analysis
      POST
    • Screening Entities Summary Analysis
      POST
    • Create BlackList
      POST
    • Get All BlackList Records
      GET
    • Get Blacklist Record by ID
      GET
    • Delete Blacklist Record by ID
      DELETE
    • Update Blacklist Record by ID
      PATCH
    • Update Blacklist Settings Account
      PATCH
  • 🌊 Flow API
    • Overview
    • Flow Step: Identity Verification
    • Flow Step: Onboarding Individual
    • Flow Step: Onboarding Organization
    • πŸ“‘ Endpoints
      • Authentication token
      • Get Flow Instance
      • Get File from Flow Instance
      • Identity: Get Details
      • Identity: Get Files
      • Identity: Update Status
      • Onboarding: Get Details
      • Onboarding: Get File
      • Onboarding: Get Multiple Files
      • Onboarding: Update Status
    • πŸ“€ Webhooks
      • Webhooks Overview
      • Flow
      • Identity Verification
      • Onboarding Individual
      • Onboarding Organizations
      • Identity Verification by Onboarding
  • πŸ’Έ Transaction API
    • πŸ”‘ Authentication
    • Overview
    • Transaction Analysis
    • Transaction Status
    • Document Types
    • Cryptocurrencies
    • Diagram
    • πŸ“€ Webhooks
  • πŸ“‘ Endpoints
    • Create operation
    • Get operation
    • Get valid document types
    • Get valid coins
  • πŸ“‚ Resources
    • Concept Details
    • Enum Validation
Home
Home
  1. 🌊 Flow API

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 TypeDescription
Identity VerificationPerforms identity verification, analyzing identity documents and other relevant data for compliance.
Onboarding PersonaUsed to collect detailed information about individuals, including personal data, proof of address, etc.
Onboarding EmpresaUsed 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 Onboarding Empresa step, ensuring that both individuals and companies are properly verified in a single flow.

How to Create a Flow#

1️⃣ Design Your Flow
Define the sequence of steps you want to include (for example: identity verification β†’ onboarding persona β†’ onboarding empresa).
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:
Flow Creation Interface

Integrating the Widget in the Frontend#

To integrate Rillis verification into your frontend, you can use the Rillis Web Component. Here’s how:

1️⃣ Import the Widget Script#

Add the following script to your frontend:

2️⃣ Use the Web Component in Your Application#

You can then embed the Rillis Widget directly into your HTML or framework component:
This renders a button for initiating the verification with Rillis. Since it’s a web component, it should integrate seamlessly with any frontend.
Modified atΒ 2025-06-02 21:32:28
Previous
Update Blacklist Settings Account
Next
Flow Step: Identity Verification
Built with