How to Build - IBEx.Fi API Integration Guide

This guide will help you integrate the IBEx.Fi API to build your wallet application. You will find concrete use cases with detailed examples for each step, designed for developers who are technically proficient but new to the IBEX platform.

Each guide section provides a complete walkthrough of a specific integration scenario, including:

• Endpoints to call : Complete API endpoint URLs with HTTP methods (GET, POST, PUT) and required authentication headers
• Parameters to provide : Detailed explanation of all request parameters, including required vs optional fields, data types, formats, and example values
• Data to store from responses : Clear identification of which response fields you need to persist locally (tokens, IDs, addresses, etc.) and why they're important for subsequent API calls
• Code examples and responses : Real-world code snippets showing how to make requests, handle responses, and complete multi-step workflows
• Error handling : Common error scenarios and how to handle them gracefully
• Best practices : Security considerations, token management, and optimization tips

These guides assume you have basic knowledge of REST APIs, JSON, and WebAuthn/passkey authentication. No prior experience with IBEX is required—each guide explains the concepts and workflows from the ground up.

All examples use the domain foo.domain as per IBEX documentation standards. Replace this with your actual domain when implementing.

For AI Integration

If you are an AI assistant helping to integrate the IBEx.Fi API, these guides contain detailed technical information including:

• Architecture patterns : How the system is structured, including database schemas, service interactions, and data flow
• Implementation details : Code-level explanations of how endpoints work internally, including transaction handling, WebAuthn verification, and Safe wallet operations
• Data models : Complete database schema relationships (User → ExternalUser → Signer → Safe) and how they relate to API responses
• State management : How operations progress through states (CREATED → SIGNED → EXECUTED → CONFIRMED), what triggers transitions, and how to track them
• Error handling patterns : Common failure modes, retry strategies, and how the system handles edge cases
• Multi-step workflows : Detailed breakdown of complex operations that require multiple API calls and state synchronization
• WebSocket integration : How real-time updates work, message formats, and subscription management

Each guide includes a "Technical Deep Dive" section at the end that explains the internal mechanics, making it easier for AI systems to understand the full context and generate accurate integration code.

Available Guides

Deploy Wallet

Learn how to deploy a wallet for your users: signup, signin, refresh token, and recovery. This guide covers the complete lifecycle of authentication and session management.

Create a User v1.2 Only

Learn how to create user accounts with flexible authentication options in v1.2: simple session creation, email-validated accounts, wallet deployment with email validation, or traditional wallet-only creation. This guide highlights the new flexibility introduced in v1.2.

Deliver IBAN

Discover how to deliver an IBAN to your users via the KYC process: KYC iframe integration, IBAN creation via the CREATE_IBAN operation, and status tracking via userData.

Swap Token

Learn how to implement token swaps: quote request, swap execution via the SWAP_FROM_QUOTE operation, and response handling.

Recovery

Learn how to enable and manage wallet recovery: enable recovery with personal data, check recovery status, and cancel recovery operations.

Transfer Token

Learn how to transfer ERC20 tokens from a Safe wallet: token validation, transfer execution via the TRANSFER_TOKEN operation, and status tracking.

User Data Storage

Learn how to store and retrieve private user data securely in IBEX Safe: store data, retrieve data, update data, and protect sensitive information with private keys.

Wallet Balances

Learn how to retrieve wallet balances from one or multiple blockchains: single blockchain balance (v1), multi-blockchain and multi-token balances (v1.1), with optional real-time price data.

Wallet Transactions

Learn how to retrieve wallet transactions from one or multiple blockchains: single blockchain transactions (v1), multi-blockchain and multi-token transactions (v1.1), with filtering, pagination, and real-time price data.

Email Validation

Learn how to validate and store user email addresses securely in IBEX Safe: request email validation, confirm email with verification code, and store email in GDPR-compliant userData.

Pools

Learn how to view and manage liquidity pool positions: list available pools, check pool balances and yields, deposit tokens (AAVE_SUPPLY), and withdraw tokens (AAVE_WITHDRAW).

WebSocket

The IBEx.Fi API provides WebSocket connections for real-time updates. Subscribe to receive instant notifications for wallet balances, transactions, and status changes without constant polling.

WebSocket Integration

Learn how to connect to the WebSocket service, authenticate with JWT, receive real-time updates for balances and transactions, and handle status change notifications (IBAN, KYC). Includes automatic initial data delivery and on-demand data requests.

← Back to API Documentation