List of subscribing events
| Event | Description |
|---|---|
* | Subscribe to all available event types. Harbor will send every event notification supported by the system. |
customer.* | Subscribe to all customer-related events. |
customer.agreement.accepted | Fired when a customer has successfully signed and accepted the required terms or service agreement. |
customer.kyc.verifying | The customer has submitted KYC information and verification is in progress. |
customer.kyc.verified | The customer’s KYC verification has been successfully completed and approved. |
customer.kyc.revoked | The customer’s previously verified KYC status has been revoked (e.g., expired documents or compliance review). |
customer.kyc.rejected | The KYC verification was rejected due to invalid or incomplete information. |
customer.kyc.declined | The KYC application was declined manually or by compliance review; the user cannot proceed. |
customer_onboarding.* | Subscribe to all customer onboarding-related events (direct API integration). |
customer_onboarding.submitted | Fired when the onboarding payload has been successfully submitted to the compliance provider for verification. |
customer_onboarding.action_required | Fired when the onboarding requires attention or corrections (requires PATCH to resolve). |
customer_onboarding.verified | Fired when the onboarding verification is approved (customer is KYC/KYB verified). |
customer_onboarding.rejected | Fired when the onboarding verification is permanently rejected. |
customer_onboarding.failed | Fired when the onboarding verification fails due to a systemic compliance provider error. |
deposit_account.* | Subscribe to all virtual deposit account-related events. |
deposit_account.activated | Fired when the customer's virtual deposit account has been successfully provisioned and activated; deposit instructions (e.g., account number) are now available. |
deposit_account.failed | Fired when the provisioning of the customer's virtual deposit account has failed. |
deposit_account.disabled | Fired when a customer's virtual deposit account is closed/disabled. |
transfer.* | Subscribe to all transfer-related events. |
transfer.deposit.created | Fired when an inbound deposit is received by a customer's deposit account, and a corresponding ON_RAMP transfer is successfully created in Harbor. Subsequent status updates will follow the standard transfer.status.* events. |
transfer.status.completed | The transfer has been successfully completed and funds are settled. |
transfer.status.expired | The transfer request has expired because it was not completed within the allowed time frame. |
transfer.status.on_hold | The transfer is temporarily placed on hold (e.g., under compliance review or awaiting manual approval). |
transfer.status.pending_harbor | The transfer is pending settlement or confirmation by Harbor. |
transfer.status.rejected | The transfer has been rejected (for example, due to invalid recipient details or compliance failure). |
wallet.* | Subscribe to all wallet-related events. |
wallet.balance.updated | When there are any changes in the wallet balance. |
Updated about 1 month ago
Did this page help you?