onIdVerificationComplete Webhook

✅

Webhook type onIdVerificationComplete

Scopes

Triggered when we receive verification data from our provider, informing the merchant of the client's KYC verification results.

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 "KYC Result"
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
result	string	It contains the review result of the KYC process
reason	string	If it's rejected, then it'll show the reason, otherwise it'll come with null
is_retry_possible	boolean	It'll come up with True or False whether it's possible to retry or not

Important

reference_id is generated only when a client initiates KYC verification. If you receive this webhook, it indicates that we received the KYC verification result from our provider for the specific client, and the corresponding verification reference_id is provided.
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",
  "kyc_email": "kyc_john.doe@example.com",
  "reference_id": "1454346432245-7864",
  "client_reference_id": "1701444864686-9565",
  "mode": "KYC Result",
  "group_name": "ABC Corporation",
  "group_token": "0123abcd4567ef8901",
  "created_at": "2023-03-10 12:30:00",
  "result": "decline/verified",
  "reason": "Mismatch in identification documents", // if decline else ""
  "is_retry_possible": false
}

onKYCSubmit onOnboarding