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 Service Activation and Configuration

TMF API Reference: TMF640 - Service Activation and Configuration Version 4.0 Service Activation and Configuration API goal is to provide the ability to activate and configure Service. This API features Monitor pattern allowing to manage service configuration/activation asynchronous request (server side will provide monitor as...

MTN Service Activation and Configuration 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, Nigeria, Uganda, South Africa, and Zambia. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 17 operations across 14 paths, organized into 4 resource areas, and defines 51 schemas. It is described by OpenAPI 2.0, at version 4.0.0.

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

17 operations 14 paths 51 schemas 2 DELETE4 GET1 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
4.0.0
Base URL
https://api.mtn.com/v1
Resource Areas
4

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 2 DELETE, 4 GET, 1 PATCH, 10 POST. They span 4 resource areas: service, monitor, events subscription, notification listeners (client side). Each is listed below with its method, path, parameters, and response codes.

service 5
GET
/service
List or find Service objects
listService 3 params → 200400401403404405409500
POST
/service
Creates a Service
createService 1 param → 201202400401403405409500
GET
/service/{id}
Retrieves a Service by ID
retrieveService 2 params → 200400401403404405409500
PATCH
/service/{id}
Updates partially a Service
patchService 2 params → 200400401403404405409500
DELETE
/service/{id}
Deletes a Service
deleteService 1 param → 204400401403404405409500
monitor 2
GET
/monitor
List or find Monitor objects
listMonitor 3 params → 200400401403404405409500
GET
/monitor/{id}
Retrieves a Monitor by ID
retrieveMonitor 2 params → 200400401403404405409500
events subscription 2
POST
/hub
Register a listener
registerListener 1 param → 201400401403404405409500
DELETE
/hub/{id}
Unregister a listener
unregisterListener 1 param → 204400401403404405500
notification listeners (client side) 8
POST
/listener/serviceCreateEvent
Client listener for entity ServiceCreateEvent
listenToServiceCreateEvent 1 param → 201400401403404405409500
POST
/listener/serviceAttributeValueChangeEvent
Client listener for entity ServiceAttributeValueChangeEvent
listenToServiceAttributeValueChangeEvent 1 param → 201400401403404405409500
POST
/listener/serviceStateChangeEvent
Client listener for entity ServiceStateChangeEvent
listenToServiceStateChangeEvent 1 param → 201400401403404405409500
POST
/listener/serviceDeleteEvent
Client listener for entity ServiceDeleteEvent
listenToServiceDeleteEvent 1 param → 201400401403404405409500
POST
/listener/monitorCreateEvent
Client listener for entity MonitorCreateEvent
listenToMonitorCreateEvent 1 param → 201400401403404405409500
POST
/listener/monitorAttributeValueChangeEvent
Client listener for entity MonitorAttributeValueChangeEvent
listenToMonitorAttributeValueChangeEvent 1 param → 201400401403404405409500
POST
/listener/monitorStateChangeEvent
Client listener for entity MonitorStateChangeEvent
listenToMonitorStateChangeEvent 1 param → 201400401403404405409500
POST
/listener/monitorDeleteEvent
Client listener for entity MonitorDeleteEvent
listenToMonitorDeleteEvent 1 param → 201400401403404405409500

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are ServiceRefOrValue (30 properties), Service (29 properties), Service_Create (27 properties), Service_Update (26 properties). Each schema is shown below with its type and property counts.

Addressable
object
Base schema for adressable entities
5 properties
Any
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties 2 required
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
5 properties
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties 1 required
EntityRef
object
Entity reference schema to be use for all entityRef class.
7 properties 1 required
EntityValue
object
Base entity value schema for use in TMForum Open-APIs
5 properties
Extensible
object
Base Extensible schema for use in TMForum Open-APIs
3 properties
Feature
object
Configuration feature.
10 properties 2 required
FeatureRelationship
object
Configuration feature
7 properties 2 required
HeaderItem
object
An item typically included in a request or response
5 properties 2 required
Monitor
object
Monitoring of resources
9 properties
Note
object
Extra information about a given entity
7 properties
OrderItemActionType
string
action to be performed on the product
Place
object
Place reference. Place defines the places where the products are sold or delivered.
6 properties
PlaceRef
object
Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.
7 properties 1 required
RelatedEntityRefOrValue
object
A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to…
8 properties 1 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 2 required
RelatedPlaceRefOrValue
object
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @sc…
8 properties 1 required
RelatedServiceOrderItem
object
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
9 properties 2 required
Request
object
A response to a request
7 properties 2 required
ResourceRef
object
7 properties 1 required
Response
object
A response to a request
6 properties 2 required
Service
object
Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. Th…
29 properties
Service_Create
object
Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. Th…
27 properties 2 required
Service_Update
object
Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. Th…
26 properties
ServiceRef
object
Service reference, for when Service is used by other entities
7 properties 1 required
ServiceRefOrValue
object
A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
30 properties
ServiceRelationship
object
6 properties 1 required
ServiceSpecificationRef
object
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
8 properties 1 required
ServiceStateType
string
Valid values for the lifecycle state of the service
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
5 properties
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties 2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties 1 required
ServiceCreateEvent
object
The notification data structure
10 properties
ServiceCreateEventPayload
object
The event data structure
1 property
ServiceAttributeValueChangeEvent
object
The notification data structure
11 properties
ServiceAttributeValueChangeEventPayload
object
The event data structure
1 property
ServiceStateChangeEvent
object
The notification data structure
10 properties
ServiceStateChangeEventPayload
object
The event data structure
1 property
ServiceDeleteEvent
object
The notification data structure
10 properties
ServiceDeleteEventPayload
object
The event data structure
1 property
MonitorCreateEvent
object
The notification data structure
10 properties
MonitorCreateEventPayload
object
The event data structure
1 property
MonitorAttributeValueChangeEvent
object
The notification data structure
11 properties
MonitorAttributeValueChangeEventPayload
object
The event data structure
1 property
MonitorStateChangeEvent
object
The notification data structure
10 properties
MonitorStateChangeEventPayload
object
The event data structure
1 property
MonitorDeleteEvent
object
The notification data structure
10 properties
MonitorDeleteEventPayload
object
The event data structure
1 property
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-service-activation-and-configuration.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 Ordering
MTN BSS TT OAuth V1
MTN Balance Management V1
Where this information came from

This is an independent, third-party profile of MTN Service Activation and Configuration, 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.