Prerequisite

This API provides external access to the NCC Regulator, allowing telcos that are already pre-approved to bypass the standard onboarding workflow.

Authentication

Clients must include a valid Bearer Token in the Authorization header of each request.

Properties

Auth Type: Bearer Token
Token Endpoint: POST /api/auth/token

API Endpoints Overview

Method	Endpoint	Purpose
POST	/api/ncc/v1/onboard-entity	Onboard telco entity and admin via NCC bypass
POST	/api/ncc/v1/upload-document	Upload required entity documents
POST	/api/ncc/v1/login	Log in as the onboarded entity admin

Endpoint: POST /api/ncc/v1/onboard-entity
Description: Registers a new telco entity along with its admin by bypassing the standard onboarding flow. Intended for entities pre-approved by NCC.

Request

Content-Type: application/json

{
  "cac": "string",
  "name": "string",
  "isDocumentRequired": true,
  "adminName": "string",
  "adminPhone": "string",
  "adminEmail": "string",
  "adminPassword": "string"
}

Response

Status Code: 200 OK

{
  "status": "string",
  "data": {
    "entityUid": "uuid",
    "entityName": "string",
    "cacNo": "string",
    "entityType": "NCC",
    "entityStatus": "Approved",
    "isDocumentRequired": true,
    "adminUid": "uuid",
    "adminName": "string",
    "adminEmail": "string",
    "adminPhone": "string",
    "isAdminVerified": true,
    "message": "string"
  },
  "statusCode": "string"
}

2. Upload documents

Endpoint: POST /api/ncc/v1/upload-document
Description: Uploads required documents for an onboarded entity. This is only necessary if isDocumentRequired = true.

Request

Content-Type: multipart/form-data

Field	Type	Required	Description
type	string	✅	Type of document being uploaded
file	binary	✅	Document file (PDF, image, etc.)

Response

Status Code: 200 OK

{
  "status": "string",
  "data": "string",
  "statusCode": "string"
}

Endpoint: POST /api/ncc/v1/login
Description: Authenticates the admin user created through the NCC regulator bypass. On success, returns a session token and basic user details.

Request

Content-Type: application/json

{
  "email": "string",
  "password": "string"
}

Response

Status Code: 200 OK

{
  "status": "string",
  "data": {
    "fullName": "string",
    "userType": "REGULATOR",
    "tokenMeta": {
      "token": "string",
      "expiration": "2025-07-10T11:35:01.342Z"
    },
    "isVerified": true
  },
  "statusCode": "string"
}

Notes & Guidelines

Entities onboarded through this API are automatically approved.
The isDocumentRequired flag determines whether the document upload step is mandatory.
Ensure that both adminEmail and adminPhone are unique in the system to avoid conflicts.

Glossary

Term	Definition
Bearer Token	A token included in the Authorization header for secure API access.
CAC	A token included in the Authorization header for secure API access.
Entity	A telco or service provider being onboarded into the system.
Admin	The main administrative user associated with a telco entity.
UUID	Universally Unique Identifier used to identify records like entities and users.
Multipart/Form-Data	A content type used for submitting files and form data in the same request.
Verified Admin	An admin whose phone number/email has passed validation.