Accounts
Onboarding notifications
The structure of the JSON payload for all events adheres strictly to the schema of the standard GET endpoint response.
Types of notifications
| Notification Type | Description | X-volt-type Header Value |
|---|---|---|
| Onboarding Ready for Review | The onboarding process is ready for submission. | onboarding_ready_for_review |
| Onboarding Additional Info Required | Additional info or documents are required. | onboarding_additional_info_required |
| Onboarding Rejected | The onboarding process was rejected. | onboarding_rejected |
| Onboarding Expired | The onboarding process has expired. | onboarding_expired |
| Onboarding Approved | The onboarding process was successfully approved. | onboarding_approved |
| Named Account Request Completed | Request to open a named account completed. | named_account_order_completed |
| Named Account Request Failed | Request to open a named account failed. | named_account_order_failed |
Configuration and overrides
Notification configuration is managed in Fuzebox settings. For individual requests the URL can be overridden by passing a communication field in the request:
{
"communication": {
"notifications": {
"url": "https://mywebsite.com/webhooks"
}
}
}Onboarding Fields
Prop
Type
Rejected onboarding example
{
"id": "43ebfac8-a569-49b1-9bfc-775182b5f369",
"status": "REJECTED",
"statusReason": "Onboarding rejected for testing",
"createdAt": "2026-01-27T15:17:09.138162+01:00",
"updatedAt": "2026-01-27T15:17:11.150896+01:00",
"completedAt": "2026-01-27T15:17:11.150896+01:00"
}Completed onboarding example
{
"id": "c651bd3e-5923-46d9-a6c5-c7c2a4dd0a79",
"onboardingEntityId": "8687c787-8fb7-4f90-aaa1-b1cce88fe713",
"accountId": "83cfd2e8-606d-4f3d-b3b2-cc1bd5e55acd",
"status": "COMPLETED",
"createdAt": "2026-01-28T18:07:00.825742Z",
"completedAt": "2026-01-28T18:07:08.104358359Z"
}Named Account Request Completed example
{
"id": "f8f934fc-190d-4cb1-b626-6e0996547f65",
"onboardingEntityId": "8687c787-8fb7-4f90-aaa1-b1cce88fe713",
"accountId": "afd446d3-4a9e-4787-8a1d-e6d400c7c725",
"status": "COMPLETED",
"createdAt": "2026-01-28T18:01:40.621809Z",
"completedAt": "2026-01-28T18:02:08.052089072Z"
}Named Account Fields
Prop
Type
Named Account Request Failed example
{
"id": "096bd8d0-1b46-4e37-82cd-d0ce2a2b9b44",
"onboardingEntityId": "8687c787-8fb7-4f90-aaa1-b1cce88fe713",
"status": "FAILED",
"statusReason": "Named account order failed due to sandbox scenario",
"createdAt": "2026-01-28T18:03:06.242767Z",
"completedAt": "2026-01-28T18:03:07.956976154Z"
}Additional Info Required onboarding example
{
"id": "60290bb9-71e6-400a-a4b3-2d9789e681fa",
"status": "ADDITIONAL_INFO_REQUIRED",
"statusReason": "Additional information required for testing",
"createdAt": "2026-01-28T18:49:49.52091Z",
"updatedAt": "2026-01-28T18:49:51.624262789Z"
}How is this guide?
Last updated on