API Reference

Introduction

Welcome to IO’s API Documentation

You're one step closer to financial automation. Our platform is at the forefront of innovation in cryptography, blockchain, multi-party computation, and distributed systems, with the aim to revolutionize the conventional finance sector. We strive to foster a safer and more compliant financial world.

Crafted by enthusiasts for enthusiasts, our offerings are 100% API-centric, categorized into three distinct services:

  • io.flow - A multi-currency, cross-border fiat payment service. Expedite your funds with unprecedented velocity across both local and global payment channels.
  • io.vault - An MPC TSS institutional digital asset self-custody solution. Fortify your assets with unparalleled security. Place trust in mathematics rather than material.
  • io.network - An always-on settlement platform enabling instant transactions. Reduce fees, delays, and counterparty risks by connecting your enterprise directly to financial institutions through our network.

Getting Started

Before you delve into the API documentation, ensure you are equipped with:

  • An active IO account. If you haven’t set one up yet, visit our support page.
  • API credentials. Refer to our API credentials guide.
  • Familiarity with our support center, including a review of our user guides aimed at non-technical stakeholders.

Key Concepts

REST and GraphQL

Our commitment lies in adopting the most suitable technologies to simplify developer integration. For io.flow, which is fine-tuned for core banking system integration, we employ REST for its familiarity and server-to-server interactions. For other services that prioritize speed, flexibility, and UI integration, we utilize GraphQL.

Please note that the io.network settlement system integrates the security features of io.vault, thus they share a common GraphQL API.

For more information on GraphQl head to the official GraphQL Foundation docs.

Core APIs

Our documentation includes a dedicated section for 'Core APIs'. This category encompasses services and features that span across products (often referred to as platform services). They consist of:

  • Authentication - Secure OAuth authentication for API access.
  • Notifications - System-wide notification access.
  • Events - Access to system event logs.
  • Settings - Configuration of system and user preferences.