Skip to main content
Private preview Working end to end for the accounts that use it; details can still change. Tell us at contact@agentaos.ai before you rely on it, and we support you directly. See Product release phases.
As a platform you do not set up a webhook for each client. Your own webhook endpoint also receives every event of every business you manage, signed with your own signing secret. It works in test mode too. account.updated is always a live event (livemode: true), because it is about your client’s real verification. It still reaches your endpoint while you build in test mode, because an account has one webhook endpoint. Set your endpoint once, as any account does: see Webhooks.

Which business an event is from

Every event carries business: the id of the business it happened in.
  • An event from your own sales carries your own id.
  • An event from a client’s sale carries that client’s business id.
Route on business to the right client in your own system. Store our business id on your side when you create the business; it is the only link between the two. If the client has its own webhook URL, it still gets its own copy, signed with its own secret. Yours is separate.

When a client’s verification changes

account.updated fires when a business’s verification changes: its identity check lands (verified, or declined), or our reviewers approve, reject, hold or resume it, or ask for changes.
string
unverified, in_review, verified, on_hold or rejected.
boolean
We asked the business for a change and are waiting on it.
boolean
The identity check is done. For another app of your own company, this is your company’s check.
boolean
Always true: verification is about live money.
A typical use: when identity_verified turns true, stop reminding your client to complete the identity check. To read the current state at any time, call businesses.retrieve(id) and look at status and identityVerified. Business status shows how verification matches status and the status in the dashboard.

Next steps

Events

Every event and its fields.

Verify signatures

Check each delivery before you trust it.