KYC Webhook

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

Status Table

STATUS ID	STATUS NAME
1	Awaiting Upload Documents
2	Awaiting Approval Documents
3	Approved
4	Pending Regularization
5	Canceled

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

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.

Show Status Object

integer

Status identifier.Possible values: 1, 2, 3, 4, 5

name

string

Name of the status.Possible values: Awaiting Upload Documents, Awaiting Approval Documents, Approved, Pending Regularization, Canceled

metadata

object

Additional metadata about the KYC process.

Show Metadata Object

blocked_person

object

Information about the person or entity in the KYC process.

Show Blocked Person Object

name

string

Name of the person or entity.

document

string

Document number (CPF or CNPJ).

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

Account

Banks

Payin

Payout

KYC

Markup

KYC Webhook

KYC Webhook

Status Table

Example Payload

Example Headers

Field Types

Webhook Status Flow

List KYC

Get KYC By ID

Get KYC By Document

Webhooks Guide

​KYC Webhook

​Status Table

​Example Payload

​Example Headers

​Field Types

​Webhook Status Flow

​Related Resources

List KYC

Get KYC By ID

Get KYC By Document

Webhooks Guide

KYC Webhook

Status Table

Example Payload

Example Headers

Field Types

Webhook Status Flow

Related Resources