{
"kyc_updated": {
"customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"walletPublicKey": "9Qx7rGN1kP2mL3nO4pQ5sR6tU7vW8xY9zA0bC1dE2fG",
"approved": false,
"updateReason": "ID document is expired",
"needsWork": true,
"userMessage": "Please upload a current government-issued ID."
}
}Kyc updated
Fired whenever a customer’s KYC status changes, and when a write you sent was accepted but could not be applied.
The status field is one of not_started, in_progress, submitted, approved, denied (see the payload schema); approved: bool is kept for back-compat. KYC is org-level, so customerId is the identifier to key on and walletPublicKey is best-effort and may be empty.
On a denial, updateReason and userMessage explain what needs to be corrected. When needsWork is true, the customer can resubmit without creating a new KYC request.
needsWork also arrives without a status change, when one of the verification endpoints answered 202 and the work then failed. status is the customer’s current status, unchanged, and userMessage names what to send again. See KYC API error handling.
{
"kyc_updated": {
"customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"walletPublicKey": "9Qx7rGN1kP2mL3nO4pQ5sR6tU7vW8xY9zA0bC1dE2fG",
"approved": false,
"updateReason": "ID document is expired",
"needsWork": true,
"userMessage": "Please upload a current government-issued ID."
}
}Authorizations
API key sent in the Authorization header.
Headers
HMAC-SHA256 signature: sha256={hex}. Computed over the canonicalized (RFC 8785) request body using your webhook secret.
Body
Webhook envelope for KYC review decisions.
Payload for kyc_updated webhooks.
Show child attributes
Show child attributes
{
"customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"walletPublicKey": "9Qx7rGN1kP2mL3nO4pQ5sR6tU7vW8xY9zA0bC1dE2fG",
"status": "approved",
"approved": true,
"updateReason": null,
"needsWork": null,
"userMessage": null
}
Response
Return any 2xx to acknowledge receipt.