Quickstart

Step 1: Get your API key

Authentication

All requests requires your API key in the header:

curl -X GET "https://api.bread.africa/tokens" \
  -H "x-service-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Step 2: Identity

Create an identity

Create an identity for KYC verification.BVN Verification:

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:

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:

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:

{
  "success": true,
  "status": 201,
  "message": "Identity created successfully",
  "timestamp": "2025-09-08T19:26:31.532Z",
  "data": {
    "id": "68bf2de7196a18d7bd165ffb",
    "link": null
  }
}

Step 3: Beneficiary

Create a beneficiary

Create a beneficiary for payouts using an identity.

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:

{
  "success": true,
  "status": 201,
  "message": "Beneficiary created successfully",
  "timestamp": "2025-09-08T20:40:35.538Z",
  "data": {
      "id": "68bf2eba196a18d7bd166184"
  }
}

Step 4: Wallet

Create a wallet

Create a wallet to receive and manage crypto.Offramp Wallet (auto-converts to fiat):

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):

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:

{
    "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"
        }
    }
}

Next steps

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

Supported Tokens

View list of all the supported local currencies across markets.

API Reference

Complete API documentation with all endpoints and examples.

Need Help?

Our team is here to help you succeed:

Need help? Contact our team at hello@bread.africa or Twitter.

Getting started

Guides

Step 1: Get your API key

Step 2: Identity

Step 3: Beneficiary

Step 4: Wallet

Next steps

Supported Tokens

API Reference

Need Help?

​Step 1: Get your API key

​Step 2: Identity

​Step 3: Beneficiary

​Step 4: Wallet

​Next steps

Supported Tokens

API Reference

​Need Help?

Step 1: Get your API key

Step 2: Identity

Step 3: Beneficiary

Step 4: Wallet

Next steps

Need Help?