In this article, you will learn the different webhook events for KYC Link and the sample payload for each event.
Webhooks are event-based notifications that are received when a specific event related to the reverse penny drop verification occurs. Read the article to add webhooks and verify signature.
Webhook events
Find the different event types and its description below:
Event | Description |
---|---|
KYC_LINK_ACTION_PERFORMED | It means that one of the verifications is performed using the link. |
KYC_LINK_SUCCESS | It means that all the verifications are successfully performed. |
KYC_LINK_EXPIRED | It means that one of the verifications is expired. |
Sample payload
Find the sample payload for the different webhook events of KYC Link:
{
"signature": "3YdAGMqBPDgWqy4zteRad/MoCmH59cm+93sogQWhOa8=",
"event_type": "KYC_LINK_ACTION_PERFORMED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"name": "Test",
"phone": "9999999999",
"email": "[email protected]",
"verification_id": "testverificationid",
"reference_id": 235461,
"link_expiry": "2025-12-02",
"form_link": "https://forms.cashfree.com/",
"form_status": "RECEIVED",
"verification_details": [
{
"reference_id": 234,
"type": "OFFLINE_AADHAAR_VERIFICATION",
"status": "SUCCESS"
},
{
"reference_id": 0,
"type": "PANDETAILS_VERIFICATION",
"status": "RECEIVED"
},
{
"reference_id": 0,
"type": "BANKDETAILS_VALIDATION",
"status": "RECEIVED"
},
{
"reference_id": 0,
"type": "UPIDETAILS_VALIDATION",
"status": "RECEIVED"
}
]
}
}
{
"signature": "3YdAGMqBPDgWqy4zteRad/MoCmH59cm+93sogQWhOa8=",
"event_type": "KYC_LINK_SUCCESS",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"name": "Test",
"phone": "9999999999",
"email": "[email protected]",
"verification_id": "testverificationid",
"reference_id": 235461,
"link_expiry": "2025-12-02",
"form_link": "https://forms.cashfree.com/",
"form_status": "SUCCESS",
"verification_details": [
{
"reference_id": 234,
"type": "OFFLINE_AADHAAR_VERIFICATION",
"status": "SUCCESS"
},
{
"reference_id": 235,
"type": "PANDETAILS_VERIFICATION",
"status": "SUCCESS"
},
{
"reference_id": 236,
"type": "BANKDETAILS_VALIDATION",
"status": "SUCCESS"
},
{
"reference_id": 237,
"type": "UPIDETAILS_VALIDATION",
"status": "SUCCESS"
}
]
}
}
{
"signature": "3YdAGMqBPDgWqy4zteRad/MoCmH59cm+93sogQWhOa8=",
"event_type": "KYC_LINK_EXPIRED",
"event_time": "2024-02-15 16:53:15",
"version": "v1",
"data": {
"name": "Test",
"phone": "9999999999",
"email": "[email protected]",
"verification_id": "testverificationid",
"reference_id": 235461,
"link_expiry": "2025-12-02",
"form_link": "https://forms.cashfree.com/",
"form_status": "EXPIRED",
"verification_details": [
{
"reference_id": 234,
"type": "OFFLINE_AADHAAR_VERIFICATION",
"status": "SUCCESS"
},
{
"reference_id": 0,
"type": "PANDETAILS_VERIFICATION",
"status": "EXPIRED"
},
{
"reference_id": 236,
"type": "BANKDETAILS_VALIDATION",
"status": "RECEIVED"
},
{
"reference_id": 0,
"type": "UPIDETAILS_VALIDATION",
"status": "EXPIRED"
}
]
}
}