1. User & KYC Webhooks
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Balances & Transaction History
        • Get Balances
        • Get Transaction History
        • Create Wallet
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • SEPA Transfers
        • Get SEPA Deposit Info
        • Get SEPA Deposit Contact List
        • Create a SEPA Transfer
        • Get SEPA Transfer Details
      • Crypto Withdrawal
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • Crypto Deposits
        • Update Travel Rule
      • Orders
        • Get Rates
        • Retrieve Order Rate and Create a Lock
        • Create and Finalize an Order
        • Get Order Details
      • Payment link & Checkout Link
        • Generate Payment Link
        • Generate Hosted Checkout
        • Get Payment Link Details
    • User Operations
      • Onboarding & KYC Flow
        • Create User Account
        • Method A: Add KYC File
        • Method B: Creating KYC Verification
        • Method B: Redirect to Verification
        • Method B: Get KYC Status
        • Add User Verification
        • Add POA File
      • Account Management
        • Update Existing User
        • Delete User
        • Suspend User
        • Unsuspend User
      • Balances & Transaction History
        • Get User Balances
        • Get User Transaction History
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • SEPA Transfers
        • Get SEPA Deposit Info
        • GET SEPA Deposit Contact List
        • Create a SEPA Transfer
        • Get SEPA Transfer Details
      • Crypto Withdrawal
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • Crypto Deposits
        • Update Travel Rule
      • Internal Transfers
        • Create a Transfer
        • Get Transfer Details
      • Virtual Cards
        • Create Virtual Card
        • Get All User Cards
        • Get Card Details
        • Update Card PIN
        • Block Card
        • Unblock Card
        • Get Card Limits
        • Update Card Limits
        • Delete Card
  • Integration
    • SDKs & Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • User & KYC Webhooks
        • User Balance Generation Webhook
        • KYC File Added Webhook
        • POA Verification Status Webhook
        • KYC Verification Status Webhook
        • Create Wallet Webhook
        • High Risk KYC Verification Webhook
      • Transfers & Payments Webhooks
        • Internal Transfer Webhook
        • IBAN Status Webhook
        • Partner SEPA Transfer Webhook
        • User SEPA Transfer Webhook
        • SEPA Deposit Webhook
        • Crypto Withdrawal Webhook
        • Crypto Deposit Webhook
        • Exchange Webhook
        • Card Transaction Webhook
        • Order Status Webhook
        • Payment Link Webhook
      • Card Webhooks
        • Card 3DS Code Webhook
        • Card Activation Code Webhook
  • Reference
    • Supported Countries
    • Supported Currencies
    • Fees
    • FAQ
    • Changelog
    • Support
  1. User & KYC Webhooks

User Balance Generation Webhook

Webhook
POST
user-status-webhook
This event is dispatched automatically once a user's onboarding and compliance flow has been successfully completed.
It serves as the final confirmation that the user has passed the required internal checks, including identity verification (KYC) and, where applicable, additional review steps such as Proof of Address (POA) verification.
Once this event is emitted, the user's balances are generated and activated for operational use. This includes both fiat and crypto balances, together with the deposit wallet configuration required for supported blockchain assets.

What This Webhook Confirms#

This webhook confirms that:
Verification is approved: The required onboarding and compliance checks have been completed successfully.
Fiat balances are active: The user can now hold and operate supported fiat balances.
Crypto balances are active: The user receives supported crypto balance entries together with network-level configuration.
Wallet configuration is available: Deposit wallet addresses for supported blockchain assets are available within the user's crypto balance structure.

Payload Meaning#

The payload represents the user's financial setup after successful activation.
Fiat Balances: Contains the list of available fiat balances assigned to the user together with their current status.
Crypto Balances: Contains the list of supported cryptocurrencies together with network configuration, including deposit and withdrawal parameters and the wallet addresses used for external deposits.
Current Response Shape
Based on the current balance structure, deposit wallet addresses are exposed inside cryptoBalances[].networkConfig, not as a single top-level wallet field.

Typical Use Cases#

Use this webhook to:
unlock product access after onboarding is complete,
confirm that the user is ready for deposits, exchanges, and withdrawals,
synchronize balance activation in your own system,
trigger follow-up actions such as welcome flows or funding instructions.

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://your-api-server.com' \
--header 'Content-Type: application/json' \
--data '{
    "externalUserId": "2e667284-6035-46f4-9c53-c096b7074a14",
    "balances": {
        "userId": "22486402-e477-4ce5-ab7b-3504ffacfd17",
        "fiatBalances": [
            {
                "id": "a85fd2c3-6ea1-4643-b1cf-fa95a9c7006a",
                "amount": "0.00",
                "name": "eur",
                "rate": 1,
                "status": "ACTIVE"
            }
        ],
        "cryptoBalances": [
            {
                "id": "ab7e771a-f0a5-475b-93d3-e250bb8c4931",
                "amount": "0.00000000",
                "name": "eth",
                "rate": 1355.47327624,
                "networkConfig": {
                    "ethereum": {
                        "wallet": "0x609855c00a45bb280d187716f17de76edfd4addf",
                        "mainnet": true,
                        "name": "mainnet",
                        "withdrawal": {
                            "feeWithdrawal": 0.001,
                            "minWithdrawal": 0.005
                        },
                        "deposit": {
                            "minDeposit": 0
                        }
                    }
                }
            },
            {
                "id": "4891edce-5cd4-4dab-a77e-a297c3fac063",
                "amount": "0.00000000",
                "name": "doge",
                "rate": 0.06450358,
                "networkConfig": {
                    "doge": {
                        "wallet": "DBiM8facdw5dpXHc2TyTQwZyrWX1RS1iX5",
                        "mainnet": true,
                        "name": "mainnet",
                        "withdrawal": {
                            "feeWithdrawal": 5,
                            "minWithdrawal": 10
                        },
                        "deposit": {
                            "minDeposit": 0
                        }
                    }
                }
            },
            {
                "id": "6db17497-fa84-42c4-8f9f-1905b8cc3d8e",
                "amount": "0.00000000",
                "name": "btc",
                "rate": 52057.43874043,
                "networkConfig": {
                    "btc": {
                        "wallet": "3PexthX1yQQd7vDPuRvorRJUmyqycTFiYR",
                        "mainnet": true,
                        "name": "mainnet",
                        "withdrawal": {
                            "feeWithdrawal": 0.0001,
                            "minWithdrawal": 0.00012
                        },
                        "deposit": {
                            "minDeposit": 0
                        }
                    }
                }
            },
            {
                "id": "e56c8b7f-e4cd-415c-892d-cb048631c2e0",
                "amount": "0.00000000",
                "name": "pol",
                "rate": 0.06304739,
                "networkConfig": {
                    "polygon": {
                        "wallet": "0x7da75946808e2633a2029bd19008df1dd4c21fd1",
                        "mainnet": true,
                        "name": "mainnet",
                        "withdrawal": {
                            "feeWithdrawal": 0.5,
                            "minWithdrawal": 2
                        },
                        "deposit": {
                            "minDeposit": 0
                        }
                    }
                }
            },
            {
                "id": "5910e7e1-9073-4c16-a102-1adfb4cb2b84",
                "amount": "0.00000000",
                "name": "ltc",
                "rate": 35.86699324,
                "networkConfig": {
                    "ltc": {
                        "wallet": "M8uHSHpUYYmHV2URJin1VcX5zEwiNdo8xf",
                        "mainnet": true,
                        "name": "mainnet",
                        "withdrawal": {
                            "feeWithdrawal": 0.002,
                            "minWithdrawal": 0.002
                        },
                        "deposit": {
                            "minDeposit": 0
                        }
                    }
                }
            },
            {
                "id": "ab20d01b-8679-421d-bac5-bdd9930827eb",
                "amount": "0.000000",
                "name": "eurc",
                "rate": 1.000425,
                "networkConfig": {
                    "ethereum": {
                        "wallet": "0x609855c00a45bb280d187716f17de76edfd4addf",
                        "mainnet": true,
                        "name": "mainnet",
                        "withdrawal": {
                            "feeWithdrawal": 4,
                            "minWithdrawal": 10
                        },
                        "deposit": {
                            "minDeposit": 5
                        }
                    }
                }
            },
            {
                "id": "f13237a4-313a-46c2-87c0-d5329c3fc028",
                "amount": "0.000000",
                "name": "usdc",
                "rate": 0.877004,
                "networkConfig": {
                    "ethereum": {
                        "wallet": "0x609855c00a45bb280d187716f17de76edfd4addf",
                        "mainnet": true,
                        "name": "mainnet",
                        "withdrawal": {
                            "feeWithdrawal": 4,
                            "minWithdrawal": 15
                        },
                        "deposit": {
                            "minDeposit": 5
                        }
                    },
                    "polygon": {
                        "wallet": "0x7da75946808e2633a2029bd19008df1dd4c21fd1",
                        "mainnet": true,
                        "name": "mainnet",
                        "withdrawal": {
                            "feeWithdrawal": 0.5,
                            "minWithdrawal": 2
                        },
                        "deposit": {
                            "minDeposit": 0
                        }
                    }
                }
            }
        ]
    }
}'
Response Response Example
null
Previous
Webhooks
Next
KYC File Added Webhook
Built with