Guides

Monitoring API Suite

Markaaz Monitoring provides monthly business and daily compliance monitoring. Our Monitoring APIs support report delivery of results in the Enterprise Portal for download. The download will include both a JSON of updated golden records for ingestion and a PDF summary of how many businesses we captured changes for.

Enable Monitoring:

  • This POST API allows for enabling monitoring of monitoring of a business entity.
  • The entity must be contained in a portfolio.

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 business and compliance values as shown 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"
            }
        ]

Updated 6 days ago

What’s Next

Did this page help you?