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 Customer API

The Customer API from MTN Group — 10 operation(s) for customer.

MTN Group Customer 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 Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 16 operations across 10 paths, and defines 54 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 5 base URLs: https://api.mtn.com/v1/survey, https://api.mtn.com/v1/customers, https://api.mtn.com/v1/datashare, https://api.mtn.com/v1/datagifting, https://serverRoot/tmf-api/customerManagement/v4/.

16 operations 10 paths 54 schemas 1 DELETE8 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

MTN Group Customer API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). An API key is passed in the header as x-api-key (API_Key). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

Paths & Operations 16

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

Customer 16
GET
/customers/{customerId}
Get Survey Quetions
4 params → 200400401403404405406415
POST
/customers/{customerId}
Submit Survey and more KYC Answers
4 params body → 200400401403404405406415
GET
/customers/surveyOptInByTimeStamp
Get Survey Msisdn List in CSV format
3 params → 200400401403404405406415
POST
/customers/surveyInvitation
Submit Survey and more KYC Answers
1 param body → 200400401404405500
GET
/customers/{customerId}/kyc
Retrieve customer KYC data
4 params → 200400401403404405500
POST
/customers/{senderMsisdn}
Share Data
2 params body → 200400401403404405406415
GET
/customers/{senderMsisdn}deprecated
Retrieve Receivers' MSISDN
1 param → 200400401403404405406415
PATCH
/customers/{senderMsisdn}deprecated
Update Receiver's information
1 param body → 200400401403404405406415
DELETE
/customers/{senderMsisdn}deprecated
Remove Receiver's Msisdn
2 params → 200400401403404405406415
GET
/customers/{customerId}/analytics
Get analytic information of your data usage
6 params → 200400401403404405406415
GET
/customers/{customerId}/summary
Get GDS summary your data usage
7 params → 200400401403404405406415
POST
/customers/{senderMsisdn}/dataGifting
Data Gifting
2 params body → 200400401403404405406415
GET
/customer
List or find Customer objects
listCustomer 16 params → 200400401403404405409500
POST
/customer
Creates a Customer
createCustomer 1 param body → 201400401403404405409500
GET
/customer/{id}
Retrieves a Customer by customer node id
retrieveCustomer 4 params → 200400401403404405409500
PATCH
/customer/{id}
Update a customer by customer node id.
patchCustomer 2 params body → 200400401403404405409500

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are Customer (18 properties), Customer_Update (15 properties), MediumCharacteristic (14 properties), AccountRef (11 properties). Each schema is shown below with its type and property counts.

Error400
object
5 properties
Error404
object
2 properties
DataResponse
object
6 properties
surveyInvitationResponse
object
5 properties
Error405
object
5 properties
Error401
object
2 properties
SurveyListResponse
string
msisdn list in csv format
surveyInvitationRequest
object
5 properties 4 required
Error500
object
5 properties
Error
object
6 properties 2 required
CustomerLinks
object
1 property 1 required
kyc
object
2 properties
Error_2
object
5 properties 2 required
GenderEnum
string
Error_3
object
7 properties
DataSummaryInformation
object
Sumary information for the subscriber
7 properties
ReceiverInformation
object
3 properties 2 required
DataShareResponseData
object
The impacted system success response
2 properties 1 required
DataShareResponse
object
6 properties
SuccessResponse
object
6 properties
DataUsagerInformation
object
The impacted system success response
9 properties
DataShareListResponse
object
5 properties
DataGiftingResponse
object
5 properties
DataGiftingResponseData
object
The impacted system success response
3 properties
RequestData
object
3 properties 3 required
Error_4
object
6 properties
ObjectKey
integer
All object keys matching search criteria returned in the response body. Array of objectKey
BillStructure
object
The bill structure that associated to the customer.
2 properties
IndividualIdentification
object
Represents our registration of information used as proof of identity by an individual (national identity card)
2 properties
PartyRef
object
Party reference. A party represents an organization or an individual.
9 properties 2 required
TreatmentExemption
object
Customer treatment exemption.
3 properties
CreditProfile
object
Credit profile for the party.
10 properties 2 required
TreatmentSuspension
object
Customer treatment suspension.
4 properties
MediumCharacteristic
object
Describes the contact medium characteristics that could be used to contact a party
14 properties
Customer_Create
object
Skipped properties: id, href
11 properties 2 required
Format
object
The bill invoice format.
3 properties
AccountRef
object
Customer primary account or prepaid account for BalanceTransfer reason.
11 properties 1 required
Error_5
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
10 properties 2 required
CaseRef
object
The Case data structure
4 properties
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
5 properties 1 required
TaxDefinition
object
Reference of a tax definition.
1 property
TimePeriod
object
A base / value business entity used to represent a period of time between two timepoints.
2 properties
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
3 properties 2 required
ErrorParam
string
Represents error parameters that are used in the construction of the error message.
CycleSpecification
object
The customer bill cycle.
8 properties
PresentationMedia
object
The bill invoice presentation media.
1 property
PaymentPlan
object
The payment plan that associated to the account.
3 properties
DunningCase
object
Customer treatment process.
5 properties
Money
object
A base / value business entity used to represent money
2 properties
ContactMedium
object
Indicates the contact medium that could be used to contact the party.
2 properties 2 required
Customer_List
object
Customer List
4 properties
Customer_Update
object
Skipped properties: id, href
15 properties
TaxExemptionCertificate
object
A tax exemption certificate represents a tax exemption granted to a customer by a tax jurisdiction which may be a city, state, country.
5 properties
Customer
object
Customer details
18 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-customer-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 Agents API
Where this information came from

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