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 using our Name Verification services.

Webhook Events	Description
kycs.name_match.created	Triggered when the Name Verification API call is successfully made.

Sample Payloads

KYCS Name Match Created

review_needed

{
  "id": "evl_9hH0cRXJ58EMY6wanIP7mPusT",
  "object": "event",
  "name": "kycs.name_match.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "nm_vP1DgoQpjuVHth2VTN2lfEuXd",
      "type": "pan_vs_aadhaar",
      "object": "name_match.pan_vs_aadhaar",
      "minimum_match_score": 70,
      "status": "success",
      "name_as_per_aadhaar": "Name as per Aadhar Records",
      "name_as_per_pan": "Name as per PAN records",
      "aadhaar_verification_id": "adh_T3BQQ16TYdSi0yjeD4sFbKm8V",
      "pan_verification_id": "pan_VNDIF0y7oa13ZWi1kGVGw4BLI",
      "match_score": 70.83,
      "message": "success",
      "review_needed": false,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "created_at": 1671020256,
      "updated_at": 1671020256,
      "is_sandbox": true
    }
  }
}