Webhooks - Brached

Webhooks allow Brached to push real-time notifications to your server when events occur, such as a verification check being completed or a suspicious transaction being flagged.

Configuring Webhooks

You can configure your webhook URL and the events you want to subscribe to in your SDK Application settings.

Receiving a Webhook

Brached sends a POST request to your configured URL with a JSON payload.

Payload Structure

{
  "event": "check.completed",
  "timestamp": "2024-05-31T23:32:00Z",
  "data": {
    "checkId": "uuid-v4",
    "status": "APPROVED",
    "type": "KYC"
  }
}

Security

We recommend verifying the webhook signature to ensure the request originated from Brached.