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
bharat_connect.business.check	Triggered when the Check Business API call is successfully made.
bharat_connect.business.register	Triggered when the Register Business API call is successfully made.
bharat_connect.business.details	Triggered when the Fetch Business Details API call is successfully made.

Sample Payload

Check Business

Triggered when the Check Business API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.business.check",
    "is_sandbox": true,
    "data": {
        "id": "bcbc_k3pbaALyh1CmzTPTOToHywYey",
        "object": "bharat_connect.business.check",
        "businesses": [
            {
                "status": "EXISTING", //EXISTING,NEW
                "name": "Business Name",
                "b2b_ids": [
                    "zw_b2bid_1730970483a8b539acf65f1279026529",
                    "zw_b2bid_1730970483a8b539acf65f1211232123"
                ],
              "bbps_business_object_id":"ORG1730970483a8b539acf65f3859174743",
              "ai_org_connection": "" //YES,NO
            }
        ]
    }
}

Register Business

Triggered when the Register Business API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.business.register",
    "is_sandbox": true,
    "data": {
	{
    "id": "bhb_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.business",
    "b2b_id": "zwch_4234233551",
    "name": "Business Name",
    "mobile_number": "9876543210",
    "email": "[email protected]",
    "phone": "9888763451",
    "kyc": {
        "city": "Bangalore",
        "postal_code": "560005",
        "state_code": "KA",
        "pan": "ABCTY1239H",
        "company_name": "ZXC Tech",
        "contact_person": "Rahul Reddy",
        "mcc_code": "4112",
        "business_type": "partnership",
        "primary_business_identifier": {
            "type": "GST",
            "reference_number": "22AAAAA0000A1Y7",
            "registered_name": "ZXC Tech"
        },
        "other_business_identifiers": [
            {
                "type": "",
                "reference_number": "",
                "registered_name": ""
            }
        ],
	  "status":""
    },
    "documents": [
        {
            "type": "customer_photo",
            "id": "doc_69ec2a9d8dbaf5ea1bc"
        },
        {
            "id": "doc_Ix0xZ13phVqfcwwpvPmQi3122",
            "type": "shop_and_establishment_license",
            "reference_number": "910192182120",
            "date_of_issue": "2016-12-18"
        },
        {
            "type": "customer_signature",
            "id": "doc_9c4O9c5DJQ3lie3SADVAHWFDT"
        }
    ],
    "addresses": [
        {
            "type": "OTHER",
            "address": "sarjapur",
            "city": "Bengaluru",
            "postal_code": "560010",
            "state_code": "KA",
            "state": "KARNATAKA"
        }
    ],
    "bank_details": [
        {
            "vpa": "test@vpa",
            "account_type": "SAVINGS",
            "bank_account_number": "67334963307",
            "name_of_account_holder": "Rahul Reddy",
            "bank_ifsc_code": "SBIN0070305",
            "bank_name": "abcd"
        }
    ],
    "status":"ACTIVE",
    "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
    },
    "response": {
        "status": "", //get from bbps resp
        "message": ""
    }
}

    }
}

Fetch Business Details

Triggered when the Fetch Business Details API call is successfully made.

{
    "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
    "object": "event",
    "name": "bharat_connect.business.details",
    "is_sandbox": true,
    "data": {
	{
    "id": "bcbd_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.business.details",
    "name": "Business Name",
    "mobile_number": "9876543210",
    "email": "[email protected]",
    "phone": "",
    "bbps_business_id": "ORG1731304320a8b539acf65f5629622526",
    "b2b_id": "zwch_1731304320a8b539acf65f1337854926",
    "b2b_id_details": [
        {
            "b2b_id": "zwch_qwerty12341",
            "status": "ACTIVE",
            "private": true,
            "bank_account": null,
            "business_identifier": {
                "document_name": "GSTIN",
                "registered_name": "ZXC Tech",
                "value": "22AAAAA0001A3Z9"
            }
        },
        {
            "b2b_id": "zwch_1731414335a8b539acf65f0982718126",
            "status": "ACTIVE",
            "private": true,
            "bank_account": null,
            "business_identifier": {
                "document_name": "GSTIN",
                "registered_name": "ZXC Tech",
                "value": "22AAAAA0001A3Z9"
            }
        }
    ],
    "kyc": {
        "city": "Bangalore",
        "postal_code": "560005",
        "state_code": "",
        "pan": "ABCTY1239H",
        "company_name": "ZXC Tech",
        "contact_person": "",
        "mcc_code": "4112",
        "primary_business_identifier": {
            "type": "GST",
            "reference_number": "22AAAAA0000A1Y7",
            "registered_name": "ZXC Tech"
        },
        "other_business_identifiers": [
            {
                "type": "",
                "reference_number": "",
                "registered_name": ""
            }
        ]
    },
    "addresses": [
        {
            "address_line1": "sarjapur",
            "address_line2": "",
            "city": "Bengaluru",
            "country": "INDIA",
            "pincode": "560010",
            "state": "KARNATAKA",
            "type": "OTHER"
        }
    ],
    "bank_accounts": [
        {
            "ac_num": "67334963307",
            "beneficiary_name": "Rahul Reddy",
            "business_vpa": "test@vpa",
            "ifsc": "SBIN0070305",
            "type": "SAVINGS"
        }
    ],
    "response": {
        "status": "",
        "message": ""
    }
}

    }
}