Skip to Content
MYIDIIDocs

Webhook events

Every event MYIDII sends, and what's inside.

Every event has the same envelope:

{
  "id": "evt_...",
  "object": "event",
  "type": "session.completed",
  "environment": "live",
  "created_at": "2026-11-16T20:16:37.000Z",
  "data": { }
}

Requests carry two headers: MYIDII-Signature, to verify, and MYIDII-Delivery, a unique id for that delivery.

EventWhendata
session.completedA check is decided, passed or failedThe session object
session.expiredA link ran out before the scan finishedThe session object
wallet.low_balanceA live check took the balance below your warning levelcurrency, balance (in cents)
wallet.topped_upA top-up was paidamount, currency, balance (in cents)
webhook.testYou chose Send test in the dashboardA short message

Wallet events are sent to live endpoints only.