Webhooks Introduction

In Smart KYC, you can register a webhook URL to receive real-time events from the platform.

Overview

Webhooks allow you to receive instant notifications when important events occur in your KYC workflows, such as when an application is approved or rejected. This enables you to build real-time integrations and automate your workflows.

Configuration

Your webhook endpoint should:

Accept POST requests
Accept application/json content type
Return a 2xx status code to acknowledge receipt

Headers

Smart KYC will send the following headers with each webhook request:

x-smart-kyc-api-key: Your API key for verification
Any custom headers you register alongside your webhook URL

Security

Always verify the x-smart-kyc-api-key header to ensure the request is coming from Smart KYC. This helps prevent unauthorized access to your webhook endpoint.

Events

Smart KYC sends the following types of events:

TEST: Test event to verify your webhook is working
KYC_APPLICATION_APPROVED: Sent when a KYC application is approved

For detailed information about each event type, see the event-specific documentation.

Best Practices

Idempotency: Handle duplicate events gracefully using the event IDs
Retry Logic: Implement retry logic for failed webhook deliveries
Logging: Log all webhook events for debugging and auditing
Verification: Always verify the API key header before processing events