Portfolio API Suite
Portfolio APIs allow you to get information about your portfolio(s) and add or remove entities from a portfolio. A business entity must be added to a portfolio to be monitored. You can create one portfolio or segment businesses into multiple portfolios for easier monitoring.
Add Entity
Add a business entity to a portfolio for subsequent monitoring.
Add Entity allows adding epInternalId to the record. epInternalId should your unique internal backend identifier of a business entity. The markaazId / epInternalId pair allows traceability between the Markaaz ID and the business in your system. There are many reasons you may wish to do this including to support compliance. As a best practice, we recommend that either you always provide epInternalId or never provide the field when adding an entity. If you use epInternalId then you should also add the Markaaz ID to your backend system record for the business entity.
{
"markaazId": "string",
"portfolioId": "string",
"epInternalId": "string"
}
}{
"markaaz": {
"traceId": "",
"maraazId": "",
"portfolioDetails": {
"wasAdded": "true / false",
"portfolioId": "",
"epInternalId": "",
"portfolioName": "",
"portfolioDesc": "",
"bizInfo": {
"dba": "",
"legalName": "",
"taxId": "",
"nationalId": "",
"addresses": [
{
"type": "",
"line1": "",
"line2": "",
"locality": "",
"region": "",
"regionAbbreviation": "",
"country": "",
"postalCode": ""
}
]
}
}
}
}Portfolio List
Get a list of portfolios for your Partner ID, including a count of contained markaazIds. The request uses the x-partner-id passed in the header.
{
"markaaz": {
"traceId": "",
"results": [
{
"portfolioid": "",
"portfolioName": "",
"portfolioDesc": "",
"entityCount": 0
}
]
}
}Portfolio Details
Get information on a specific business entity (markaazId) within a portfolio, including it's currently configured Monitoring Type.
{
"portfolioId": "string",
"markaazId": "string",
"epInternalId": "string"
}
}{
"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": [
{
"monitoringType": "",
"statusDate": ""
}
]
}
}
}Remove Entity
Remove a business entity from a portfolio.
{
"data": {
"markaazId": "string",
"portfolioId": "string"
}
}{
"markaaz": {
"traceId": "",
"maraazId": "",
"portfolioDetails": {
"wasRemoved": "true / false",
"portfolioId": "",
"epInternalId": "",
"portfolioName": "",
"portfolioDesc": "",
"bizInfo": {
"dba": "",
"legalName": "",
"taxId": "",
"nationalId": "",
"addresses": [
{
"type": "",
"line1": "",
"line2": "",
"locality": "",
"region": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geoprecision":"",
"businessIndicator": "",
"residentialIndicator":"",
"sohoIndicator": ""
}
]
}
}
}
}Updated 1 day ago