onInit Webhook

✅

Webhook type onInit

Scopes

This webhook is triggered when a user verifies an OTP during the onboarding process. However, if OTP verification is disabled for the journey/group, the webhook will not be triggered.

Note: The webhook url must in a POST method.

Payload

These informations will be sent using the webhook URL:

Field	Type	Description
email	string	The email ID of the Client
reference_id	string	Reference ID number of the Client's KYC
client_reference_id	string	Reference ID number of the client
mode	string	Base message, i.e "Started"
group_name	string	Name of the group using which the onboarding process was executed
group_token	string	Group Token number of the Group
created_at	datetime	It contains the on-point date and time

Important

reference_id is only generated when a client initiates KYC verification. Since this webhook is not related with KYC verification so that the reference_id is null in this case.
client_reference_id in the webhook payload is a unique identifier assigned when a client is created. This identifier is included in all webhook events.

Request Payload json

{
  "email": "jidorisut@mailinator.com",
  "reference_id": null,
  "client_reference_id": "1701444864686-9565",
  "mode": "Started",
  "group_name": "Kyc check for individual",
  "group_token": "7b2c10c4-c76a-464c-8861-e8f85b7fc167",
  "created_at": "2023-12-01 15:34:24"
}

Webhook onAction