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

# Quickstart

> Get started with Breads in minutes

### Step 1: Get your API key

<AccordionGroup>
  <Accordion icon="key" title="Sign up for an account">
    1. Visit the [Bread Dashboard](https://developer.bread.africa)
    2. Create your account or sign in
    3. Navigate to API Keys section
    4. Copy your API key

    <Warning>Keep your API key secure and never expose it.</Warning>
  </Accordion>

  <Accordion icon="shield-check" title="Authentication">
    All requests requires your API key in the header:

    ```bash theme={null}
    curl -X GET "https://api.bread.africa/tokens" \
      -H "x-service-key: YOUR_API_KEY" \
      -H "Content-Type: application/json"
    ```
  </Accordion>
</AccordionGroup>

### Step 2: Identity

<AccordionGroup>
  <Accordion icon="id-card" title="Create an identity">
    Create an identity for KYC verification.

    **BVN Verification:**

    ```bash theme={null}
    curl -X POST "https://api.bread.africa/identity" \
      -H "x-service-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
          "type": "BVN",
          "name": "John Doe",
          "details": {
            "bvn": "1234567890",
            "dob": "01-05-1990"
          }
      }'
    ```

    **NIN Verification:**

    ```bash theme={null}
    curl -X POST "https://api.bread.africa/identity" \
      -H "x-service-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
          "type": "NIN",
          "name": "John Doe",
          "details": {
            "nin": "1234567890",
            "dob": "01-05-1990"
          }
      }'
    ```

    **Link Verification:**

    ```bash theme={null}
    curl -X POST "https://api.bread.africa/identity" \
      -H "x-service-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
          "type": "Link",
          "name": "John Doe",
          "details": {
            "email": "user@example.com",
            "name": "John Doe",
            "country": "NG"
          }
      }'
    ```

    You should receive a response like:

    ```json theme={null}
    {
      "success": true,
      "status": 201,
      "message": "Identity created successfully",
      "timestamp": "2025-09-08T19:26:31.532Z",
      "data": {
        "id": "68bf2de7196a18d7bd165ffb",
        "link": null
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### Step 3: Beneficiary

<AccordionGroup>
  <Accordion icon="users" title="Create a beneficiary">
    Create a beneficiary for payouts using an identity.

    ```bash theme={null}
    curl -X POST "https://api.bread.africa/beneficiary" \
      -H "x-service-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
          "currency": "ngn",
          "identity_id": "68bf2de7196a18d7bd165ffb",
          "details": {
            "account_number": "1234567890",
            "bank_code": "100004"
          }
      }'
    ```

    You should receive a response like:

    ```json theme={null}
    {
      "success": true,
      "status": 201,
      "message": "Beneficiary created successfully",
      "timestamp": "2025-09-08T20:40:35.538Z",
      "data": {
          "id": "68bf2eba196a18d7bd166184"
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### Step 4: Wallet

<Accordion icon="wallet" title="Create a wallet">
  Create a wallet to receive and manage crypto.

  **Offramp Wallet (auto-converts to fiat):**

  ```bash theme={null}
  curl -X POST "https://api.bread.africa/wallet" \
    -H "x-service-key: YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
        "offramp": true,
        "beneficiary_id": "68bf2eba196a18d7bd166184"
    }'
  ```

  **Basic Wallet (Manual operations):**

  ```bash theme={null}
  curl -X POST "https://api.bread.africa/wallet" \
    -H "x-service-key: YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
        "reference": "my-unique-reference"
    }'
  ```

  You should receive a response like:

  ```json theme={null}
  {
      "success": true,
      "status": 201,
      "message": "Wallet created successfully",
      "timestamp": "2025-09-08T02:03:46.201Z",
      "data": {
          "reference": "l7vdjhve4l46fgjeadv5l772q6org3",
          "wallet_id": "68be398168e841ce24c576af",
          "address": {
              "evm": "0x77373761e1a69BB6daF15eFb8dD3959BEE34E98D",
              "svm": "ekKeWZ6x3xDs1sdVQ4KHfZ5Eq5p6UyitHQtCemTtLgn"
          }
      }
  }
  ```
</Accordion>

## Next steps

Now that you've made your first API call, let's build:

<CardGroup cols={2}>
  <Card title="Supported Tokens" icon="coins" href="/currencies">
    View list of all the supported local currencies across markets.
  </Card>

  <Card title="API Reference" icon="terminal" href="/api-reference">
    Complete API documentation with all endpoints and examples.
  </Card>
</CardGroup>

## Need Help?

Our team is here to help you succeed:

<Note>
  **Need help?** Contact our team at [hello@bread.africa](mailto:hello@bread.africa) or [Twitter](https://x.com/UseBreadAfrica).
</Note>