API Reference Background

API Reference v1

Complete documentation for N1SMS public API

Base URL: /api/mobile RESTful API JSON Response

Quick Service IDs Reference

Use these IDs when making API requests

One-Time SMS

1688

WhatsApp

1012

Facebook

329

Instagram

457

Telegram

907

TikTok

924

Twitter/X

948

YouTube

1227

Google

395

Authentication

Authentication Required: All authenticated endpoints require a Bearer token in Authorization header

POST

/api/mobile/auth/register

Register a new user account.

Request Body

{
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+233XXXXXXXXX",
    "password": "password123",
    "password_confirmation": "password123",
    "referral_code": "OPTIONAL_CODE"
}

Response

{
    "success": true,
    "message": "Registration successful. Please verify your phone number.",
    "data": {
        "user_id": 1,
        "requires_verification": true
    }
}
POST

/api/mobile/auth/login

Authenticate user and get access token.

Request Body

{
    "email": "john@example.com",
    "password": "password123"
}

Response

{
    "success": true,
    "message": "Login successful",
    "data": {
        "token": "1|abc123...",
        "token_type": "Bearer",
        "expires_at": "2026-02-14T00:00:00.000000Z",
        "user": {
            "id": 1,
            "name": "John Doe",
            "email": "john@example.com",
            "phone": "+233XXXXXXXXX"
        }
    }
}

Using Your Token

Include your token in Authorization header for authenticated requests:

Authorization: Bearer YOUR_TOKEN_HERE

Dashboard

GET

/api/mobile/dashboard

Get user dashboard statistics and recent activity

GET

/api/mobile/dashboard/prices

Get country prices for a specific service

Query: ?service=1688&page=1

GET

/api/mobile/dashboard/services

Get list of available services

Orders

GET

/api/mobile/orders

Get list of user's orders

Query: ?status=active&page=1&per_page=20

POST

/api/mobile/orders

Create a new SMS number order

{
    "country": "1",
    "service": "1688",
    "pool": "optional_pool",
    "pricing_option": "0"
}

Quick Service IDs Reference

Use these IDs when making API requests

One-Time SMS

1688

WhatsApp

1012

Facebook

329

Instagram

457

Telegram

907

TikTok

924

Twitter/X

948

YouTube

1227

Google

395

Need More Details?

Download complete API documentation file for offline reference

Download Full Documentation