Partner API
  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
      • Transfers & Payments Webhooks
        • P2P Transfer 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 the Partner API, these requests are focused on end-user specific data, including personal onboarding (KYC), individual balances, personal transaction history, and peer-to-peer (P2P) transfers.
The User API is designed for managing the full lifecycle of your customers, from identity verification to individual treasury operations.

Core endpoints#

Onboarding & 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 to redirect users to the 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 & Transaction History#

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

Currency Exchange#

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

SEPA Transfers#

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

Crypto Withdrawal#

Get Network Fee
Check current blockchain gas costs and limits for withdrawals.
Create Withdrawal
Withdraw user crypto to an external blockchain address.
Withdrawal Details
Track network confirmations for a user withdrawal.

Crypto Deposits#

Update Travel Rule
Submit compliance data for user crypto deposits.

Internal Transfers#

Create Transfer
Move funds between Partner and User (or vice versa).
Transfer Details
Track the final status of an 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 will return an error if called.

Typical Workflows#

Workflow: User Onboarding & KYC#

1.
Create User Account: Start by registering the user via Create User to receive a unique identifier.
2.
KYC Verification:
Method A: Upload files directly for background processing using Add KYC File.
Method B: Redirect the user to a secure verification interface using the session URL generated via Initiate Verification.
3.
Monitor Status: Use KYC Status or Webhooks to know when the user is verified and ready to perform transactions.

Workflow: Internal (P2P) Transfers#

1.
Use Create Transfer to move liquidity.
2.
Set the Partner as the source and a User as the destination to perform a payout.
3.
Set a User as the source and the Partner as the destination to collect funds.
4.
Track the progress using Transfer Details.
Note: Direct user-to-user transfers are not supported; they must route through the Partner account.

Workflow: User Crypto Payout#

1.
Ensure the user has sufficient balance by checking User Balances.
2.
(Recommended) Check current network costs using Get Network Fee (ID: 28597680).
3.
Execute Create Withdrawal to send funds to the user's external wallet.
4.
Monitor confirmations via Withdrawal Details.
Previous
Get Payment Link Details
Next
Onboarding & KYC Flow
Built with