Account onboarding
Audience: partners integrating with our push notification service.
Scope: events whose
eventvalue starts withv1.onboarding.account.*Version: 1.0
1. Overview
Account onboarding allows you to create a new account and submit related details and documents to complete onboarding of the account. An account cannot transact until onboarding has successfully completed. Whenever an account is created or moves through the onboarding lifecycle, we emit a webhook so your system can react in real‑time (update UI, trigger fulfilment, etc.).
2. Event catalogue
| Event | When it triggers |
|---|---|
v1.onboarding.account.created | On successful creation of new account. |
v1.onboarding.account.signed_up | On acceptance of account sign-up details. |
v1.onboarding.account.rejected | On rejection of account sign-up details or documentation. |
v1.onboarding.account.submitted | On submission of account sign-up details (incl. documentation) for review and decision. |
v1.onboarding.account.approved | On approval of account sign-up details (incl. documentation). |
v1.onboarding.account.onboarded | The account is fully onboarded and able to transact. |