KYC Link Webhooks | Cashfree Payments

Webhooks are event-based notifications that are received when a specific event related to the KYC verification occurs.

In rare cases, such as network retries, read timeouts, processing delays, or delivery failures, the same webhook might be sent more than once for the same event. To prevent unintended side effects, implement idempotency in your webhook handler to handle duplicate deliveries.

Add webhooks

Add your webhook URL in our system for us to deliver webhook events. Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.

Log in to the Merchant Dashboard and click Developers.
Click Webhooks listed under the Secure ID card.
Click Add Webhook URL in the Webhook screen.
In the Add Webhook popup, fill in the following information:
- Webhook URL: Enter the URL in this field.
Click Test & Add Webhook.

Webhook events

The following events are triggered at different stages of the KYC link process:

Event	Description
KYC_LINK_ACTION_PERFORMED	You will receive this event when one of the verifications is performed using the link.
KYC_LINK_SUCCESS	You will receive this event when all the verifications are performed successfully.
KYC_LINK_EXPIRED	You will receive this event when the link expires.

KYC_LINK_ACTION_PERFORMED

{
  "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": "test@cashfree.com",
    "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"
        }
      ]
     }
}

KYC_LINK_SUCCESS

{
  "event_type": "KYC_LINK_SUCCESS",
  "event_time": "2024-02-15 16:53:15",
  "version": "v1",
  "data": {
    "name": "Test",
    "phone": "9999999999",
    "email": "test@cashfree.com",
    "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"
        }
      ]
     }
}

KYC_LINK_EXPIRED

{
  "event_type": "KYC_LINK_EXPIRED",
  "event_time": "2024-02-15 16:53:15",
  "version": "v1",
  "data": {
    "name": "Test",
    "phone": "9999999999",
    "email": "test@cashfree.com",
    "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": "SUCCESS"
        },
        {
          "reference_id": 0,
          "type": "UPIDETAILS_VALIDATION",
          "status": "EXPIRED"
        }
      ]
     }
}

Webhook signature

You will receive the webhook signature in the webhook header. Here is a sample header from a webhook request.

Header name	Header value
content-length	1099
x-webhook-attempt	1
content-type	application/json
x-webhook-signature	07r5C3VMwsGYeldGOCYxe5zoHhIN1zLfa8O0U/yngHI=
x-webhook-timestamp	1746427759733

Always capture the webhook payload in its raw text format before parsing into JSON. Parsing and re-serialising the payload can change the structure (for example, array ordering, spacing, or null handling) and cause a signature mismatch during verification. Use the exact raw body string from the request when computing the signature.

Webhook payload fields

The webhook payload contains important metadata in its top-level fields.

Field	Type	Description
`event_type`	`string`	Indicates the type of event that triggered the webhook.
`event_time`	`string`	The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`).
`version`	`string`	Indicates the webhook format being used. Default version is “v1”.
`data`	`object`	Contains event-specific details related to this feature.

Verifying the signature is mandatory before processing any response. Refer to Signature Verification for more details.

Secure ID APIs

V2

V1 (Depricated API's)

Webhooks

Add webhooks

Webhook events

Webhook signature

Webhook payload fields

​Add webhooks

​Webhook events

​Webhook signature

​Webhook payload fields

Add webhooks

Webhook events

Webhook signature

Webhook payload fields