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 SIM Management V1

This API provides a comprehensive suite of services for managing SIM-related operations, including SIM swap initiation, status tracking, eligibility checks, and resource management. It ensures secure and efficient handling of customer SIM lifecycle events.

MTN SIM Management V1 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, Benin, Côte d’Ivoire, Cameroon, and Congo. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 12 operations across 12 paths, organized into 2 resource areas, and defines 21 schemas. It is described by OpenAPI 3.0.1, at version 3.0.0 - Last updated date:2026-07-15 18:20:11.

Requests are made against a single base URL, https://api.mtn.com/v1.

12 operations 12 paths 21 schemas 7 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
3.0.0 - Last updated date:2026-07-15 18:20:11
Base URL
https://api.mtn.com/v1
Authentication
OAuth 2.0, HTTP Bearer
License
Resource Areas
2

Authentication & Security 2

MTN SIM Management V1 declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. It accepts HTTP bearer tokens (JWT) (Bearer). By default, every request must be authenticated.

  • Bearer — Bearer token received from OAuth2.0 authentication with the MADAPI

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 7 GET, 4 POST, 1 PUT. They span 2 resource areas: NumberRecycleService, SimManagementService. Each is listed below with its method, path, parameters, and response codes.

NumberRecycleService 1
POST
/customers/recycleStatus
Retrieve Customer Registration Status by specifying the 'customerId'.
NumberRecycleService_post_customerSimRecycleStatus_customersrecycleStat 1 param body → 200400401403404500502503
SimManagementService 11
POST
/customers/registration
provide the functionality of starter pack registration
SimManagementService_post_registration_customersregistratio 3 params body → 200400401403404500502503
GET
/customers/sim/resourcePool
Retrieve available Resources.
SimManagementService_get_availableMsisdn_customerssimresource 5 params → 200400401403404500502503
POST
/customers/{customerId}/sim/resourcePool/reserve
Reserve a resource such as an MSISDN
SimManagementService_post_reserveResource_customerscustomerIds 3 params body → 200400401403404500502503
GET
/customers/{customerId}/simRecycle/verifyStatus
verify sim Recycle status
SimManagementService_get_simRecycleStatus_customerscustomerIds 3 params → 200400401403404500502503
PUT
/customers/{customerId}/simSwap
Initiate the SIM swap process
SimManagementService_put_initiateSimSwap_customerscustomerIds 4 params body → 200400401403404500502503
GET
/customers/{customerId}/simSwap/details
Get sim details
SimManagementService_get_customerSimDetails_customerscustomerIds 4 params → 200400401403404500502503
GET
/customers/{customerId}/simSwap/eligibility
Get sim swap eligibility
SimManagementService_get_getSimSwapEligibility_customerscustomerIds 3 params → 200400401403404500502503
POST
/customers/{customerId}/simSwap/nextAuthentication
Get next Authentication (Q&A)
SimManagementService_post_getNextauthenticationQuestion_customerscustomerIds 2 params body → 200400401403404500502503
GET
/customers/{customerId}/simSwap/status
Get sim swap status
SimManagementService_get_getSimSwapStatus_customerscustomerIds 6 params → 200400401403404500502503
GET
/customers/{customerId}/simSwap/validateStatus
validate sim-swap status
SimManagementService_get_validateSimSwapStatus_customerscustomerIds 5 params → 200400401403404500502503
GET
/customers/{customerId}/simSwap/verifyStatus
verify sim-swap status
SimManagementService_get_verifySimSwapStatus_customerscustomerIds 3 params → 200400401403404500502503

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are za_co_mtn_simswap_aggregator_model_request_InitiateSimSwapRequestDto (16 properties), APIError (9 properties), za_co_mtn_simswap_aggregator_model_request_IndividualIdentification (7 properties), za_co_mtn_simswap_aggregator_model_request_EngagedParty (7 properties). Each schema is shown below with its type and property counts.

za_co_mtn_simswap_aggregator_model_response_simrecycle_SimRecycleResponse
object
7 properties
za_co_mtn_simswap_aggregator_model_request_ContactMedium
object
2 properties
za_co_mtn_simswap_aggregator_model_request_IndividualIdentification
object
7 properties
za_co_mtn_simswap_aggregator_model_request_CustomFields
object
1 property
za_co_mtn_simswap_aggregator_model_PreviousQuestionsAnswer
object
2 properties
za_co_mtn_simswap_aggregator_model_request_CustomerRegistrationRequest
object
2 properties
za_co_mtn_simswap_aggregator_model_request_RelatedParty
object
5 properties
za_co_mtn_simswap_aggregator_model_request_ProductOffering
object
2 properties
za_co_mtn_simswap_aggregator_enums_ResourceType
object
1 property
za_co_mtn_simswap_aggregator_model_request_EngagedParty
object
7 properties
za_co_mtn_simswap_aggregator_model_request_Resource
object
3 properties
za_co_mtn_simswap_aggregator_model_request_Geometry
object
3 properties
za_co_mtn_simswap_aggregator_model_request_CustomerInformation
object
2 properties
za_co_mtn_simswap_aggregator_model_request_simrecycle_SimRecycleRequest
object
1 property 1 required
za_co_mtn_simswap_aggregator_model_request_GetNextAuthenticationQuestionRequestDto
object
1 property
za_co_mtn_simswap_aggregator_model_request_GeographicLocation
object
2 properties
za_co_mtn_simswap_aggregator_model_request_Characteristic
object
4 properties
za_co_mtn_simswap_aggregator_model_request_InitiateSimSwapRequestDto
object
16 properties
APIError
object
Generic MADAPI error response structure
9 properties 2 required
za_co_mtn_simswap_aggregator_model_request_ReserveResourceData
object
2 properties
za_co_mtn_simswap_aggregator_model_response_simrecycle_SimRecycleStatus
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-sim-management-staging.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 SIM Management V1, 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.