> ## 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.

# Platform overview

> How partners, flows, magic links, and operations fit together in RaaS Widgets

## Mental model

RaaS Widgets separates **your integration surface** from **the widget runtime**:

| Layer                           | Who uses it    | Auth                                             |
| ------------------------------- | -------------- | ------------------------------------------------ |
| Partner API (`/partner/*`)      | Your backend   | `X-API-Key`                                      |
| Flow widget (browser / WebView) | End user       | Opens magic-link URL                             |
| Widget API (`/widget/*`)        | Flow apps only | Magic-link JWT — **out of scope for these docs** |

You never call the Widget API from your servers. You mint links, deliver URLs, and observe results.

```mermaid theme={null}
flowchart LR
  YourApp[Your backend] -->|X-API-Key| PartnerAPI[Partner API]
  PartnerAPI -->|url| Delivery[Email SMS App WebView]
  Delivery --> EndUser[End user]
  EndUser --> FlowHost[Flow host]
  PartnerAPI -->|webhooks| YourApp
```

## Tenancy

Every Partner API call is scoped to your `partnerId`. Your sandbox and production environments, branding, corridors, and `allowedFlows` are configured by Leap when your account is provisioned. Inspect your profile with `GET /partner/me`.

## Primary objects

<AccordionGroup>
  <Accordion title="Partner">
    Your tenant account: environment, branding, allowed flows, corridors, and webhook settings.
  </Accordion>

  <Accordion title="Flow">
    A productized experience (`smart`, `m2m`, `request`, …). Each flow has a host URL and a create-link `config` schema.
  </Accordion>

  <Accordion title="Magic link">
    A time-bound URL that binds a `referenceId` to a flow instance. Response includes `linkId`, `url`, `token`, and expiry.
  </Accordion>

  <Accordion title="User">
    An end user keyed by your `referenceId` (and internal user id). CIP status and history accumulate across links.
  </Accordion>

  <Accordion title="Operation">
    A money-transfer record created when a user completes a transfer in a flow. List and inspect via `/partner/operations`.
  </Accordion>
</AccordionGroup>

## Integration styles

1. **Minimal** — mint `smart` (or similar) with only `referenceId`; the widget collects everything.
2. **Prefill** — pass flow `config` (for example m2m `userData`) to skip steps.
3. **Hybrid** — prefill what you have; fulfill [data requests](/raas-widgets/guides/data-requests) via webhooks when more is needed.

## Next steps

<CardGroup cols={2}>
  <Card title="Magic links" icon="link" href="/raas-widgets/concepts/magic-links">
    Envelope, lifecycle, and delivery.
  </Card>

  <Card title="Flows" icon="layer-group" href="/raas-widgets/concepts/flows">
    Catalog of use cases.
  </Card>
</CardGroup>
