Webhook Events

All important activity on your ZWITCH account is recorded as an event. We use webhooks to notify you about important events on your account. 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. Webhook payloads use the JSON format.

Learn how to set up webhooks.

Available Webhook Events

The table below lists the various webhook events triggered when checking and downloading an individual or entity’s CKYC registration.

Webhook Events	Description
kycs.ckyc.created	Triggered when the Check CKYC Registration API call is successfully made.
kycs.ckyc.updated	Triggered when the Download CKYC API call is successfully made.

Sample Payloads

Below are sample payloads for the different CKYC Verification webhook events.

KYC CKYC Created

Triggered when the Check CKYC Registration API call is successfully made.

{
  "id": "evl_26tnpukBDSH3PZAiPRWfarP1l",
  "object": "event",
  "name": "kycs.ckyc.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "ckyc_ioiEaFSn819vFhAfenwpJD6yA",
      "object": "ckyc_verification",
      "purpose": "savings_account",
      "document_type": "pan",
      "document_number": "AAAPA0000A",
      "name": "Anil Reddy",
      "fathers_name": "Sunil Reddy",
      "ckyc_number": "45968122540862",
      "registration_type": "normal",
      "ckyc_date": "28-09-2018",
      "status": "success",
      "message": "success",
      "merchant_reference_id": "1004503",
      "consent": true,
      "metadata": {
        "key_1": "DD",
        "key_2": "XoF"
      },
      "created_at": 1678961123,
      "updated_at": 1678961123,
      "is_sandbox": true
    }
  }
}

KYC CKYC Updated

Triggered when the Download CKYC API call is successfully made.

{
  "id": "evl_UjWPM3FOomByiIjW28VaICnVu",
  "object": "event",
  "name": "kycs.ckyc.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "ckyc_ioiEaFSn819vFhAfenwpJD6yA",
      "type": "individual",
      "object": "ckyc_download.individual",
      "name": "Anil Reddy",
      "date_of_birth": "2020-12-31",
      "fathers_name": "Sunil Reddy",
      "ckyc_number": "45968122540862",
      "mobile_number": "9876543210",
      "email": "[email protected]",
      "addresses": [
        {
          "type": "permanent",
          "address": "221B BAKER STREET, 5TH AVENUE, OPPOSITE WOLLATON HALL, BANGALORE",
          "city": "BANGALORE_URBAN",
          "postal_code": "560035",
          "state_code": "KA"
        },
        {
          "type": "communication",
          "address": "221B BAKER STREET, 5TH AVENUE, OPPOSITE WOLLATON HALL, BANGALORE",
          "city": "BANGALORE_URBAN",
          "postal_code": "560035",
          "state_code": "KA"
        }
      ],
      "registration_type": "normal",
      "status": "success",
      "message": "success",
      "consent": true,
      "is_sandbox": true,
      "created_at": 1678961123,
      "updated_at": 1678961163
    }
  }
}