Onboarding Individual

This document covers the webhook events for onboarding processes of individuals. These events notify your system when an onboarding form has been completed, either pending review or explicitly rejected.

Overview

The webhook is sent when an individual's onboarding form is finalized. The main difference between the two events is the status:

"PENDING_REVIEW" for completed forms waiting for manual review.

"REJECTED" for forms that have been explicitly rejected.

The rest of the payload structure remains consistent.

Webhook Trigger

When an onboarding form is completed (either pending review or rejected), Rillis sends a POST request to your configured webhook endpoint with detailed onboarding data.

Webhook Payload Schema

Parameter	Type	Description
id	String	Unique webhook event identifier.
type	String	Event type: `"ONBOARDING_FORM_INDIVIDUAL_COMPLETED"` or `"ONBOARDING_FORM_INDIVIDUAL_REJECTED"`.
timestamp	Number (timestamp)	Timestamp of the event.
data.onboarding_id	String	Unique identifier of the onboarding process.
data.onboarding	Object	Full details of the onboarding form, including submitted data.
data.flow_instance_id	String	ID of the flow instance associated with this onboarding.
data.flow_id	String	ID of the flow.
data.user_id	String	ID of the user associated with this onboarding process.
data.status	String	`"PENDING_REVIEW"` or `"REJECTED"`.
data.completed_at	String (ISO date)	When the onboarding process was completed.
data.metadata	Object	Additional metadata.
data.url	String	Reference URL for the onboarding form details.

Common Onboarding Fields (`data.onboarding`)

The onboarding object includes:

data_individual: Detailed personal and financial information, including:

first_name, middle_name, last_name

address_1, address_2, city, province, country_of_residence, postal_code

email, is_pep, fund_origin, source_of_income, etc.

identities: List of identity references (empty in this example).

status: The final status of the onboarding (PENDING_REVIEW or REJECTED).

Status Differences

ONBOARDING_FORM_INDIVIDUAL_COMPLETED: Triggered when the onboarding form is successfully completed and is pending manual review.

ONBOARDING_FORM_INDIVIDUAL_REJECTED: Triggered when the onboarding form is explicitly rejected.

Example Webhook Payloads

Example: Onboarding Individual - Completed (Pending Review)

{
  "id": "6824f9480ac4747b53670572",
  "type": "ONBOARDING_FORM_INDIVIDUAL_COMPLETED",
  "timestamp": 1747253576758,
  "data": {
    "onboarding_id": "6824f94815f0e8499e51a2f6",
    "onboarding": {
      "_id": "6824f94815f0e8499e51a2f6",
      "flow": "67a3af4ca59af345d61f4f9c",
      "user": "67a3a5065eee513d753f19b7",
      "flow_instance": "6824f15c15f0e8499e51a25c",
      "identities": [],
      "data": {
        "data_individual": {
          "first_name": "name person",
          "middle_name": "name person",
          "last_name": "my lastname",
          "address_1": "AV 5 Calle x",
          "address_2": "AV 8 Calle 33",
          "city": "Colorado",
          "province": "El caio",
          "country_of_residence": "USA",
          "postal_code": "4324",
          "email": "email@gmail.com",
          "is_pep": true,
          "business_information": {
            "annual_income_usd": 566600000,
            "commercial_relationship_purpose": "COMMERCIAL_OPERATIONS",
            "estimated_annual_transaction_usd": 160000.3,
            "fund_origin": "FOREIGN_INVESTMENT",
            "income_brief_description": "description income",
            "source_of_income": "PRODUCT_SALES",
            "total_assets": 666666
          }
        },
        "type": "INDIVIDUAL",
        "identityRef": { "id": "6824f94815f0e8499e51a2ee", "model": "Onboarding" }
      },
      "status": "PENDING_REVIEW",
      "file_references_data": [],
      "completed_at": "2025-05-14T20:12:56.725Z"
    },
    "flow_instance_id": "6824f15c15f0e8499e51a25c",
    "flow_id": "67a3af4ca59af345d61f4f9c",
    "user_id": "67a3a5065eee513d753f19b7",
    "status": "PENDING_REVIEW",
    "completed_at": "2025-05-14T20:12:56.725Z",
    "metadata": {},
    "url": "https://webhook.site/44c2ff65-88fb-4241-956b-6e8ad5a0f782"
  }
}

Example: Onboarding Individual - Rejected

{
  "id": "6824f9480ac4747b53670572",
  "type": "ONBOARDING_FORM_INDIVIDUAL_REJECTED",
  "timestamp": 1747253576758,
  "data": {
    "onboarding_id": "6824f94815f0e8499e51a2f6",
    "onboarding": { /* same as above */ },
    "flow_instance_id": "6824f15c15f0e8499e51a25c",
    "flow_id": "67a3af4ca59af345d61f4f9c",
    "user_id": "67a3a5065eee513d753f19b7",
    "status": "REJECTED",
    "completed_at": "2025-05-14T20:12:56.725Z",
    "metadata": {},
    "url": "https://webhook.site/44c2ff65-88fb-4241-956b-6e8ad5a0f782"
  }
}

Onboarding Individual

Overview#

Webhook Trigger#

Webhook Payload Schema#

Common Onboarding Fields (data.onboarding)#

Status Differences#

Example Webhook Payloads#

Example: Onboarding Individual - Completed (Pending Review)#

Example: Onboarding Individual - Rejected#