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 webhook events triggered when creating and managing an in-person KYC verification request.

Webhook Events	Description
accounts.schedule_kyc.created	Triggered when the Schedule KYC API call is successfully made. This verification request can either be in the `success` or `failed` status. If the request goes to the `failed` status, a new request must be created.
accounts.schedule_kyc.updated	Triggered when the in-person KYC request: Undergoes a status change. Is rescheduled.

Sample Payloads

Accounts Schedule KYC Created

Triggered when the Schedule KYC API call is successfully made.

This verification request can either be in the success or failed status.

{
"id": "evl_zLT98mTVumLQz332x65u1tk2oefdgh",
    "object": "event",
    "name": "accounts.scheduled_kyc.created",
    "is_sandbox": true,
    "data": {
        "object": {
  "id": "fkyc_zLT98mTVumLQz332x65u1tk2o",
  "object": "schedule_kyc",
  "awb_number": "2364206548",
  "time_slot": "8am_to_12pm",
  "date": "2022-06-25",
  "merchant_reference_id": "141978910cvse0",
  "metadata": {
    "Key_1": "DD",
    "Key_2": "XOF"
  "status": "scheduled",
  "accounts_id": "sa_5Tv0bbFHRAhrqjOkrjMGfGfsI",
  "created_at": 1655800219,
  "is_sandbox": true
        }
    }
}

Accounts Schedule KYC Updated

Triggered when the in-person KYC verification request:

Undergoes a status change.
Is rescheduled.

{
"id": "evl_zLT98mTVumLQz332x65u1tk2oefdgh",
    "object": "event",
    "name": "accounts.scheduled_kyc.updated",
    "is_sandbox": true,
    "data": {
        "object": {
  "id": "fkyc_zLT98mTVumLQz332x65u1tk2o",
  "object": "schedule_kyc",
  "awb_number": "2364206548",
  "time_slot": "8am_to_12pm",
  "date": "2022-06-25",
  "merchant_reference_id": "141978910cvse0",
  "metadata": {
    "Key_1": "DD",
    "Key_2": "XOF"
  },
  "status": "cancelled",
  "accounts_id": "sa_5Tv0bbFHRAhrqjOkrjMGfGfsI",
  "created_at": 1655800219,
  "is_sandbox": true
       }
    }
}