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 Document Management

TMF667 Document API describes the meta-data of a Document, such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a Word.doc, PDF, Video clip, or Image) will be held in the associated Attachment(s) either by Ref or Value. If by value - the binary content is held in the...

MTN Document 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, Uganda, Nigeria, 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 37 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

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

4 operations 2 paths 37 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://mtn.com/tmf-api/document/v4/
Resource Areas
1

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.

document 4
GET
/document/{id}
Retrieves/Downloads a document by ID
retrieveDocument 3 params → 200400401403404405409500
PATCH
/document/{id}
Updates partially a Document
patchDocument 3 params → 200400401403404405409500
GET
/document
List or find document objects
listDocument 2 params → 200400401403404405409500
POST
/document
Creates a Document
createDocument 3 params → 200400401403405409500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Document (19 properties), Document2 (18 properties), DocumentSpecificationRefOrValue (17 properties), CharacteristicSpecification (17 properties). Each schema is shown below with its type and property counts.

CategoryRef
object
The category for grouping recommendations
8 properties 1 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
7 properties 2 required
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
6 properties
CharacteristicSpecification
object
This class defines a characteristic specification.
17 properties
CharacteristicSpecificationBase
object
This class defines a characteristic specification.
15 properties
CharacteristicSpecificationRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic i…
9 properties
CharacteristicValueSpecification
object
specification of a value (number or text or an object) that can be assigned to a Characteristic.
11 properties
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties 1 required
Document
object
A Document describes the meta-data of a Document - such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a…
19 properties
Document_Update
object
A Document describes the meta-data of a Document - such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a…
5 properties
DocumentRef
object
7 properties 1 required
DocumentSpecification
object
A DocumentSpecification provides the characteristics and constraints that describe a particular type of Document. It follows the EntitySpecification pattern, s…
16 properties
DocumentSpecificationRef
object
A DocumentSpecificationRef provides a reference to a DocumentSpefication
7 properties 1 required
DocumentSpecificationRefOrValue
object
A DocumentSpecificationRefOrValue where you can select between a DocumentSpecification (by Value) or a DocumentSpecificationRef (by Reference)
17 properties
DocumentSpecificationStatusType
string
Possible values for the status of a DocumentSpecification
DocumentStatusType
string
Possible values for the status of a Document
ExternalIdentifier
object
An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off fro…
7 properties 1 required
Quantity
object
An amount in a given unit
2 properties
RelatedEntity
object
A reference to an entity, where the type of the entity is not known in advance.
8 properties 3 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 2 required
TargetEntitySchema
object
The reference object to the schema and type of target entity which is described by a specification
2 properties 2 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
Any
ApiResponse
object
6 properties
AttachmentRefOrValue
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
14 properties
Characteristic2
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties 2 required
CharacteristicRelationship2
object
Another Characteristic that is related to the current Characteristic;
5 properties
Document2
object
Document is a tangible output from an activity
18 properties
Document_Create
object
Document is a tangible output from an activity Skipped properties: id,href
16 properties
DocumentRef2
object
7 properties 1 required
DocumentSpecification2
object
A document specification reference
8 properties
Quantity2
object
An amount in a given unit
2 properties
RelatedEntity2
object
A reference to an entity, where the type of the entity is not known in advance.
8 properties 3 required
RelatedParty2
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 2 required
TimePeriod2
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
Error2
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-document-managment.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 Document 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.