Introduction

Welcome to the Bridflow API. This documentation covers the public HTTP/JSON API used to onboard accounts, inspect account status, manage transfer destinations, create transfers, and configure Auto Convert Routes.

Current version

Current documentation version: v0.3. The API is still in beta and can introduce breaking changes before a stable release.

Quick overview

Bridflow endpoints accept and return JSON over HTTPS. Most endpoints require an authenticated identity and an account selected with the AccountId header. Query-style endpoints use request bodies for filters, route selections, and dynamic query parameters.

Recommended integration flow

  1. Authenticate with an External API Consumer or a user session.
  2. Create an account and keep its returned accountId.
  3. Send that id in the AccountId header and complete personal or business onboarding.
  4. Poll account status until accountCreationStatus is Complete.
  5. Discover supported transfer routes with GetTransfersInfoQueryV1.
  6. Collect route-specific fields using GetTransferRouteFieldMetadataQueryV1.
  7. Create compatible saved contacts, then preview and execute a Direct Transfer or Auto Convert Route.

Guides and reference

  • Use these docs as task-oriented guides for personal onboarding, staged business onboarding, route selection, transfers, saved contacts, and operational errors.
  • Use the API Calls Reference for the exact generated contract, schemas, enum values, and response shapes.
  • Query endpoints are shown as QUERY in these guides. Generated OpenAPI clients may still call the same endpoints as PATCH.

Currently in Beta

This API is currently in beta version. Expect breaking changes; integration teams should prepare for required updates when new major versions are published.

API Calls Reference