User Updates Notifications

Webhook

POST

user-update

This webhook is designed to communicate various user-related actions — such as verification, blacklisting, or inactivation — which are conducted by a third-party service. When the third-party service completes an action, the webhook instantly relays the outcome:

Verification: It notifies whether the user's verification process has succeeded or failed after analysing the provided documents.

Blacklisting: Deprecated It alerts when a user has been added to or updated on the blacklist, usually due to breaching terms of service or other predefined criteria.

Inactivation: It sends a notification if a user's account has been deactivated, which may occur for various reasons.

By subscribing to this webhook, partners can ensure they are immediately informed of critical updates to user status, enabling prompt and appropriate responses within their systems.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

Return a 200, 201, 202 or 204 status to indicate that the data was received successfully

This response does not have a body.

Request Example

Shell

JavaScript

Java

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": {
        "action": "verification",
        "success": true,
        "user_pid": "abcd1234-12ab-ab12-abcdef123456",
        "timestamp": 1646154525
    }
}'

Modified at 2026-06-01 11:50:45

Setting up Webhooks

Corporate Actions Notifications