find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mtn-group-customer-kyc-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: The Customer KYC(Know Your Client) Verification API will validate the 3PP Customer KYC information with MTN Customer KYC information
  version: 1.0.2
  title: MTN Verification Customer KYC API
servers:
- url: https://api.mtn.com/v1/kycVerification/
security:
- ApiKeyAuth: []
- basicAuth: []
tags:
- name: Customer KYC
paths:
  /customers:
    get:
      tags:
      - Customer KYC
      summary: Verify multiple customer kyc information by submitting an array of only msisdn or BVNs as a query params
      description: This endpoint is responsible for handling the verification of multiple kyc information by sending an array of unique identifiers i.e MSISDN, BVN only
      parameters:
      - name: transactionId
        in: header
        x-example: e938-300949-394999-39993
        description: A transactionId for tracking purposes
        schema:
          type: string
      - name: targetSystem
        in: header
        x-example: NIBSS
        description: Target System
        schema:
          type: string
      - in: header
        name: bvns
        description: An array list of all the bvns to get customer details from
        x-example: '[BVN123455,BVN3409394]'
        schema:
          type: array
          items:
            type: string
            x-example: BVN123455,BVN3409394
      responses:
        '200':
          description: Callback Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerVerificationKYCMultiResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '5000'
                - $ref: '#/components/schemas/ErrorPayload'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4000'
                - $ref: '#/components/schemas/ErrorPayload'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4001'
                - $ref: '#/components/schemas/ErrorPayload'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '1000'
                - $ref: '#/components/schemas/ErrorPayload'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '406':
          description: Not acceptable
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '415':
          description: Unsupported media Type
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
    post:
      tags:
      - Customer KYC
      summary: Verify multiple customer kyc information by submitting an array of customer information
      description: This endpoint is responsible for handling the verification of multiple customers by passing an array of customers data.
      parameters:
      - name: transactionId
        in: header
        x-example: e938-300949-394999-39993
        description: A transactionId for tracking purposes
        schema:
          type: string
      - name: targetSystem
        in: header
        x-example: NIBSS
        description: Target System
        schema:
          type: string
      - name: requestType
        in: query
        description: The type of request to be made ie. whether it's a Face match or fingerprint verification,  Required to be passed when targetSystem is NIBSS
        required: false
        schema:
          type: string
          enum:
          - FACE_MATCH
          - FINGERPRINT_MATCH
      - name: verificationType
        in: query
        required: false
        description: Defines the type of verification 3PP wants to perform base on the passed payload ie. Whether it's a finger print, fingerprint with date of birth verification etc.  Required to be passed when targetSystem is NIBSS
        schema:
          type: string
          enum:
          - FINGERPRINT
          - FINGERPRINT_DOB
      responses:
        '200':
          description: Callback Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerVerificationKYCMultiResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '5000'
                - $ref: '#/components/schemas/ErrorPayload'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4000'
                - $ref: '#/components/schemas/ErrorPayload'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4001'
                - $ref: '#/components/schemas/ErrorPayload'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '1000'
                - $ref: '#/components/schemas/ErrorPayload'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '406':
          description: Not acceptable
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '415':
          description: Unsupported media Type
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerKYCVerificationMultipleRequest'
        description: The request body to be sent to the backend
  /customers/{customerId}:
    post:
      tags:
      - Customer KYC
      summary: Verify mtn customer kyc information against 3PP customer kyc information
      description: This endpoint is to enable trusted partners verify customer's KYC information passed in the request body. The verification logic will be carried out at the process layer where each KYC attributes will be validated to be TRUE or FALSE based on their matching record on the network downstream system
      parameters:
      - name: customerId
        in: path
        description: ID of the customer. It could be MSISDN, email address, or any other customer identifier. if customerId is msisdn, then the format must be E.123
        required: true
        schema:
          type: string
      - name: isConsentVerified
        in: query
        description: This will indicate that the customer consent has been acquired by the partner for KYC verification. For the request to be executed, this field should be set to TRUE if the consent validation has been successfully processed by the partner
        required: true
        schema:
          type: boolean
          enum:
          - false
          - true
      - in: header
        name: transactionId
        required: false
        description: A unique ID for tracking a particular transaction, optional and to be generated if not passed by the API caller
        x-example: c125d1e7-843f-410f-9252-71a55ec7cb92
        schema:
          type: string
      - in: query
        name: targetSystem
        schema:
          type: string
          enum:
          - DAAS
          - CLM
          - BANK_BILLING
          - CLM_REST
          - BIOSMART
      responses:
        '200':
          description: Callback Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCVerificationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '5000'
                - $ref: '#/components/schemas/ErrorPayload'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4000'
                - $ref: '#/components/schemas/ErrorPayload'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4001'
                - $ref: '#/components/schemas/ErrorPayload'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '1000'
                - $ref: '#/components/schemas/ErrorPayload'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '406':
          description: Not acceptable
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '415':
          description: Unsupported media Type
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BasicKYCRequestData'
        description: Request body
        required: true
    get:
      security:
      - basicAuth: []
      tags:
      - Customer KYC
      summary: Verify if customer MSISDN is active on either the bank or MTN
      description: This endpoint is to enable a 3PP confirm if a mobile number is active on the bank and to get a hashed mobile number
      parameters:
      - name: customerId
        in: path
        description: customer MSISDN that is to be confirmed
        required: true
        schema:
          type: string
      - name: transactionId
        in: query
        description: transactionId for tracking purposes
        schema:
          type: string
      - name: verificationType
        in: query
        description: Verification Type.
        schema:
          type: string
          enum:
          - BANK
          - HASHCODE
          - EVALIDATOR
          - WinBack
          - VALENTINE_PROMO
      - name: targetSystem
        in: query
        schema:
          type: string
          enum:
          - DAAS
          - CLM
          - BANK_BILLING
          - CLM_REST
          - NIBSS
      - name: externalCode
        in: query
        description: This can be the bank's short code
        schema:
          type: string
      - name: startDate
        in: query
        description: An optional parameter, together with endDate, allows developers to specify a time range by which to query customer data on. If you want to request data for 2 months, then start date will need to set to 2 months prior to today, and endDate to todays date. If this is not set, the date range will be defaulted to 6 months
        schema:
          type: string
      - name: endDate
        in: query
        description: An optional parameter, together with startDate, allows developers to specify a time range by which to query customer data on. If you want to request data for 2 months, then start date will need to set to 2 months prior to today, and endDate to todays date. If this is not set, the date range will be defaulted to 6 months
        schema:
          type: string
      responses:
        '200':
          description: Successful verification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerVerificationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '5000'
                - $ref: '#/components/schemas/ErrorPayload'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4000'
                - $ref: '#/components/schemas/ErrorPayload'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4001'
                - $ref: '#/components/schemas/ErrorPayload'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '1000'
                - $ref: '#/components/schemas/ErrorPayload'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '406':
          description: Not acceptable
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '415':
          description: Unsupported media Type
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
  /customers/{customerId}/kycScore:
    post:
      tags:
      - Customer KYC
      summary: Verify mtn customer kyc information against 3PP customer kyc information
      description: This endpoint is to enable trusted partners to verify customer's KYC information passed in the request body. The verification logic will be carried out where each KYC attributes will be validated and given a percentage score (between 0 - 100) based on their matching record on the network downstream system
      parameters:
      - name: customerId
        in: path
        description: ID of the customer. It could be MSISDN, email address, or any other customer identifier. if customerId is msisdn, then the format must be E.123
        required: true
        schema:
          type: string
      - in: header
        name: transactionId
        required: false
        description: A unique ID for tracking a particular transaction, optional and to be generated if not passed by the API caller
        x-example: c125d1e7-843f-410f-9252-71a55ec7cb92
        schema:
          type: string
      responses:
        '200':
          description: Callback Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCVerificationScoreResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '5000'
                - $ref: '#/components/schemas/ErrorPayload'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4000'
                - $ref: '#/components/schemas/ErrorPayload'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4001'
                - $ref: '#/components/schemas/ErrorPayload'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '1000'
                - $ref: '#/components/schemas/ErrorPayload'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '406':
          description: Not acceptable
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '415':
          description: Unsupported media Type
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KYCRequestDataScore'
        description: Request body
        required: true
  /customers/{customerId}/nameScore:
    post:
      tags:
      - Customer KYC
      summary: Verify mtn customer kyc information against 3PP customer kyc information
      description: This endpoint is to enable trusted partners to verify customer's KYC information passed in the request body. The verification logic will be carried out where each KYC attributes will be validated and given a percentage score (between 0 - 100) based on their matching record on the network downstream system
      parameters:
      - name: customerId
        in: path
        description: ID of the customer. It could be MSISDN, email address, or any other customer identifier. if customerId is msisdn, then the format must be E.123
        required: true
        schema:
          type: string
      - in: header
        name: transactionId
        required: false
        description: A unique ID for tracking a particular transaction, optional and to be generated if not passed by the API caller
        x-example: c125d1e7-843f-410f-9252-71a55ec7cb92
        schema:
          type: string
      responses:
        '200':
          description: Callback Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCNameVerificationScoreResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '5000'
                - $ref: '#/components/schemas/ErrorPayload'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4000'
                - $ref: '#/components/schemas/ErrorPayload'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4001'
                - $ref: '#/components/schemas/ErrorPayload'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '1000'
                - $ref: '#/components/schemas/ErrorPayload'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4001'
                - $ref: '#/components/schemas/ErrorPayload'
        '406':
          description: Not acceptable
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '415':
          description: Unsupported media Type
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '3000'
                - $ref: '#/components/schemas/ErrorPayload'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KYCNameRequestDataScore'
        description: Request body
        required: true
  /customers/{customerId}/addressScore:
    post:
      tags:
      - Customer KYC
      summary: Verify mtn customer kyc information against 3PP customer kyc information
      description: This endpoint is to enable trusted partners to verify customer's KYC information passed in the request body. The verification logic will be carried out where each KYC attributes will be validated and given a percentage score (between 0 - 100) based on their matching record on the network downstream system
      parameters:
      - name: customerId
        in: path
        description: ID of the customer. It could be MSISDN, email address, or any other customer identifier. if customerId is msisdn, then the format must be E.123
        required: true
        schema:
          type: string
      - in: header
        name: transactionId
        required: false
        description: A unique ID for tracking a particular transaction, optional and to be generated if not passed by the API caller
        x-example: c125d1e7-843f-410f-9252-71a55ec7cb92
        schema:
          type: string
      responses:
        '200':
          description: Callback Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCAddressVerificationScoreResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '5000'
                - $ref: '#/components/schemas/ErrorPayload'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    statusCode:
                      type: string
                      description: MADAPI canonical code for success
                      example: '4000'
                - $ref: '#/components/schemas/ErrorPayload'
        '403':
          description: Forb

# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mtn-group/refs/heads/main/openapi/mtn-group-customer-kyc-api-openapi.yml