Introduction

Welcome to the Arewa Smart API Documentation. Our API allows you to integrate our robust identity verification, utility bill payments, and telecommunication services directly into your own applications seamlessly.

Base URL: https://arewasmart.com.ng/api
All endpoints documented here should be prefixed with this base URL.

Authentication

We use Bearer Token authentication to secure our endpoints. To access any API route, you must include your unique API Token in the Authorization header of your HTTP request.

Getting your API Token

Create an account on our platform.
Log in to your dashboard.
Navigate to your Profile Settings -> API Application to view or generate your API Token.

Keep your token secure! Never share your API Token publicly, commit it to version control, or expose it in client-side code such as front-end JavaScript apps.

Example Request

Here is an example of how to attach your API token in a standard HTTP request using cURL.

Authentication Header Example

curl -X GET "https://arewasmart.com.ng/api/endpoint" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Responses

Our API returns standardized JSON responses. A successful request typically yields a 200 OK status code with a JSON payload containing the requested data and a status indicator.

Success Response (2xx)

{
    "status": true,
    "message": "Operation successful",
    "data": { ... }
}

If an error occurs, you will receive an appropriate HTTP status code (e.g., 400 Bad Request, 401 Unauthorized, 422 Unprocessable Entity) alongside a JSON error message.

Error Response (4xx/5xx)

{
    "status": false,
    "message": "The provided token is invalid or expired."
}

Next Steps

Navigate through the sidebar to explore specific services like NIN Verification, BVN Checking, and Utility payments. Each service page provides detailed endpoint URLs, required parameters, and sample responses.