KYB Email Notification Webhook Events

Overview

During specific business scenarios, the KYB system needs to send email notifications to end users. When a customer has enabled the Webhook email notification feature, the system will not send emails directly. Instead, it pushes email-related information to the customer via Webhook events, allowing the customer to handle the email delivery on their own.

This document describes the business flow and payload structure for the following two Webhook events:

1. IDV Email Notification Event (KYB_IDV_EMAIL)

Business Scenarios

IDV (Identity Verification) is the step in the KYB process where individuals undergo identity checks. The system needs to notify relevant parties at the following points:

1. Verification Request — After the system generates a verification link, it notifies the individual to complete the verification
2. Verification Passed — After identity verification is approved, the individual is notified of the result
3. Verification Failed — After identity verification is rejected, the individual is notified of the result

emailType Enum

Payload Fields

Payload Examples

Verification Request:

{
  "email": "[email protected]",
  "directUrl": "https://kyb.example.com/idv?id=xxx&token=yyy",
  "expireHour": 72,
  "emailType": "REQUEST_IDV"
}

Verification Result Notification:

{
  "email": "[email protected]",
  "emailType": "NOTIFY_IDV_SUCCESS"
}

2. Questionnaire Email Notification Event (KYB_QNRE_EMAIL)

Business Scenarios

The Questionnaire is the step in the KYB process where information about the company and related individuals is collected. The customer creates a questionnaire task and generates a form link, which is then embedded into the customer's own system. End customers access the form link directly to fill out the form. The system needs to notify relevant parties at the following points:

1. Form Filling Notification — During form filling, when the respondent needs to delegate part of the form to another person or wants to save the current progress as a draft, the filled information is temporarily saved and an email notification is triggered to inform the recipient to continue or complete the form
2. OTP Verification Code — When the respondent submits the form, the system sends an OTP code to verify their email identity
3. Submission Confirmation — After successful form submission, a confirmation notification is sent to the respondent

emailType Enum

Payload Fields

Payload Examples

Form Filling Notification:

{
  "email": "[email protected]",
  "url": "https://kyb.example.com/form?token=abc123",
  "emailType": "FORM_NOTIFICATION"
}

OTP Verification Code:

{
  "email": "[email protected]",
  "otpCode": "385721",
  "emailType": "OTP_VERIFICATION"
}

Submission Confirmation:

{
  "email": "[email protected]",
  "emailType": "SUBMISSION_CONFIRMATION"
}

3. Business Flow Diagrams

IDV Email Notification Flow

flowchart TD
    A[Initiate IDV Check] --> B[Generate Verification Link]
    B --> C{IDV Webhook<br/>Enabled?}
    C -->|Yes| D[Push Webhook Event<br/>emailType: REQUEST_IDV]
    C -->|No| E[System Sends<br/>Verification Request Email]
    D --> F[Customer Sends Email<br/>to Individual]
    E --> F2[Individual Receives Email]
    F --> G[Individual Clicks Link<br/>and Completes Verification]
    F2 --> G
    G --> H[System Retrieves<br/>Verification Result]
    H --> I{Verification<br/>Passed?}
    I -->|Yes| J{IDV Webhook<br/>Enabled?}
    I -->|No| K{IDV Webhook<br/>Enabled?}
    J -->|Yes| L[Push Webhook Event<br/>emailType: NOTIFY_IDV_SUCCESS]
    J -->|No| M[System Sends<br/>Success Notification Email]
    K -->|Yes| N[Push Webhook Event<br/>emailType: NOTIFY_IDV_FAILED]
    K -->|No| O[System Sends<br/>Failure Notification Email]

Questionnaire Email Notification Flow

flowchart TD
    A[Create Questionnaire Task] --> B[Generate Form Link]
    B --> C[Embed Form Link into<br/>Customer's System]
    C --> D[End Customer Accesses<br/>Form Link]
    D --> E[Respondent Fills Out Form]
    E --> F{Delegate to Another Person<br/>or Save as Draft?}
    F -->|Yes| G[System Temporarily Saves<br/>Filled Information]
    G --> H{Questionnaire Webhook<br/>Enabled?}
    H -->|Yes| I[Push Webhook Event<br/>emailType: FORM_NOTIFICATION]
    H -->|No| J[System Sends<br/>Form Notification Email]
    I --> K[Customer Sends Email<br/>to Recipient]
    J --> K2[Recipient Receives Email]
    K --> L[Recipient Clicks Link<br/>and Continues Filling]
    K2 --> L
    L --> E
    F -->|No, Ready to Submit| M[Respondent Requests Submission]
    M --> N{Questionnaire Webhook<br/>Enabled?}
    N -->|Yes| O[Push Webhook Event<br/>emailType: OTP_VERIFICATION]
    N -->|No| P[System Sends<br/>OTP Verification Email]
    O --> Q[Customer Sends<br/>OTP Code]
    P --> Q2[Respondent Receives<br/>Verification Code]
    Q --> R[Respondent Enters Code<br/>and Completes Submission]
    Q2 --> R
    R --> S{Questionnaire Webhook<br/>Enabled?}
    S -->|Yes| T[Push Webhook Event<br/>emailType: SUBMISSION_CONFIRMATION]
    S -->|No| U[System Sends<br/>Confirmation Email]

4. General Notes

• Activation Requirement: To use webhook email notifications, please contact our support team to enable the appropriate KYB verification level for your account. Once configured, email notifications will be delivered via the webhook flow. Otherwise, the system will continue sending emails automatically.
• Empty Fields Are Omitted: When a field is not applicable to the current emailType, it will not appear in the payload (rather than being returned as null).
• Event Delivery Timing: Events are pushed in real-time when the business action occurs. Customers should send the corresponding emails promptly upon receiving the event to ensure a good user experience.