Home
Home
  1. πŸ“€ Webhooks
  • πŸš€ Getting Started
  • πŸ”Ž Screening API
    • Overview
    • Blacklist Matching Logic
    • πŸ“‘ Endpoints
      • Blockchain Analysis
      • Individuals Analysis
      • Organizations Analysis
      • Screening Entities Summary Analysis
      • Create BlackList
      • Get All BlackList Records
      • Get Blacklist Record by ID
      • Delete Blacklist Record by ID
      • Update Blacklist Record by ID
      • Update Blacklist Settings Account
  • 🌊 Flow API
    • Overview
    • Flow Step: Identity Verification
    • Flow Step: Onboarding Individual
    • Flow Step: Onboarding Organization
    • πŸ“‘ Endpoints
      • Authentication token
      • Get Flow Instances
      • Get Flow Instance By Id
      • 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
      • Onboarding: Get Entity by document number
      • Onboarding: Get Entity List by document number
    • πŸ“€ Webhooks
      • Overview
      • Flow
      • Identity Verification
      • Onboarding Individual
      • Onboarding Organizations
      • Identity Verification by Onboarding
  • πŸ’ΈTransaction Screening API
    • πŸ”‘ Authentication
    • Overview
    • Transaction Analysis
    • Monitoring & History
    • Document Types
    • Supported Currencies
    • Diagram
    • πŸ“€ Webhooks
    • πŸ“‘ Endpoints
      • Submit Transaction
      • List Transactions
      • List Document types
      • List Cryptocurrencies
      • Register remitter
      • Register Beneficiary
  • πŸ“‚ Resources
    • Concept Details
    • Enum Validation
Home
Home
  1. πŸ“€ Webhooks

Onboarding Organizations

These webhooks are triggered when a company onboarding process is either completed (pending review) or rejected.
They provide all the details captured in the onboarding form, as well as associated identity verifications and file references.

Webhook Trigger#

When the onboarding process for a company is completed or rejected, Rillis sends a POST request to your configured webhook URL with the following payload:

Webhook Payload Schema#

ParameterTypeDescription
idStringUnique webhook event identifier.
typeStringType of the event: either "ONBOARDING_FORM_COMPANY_COMPLETED" or "ONBOARDING_FORM_COMPANY_REJECTED".
timestampNumber (timestamp)Timestamp of the webhook event.
data.onboarding_idStringUnique identifier for the onboarding process.
data.onboardingObjectFull onboarding data including company details, identities, and file references.
data.flow_instance_idStringThe flow instance ID associated with this onboarding.
data.flow_idStringID of the flow to which the onboarding belongs.
data.user_idStringID of the user associated with the onboarding.
data.statusStringStatus of the onboarding: typically "PENDING_REVIEW" or "REJECTED".
data.completed_atString (ISO date)When the onboarding process was completed.
data.metadataObjectAdditional metadata (if any).
data.urlStringReference URL for the onboarding details.

Common Onboarding Fields (data.onboarding)#

The onboarding object includes:
Company Information:
name, nif, legal_address, email, phone, website, and much more.
business_information object with details like income, source of funds, total assets, etc.
legal_representatives and final_beneficiaries arrays with detailed information.
Identities:
An array of identity IDs linked to the onboarding (for example, identity verifications of company partners).
File References:
file_references_data array with uploaded document details (name, path, type, etc.).
Status and Timestamps:
Status of the onboarding, and timestamps for creation and completion.

Example Webhook Payload - Completed#

{
  "id": "6824f9480ac4747b5367056f",
  "type": "ONBOARDING_FORM_COMPANY_COMPLETED",
  "timestamp": 1747253576694,
  "data": {
    "onboarding_id": "6824f94815f0e8499e51a2d7",
    "onboarding": {
      "_id": "6824f94815f0e8499e51a2d7",
      "flow": "67a3af4ca59af345d61f4f9c",
      "user": "67a3a5065eee513d753f19b7",
      "status": "PENDING_REVIEW",
      "data": {
        "data_company": {
          "name": "my company s.a",
          "nif": "A12345678",
          "city": "New York",
          "country": "CHL",
          "email": "company@gmail.com",
          "phone": "+1234567890",
          "website": "https://www.example.com",
          "date_of_incorporation": "2023-01-15",
          "business_information": {
            "annual_income_usd": 500000,
            "commercial_relationship_purpose": "OPENING_BUSINESS_ACCOUNT",
            "estimated_annual_transaction_usd": 10000.3,
            "fund_origin": "OWN_CAPITAL",
            "source_of_income": "PRODUCT_SALES",
            "total_assets": 345555
          }
        }
      },
      "file_references_data": [
        {
          "id": "6e5e22e0-fb4f-4aa9-8172-3dccc0b5ce9a",
          "field_name": "document_key_123",
          "original_name": "frontal-irarrazaval-jose.jpg",
          "mime_type": "image/jpeg",
          "size": 131186
        }
      ],
      "completed_at": "2025-05-14T20:12:56.637Z"
    },
    "flow_instance_id": "6824f15c15f0e8499e51a25c",
    "flow_id": "67a3af4ca59af345d61f4f9c",
    "user_id": "67a3a5065eee513d753f19b7",
    "status": "PENDING_REVIEW",
    "completed_at": "2025-05-14T20:12:56.637Z",
    "metadata": {},
    "url": "https://webhook.site/44c2ff65-88fb-4241-956b-6e8ad5a0f782"
  }
}

Example Webhook Payload - Rejected#

{
  "id": "6824f9480ac4747b5367056f",
  "type": "ONBOARDING_FORM_COMPANY_REJECTED",
  "timestamp": 1747253576694,
  "data": {
    "onboarding_id": "6824f94815f0e8499e51a2d7",
    "onboarding": {
      "_id": "6824f94815f0e8499e51a2d7",
      "flow": "67a3af4ca59af345d61f4f9c",
      "user": "67a3a5065eee513d753f19b7",
      "status": "REJECTED",
      "data": {
        "data_company": {
          "name": "my company s.a",
          "nif": "A12345678",
          "city": "New York",
          "country": "CHL",
          "email": "company@gmail.com",
          "phone": "+1234567890",
          "website": "https://www.example.com"
        }
      },
      "file_references_data": [
        {
          "id": "6e5e22e0-fb4f-4aa9-8172-3dccc0b5ce9a",
          "field_name": "document_key_123",
          "original_name": "frontal-irarrazaval-jose.jpg",
          "mime_type": "image/jpeg",
          "size": 131186
        }
      ],
      "completed_at": "2025-05-14T20:12:56.637Z"
    },
    "flow_instance_id": "6824f15c15f0e8499e51a25c",
    "flow_id": "67a3af4ca59af345d61f4f9c",
    "user_id": "67a3a5065eee513d753f19b7",
    "status": "REJECTED",
    "completed_at": "2025-05-14T20:12:56.637Z",
    "metadata": {},
    "url": "https://webhook.site/44c2ff65-88fb-4241-956b-6e8ad5a0f782"
  }
}

Status Field#

PENDING_REVIEW: The onboarding form has been completed and is pending a manual review.
REJECTED: The onboarding form was rejected during the review process.
Modified atΒ 2025-05-29 16:17:10
Previous
Onboarding Individual
Next
Identity Verification by Onboarding
Built with