1. User Operations
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 Operations

Account Management

This module provides endpoints for managing the ongoing lifecycle of users. Once a user is verified and active, you may need to update personal data, temporarily restrict access for security reasons, or permanently close the account.

Key Capabilities#

Data Maintenance: Update contact details (email, phone) and residential address.
Security Control: Instantly suspend users to prevent fraud.
Access Restoration: Reactivate accounts after review.
Offboarding: Permanently delete user accounts and related data.

Core Endpoints#

Update Existing User
Modify user details such as email address, phone number, or street address.
Delete User
Permanently remove a user account. This action is irreversible.
Suspend User
Temporarily freeze a user account to block transactions and withdrawals.
Unsuspend User
Restore full access and functionality to a previously suspended user.

Updating User Details#

Use Update Existing User to keep records synchronized with the user current profile. Most data provided during account creation can be updated without modifying separate KYC records.

Allowed Updates#

Contact Info: Email address, phone number.
Address Details: Street, city, postal code.

Restrictions#

Country: Country of residence cannot be changed after account creation.
Identity Data: Data extracted during KYC remains immutable for compliance integrity.

Security and Suspension#

If suspicious activity, fraud, or compliance breach is detected, secure funds immediately.

Suspending an Account#

Calling Suspend User moves account into a frozen state.
Effect: User cannot perform deposits, withdrawals, exchanges, or card transactions.
Use Cases: Fraud alerts, account takeover report, pending compliance review.

Restoring Access#

After security review is cleared, call Unsuspend User to restore full functionality.

Account Closure (Deletion)#

Use Delete User for permanent offboarding, for example on user request (GDPR right to erasure) or relationship termination.
Irreversible Action
Deleting a user is permanent. Ensure balances are settled before deletion. The user loses platform access and association with your partner account is removed.
Previous
Add POA File
Next
Update Existing User
Built with