Event notification
The platform delivers events to your registered webhook endpoint using a shared envelope:
id, created_at, type, reason, and a related_object you can fetch for the detail.
The type field identifies the event. The events documented here are the Account
Information Service’s ais.* events, sent when an account-check session reaches a terminal
state:
- On
ais.completed,related_objectreferences the account information record — fetch it with Get account information. - On a failure event,
related_objectreferences the session.
Every delivery is signed with x-hmac-signature (HMAC-SHA256 over the raw body, keyed by
your signing_secret); verify it before trusting the payload.
Headers
HMAC-SHA256 of the raw request body, keyed by your signing_secret.
Body
The platform event envelope: a minimal event referencing the resource it concerns. Branch on type; fetch the referenced resource via related_object.url when you need the detail.
The unique identifier for the event.
"f1e2d3c4-b5a6-4978-8a1b-2c3d4e5f6a7b"
When the event was created.
"2026-06-22T09:59:56Z"
The event type. The platform namespaces event types by service; the values below are the Account Information Service events.
ais.completed, ais.user_cancelled, ais.authentication_error, ais.technical_error A human-readable description of why the event was triggered.
"The account check completed successfully."
Response
Return any 2xx to acknowledge receipt. Non-2xx responses are retried with backoff.