Online Onboarding Webhooks

Webhook Notifications Overview

Webhook notifications provide updates on key events related to account creation and onboarding progress. Below is a summary of the key notification types, implementation guidelines, and best practices.


đź”” Notification Types

1. Account Creation & Status Updates

Receive updates when an account is created or its status changes.

  • Webhook Event ID: 50

  • Status Values:

    • 1 = Created
    • 2 = Accepted
    • 3 = Denied
    • 4 = Blocked
    • 5 = KYC update requested
    • 6 = KYC update rejected
    • 7 = KYC update accepted
  • Payload Example:

{
  "EventDate": "2015-11-01T16:44:55.883",
  "AccountID": "37373",
  "ProfileID": "93843",
  "IntId": "32",
  "ExtId": "jdkc",
  "Status": "2"
}

2. Onboarding Progress Updates (Profile Status)

Track the onboarding journey through changes in profile status.

  • Webhook Event ID: 49

  • Status Values:

    • 1 = Onboarding in progress
    • 2 = Under analysis
    • 3 = Accepted
    • 4 = Denied
    • 5 = Rejected
  • Payload Example:

{
  "EventDate": "2015-11-01T16:44:55.883",
  "AccountID": "37373",
  "ProfileID": "454545",
  "IntId": "32",
  "ExtId": "jdkc",
  "Status": "2"
}

đź’ˇ Account status is updated upon completion of KYC checks. Depending on whether controls are automatic or manual, results may take from a few minutes up to a maximum of 48 hours.

⚠️ Please note: Webhook notifications can be delayed by up to one hour. We recommend performing aGET request after receiving a webhook to retrieve the latest information.


⚙️ Implementation Steps

  1. Set Up Webhooks
    Configure webhook endpoints to receive notifications for both account and profile status changes.

  2. Handle Notifications
    Implement logic to process different notification types and update your systems accordingly.

  3. Monitor Status Continuously
    Regularly check account and profile statuses to ensure onboarding is progressing as expected.