> ## Documentation Index
> Fetch the complete documentation index at: https://docs.remitflex.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Platform overview

> How RemitFlex fits together — orgs, API keys, products, and settlement rails.

RemitFlex gives you **programmable stablecoin infrastructure** over HTTPS. You create resources (swaps, payment routes, customers), fund them on-chain, and read status from a unified ledger.

## Mental model

The integration pattern is straightforward:

1. **Authenticate** with an API key (`rmf_test_` / `rmf_live_`)
2. **Create** a payment intent (swap or payment route), optionally tied to a [customer](/products/customers)
3. **Fund** the deposit address returned by the API
4. **Track** status until settled
5. **Reconcile** via `GET /v1/transactions` — filter by `customerId` when needed

RemitFlex is focused on **stablecoins** and **African use cases** — same-chain swaps and cross-chain collection routes, not a full fiat bank network (yet).

## Core objects

| Object            | Purpose                                                                                  |
| ----------------- | ---------------------------------------------------------------------------------------- |
| **Organisation**  | Your tenant. Created at signup. Gets a primary customer automatically.                   |
| **Customer**      | A payer or counterparty under your org. Swaps and payment routes are tied to a customer. |
| **Swap**          | Same-chain stablecoin conversion with a time-bound deposit address.                      |
| **Payment route** | Cross-chain collection route with a persistent deposit address.                          |
| **Transaction**   | Ledger row linking swaps and route deposits for reporting.                               |
| **API key**       | Scoped programmatic access (`fx:read`, `transfers:write`, `collections:write`, etc.).    |

## Authentication layers

| Audience        | Auth              | Used for                                      |
| --------------- | ----------------- | --------------------------------------------- |
| Dashboard users | JWT (email + OTP) | Signup, login, API key management             |
| Integrations    | API key (Bearer)  | Swaps, routes, customers, rates, transactions |

Dashboard: [dashboard.remitflex.io](https://dashboard.remitflex.io)

API base: `https://api.remitflex.io/v1`

## Products

| Product        | Typical use                                                      |
| -------------- | ---------------------------------------------------------------- |
| Swaps          | Same-chain stablecoin conversion (e.g. USDC → EURC on Solana)    |
| Payment routes | Cross-chain pay-in (e.g. collect on Ethereum, deliver on Solana) |

## Scopes

API keys use fine-grained scopes. Grant only what each service needs:

| Scope               | Access                                |
| ------------------- | ------------------------------------- |
| `fx:read`           | Rates                                 |
| `transfers:read`    | Read swaps, customers, transactions   |
| `transfers:write`   | Create/cancel swaps, create customers |
| `collections:read`  | Read payment routes and deposits      |
| `collections:write` | Create and manage payment routes      |

See [Authentication](/authentication) for key format and idempotency rules.

## What we do not do yet

* Fiat bank off-ramp (NGN, KES, etc. to local bank accounts)
* Outbound merchant webhooks
* Self-serve API key creation via API key (keys are created in the dashboard)

These are planned; the API surface will expand without breaking existing v1 contracts where possible.