Quick Start

1

Create an Account

Sign up at checkghana.com and note your account email.

2

Log In for a Token

POST to /api/v1/Auth/login with your credentials to receive a JWT.

3

Make Requests

Send the token as a Bearer header. All responses are JSON.

4

Go Live

Public GET endpoints (Businesses, Categories, Jobs, etc.) don't require a token at all.

Get a Token

curl -X POST https://checkghana.com/api/v1/Auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"YOUR_PASSWORD"}'

Use It

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://checkghana.com/api/v1/Businesses?region=Ashanti

Or Use an API Key

curl -H "X-Api-Key: YOUR_KEY" \
  https://checkghana.com/api/v1/Businesses?region=Ashanti

The endpoints below also accept a long-lived X-Api-Key header as an alternative to a JWT — generate one from your business dashboard's API Keys tab.

API Endpoints
GET/api/v1/BusinessesList verified businesses with search and filter
GET/api/v1/Businesses/{id}Get a single business by ID
POST/api/v1/BusinessesRegister a new business (auth required)
GET/api/v1/CategoriesGet all business categories with icons
GET/api/v1/RegionsGet all 16 Ghana regions
GET/api/v1/MunicipalitiesGet municipalities (filter by ?region=)
GET/api/v1/EventsList business events
GET/api/v1/MarketplaceList marketplace listings
GET/api/v1/JobsList job listings
POST/api/v1/Auth/loginAuthenticate and receive JWT token
POST/api/v1/FraudReportsSubmit a fraud report
GET/api/v1/StatsPlatform statistics

Rate Limits

Login

5 requests / minute / IP

Uploads

20 requests / minute / user

All other endpoints are currently unmetered.

Need help with your integration?

Contact Developer Support