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 Digital Partner Management

TM Forum Open APIs (Apache 2.0) Party Management API Provides standardized mechanism for digital partner management such as creation, update, retrieval, deletion and notification of events. Partner is an organization that has any kind of relation with the enterprise.

MTN Digital Partner 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 Customers and South Africa. 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 44 schemas. It is described by OpenAPI 2.0, at version 1.0.

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

4 operations 2 paths 44 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

MTN Digital Partner 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.

partners 4
GET
/partners
List or find Organization details
listOrganization 8 params → 200400401403404405409500
POST
/partners
Creates a Organization
createOrganization 3 params → 201400401403405409500
GET
/partners/{id}
Retrieves a Organization by ID
retrieveOrganization 7 params → 200400401403404405409500
PATCH
/partners/{id}
Updates partially a Organization
patchOrganization 3 params → 200400401403404405409500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are CreateCustomerRequestPayload (42 properties), Individual (41 properties), Individual_Update (35 properties), Individual_Create (34 properties). Each schema is shown below with its type and property counts.

CreateCustomerRequestPayload
object
Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization nee…
42 properties 2 required
ChannelRef
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
8 properties 1 required
QuoteRef
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
8 properties
Attachment
object
Complements the description of an element (for instance a product) through video, pictures...
13 properties
AttachmentRef
object
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
9 properties 1 required
AttachmentRefOrValue
object
An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.
14 properties
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
10 properties 2 required
ContactMedium
object
Indicates the contact medium that could be used to contact the party.
11 properties
Disability
object
Lack or inadequate strength or ability.
6 properties
EntityRef
object
Entity reference schema to be use for all entityRef class.
7 properties 1 required
ExternalReference
object
External reference of the individual or reference in other system
12 properties
Individual
object
Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization nee…
41 properties 1 required
Individual_Create
object
Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization nee…
34 properties 3 required
Individual_Update
object
Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization nee…
35 properties 1 required
Individual_UpdateResponse
object
Represents the response structure returned to the api caller when updating a customer information
4 properties 1 required
IndividualIdentification
object
Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security numbe…
11 properties
IndividualStateType
string
Valid values for the lifecycle state of the individual. The I and U represent Create & Update respectively for comviva backend
Note
array
LanguageAbility
object
Ability of an individual to understand or converse in a language.
11 properties
MediumCharacteristic
object
Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
30 properties
Organization
object
Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the compl…
25 properties 1 required
Organization_Create
object
Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the compl…
16 properties 2 required
Organization_Update
object
Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the compl…
21 properties 1 required
OrganizationChildRelationship
object
Child references of an organization in a structure of organizations.
5 properties
OrganizationIdentification
object
Represents our registration of information used as proof of identity by an organization
10 properties
OrganizationParentRelationship
object
Parent references of an organization in a structure of organizations.
5 properties
OrganizationRef
object
7 properties 1 required
OrganizationStateType
string
Valid values for the lifecycle state of the organization
OtherNameIndividual
object
Keeps track of other names, for example the old name of a woman before marriage or an artist name.
19 properties
OtherNameOrganization
object
Keeps track of other names, for example the old name of an organization.
7 properties
Party
object
Generic Party structure used to define commonalities between sub concepts of Individual and Organization.
11 properties
PartyCreditProfile
object
An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.
12 properties
Quantity
object
An amount in a given unit
2 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
14 properties 2 required
Skill
object
Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level…
8 properties
TaxDefinition
object
Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Governmen…
7 properties
TaxExemptionCertificate
object
A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, countr…
8 properties
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
Money
object
2 properties 2 required
DueDetail
array
Error
object
7 properties 2 required
Result
object
4 properties 2 required
MemberList
array
Any

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-digital-partner-management.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 Digital Partner 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.