{
  "opencollection": "1.0.0",
  "info": {
    "name": "Customer Identification API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Usage Historical Information",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Usage, Roaming, Recharge History, Customer Profile or Eligibility status of a customer, identified by an MSISDN",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/customer",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "query",
                "description": "MSISDN of the customer"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query",
                "description": "Unique identifier of the system from which the request for customer information is coming. This is to be assigned by the back-end provider system"
              },
              {
                "name": "operationName",
                "value": "",
                "type": "query",
                "description": "Name assigned to the task to be performed. Below are the possible values;\n- **subscriberUsage:** Data, Voice, SMS call events records\n- **roamingUsage:** Data, Voice, SMS call events records for Roaming\n- **rechargeHistory:** Airtime Recharge History\n- **daUsageHistory:** Dedicated Account Balance usage\n- **mainAccountUsage:** Events that used the Main Airtime\n- **accountAdjustments:** Bucket Balance adjustment events that\nhappened on MA and DA's\n- **internetUsageDetails:** Detailed Data usage events\n- **viewloandetailsCVAS:** gets the list of open loans and their data for a subscriber of Xtratime product\n- **viewtrxdetailsCVAS:** used to get a list of the history for loans (Advance/Recoveries) for a subscriber of xtratime product.\n- **checkEligibilityCVAS:** used to retrieve the list of denomination identifiers i.e. loan bands for which the subscriber is eligible at the time of the request.\n- **checkProfileCVAS:** used to retrieve the credit limit and balances list of the customer\n- **validateKYC:** confirm NIN and MSISDN are a match/no-match"
              },
              {
                "name": "IdNumber",
                "value": "",
                "type": "query",
                "description": "NIN of the msisdn for which a match or no match is required . It is only applicable and mandatory if the operationName is set to validateKYC."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Start Date from which information is required. Format; YYYYMMDD\n\n*Only applicable and mandatory when **operationName** = subscriberUsage, roamingUsage, rechargeHistory, daUsageHistory, mainAccountUsage, accountAdjustments, internetUsageDetails*"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "End Date to which information is required. Format; YYYYMMDD\n\n*Only applicable when **operationName** = subscriberUsage, roamingUsage, rechargeHistory, daUsageHistory, mainAccountUsage, accountAdjustments, internetUsageDetails*"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Status of the loan\n\n*Only applicable when **operationName** = viewloandetailsCVAS*"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Indicates the max number of loan transaction to return. This is a limiter and can not exceed the project maximum.\n\n*Only applicable when **operationName** = viewtrxdetailsCVAS*"
              },
              {
                "name": "cvasBandName",
                "value": "",
                "type": "query",
                "description": "Specifies a specific loan band against which eligibility is checked.\n\n*Only applicable when **operationName** = checkEligibilityCVAS*"
              },
              {
                "name": "cvasBandGroup",
                "value": "",
                "type": "query",
                "description": "Specifies the loan bands of the group against which eligibility is checked.\n\n*Only applicable when **operationName** = checkEligibilityCVAS*"
              },
              {
                "name": "responseType",
                "value": "",
                "type": "query",
                "description": "Specifies the level of information to return.\n\n*Only applicable when **operationName** = checkEligibilityCVAS*\n- B stands for \"Basic\". Returns Eligibility status only\n- E stands for \"Extend\". Returns Eligibility status and the list of eligible bands."
              },
              {
                "name": "eligibilityCheck",
                "value": "",
                "type": "query",
                "description": "Specifies the eligibility rules to run.\n\n*Only applicable when **operationName** = checkEligibilityCVAS*\n- B stands for \"Basic\". Without IN interaction\n- E stands for \"Extend\". With complete eligibility rules"
              },
              {
                "name": "usageType",
                "value": "",
                "type": "query",
                "description": "Specifies the type of usage to be fetched.\n\n*Only applicable when **operationName** = subscriberUsage*."
              }
            ]
          },
          "docs": "Get Usage, Roaming, Recharge History, Customer Profile or Eligibility status of a customer, identified by an MSISDN"
        }
      ]
    },
    {
      "info": {
        "name": "Customer Information",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Query Customer or Merchant Data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/customer",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              },
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Query Customer or Merchant Data"
        }
      ]
    }
  ],
  "bundled": true
}