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

MTN Group Agents API

The agents API from MTN Group — 4 operation(s) for agents.

MTN Group Agents API is one of 148 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single 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 3.2.0
API Version
v1.0
Base URL
https://api.mtn.com/accountDecisioning/v1
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

MTN Group Agents API 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 clientCredentials 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
3 params body → 201400401403404405500
POST
/{agentId}/tracking/
submit app installation confirmation details to the API.
addAppInstallationConfirmationDetails 1 param body → 200400401403404405409500

Schemas 15

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-agents-api-openapi.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN MoMo Collection API
MTN MoMo Disbursements API
MTN MoMo Remittance API
MTN MoMo Sandbox User Provisioning API
MTN Group Accessible to 3PP API
MTN Group Accessible to USSD Gateway API
MTN Group Activation API
MTN Group Add User API
MTN Group Admin Suspend API
MTN Group Adverts API
MTN Group Advice Reconcile API
MTN Group Applied Customer Billing Rate API
Where this information came from

This is an independent, third-party profile of MTN Group Agents API, 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.