{
  "opencollection": "1.0.0",
  "info": {
    "name": "MTN Customer Score API",
    "version": "v1.0.1"
  },
  "items": [
    {
      "info": {
        "name": "customers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Customer score.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/customers/:customerId/score",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "x-country-code",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Score Type"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Start Date"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "End Date"
              },
              {
                "name": "reportId",
                "value": "",
                "type": "query",
                "description": "This identifies the type in which the score report should be sent"
              },
              {
                "name": "idNumber",
                "value": "",
                "type": "query",
                "description": "This is the customer's bank verification number"
              },
              {
                "name": "fullName",
                "value": "",
                "type": "query",
                "description": "This is the customer's full name"
              },
              {
                "name": "dob",
                "value": "",
                "type": "query",
                "description": "Customer's date of birth. format `'YYYY-MM-DD'`"
              },
              {
                "name": "targetSystem",
                "value": "",
                "type": "query"
              },
              {
                "name": "userId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "This Endpoint is used to determine the customer's score through an activities performed within a period of time."
        },
        {
          "info": {
            "name": "Sends Credit Information to CRC",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/customers/:customerId/score/creditinfo",
            "headers": [
              {
                "name": "requestType",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This operation helps to send credit information to the backend"
        }
      ]
    },
    {
      "info": {
        "name": "Reporting",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "retrieve credit score report for an individual and coorporate entity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/customers/:customerId/score/creditreport",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Identifier of the Individual. This could be msisdn number with country code or an organisation business ID for a corporate report"
              },
              {
                "name": "countryCode",
                "value": "",
                "type": "query",
                "description": "Country ISO code. Must be ISO 3166-1 alpha-3 codes (It is a 3 character string)"
              },
              {
                "name": "idType",
                "value": "",
                "type": "query",
                "description": "This should be the type of ID. For eaxmple- passport, national identity card,refugee under document etc."
              },
              {
                "name": "idValue",
                "value": "",
                "type": "query",
                "description": "Value of the 'idType'"
              },
              {
                "name": "customerCode",
                "value": "",
                "type": "query"
              },
              {
                "name": "calllbackUrl",
                "value": "",
                "type": "query",
                "description": "URL that will receive final results for async processing"
              },
              {
                "name": "referenceNumber",
                "value": "",
                "type": "query",
                "description": "Reference number that is used when merging multiple facilities"
              },
              {
                "name": "facilityId",
                "value": "",
                "type": "query"
              },
              {
                "name": "facilityList",
                "value": "",
                "type": "query",
                "description": "This is a comma separated list of the different failities to be merged"
              },
              {
                "name": "requestType",
                "value": "",
                "type": "query",
                "description": "identifier to know if the request is for an individual, corporate or a merge request"
              }
            ]
          },
          "docs": "This operation retrieves a credit score report for an individual and coorporate entity. This can be a nano, classic or a basic individual or cooporate report"
        }
      ]
    }
  ],
  "bundled": true
}