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 Profiles V2

An API to retrieve the profile of an MTN customer. Please refer to the reference guides https://developers.mtn.com/API-Reference-Guides and Response and Error Codes documents https://developers.mtn.com/ResponseCodes.

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

Tagged areas include Customers, Benin, Congo, Côte d’Ivoire, and Cameroon. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 6 operations across 6 paths, organized into 3 resource areas, and defines 47 schemas. It is described by OpenAPI 2.0, at version v1.11.

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

6 operations 6 paths 47 schemas 5 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v1.11
Base URL
https://api.mtn.com/v2
Authentication
API Key, OAuth 2.0
Resource Areas
3

Authentication & Security 2

MTN Profiles V2 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 6

Across 6 paths, the API surfaces 6 operations — 5 GET, 1 PUT. They span 3 resource areas: customers, Customer Characteristics, Member Summary. Each is listed below with its method, path, parameters, and response codes.

customers 4
GET
/customers/{customerId}
View customer profile
4 params → 200207400401403404405500
GET
/customers/upgrade-eligibility/{customerId}
Get customer’s upgrade eligibility
2 params → 200400401403404405406415
GET
/customers/{customerId}/tenure
Get customer’s tenure
3 params → 200400401403404405406415
GET
/customers/{customerId}/activityStatus
Get customer’s activity status
3 params → 200400401403404405406415
Customer Characteristics 1
PUT
/customers/{customerId}/set-lang
Sets the Customer’s Language Preference
4 params → 200400401403404405406415
Member Summary 1
GET
/customers/{customerId}/summary
Member Summary
7 params → 200400401403500

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are Customer (14 properties), ayocoverDetails (8 properties), Plans (8 properties), momo-loans (8 properties). Each schema is shown below with its type and property counts.

Customer
object
14 properties 2 required
CustomerProfile
object
7 properties 2 required
CustomerLinks
object
1 property 1 required
Any
CustomerCharacteristics
object
Describes a given characteristic of an object or entity through a name/value pair.
4 properties 2 required
CustomerLocations
object
2 properties 1 required
Locations
object
2 properties 2 required
CustomerPlans
object
3 properties 1 required
Plans
object
The plan details for the customer.
8 properties 5 required
CustomerBalances
object
1 property
CustomerLoans
object
2 properties 1 required
Loans
object
The loans details of a customer, if it exists
3 properties 1 required
Band
object
2 properties
Eligibility
object
3 properties
Link
object
8 properties
Error
object
5 properties
ErrorDefault
object
2 properties
ErrorNew
object
6 properties 2 required
CustomerUpgradeEligibilityResponse
object
5 properties
Upgrade
object
1 property
UpgradeEligibilityParams
object
Describes a given characteristic of an object or entity through a name/value pair.
3 properties 2 required
links
object
1 property
CustomerSetLangResponse
object
7 properties
setLang
object
1 property
CustomerTenureResponse
object
5 properties
tenure
object
1 property
CustomerStatusResponse
object
5 properties
status
object
1 property
AccountRef
object
2 properties
KYC
object
2 properties
GenderEnum
string
Devices
object
2 properties
timePeriodEnum
string
a time period for which data is available. Usually data is available for multiple time periods, like 1 month, 3 month, and 6 month. Each time period will be re…
transactions-summaries
object
3 properties
withdrawals
object
5 properties
deposits
object
5 properties
billPayments
object
5 properties
send
object
5 properties
received
object
2 properties
transfers
object
2 properties
gsm
object
2 properties
activity
object
Actvity related to GSM calls, data bundles, and airtime
3 properties
momo-loans
object
8 properties
ayoSummaryResponse
object
6 properties 2 required
ayocoverDetails
object
8 properties
ayoAmount
object
2 properties
ayoSummaryError
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-mtn-customer-profiles-api-v2-product.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN Account Decisioning
MTN TMF Customer Bill Management - TMF678
MTN Loans
MTN Subscriber Details
MTN Subscriber Type
MTN Provisioning
MTN Unified Balance V1
MTN TMF Resource Inventory Management - TMF639
MTN Sales Lead
MTN Service Activation and Configuration
MTN Service Ordering
MTN BSS TT OAuth V1
Where this information came from

This is an independent, third-party profile of MTN Profiles V2, 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.