MTN Group · Authentication Profile
Mtn Group Authentication

Authentication
MTN Group secures its APIs with apiKey, http, and oauth2 across 7 declared security schemes, as derived from its OpenAPI definitions. OAuth 2.0 is offered via the clientCredentials flow(s).
TelecommunicationsSouth AfricaAfricaMobile Network OperatorNetwork APIsOpen GatewayTM ForumBSSMobile MoneyMessagingSMSUSSDIoTSIM SwapIdentity VerificationPayments
Methods: apiKey, http, oauth2 Schemes: 7 OAuth flows: clientCredentials API key in: header
Security Schemes

OAuth2 oauth2
· flows: clientCredentials
bearerAuth http
scheme: bearer
ApiKeyAuth apiKey
· in: header (X-API-Key)
ApiKey apiKey
· in: header (x-api-key)
basicAuth http
scheme: basic
APIKeyAuth apiKey
· in: header (x-API-Key)
Bearer apiKey
· in: header (Authorization)
Source

Authentication Profile

generated: '2026-07-25'
method: searched
source: openapi/mtn-group-account-decisioning.yml, openapi/mtn-group-account-management-coe.yml, openapi/mtn-group-advertising-v2.yml,
  openapi/mtn-group-agent-profile.yml, openapi/mtn-group-ayo-preapproval.yml, openapi/mtn-group-ayoaccountholderinfo.yml,
  openapi/mtn-group-balance-management-v1.yml, openapi/mtn-group-bss-tt-oauth-v1.yml, openapi/mtn-group-callmeback-v1.yml,
  openapi/mtn-group-callmeback-v2.yml, openapi/mtn-group-communication-management-v1.yml, openapi/mtn-group-content-push.yml
  ...
docs:
- https://developers.mtn.com/getting-started/understanding-oauth-20
- https://developers.mtn.com/getting-started/things-every-developer-should-know
- https://momodeveloper.mtn.com/api-documentation/getting-started
summary:
  types:
  - apiKey
  - http
  - oauth2
  api_key_in:
  - header
  oauth2_flows:
  - clientCredentials
documented_model:
  madapi:
    flow: oauth2 client_credentials
    token_url: https://api.mtn.com/v1/oauth/access_token?grant_type=client_credentials
    token_request: POST application/x-www-form-urlencoded, body client_id={consumer-key}&client_secret={consumer-secret}
    token_type: BearerToken
    expires_in_seconds: 3599
    scope: empty in the documented token response
    call_headers:
    - 'Authorization: Bearer {access_token}'
    - 'x-api-key: {consumer key}'
    - transactionID (traceability, required by some products)
    credential_source: the My Apps section of https://developers.mtn.com/apps
  momo:
    flow: subscription key + provisioned API user/key exchanged for a bearer token
    headers:
    - Ocp-Apim-Subscription-Key
    - 'Authorization: Bearer {token}'
    - X-Target-Environment
    - X-Reference-Id
    - X-Callback-Url
    key_pages:
      sandbox: https://momodeveloper.mtn.com/profile
      production: https://momoapi.mtn.com/profile
    note: primary and secondary subscription keys are issued per product and never expire; the sandbox API user/key
      pair is provisioned through the Sandbox Provisioning API
schemes:
- name: OAuth2
  type: oauth2
  flows:
  - flow: clientCredentials
    tokenUrl: https://api.mtn.com/v1/oauth/access_token?grant_type=client_credentials
    scopes: 0
  sources:
  - openapi/mtn-group-account-decisioning.yml
  - openapi/mtn-group-advertising-v2.yml
  - openapi/mtn-group-agent-profile.yml
  - openapi/mtn-group-ayo-preapproval.yml
  - openapi/mtn-group-ayoaccountholderinfo.yml
  - openapi/mtn-group-balance-management-v1.yml
  - openapi/mtn-group-callmeback-v1.yml
  - openapi/mtn-group-callmeback-v2.yml
  - openapi/mtn-group-communication-management-v1.yml
  - openapi/mtn-group-content-push.yml
  - openapi/mtn-group-customer-account-management-v1.yml
  - openapi/mtn-group-customer-billing-token-v1.yml
  - openapi/mtn-group-customer-data-transfer-ng-prod.yml
  - openapi/mtn-group-customer-delivery-booking.yml
  - openapi/mtn-group-customer-pin-management-v2.yml
  - openapi/mtn-group-customer-promotion.yml
  - openapi/mtn-group-device-swap-v1.yml
  - openapi/mtn-group-digital-partner-management.yml
  - openapi/mtn-group-g2m.yml
  - openapi/mtn-group-hcm-v1.yml
  - openapi/mtn-group-insurance.yml
  - openapi/mtn-group-iot-device-management.yml
  - openapi/mtn-group-kyc-consent.yml
  - openapi/mtn-group-logback-v1.yml
  - openapi/mtn-group-medallia-sms-v2.yml
  - openapi/mtn-group-merchant-provisioning-v1.yml
  - openapi/mtn-group-mobile-customer-information.yml
  - openapi/mtn-group-momo-verification.yml
  - openapi/mtn-group-mtn-customer-bill-management.yml
  - openapi/mtn-group-mtn-customer-datatransfer.yml
  - openapi/mtn-group-mtn-customer-kyc-api-v1-product.yml
  - openapi/mtn-group-mtn-customer-plans-api-v2.yml
  - openapi/mtn-group-mtn-customer-profiles-api-v2-product.yml
  - openapi/mtn-group-mtn-party-management.yml
  - openapi/mtn-group-mtn-product-offering-api-v3.yml
  - openapi/mtn-group-mtn-sms-api-v1.yml
  - openapi/mtn-group-mtn-sms-interface.yml
  - openapi/mtn-group-mtn-subscription-api-v2.yml
  - openapi/mtn-group-notification-production.yml
  - openapi/mtn-group-notification-v2.yml
  - openapi/mtn-group-payment-methods-management-sa.yml
  - openapi/mtn-group-payments-v1.yml
  - openapi/mtn-group-product-catalog-coe.yml
  - openapi/mtn-group-product-catalog-management-v1.yml
  - openapi/mtn-group-product-catalogue-management.yml
  - openapi/mtn-group-product-ordering-coe.yml
  - openapi/mtn-group-provisioning.yml
  - openapi/mtn-group-resource-config-v1.yml
  - openapi/mtn-group-risk-management.yml
  - openapi/mtn-group-rwanda-party-management.yml
  - openapi/mtn-group-sales-management.yml
  - openapi/mtn-group-service-ordering.yml
  - openapi/mtn-group-siebel.yml
  - openapi/mtn-group-sim-management-staging.yml
  - openapi/mtn-group-sim-swap-verification-v1.yml
  - openapi/mtn-group-simverification.yml
  - openapi/mtn-group-sms-v3-api.yml
  - openapi/mtn-group-subscriber-management.yml
  - openapi/mtn-group-subscriber-type.yml
  - openapi/mtn-group-taxation-v1.yml
  - openapi/mtn-group-ticket.yml
  - openapi/mtn-group-tmf-720-digital-identity-management.yml
  - openapi/mtn-group-tmf-party-interaction-tmf683.yml
  - openapi/mtn-group-tmf-party-management.yml
  - openapi/mtn-group-tmf-payment-management-tmf676.yml
  - openapi/mtn-group-tmf-prepay-balance-management-tmf654.yml
  - openapi/mtn-group-tmf-product-catalog-tmf620.yml
  - openapi/mtn-group-tmf-product-ordering-tmf622.yml
  - openapi/mtn-group-tmf-usage-consumption-tmf677.yml
  - openapi/mtn-group-tmf-usage-management-tmf635.yml
  - openapi/mtn-group-tmf629-customer-management.yml
  - openapi/mtn-group-tmf633-shopping-cart-management.yml
  - openapi/mtn-group-tmf637-product-inventory.yml
  - openapi/mtn-group-unified-balance-v1.yml
  - openapi/mtn-group-usage-consumption.yml
  - openapi/mtn-group-usage-management.yml
  - openapi/mtn-group-withdrawals-v1.yml
- name: bearerAuth
  type: http
  scheme: bearer
  bearerFormat: JWT
  sources:
  - openapi/mtn-group-account-management-coe.yml
  - openapi/mtn-group-advertising-v2.yml
  - openapi/mtn-group-customer-data-transfer-ng-prod.yml
  - openapi/mtn-group-iot-device-management.yml
  - openapi/mtn-group-kyc-consent.yml
  - openapi/mtn-group-mtn-customer-datatransfer.yml
  - openapi/mtn-group-payments-v1.yml
  - openapi/mtn-group-sim-management-staging.yml
  - openapi/mtn-group-taxation-v1.yml
  - openapi/mtn-group-tmf-party-management.yml
  - openapi/mtn-group-tmf-payment-management-tmf676.yml
  - openapi/mtn-group-tmf-usage-management-tmf635.yml
  - openapi/mtn-group-usage-management.yml
- name: ApiKeyAuth
  type: apiKey
  in: header
  parameter: X-API-Key
  sources:
  - openapi/mtn-group-agent-profile.yml
  - openapi/mtn-group-ayo-preapproval.yml
  - openapi/mtn-group-balance-management-v1.yml
  - openapi/mtn-group-callmeback-v1.yml
  - openapi/mtn-group-callmeback-v2.yml
  - openapi/mtn-group-communication-management-v1.yml
  - openapi/mtn-group-content-push.yml
  - openapi/mtn-group-customer-account-management-v1.yml
  - openapi/mtn-group-customer-billing-token-v1.yml
  - openapi/mtn-group-customer-delivery-booking.yml
  - openapi/mtn-group-customer-identification-v1.yml
  - openapi/mtn-group-customer-kyc-verification.yml
  - openapi/mtn-group-customer-loyalty-management.yml
  - openapi/mtn-group-customer-management-coe-za-preprod.yml
  - openapi/mtn-group-customer-management.yml
  - openapi/mtn-group-customer-pin-management-v2.yml
  - openapi/mtn-group-customer-promotion.yml
  - openapi/mtn-group-customer-survey.yml
  - openapi/mtn-group-digital-partner-management.yml
  - openapi/mtn-group-eec-token-management.yml
  - openapi/mtn-group-g2m.yml
  - openapi/mtn-group-hcm-v1.yml
  - openapi/mtn-group-logback-v1.yml
  - openapi/mtn-group-merchant-provisioning-v1.yml
  - openapi/mtn-group-mobile-customer-information.yml
  - openapi/mtn-group-momo-verification.yml
  - openapi/mtn-group-mtn-customer-bill-management.yml
  - openapi/mtn-group-mtn-customer-locations-api-v1.yml
  - openapi/mtn-group-mtn-customer-plans-api-v2.yml
  - openapi/mtn-group-mtn-customer-profiles-api-v2-product.yml
  - openapi/mtn-group-mtn-customer-score.yml
  - openapi/mtn-group-mtn-ng-retailer-productivity-tracking-v1.yml
  - openapi/mtn-group-mtn-nigeria-customer-datashare.yml
  - openapi/mtn-group-mtn-nigeria-data-gifting-v1.yml
  - openapi/mtn-group-mtn-party-management.yml
  - openapi/mtn-group-mtn-product-offering-api-v2.yml
  - openapi/mtn-group-mtn-product-offering-api-v3.yml
  - openapi/mtn-group-mtn-subscription-api-v2.yml
  - openapi/mtn-group-payment-methods-management-sa.yml
  - openapi/mtn-group-product-catalog-coe.yml
  - openapi/mtn-group-product-catalog-management-v1.yml
  - openapi/mtn-group-product-catalogue-management.yml
  - openapi/mtn-group-product-ordering-coe.yml
  - openapi/mtn-group-provisioning.yml
  - openapi/mtn-group-resource-config-v1.yml
  - openapi/mtn-group-risk-management.yml
  - openapi/mtn-group-rwanda-party-management.yml
  - openapi/mtn-group-siebel.yml
  - openapi/mtn-group-subscriber-management.yml
  - openapi/mtn-group-subscriber-type.yml
  - openapi/mtn-group-ticket.yml
  - openapi/mtn-group-tmf-720-digital-identity-management.yml
  - openapi/mtn-group-tmf-party-interaction-tmf683.yml
  - openapi/mtn-group-tmf-prepay-balance-management-tmf654.yml
  - openapi/mtn-group-tmf-product-catalog-tmf620.yml
  - openapi/mtn-group-tmf-product-ordering-tmf622.yml
  - openapi/mtn-group-tmf-usage-consumption-tmf677.yml
  - openapi/mtn-group-tmf629-customer-management.yml
  - openapi/mtn-group-tmf633-shopping-cart-management.yml
  - openapi/mtn-group-tmf637-product-inventory.yml
  - openapi/mtn-group-tmf688-event-management.yml
  - openapi/mtn-group-unified-balance-v1.yml
  - openapi/mtn-group-usage-consumption.yml
  - openapi/mtn-group-withdrawals-v1.yml
- name: ApiKey
  type: apiKey
  in: header
  parameter: x-api-key
  sources:
  - openapi/mtn-group-bss-tt-oauth-v1.yml
  - openapi/mtn-group-insurance.yml
  - openapi/mtn-group-mtn-customer-kyc-api-v1-product.yml
  - openapi/mtn-group-mtnid-getinfo.yml
  - openapi/mtn-group-ussd.yml
- name: basicAuth
  type: http
  scheme: basic
  sources:
  - openapi/mtn-group-customer-kyc-verification.yml
  - openapi/mtn-group-tmf688-event-management.yml
- name: APIKeyAuth
  type: apiKey
  in: header
  parameter: x-API-Key
  sources:
  - openapi/mtn-group-order-fulfillment.yml
  - openapi/mtn-group-rcs-capability.yml
  - openapi/mtn-group-simverification.yml
- name: Bearer
  type: apiKey
  in: header
  parameter: Authorization
  sources:
  - openapi/mtn-group-resource-pool-management.yml