Onboarding
The structure of the JSON payload for all events adheres strictly to the schema of the standard GET endpoint response.
Named account provisioning notifications are documented under Account ordering.
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 |
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"
}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