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 for enable may be either or both values as hown in the example below.

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

{
  "markaaz": {
    "traceId": "",
    "markaazId": "",
    "bizInfo": { ... },
    "monitoring": [
      {
        "action": "enabled",
        "monitoringType": [],
        "statusDate": ""
      }
    ]
  }
}


# Example with the monitoring object populated:
        "monitoring": [
            {
                "monitoringType": "business",
                "monitoringStatus": "enabled",
                "statusDate": "2024-07-12"
            },
            {
                "monitoringType": "compliance",
                "monitoringStatus": "disabled",
                "statusDate": "2024-07-12"
            }
        ]

Disable Monitoring:

This POST API allows for disabling monitoring of 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 for disable will be passed in as either "business" or "compliance". If both are enabled, you will have to call disable twice to disable both.

{  
  "data": {  
    "markaazId": "",  
    "portfolioId": "",  
    "epInternalId": "",  
    "monitoringType": ""  
  }  
}

{
  "markaaz": {
    "traceId": "",
    "markaazId": "",
    "bizInfo": { ... },
    "portfolioDetail": {
      "portfolioId": "",
      "portfolioName": "",
      "portfolioDesc": ""
    },
    "monitoring": [
      {
        "action": "disabled",
        "monitoringType": [],
        "statusDate": ""
      }
    ]
  }
}

# Example with the monitoring object populated:
        "monitoring": [
            {
                "monitoringType": "business",
                "monitoringStatus": "enabled",
                "statusDate": "2024-07-12"
            },
            {
                "monitoringType": "compliance",
                "monitoringStatus": "disabled",
                "statusDate": "2024-07-12"
            }
        ]