Skip to main content
Customer webhook events are in preview as part of USD Virtual Accounts.
Customer webhooks notify your server when Yara creates a customer or applies a verification state. Configure and filter webhook endpoints from the Webhooks page in the dashboard.

Events

Every accepted verification request creates customer.verification.submitted. If processing returns a terminal or information-requested state immediately, Yara also creates the corresponding state event. When a pending submission reaches a terminal state later, Yara sends the terminal event after it applies that state.

Payload

Customer events contain stable Yara IDs and normalized state. They do not contain names, email addresses, BVNs, government identification numbers, documents, image data, or internal provider identifiers. A rejected event may include the safe rejection_reasons also available from the authorized verification read endpoint.

Handle deliveries safely

  • Verify the X-Yara-Signature against the raw request body before parsing the payload.
  • Return a 2xx quickly and process the event asynchronously.
  • De-duplicate deliveries using the top-level event id.
  • Fetch the customer or submission if you need the latest state after receiving an event.
See the general webhook guide for endpoint setup, signature verification, delivery history, and retry behavior.