GuidesAPI ReferenceChangelog
API Reference

Onboarding Webhooks

Real-time notifications for business sub-account onboarding events.

Onboarding webhooks deliver real-time notifications of state changes in a business sub-account throughout the onboarding lifecycle — including compliance approval, rejection, and Requests for Information (RFI). Use these events to drive integration logic without polling.

See the Business Onboarding Overview for how webhooks fit into the end-to-end onboarding flow.

Events

EventDescription
account.business.readyThe business sub-account has passed compliance review and is ready for use.
account.business.rejectedThe business sub-account has been rejected during compliance review and cannot be activated.
account.business.under_reviewThe business sub-account is under manual compliance review.
account.business.rfiCompliance review has identified issues that require partner action before the account can proceed.

account.business.ready

Fired when a business sub-account passes compliance review and becomes ready for use.

Payload

FieldTypeDescription
event_namestringAlways account.business.ready.
data.account_idstringPublic account id of the business sub-account (e.g. BZ-ABCD-1234).
data.statusstringAccount status. Always APPROVED for this event.
resource.idstringPublic account id of the business sub-account.
resource.typestringResource type. Always business_account for this event.

account.business.rejected

Fired when a business sub-account is rejected during compliance review.

Payload

FieldTypeDescription
event_namestringAlways account.business.rejected.
data.account_idstringPublic account id of the business sub-account (e.g. BZ-ABCD-1234).
data.statusstringAccount status. Always REJECTED for this event.
resource.idstringPublic account id of the business sub-account.
resource.typestringResource type. Always business_account for this event.

account.business.under_review

Fired when a business sub-account moves into manual compliance review.

Payload

FieldTypeDescription
event_namestringAlways account.business.under_review.
data.account_idstringPublic account id of the business sub-account (e.g. BZ-ABCD-1234).
data.statusstringAccount status. Always UNDER_REVIEW for this event.
resource.idstringPublic account id of the business sub-account.
resource.typestringResource type. Always business_account for this event.

account.business.rfi

Fired when compliance review identifies one or more issues that require partner action before the sub-account can proceed. See RFI Handling for the response flow.

Payload

FieldTypeDescription
event_namestringAlways account.business.rfi.
data.account_idstringPublic account id of the business sub-account (e.g. BZ-ABCD-1234).
data.statusstringAccount status. Always ACTION_REQUIRED for this event.
data.errorsarray of ErrorList of errors identified during review. Each error describes a problem and the affected entity or document.
resource.idstring (UUID)Identifier of the RFI snapshot. Stable per snapshot — use it to dedup retries of the same RFI delivery.
resource.typestringResource type. Always account_rfi for this event.

Error object

FieldTypeDescription
typestring (optional)Machine-readable issue type or code, when available (e.g., FIELD_VALIDATION, DOCUMENT_MISSING, or a compliance review code).
descriptionstringHuman-readable description of the issue.
targetTargetThe entity, field, or document the issue applies to.

Target object

FieldTypeDescription
scopestringEntity scope the issue applies to: BUSINESS, CONTROLLER, or INTERMEDIARY.
dataTargetData objectDetails identifying the affected entity, field, or document.

TargetData object

Only fields relevant to the issue are included.

FieldTypeDescription
account_idstringPublic account id of the business sub-account. Present when scope is BUSINESS.
controller_idstringIdentifier of the controller. Present when scope is CONTROLLER.
intermediary_idstringIdentifier of the intermediary entity. Present when scope is INTERMEDIARY.
propertystringField path the issue applies to, when the issue is field-specific.
document_typestringDocument type the issue applies to, in SCREAMING_SNAKE_CASE (e.g. ID_FRONT, POA, CERT_OF_INC).