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

# Introduction

> Get started with the Bringin Partner API

## What is Bringin?

Bringin lets your users convert crypto to Euro and spend it — via a debit card, bank withdrawal, or recurring standing orders.

As a partner, you integrate the Bringin API so your users can:

* **Top up a debit card** — User deposits USDC/BTC, it's converted to EUR, and they can spend it anywhere or withdraw to their bank
* **Set up connections** — A permanent link between a Bitcoin address and a bank account. Funds convert automatically, any amount, any time.

<CardGroup cols={3}>
  <Card title="API Keys" icon="key" href="/guides/api-keys">
    Onboard users and get per-user api-keys. Start here.
  </Card>

  <Card title="Top-up Debit Card" icon="credit-card" href="/guides/offramp-integration">
    Deposit crypto, spend EUR. One-off top-ups via API.
  </Card>

  <Card title="Connections" icon="link" href="/guides/connection-integration">
    Pass a crypto address, get back an IBAN. Auto-converts forever.
  </Card>
</CardGroup>

## The API Key

Every API call requires an `api-key` header. Your **master key** is provided by Bringin during setup. **Per-user keys** are unique to each user and have limited permissions — they can only push crypto for conversion.

<Info>Per-user keys are safe to store on client devices (mobile, web) or your backend — permissions are limited to crypto push only.</Info>

You get per-user keys by calling `POST /application/connect` with the user's email. Bringin handles three scenarios automatically: returning the key immediately (if already connected), sending a consent email (existing user), or providing a signup link (new user).

**[Read the full API Keys guide](/guides/api-keys)** for the complete onboarding flow, webhook setup, and polling alternative.

## Base URLs

| Environment | URL                       |
| ----------- | ------------------------- |
| Sandbox     | `https://dev.bringin.xyz` |
| Production  | `https://api.bringin.xyz` |

All endpoints use the prefix `/api/v0/`.

## All APIs require an api-key header

```bash theme={null}
api-key: ZTY3YzNhMzQ3Yzk4NGJjMmEwZWU1NTQ4NmE5MjJjZTk=
```

For onboarding APIs (getting signup links, checking status), use your **master api-key** provided by Bringin.

For user-level APIs (creating orders, checking balance, listing transactions), use the **per-user api-key** you receive after connecting a user.
