Webhook Events
Detailed onboarding-specific payload guidance is documented separately for Business Onboarding Webhooks and Individual Onboarding Webhooks. RFI event payloads are documented in RFI Webhooks and Recipient RFI Webhooks.
| Category | Event Name | Description |
|---|---|---|
| Business Onboarding | account.business.ready | The business sub-account has passed compliance review and is ready for use. |
account.business.rejected | The business sub-account has been rejected during compliance review and cannot be activated. | |
account.business.under_review | The business sub-account is under manual compliance review. | |
account.business.rfi | Compliance review has identified issues that require partner action before the account can proceed. | |
| Individual Onboarding | account.individual.ready | The individual account has passed review and is ready for use. |
account.individual.rejected | The individual account has been rejected during review and cannot be activated. | |
account.individual.under_review | The individual account is under manual compliance review. | |
account.individual.rfi | Review has identified issues that require partner action before the account can proceed. | |
account.individual.reviewed | The individual account's reviewed tier or limits have changed. | |
| Deposits | deposit.pending | Deposit transaction is pending |
deposit.completed | Deposit successfully credited to account | |
deposit.failed | Deposit transaction failed | |
deposit.reversed | Returned withdrawal funds credited to account | |
| Crypto Deposit Address | deposit_instruction.ready | Deposit wallet address provisioned and ready for use |
| Withdrawals | withdrawal.completed | Withdrawal successfully processed |
withdrawal.failed | Withdrawal transaction failed | |
withdrawal.returned | Withdrawal was returned by the receiving bank | |
| Internal Transfers | transfer.completed | Internal transfer completed successfully |
| Recipients | recipient.approved | Recipient has been approved by compliance review |
recipient.rejected | Recipient has been rejected by compliance review | |
| RFI | rfi.transaction.action_required | A transaction RFI case needs a new or corrected response |
rfi.transaction.answered | Everything requested in the current round of a transaction RFI case was received | |
rfi.transaction.rejected | A transaction RFI case was rejected | |
rfi.transaction.closed | A transaction RFI case was closed after review | |
rfi.recipient.action_required | A recipient RFI case needs a new or corrected response | |
rfi.recipient.answered | Everything requested in the current round of a recipient RFI case was received | |
rfi.recipient.rejected | A recipient RFI case was rejected | |
rfi.recipient.closed | A recipient RFI case was closed after review | |
| External Accounts | external_account.approved | External account verified and approved |
external_account.failed | External account verification failed | |
| Conversions | conversion.completed | Conversion executed successfully |
conversion.failed | Conversion transaction failed | |
| Auto-Conversion Rules | auto_conversion_rule.create | Auto-conversion rule creation result (SUCCESS or FAILED) |
auto_conversion_rule_order.completed | Full conversion flow completed | |
auto_conversion_rule_order.deposit_failed | Failed at deposit stage | |
auto_conversion_rule_order.conversion_failed | Failed at conversion stage | |
auto_conversion_rule_order.withdrawal_failed | Failed at withdrawal stage |
Payload Structure
All webhook payloads follow this structure:
{
"event_name": "event.type",
"resource": {
"type": "resource_type",
"id": "resource_id",
"idempotency_key": "client_passed_idempotency_key"
},
"data": {
// Event-specific data
}
}