Webhook Events

We use webhooks to notify you about important events on your KYC verification. These webhooks contain details about the event such as changes that occurred and the resources impacted by the change.

We send webhooks as HTTP POST call to a URL configured by you. The webhook payload uses the JSON format.

Learn more about our Webhooks.

Available Events

The table below lists the various webhook events triggered when verifying Aadhaar via OTP.

Webhook Events	Description
kycs.aadhaar.created	Triggered when the Send OTP API call is successfully made.
kycs.aadhaar.updated	Triggered when the Download Aadhaar Details API call is successfully made.

Sample Payload

KYCs Aadhaar Created

Triggered when the Aadhaar via OTP: Send OTP API call is successfully made.

{
  "id": "evl_Qsr3oSu0Y71asSNxlt2Gb1Z01",
  "object": "event",
  "name": "kycs.aadhaar.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "adh_6Zr0nsjOK8QxxyRqWmOQpt7Z4",
      "object": "aadhaar_verification",
      "aadhaar_number": "XXXXXXXX0989",
      "name": "Anil Reddy",
      "message": "OTP sent to registered mobile number",
      "status": "success",
      "remark": null,
      "merchant_reference_id": "1000989",
      "created_at": 1655281933,
      "is_sandbox": true
    }
  }
}

KYCs Aadhaar Updated

Triggered when the Aadhaar via OTP: Download Aadhar Details API call is successfully made.

{
  "id": "evl_HRjpC8YdzJOzsIqtYgnd7q6lS",
  "object": "event",
  "name": "kycs.aadhaar.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "adh_6Zr0nsjOK8QxxyRqWmOQpt7Z4",
      "object": "aadhaar_verification",
      "message": "Aadhaar XML file downloaded successfully",
      "status": "success",
      "name": "Anil Reddy",
      "aadhaar_number": "XXXXXXXX0989",
      "date_of_birth": "1990-01-20",
      "gender": "M",
      "father_name": "Father",
      "address": "Address as per aadhaar records",
      "postal_code": "560035",
      "state": "Kerala",
      "state_code": "KL",
      "city": "bangalore urban",
      "remark": null,
      "merchant_reference_id": "1000989",
      "is_sandbox": true
    }
  }
}