1. API References
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. API References

User Operations

This module contains endpoints for managing individual User Accounts. Unlike Partner API flows, these requests are focused on end-user data, including onboarding (KYC), individual balances, personal history, and internal transfers.
User API is designed to manage the full customer lifecycle: from identity verification to user-level treasury operations.

Core Endpoints#

Onboarding and KYC Flow#

Create User
Register a new end-user in the system.
Add KYC File
Method A: Direct upload of identity documents.
Initiate Verification
Method B: Start a guided KYC verification session.
Redirect to Verification
Method B: Obtain the secure URL for redirecting users to KYC interface.
KYC Status
Retrieve the current verification stage and result.
Add Verification
Submit additional user verification data.
Add POA File
Upload proof of address (POA) documents.

Account Management#

Update User
Modify existing user profile information.
Delete User
Permanently remove a user account.
Suspend User
Temporarily block user account activity.
Unsuspend User
Restore access to a suspended user account.

Balances and Transaction History#

Get User Balances
Check fiat and crypto balances for a specific user.
User History
Retrieve detailed transaction history for an individual user.

Currency Exchange#

Retrieve Rate
Get real-time rates for user-specific exchange pairs.
Create Lock
Lock a rate for user currency exchange.
Finalize Exchange
Execute a swap using user balance.
Exchange Details
Check status of a specific user exchange.

SEPA Transfers#

SEPA Deposit Info
Retrieve dedicated user banking details for incoming SEPA.
Contact List
Manage saved bank contacts for a specific user.
Create SEPA Transfer
Initiate SEPA withdrawal from user balance.
Transfer Details
Track status of a user outgoing bank transfer.

Crypto Withdrawals#

Get Network Fee
Check current blockchain fee estimates for withdrawals.
Create Withdrawal
Withdraw user crypto to an external blockchain address.
Withdrawal Details
Track confirmations and status for user withdrawal.

Crypto Deposits#

Update Travel Rule
Submit compliance data for user crypto deposits.

Internal Transfers#

Create Transfer
Move funds between Partner and User accounts.
Transfer Details
Track status of internal fund movement.

Virtual Cards#

Service Suspended
All Virtual Card services are temporarily suspended.
The entire card module, including issuance, management, and transaction processing, is currently offline. All associated endpoints are disabled and return an error if called.

Typical Workflows#

Workflow: User Onboarding and KYC#

1.
Create User Account: Register user via Create User to get unique user identifier.
2.
KYC Verification:
Method A: Upload documents directly via Add KYC File.
Method B: Start verification session via Initiate Verification, then redirect user to secure KYC flow.
3.
Monitor Status: Use KYC Status or webhooks to detect verification completion.

Workflow: Internal Transfers#

1.
Use Create Transfer to move liquidity.
2.
Set Partner as source and User as destination for payout.
3.
Set User as source and Partner as destination for collection.
4.
Track progress via Transfer Details.
Transfer Routing Rule
Direct user-to-user transfers are not supported. Transfers must be routed through Partner account.

Workflow: User Crypto Payout#

1.
Verify user balance via Get User Balances.
2.
Check current fee estimates via Get Network Fee.
3.
Execute withdrawal via Create Withdrawal.
4.
Monitor blockchain confirmations via Withdrawal Details.
Previous
Get Payment Link Details
Next
Onboarding & KYC Flow
Built with