User KYC updated

Fired when the KYC verification status of a user changes, including endorsement and capability updates.

WEBHOOK user.kyc.updated

user-kyc-updated

{
  "type": "user.kyc.updated",
  "event_id": "evt_lxfhnkpoa4bz7kqdy6c6vcyc",
  "user_id": "did:privy:cfbsvtqo2c22202mo08847jdux2z",
  "provider": "bridge",
  "environment": "sandbox",
  "data": {
    "status": "approved",
    "tos": {
      "status": "approved"
    },
    "kyc": {
      "status": "approved"
    },
    "endorsements": [],
    "capabilities": {
      "payin_crypto": "enabled",
      "payout_crypto": "enabled",
      "payin_fiat": "enabled",
      "payout_fiat": "enabled"
    },
    "stripe_cardholder_id": "ich_1Nxxx"
  },
  "changes": {}
}

Body

application/json

type · enum<string> · required

The type of webhook event.

Available options: user.kyc.updated

user_id · string · required

provider · enum<string> · required

KYC/KYB provider identifier.

Available options: bridge

environment · enum<string> · required

Provider environment (production or sandbox).

Available options: production, sandbox

data · UserKycUpdatedData · object · required

Full KYC state snapshot in a KYC update event.

Show child attributes

changes · object · required

Show child attributes

event_id · string · required

The ID of this event, stable across repeat deliveries so clients can deduplicate on it.

Response

200

Return a 200 status to indicate that the webhook was received successfully.