Skip to main content

​
KYC Webhook

For each KYC status change, a webhook will be sent for the following statuses:

​
Status Table

STATUS IDSTATUS NAME
1Awaiting Upload Documents
2Awaiting Approval Documents
3Approved
4Pending Regularization
5Canceled
The callback URL used is the same for all KYC processes. To configure a new callback URL, you need to contact the Customer Experience team.

​
Example Payload

The webhook payload contains information about the KYC status change: 
{
  "entity": "KYC",
  "id": 1670,
  "merchant_id": 516,
  "status": {
    "id": 1,
    "name": "Awaiting Upload Documents"
  },
  "metadata": {
    "blocked_person": {
      "name": "Test Kyc",
      "document": "99999919999979"
    }
  },
  "updated_at": "2025-07-13T14:00:13.6090002"
}

​
Example Headers

The webhook request includes the following headers: 
{
  "Accept": "application/json",
  "Content-type": "application/json",
  "User-Agent": "WEPayments"
}

​
Field Types

​
id
integer
Unique identifier for the KYC record.
​
merchant_id
integer
Merchant identifier associated with the KYC.
​
status
object
Object containing the current status of the KYC.
​
metadata
object
Additional metadata about the KYC process.
​
updated_at
string
Timestamp of when the KYC status was updated.Format: <date-time>

​
Webhook Status Flow

List KYC

List all KYC verifications

Get KYC By ID

Get KYC by ID

Get KYC By Document

Get KYC by document

Webhooks Guide

Learn about webhooks