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 TMF629 - Customer Management

This is Swagger UI environment generated for the TMF Customer Management specification.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include TM Forum, TMF629, South Africa, and Ghana. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 30 schemas. It is described by OpenAPI 2.0, at version 4.0.

Requests are made against the base URL https://api.mtn.com/tmf-api/customerManagement/v4.

4 operations 2 paths 30 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
4.0
Base URL
https://api.mtn.com/tmf-api/customerManagement/v4
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

MTN TMF629 - Customer Management 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 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

customer 4
GET
/customer
List or find Customer objects
listCustomer 16 params → 200400401403404405409500
POST
/customer
Creates a Customer
createCustomer 2 params → 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 3 params → 200400401403404405409500

Schemas 30

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

Customer
object
Customer details
18 properties 2 required
Customer_List
object
Customer List
4 properties
Customer_Create
object
Skipped properties: id, href
11 properties 2 required
Customer_Update
object
Skipped properties: id, href
15 properties
TimePeriod
object
A base / value business entity used to represent a period of time between two timepoints.
2 properties
PartyRef
object
Party reference. A party represents an organization or an individual.
9 properties 2 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
3 properties 2 required
AccountRef
object
Customer primary account or prepaid account for BalanceTransfer reason.
11 properties 1 required
BillStructure
object
The bill structure that associated to the customer.
2 properties
CycleSpecification
object
The customer bill cycle.
8 properties
Format
object
The bill invoice format.
3 properties
PresentationMedia
object
The bill invoice presentation media.
1 property
PaymentPlan
object
The payment plan that associated to the account.
3 properties
CreditProfile
object
Credit profile for the party.
10 properties 2 required
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
5 properties 1 required
BankAccountDebitType
object
Details of a bank account
5 properties
BankCardType
object
Details of a bank card
6 properties
IndividualIdentification
object
Represents our registration of information used as proof of identity by an individual (national identity card)
2 properties
ContactMedium
object
Indicates the contact medium that could be used to contact the party.
2 properties 2 required
MediumCharacteristic
object
Describes the contact medium characteristics that could be used to contact a party
14 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
TaxDefinition
object
Reference of a tax definition.
1 property
TreatmentExemption
object
Customer treatment exemption.
3 properties
TreatmentSuspension
object
Customer treatment suspension.
4 properties
DunningCase
object
Customer treatment process.
5 properties
ObjectKey
integer
All object keys matching search criteria returned in the response body. Array of objectKey
CaseRef
object
The Case data structure
4 properties
Money
object
A base / value business entity used to represent money
2 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
10 properties 2 required
ErrorParam
string
Represents error parameters that are used in the construction of the error message.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-tmf629-customer-management.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
#TM Forum#TMF629#South Africa#Ghana
← Back to M APIs
API Details
ID
mtn-group:tmf629-customer-management
Base URL
https://api.mtn.com/tmf-api/customerManagement/v4
Docs
https://developers.mtn.com/products/tmf629-customer-management
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=tmf629-customer-management&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/tmf629-customer-management"

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 TMF629 - Customer Management, 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.