How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
MTN Group

MTN Agent Profile

An API to retrieve the profile of an MTN field agent. Please refer to the reference guides https://developers.mtn.com/getting-started and Response and Error Codes documents https://developers.mtn.com/getting-started/response-and-error-codes.

Documentation Provider Profile APIs.io OpenAPI GitHub

MTN Agent Profile is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agents, Ghana, Uganda, Eswatini, and Nigeria. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 4 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 2.0, at version v1.0.

Requests are made against the base URL https://api.mtn.com/v1/agents.

4 operations 4 paths 15 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v1.0
Base URL
https://api.mtn.com/v1/agents
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

MTN Agent Profile declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It supports OAuth 2.0 (OAuth2) using the application flow. By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

agents 4
GET
/{agentId}
View agent profile
3 params → 200207400401403404405500
GET
/{customerId}/agentFlag
To know if any given customer Id (MSISDN) is registered as an MTN field Agent or not
2 params → 200400401403404405500
PATCH
/{agentId}/devices
Update device information of a registered MTN Agent
4 params → 201400401403404405500
POST
/{agentId}/tracking/
submit app installation confirmation details to the API.
addAppInstallationConfirmationDetails 2 params → 200400401403404405409500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are installationConfirmationDetailsRequest (7 properties), Agent (6 properties), agentFLAG (6 properties), Error (5 properties). Each schema is shown below with its type and property counts.

Agent
object
6 properties
AgentLinks
object
1 property 1 required
AGENTKYC
object
1 property
AGENTPLANS
object
1 property
BalanceDetail
object
The details for a balance type.
3 properties 3 required
Wallet
object
Contributing wallets to the aggregated balance
2 properties 2 required
Amount
object
The amount details for a wallet.
3 properties 3 required
Devices
object
1 property
ACTIVITYREPORT
object
2 properties
agentFLAG
object
6 properties
geoTagging
object
4 properties
Error
object
5 properties
ErrorDefault
object
2 properties
installationConfirmationDetailsRequest
object
7 properties 4 required
installationConfirmationDetailsResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-agent-profile.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN Account Decisioning
AE Profile APIs.io
MTN TMF Customer Bill Management - TMF678
AE Profile APIs.io
MTN Loans
AE Profile APIs.io
MTN Subscriber Details
AE Profile APIs.io
MTN Subscriber Type
AE Profile APIs.io
MTN Provisioning
AE Profile APIs.io
MTN Unified Balance V1
AE Profile APIs.io
MTN TMF Resource Inventory Management - TMF639
AE Profile APIs.io
MTN Sales Lead
AE Profile APIs.io
MTN Service Activation and Configuration
AE Profile APIs.io
MTN Service Ordering
AE Profile APIs.io
MTN BSS TT OAuth V1
AE Profile APIs.io
#Agents#Ghana#Uganda#Eswatini#Nigeria
← Back to M APIs
API Details
ID
mtn-group:agent-profile
Base URL
https://api.mtn.com/v1/agents
Docs
https://developers.mtn.com/products/agent-profile
Provider
MTN Group
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=agent-profile&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/agent-profile"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of MTN Agent Profile, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.