onAction Webhook

✅

Webhook type onAction

Scopes

Triggered when a merchant modifies a client’s status.
When a merchant assigns risk levels (low, medium, high) to a client.
When requesting additional documents from a client.
Upon submission of any documents by a client.
KYC verification results (approved/declined).
Automatic risk score approval or decline based on predefined settings.
When a periodic review is created for a client.

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
kyc_email	string	The email ID that is used in the KYC process
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 "Accepted/Declined/Requested"
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 generated only when a client initiates KYC verification. If the webhook scope is related to KYC verification results, the verification reference_id will be provided; otherwise, for other scopes, reference_id will be null.
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": "john.doe@example.com",
    "reference_id": null,
    "client_reference_id": "1701444864686-9565",
    "mode": "Accepted",
    "group_name": "ABC Company",
    "group_token": "456e7890-f12c-34d5-6789-012345678901",
    "created_at": "2023-01-15 08:30:00"
}

onInit onKYCSubmit