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

# Introduction

> Enable cross-border payments with RaaS Widgets — mint magic links to embeddable flows via the Partner API

## What is RaaS Widgets?

RaaS Widgets is a multi-tenant platform that lets you offer cross-border money transfers through embeddable **flows**. As a partner, you call the Partner API once to create a magic link, share that URL with your user (browser, deep link, or native WebView), and receive webhooks as the journey progresses.

M2M is one flow among several — not the product itself. Your account is configured with the flows you can mint (`allowedFlows`).

```mermaid theme={null}
sequenceDiagram
    participant Partner
    participant API as Partner API
    participant User
    participant Flow as Flow widget

    Partner->>API: Create magic link (flow + config)
    API-->>Partner: Return link URL
    Partner->>User: Deliver URL (email, SMS, app, WebView)
    User->>Flow: Open link
    Flow->>User: Complete transfer experience
    API->>Partner: Webhook notifications
```

## How it works

<Steps>
  <Step title="Create a magic link">
    Call `POST /partner/links` with a `flow` slug, your user's `referenceId`, and any flow-specific `config`.
  </Step>

  <Step title="Share the link">
    Send the URL via email, SMS, push, in-app button, or load it in a native WebView.
  </Step>

  <Step title="User completes the flow">
    Your user opens the link and completes the experience in that flow's widget (send, request, cash deposit, and more).
  </Step>

  <Step title="Receive notifications">
    Get signed webhook events for link activity, data requests, and related lifecycle updates.
  </Step>
</Steps>

## Core concepts

<AccordionGroup>
  <Accordion title="Flows">
    A **flow** is a deployable widget experience (for example `smart`, `m2m`, `request`, `fund-request`). Each flow has its own host URL and `config` shape. Discover what you can mint with `GET /partner/flows`.
  </Accordion>

  <Accordion title="Magic links">
    A magic link is a secure URL that opens a specific flow for a specific user. Links expire after a configurable TTL, are scoped to your partner account, and return a full widget URL you can deliver immediately.
  </Accordion>

  <Accordion title="Reference ID">
    The `referenceId` is your stable identifier for an end user. Always reuse the same value so CIP status, history, and friction reduction carry across sessions.
  </Accordion>

  <Accordion title="Webhooks">
    RaaS Widgets sends signed outbound events to your webhook URL using `X-RAAS-*` signature headers — see [Webhook Security](/raas-widgets/webhooks/security). Operation statuses and terminal events are covered in [Operation lifecycle](/raas-widgets/ops/operation-lifecycle).
  </Accordion>

  <Accordion title="Operations">
    An **operation** is the money-transfer record created when a user completes a flow. Track `status` (`created` → `processing` → `completed` / `failed` / `cancelled`) via webhooks and [GET /partner/operations](/raas-widgets/ops/operations).
  </Accordion>
</AccordionGroup>

## Get started

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/raas-widgets/quickstart">
    Create your first magic link with the smart flow.
  </Card>

  <Card title="Authentication" icon="key" href="/raas-widgets/authentication">
    API keys and request security.
  </Card>

  <Card title="Request API" icon="hand-holding-dollar" href="/raas-widgets/request-api">
    Create request-money asks via `/v1/request-money`.
  </Card>

  <Card title="Flows catalog" icon="layer-group" href="/raas-widgets/concepts/flows">
    Understand which flow fits your use case.
  </Card>

  <Card title="API Reference" icon="code" href="/raas-widgets/api-reference/introduction">
    Full Partner API documentation.
  </Card>
</CardGroup>

## Environments

| Environment | Base URL                                              | API Key Prefix  | Purpose                 |
| ----------- | ----------------------------------------------------- | --------------- | ----------------------- |
| Sandbox     | `https://raas-widgets-backend-sandbox.up.railway.app` | `raas_sandbox_` | Development and testing |
| Production  | Provided at go-live                                   | `raas_live_`    | Live transactions       |

<Warning>
  Never use production API keys in development. Use sandbox keys for all non-production work.
</Warning>

<Note>
  This documentation covers the **Partner-accessible API** (`X-API-Key` against `/partner/*`). The Widget API used by flow apps and the Superadmin API are out of scope.
</Note>