KYC Refresh Notification
Webhook
POSTkyc-refresh
It covers two distinct event types:
reminder — sent at scheduled milestones before and after the refresh due date to prompt partner action. Multiple reminders are sent throughout the cycle window.status_update — sent when the refresh cycle is marked complete (all pending actions resolved).Reminder schedule
kyc_refresh_period_end (T):| Risk level | Offsets |
|---|---|
| RL1 / RL2 | T-90, T-75, T-60, T-30, T-0, T+15, T+30, T+60 |
| RL3 | T-60, T-50, T-40, T-30, T-0, T+5, T+10, T+30 |
Pending actions
pending_actions array lists what the user must still complete:personal_data — required PII fields (name, date of birth, address, place of birth) are missing or incomplete.aml_questionnaire — the user's Anti-Money Laundering questionnaire answers are stale for the current refresh cycle.[]) means the user is already compliant; the notification is informational only (e.g., a completion status_update).Statuses
in-progress — refresh cycle is open; the deadline has not yet passed.pending — the deadline has passed but the cycle is not yet complete.up-to-date — all pending actions have been resolved; the cycle is complete.Partner responsibilities
reminder, partners should update user PII date.status_update with status: up-to-date, partners can unlock any previously restricted functionality for the user.Examples
1. Reminder — personal data missing (before deadline)
{
"params": {
"event_type": "reminder",
"user_id": "408d0ea8-cef2-46a8-84f7-2736b17dc983",
"status": "in-progress",
"kyc_refresh_period_end": "2026-12-06",
"pending_actions": ["personal_data"],
"time": "2026-09-06T10:00:00Z"
}
}2. Reminder — both personal data and AML questionnaire missing (at deadline)
{
"params": {
"event_type": "reminder",
"user_id": "408d0ea8-cef2-46a8-84f7-2736b17dc983",
"status": "pending",
"kyc_refresh_period_end": "2026-12-06",
"pending_actions": ["personal_data", "aml_questionnaire"],
"time": "2026-12-06T10:00:00Z"
}
}3. Status update — refresh cycle complete
{
"params": {
"event_type": "status_update",
"user_id": "408d0ea8-cef2-46a8-84f7-2736b17dc983",
"status": "up-to-date",
"kyc_refresh_period_end": "2027-12-06",
"pending_actions": [],
"time": "2026-12-10T14:40:27Z"
}
}Request
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Go
curl --location 'https://your-api-server.com' \
--header 'X-BTS-Idempotency-Key;' \
--header 'Signature;' \
--header 'Content-Digest;' \
--header 'Date;' \
--header 'Content-Type: application/json' \
--data '{
"params": {
"event_type": "reminder",
"user_id": "408d0ea8-cef2-46a8-84f7-2736b17dc983",
"status": "in-progress",
"kyc_refresh_period_end": "2026-09-10",
"pending_actions": [
"personal_data"
],
"time": "2026-09-10T14:40:27Z"
}
}'Modified at 2026-10-21 09:51:37