onOnboarding Webhook

✅

Webhook type onOnboarding

Scopes

Triggered when a client successfully completes all steps in their journey, notifying the merchant that the onboarding process is complete.

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 "Onboarding Completed"
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": "alice.jones@example.com",
    "reference_id": null,
    "client_reference_id": "1701444864686-9565",
    "mode": "Onboarding Completed",
    "group_name": "XYZ Corporation",
    "group_token": "4567efgh8901abcd2345",
    "created_at": "2023-04-05 09:15:00"
}

onIdVerificationComplete