Enable Monitoring:

Overview

A business entity may be monitored for business and compliance. Business monitoring is reported monthly while compliance monitoring is reported daily. This POST API enables monitoring for either or both, business and compliance. You must retrieve the markaazId using Markaaz Match and add that entity to a portfolio before calling the Enable Monitoring API. Review the Portfolio APIs before proceeding if this is unclear. Monitoring reports are available via the Enterprise Portal.

Inputs:

markaazId, portfolioId and monitoringType (must have at least one entry) are required. epInternalId is optional and is your internal ID. The epInternalId can be used to tie a Markaaz ID to the internal identifier of the business entity in your backend systems.
monitoringType may be either one or both values shown in the example below.

{  
  "data": {  
    "markaazId": "",  
    "portfolioId": "",  
    "epInternalId": "",  
    "monitoringType": ["business","compliance"]  
  }  
}

{
  "markaaz": {
    "traceId": "",
    "markaazId": "",
    "bizInfo": {
      "dba": "",
      "legalName": "",
      "taxId": "",
      "nationalId": "",
      "addresses": [
        {
          "type": "",
          "line1": "",
          "line2": "",
          "locality": "",
          "region": "",
          "country": "",
          "postalCode": "",
          "latitude": "",
          "longitude": "",
          "geoprecision": "",
          "businessIndicator": "",
          "residentialIndicator": "",
          "sohoIndicator": ""
        }
      ]
    },
    "portfolioDetail": {
      "portfolioId": "",
      "portfolioName": "",
      "portfolioDesc": ""
    },
    "monitoring": [
      {
        "action": "enabled",
        "monitoringType": [],
        "statusDate": ""
      }
    ]
  }
}

Disable Monitoring:

This POST API allows for disabling monitoring of either or both, business and compliance monitoring.
It does not remove the entity from the portfolio.

Inputs:

markaazId, portfolioId and monitoringType (must have at least one entry) are required. The epInternalId can be used to tie a Markaaz ID to your internal identifier of the business entity in your backend systems.
monitoringType may be either or both values shown in the example below.

{  
  "data": {  
    "markaazId": "",  
    "portfolioId": "",  
    "epInternalId": "",  
    "monitoringType": ["business","compliance"]  
  }  
}

{
  "markaaz": {
    "traceId": "",
    "markaazId": "",
    "bizInfo": {
      "dba": "",
      "legalName": "",
      "taxId": "",
      "nationalId": "",
      "addresses": [
        {
          "type": "",
          "line1": "",
          "line2": "",
          "locality": "",
          "region": "",
          "country": "",
          "postalCode": "",
          "latitude": "",
          "longitude": "",
          "geoprecision": "",
          "businessIndicator": "",
          "residentialIndicator": "",
          "sohoIndicator": ""
        }
      ]
    },
    "portfolioDetail": {
      "portfolioId": "",
      "portfolioName": "",
      "portfolioDesc": ""
    },
    "monitoring": [
      {
        "action": "disabled",
        "monitoringType": [],
        "statusDate": ""
      }
    ]
  }
}