The Notifications API enables you to receive real-time updates about compliance-related events via webhooks. It allows businesses to stay informed as verification statuses change, features are enabled, or requirements are updated. This system is critical for maintaining a smooth and automated onboarding or monitoring flow.
Endpoints
| Method | URL | Description |
|---|---|---|
| POST | /notification | Create webhook |
| GET | /notification | List webhooks |
| GET | /notification/{id} | Get webhook details |
| PUT | /notification/{id} | Update webhook |
| DELETE | /notification/{id} | Delete webhook |
Payload Snapshot
Key fields in the webhook JSON:
data.entityId(string, UUID)data.status(APPROVED|PENDING|REJECTED)data.message(string)data.moderationComment,data.reviewRejectType,data.rejectLabels(optional on rejection)data.timestamp(ISO 8601)
For full payload schema, examples, and implementation guidance, see:
Webhook Notifications
Quick Tips
- Use HTTPS and verify
reap-signature(RSA‑SHA512). - Respond with
200 OKwithin 5 seconds. - Limit: up to 10 webhooks per business.
- Failed deliveries retry with exponential backoff.