Pyramid Docs
HomeGetting StartedGuidesREST API ReferenceMain SiteHelp Center

Quick Start

Get up and running with the Pyramid API in under 5 minutes.

Prerequisites

Before you begin, make sure you have:

  • A Pyramid account (sign up at app.pyramid.africa)
  • Basic knowledge of REST APIs and your preferred programming language

Get Your API Key

Navigate to your dashboard and create a new API key. Keep this key secure - it grants access to your account.

For testing, use the sandbox environment with test API keys.

Make Your First Request

Here's a simple example to create an account using curl:

curl https://api.pyramid.africa/v1/accounts \
  -X POST \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "usr_12345",
    "phone_number": "+254712345678",
    "email": "user@example.com"
  }'

Next Steps