GET api/business/{id}?trackingId={trackingId}
Business Detail
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| trackingId |
An ID supplied by the client to track or name this request |
string |
Required |
| id |
Midas Business Key |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
success
BusinessDetailResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TrackingID | string |
None. |
|
| BusinessKey | integer |
None. |
|
| BuildingKey | integer |
None. |
|
| BillingDescriptors | BillingDescriptors |
None. |
|
| BusinessName | string |
None. |
|
| BusinessNameAlternative | string |
None. |
|
| Phone | string |
None. |
|
| LocationTypeValue | string |
None. |
|
| MailAddress | string |
None. |
|
| Suite | string |
None. |
|
| City | string |
None. |
|
| State | State |
None. |
|
| MailZIPCode | string |
None. |
|
| DeliveryPointValidation | DeliveryPointValidation |
None. |
|
| Nixed | string |
None. |
|
| NixedReason | string |
None. |
|
| VerticalName | string |
None. |
|
| SegmentName | string |
None. |
|
| NAICSCode | string |
None. |
|
| NAICSDirectoryTitle | string |
None. |
|
| YellowPageHeading | string |
None. |
|
| EmployeeCount | string |
None. |
|
| EmploymentDerivationDescription | string |
None. |
|
| AlternativeSize | string |
None. |
|
| SalesVolume | string |
None. |
|
| WorkAtHomeFlag | boolean |
None. |
|
| CreditScore | string |
None. |
|
| Fiber_Decile | string |
None. |
|
| ParentActualEmployeeCount | string |
None. |
|
| NumberofEmployeesActual | string |
None. |
|
| MailDeliverability | MailDeliverability |
None. |
|
| DUNSNumber | string |
None. |
|
| MarketDataSourceCode | string |
None. |
|
| LastUpdatedDate | date |
None. |
|
| LocalExchangeCarrierName | string |
None. |
|
| NoMarketData | boolean |
None. |
|
| BusinessTelecomData | BusinessTelecomData |
None. |
|
| ServiceReturnStatus | ServiceReturnStatus |
None. |
Response Formats
application/json, text/json
Sample:
{
"trackingID": "sample string 1",
"businessKey": 2,
"buildingKey": 3,
"billingDescriptors": {
"billingInstanceName": "sample string 1",
"billingInstanceKey": 2,
"billingInstanceKeySpecified": true,
"billingSystemTypeIndicator": "sample string 4",
"billingSiteID": 5,
"billingSiteIDSpecified": true,
"franchiseCode": {
"fullFranchiseCode": "sample string 1",
"csg": {
"sys": "sample string 1",
"prin": "sample string 2",
"agent": "sample string 3"
},
"icoms": {
"siteID": "sample string 1",
"company": "sample string 2",
"division": "sample string 3",
"franchiseArea": "sample string 4"
}
},
"legacyMSO": "sample string 7"
},
"businessName": "sample string 4",
"businessNameAlternative": "sample string 5",
"phone": "sample string 6",
"locationTypeValue": "sample string 7",
"mailAddress": "sample string 8",
"suite": "sample string 9",
"city": "sample string 10",
"state": "Item",
"mailZIPCode": "sample string 11",
"deliveryPointValidation": {
"dpvResultCode": "sample string 1",
"dpvResultCodeDescription": "sample string 2",
"dpvResultFootnote": "sample string 3"
},
"nixed": "sample string 12",
"nixedReason": "sample string 13",
"verticalName": "sample string 14",
"segmentName": "sample string 15",
"naicsCode": "sample string 16",
"naicsDirectoryTitle": "sample string 17",
"yellowPageHeading": "sample string 18",
"employeeCount": "sample string 19",
"employmentDerivationDescription": "sample string 20",
"alternativeSize": "sample string 21",
"salesVolume": "sample string 22",
"workAtHomeFlag": true,
"creditScore": "sample string 24",
"fiber_Decile": "sample string 25",
"parentActualEmployeeCount": "sample string 26",
"numberofEmployeesActual": "sample string 27",
"mailDeliverability": {
"mailDeliverabilityScore": 1,
"mailDeliverabilityScoreSpecified": true,
"mailDeliverabilityDescription": "sample string 3"
},
"dunsNumber": "sample string 28",
"marketDataSourceCode": "sample string 29",
"lastUpdatedDate": "2025-12-11T05:59:05.6299983-06:00",
"localExchangeCarrierName": "sample string 31",
"noMarketData": true,
"businessTelecomData": {
"eF_CABSAT_VID_BILL_604": 1,
"eF_CABSAT_VID_BILL_604Specified": true,
"eF_CORP_DAT_NET_BILL_1655": 3,
"eF_CORP_DAT_NET_BILL_1655Specified": true,
"eF_INTNET_SVC_BILL_1653": 5,
"eF_INTNET_SVC_BILL_1653Specified": true,
"eF_TOT_WL_CM_BILL_1648": 7,
"eF_TOT_WL_CM_BILL_1648Specified": true,
"eF_TWCM_DATA_BILL_1317": 9,
"eF_TWCM_DATA_BILL_1317Specified": true,
"eF_TWCM_VOX_BILL_1649": 11,
"eF_TWCM_VOX_BILL_1649Specified": true
},
"serviceReturnStatus": {
"returnCode": 1,
"returnMessage": "sample string 2",
"responseTypeCode": 3,
"responseTypeCodeSpecified": true,
"responseTypeMessage": "sample string 5",
"currentPeriodRequestsUsed": 6,
"currentPeriodRequestsAvailable": 7
}
}
application/xml, text/xml
Sample:
<BusinessDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
<AlternativeSize>sample string 21</AlternativeSize>
<BillingDescriptors>
<billingInstanceKeyField>2</billingInstanceKeyField>
<billingInstanceKeyFieldSpecified>true</billingInstanceKeyFieldSpecified>
<billingInstanceNameField>sample string 1</billingInstanceNameField>
<billingSiteIDField>5</billingSiteIDField>
<billingSiteIDFieldSpecified>true</billingSiteIDFieldSpecified>
<billingSystemTypeIndicatorField>sample string 4</billingSystemTypeIndicatorField>
<franchiseCodeField>
<cSGField>
<agentField>sample string 3</agentField>
<prinField>sample string 2</prinField>
<sysField>sample string 1</sysField>
</cSGField>
<fullFranchiseCodeField>sample string 1</fullFranchiseCodeField>
<iCOMSField>
<companyField>sample string 2</companyField>
<divisionField>sample string 3</divisionField>
<franchiseAreaField>sample string 4</franchiseAreaField>
<siteIDField>sample string 1</siteIDField>
</iCOMSField>
</franchiseCodeField>
<legacyMSOField>sample string 7</legacyMSOField>
</BillingDescriptors>
<BuildingKey>3</BuildingKey>
<BusinessKey>2</BusinessKey>
<BusinessName>sample string 4</BusinessName>
<BusinessNameAlternative>sample string 5</BusinessNameAlternative>
<BusinessTelecomData>
<eF_CABSAT_VID_BILL_604Field>1</eF_CABSAT_VID_BILL_604Field>
<eF_CABSAT_VID_BILL_604FieldSpecified>true</eF_CABSAT_VID_BILL_604FieldSpecified>
<eF_CORP_DAT_NET_BILL_1655Field>3</eF_CORP_DAT_NET_BILL_1655Field>
<eF_CORP_DAT_NET_BILL_1655FieldSpecified>true</eF_CORP_DAT_NET_BILL_1655FieldSpecified>
<eF_INTNET_SVC_BILL_1653Field>5</eF_INTNET_SVC_BILL_1653Field>
<eF_INTNET_SVC_BILL_1653FieldSpecified>true</eF_INTNET_SVC_BILL_1653FieldSpecified>
<eF_TOT_WL_CM_BILL_1648Field>7</eF_TOT_WL_CM_BILL_1648Field>
<eF_TOT_WL_CM_BILL_1648FieldSpecified>true</eF_TOT_WL_CM_BILL_1648FieldSpecified>
<eF_TWCM_DATA_BILL_1317Field>9</eF_TWCM_DATA_BILL_1317Field>
<eF_TWCM_DATA_BILL_1317FieldSpecified>true</eF_TWCM_DATA_BILL_1317FieldSpecified>
<eF_TWCM_VOX_BILL_1649Field>11</eF_TWCM_VOX_BILL_1649Field>
<eF_TWCM_VOX_BILL_1649FieldSpecified>true</eF_TWCM_VOX_BILL_1649FieldSpecified>
</BusinessTelecomData>
<City>sample string 10</City>
<CreditScore>sample string 24</CreditScore>
<DUNSNumber>sample string 28</DUNSNumber>
<DeliveryPointValidation>
<dPVResultCodeDescriptionField>sample string 2</dPVResultCodeDescriptionField>
<dPVResultCodeField>sample string 1</dPVResultCodeField>
<dPVResultFootnoteField>sample string 3</dPVResultFootnoteField>
</DeliveryPointValidation>
<EmployeeCount>sample string 19</EmployeeCount>
<EmploymentDerivationDescription>sample string 20</EmploymentDerivationDescription>
<Fiber_Decile>sample string 25</Fiber_Decile>
<LastUpdatedDate>2025-12-11T05:59:05.6299983-06:00</LastUpdatedDate>
<LocalExchangeCarrierName>sample string 31</LocalExchangeCarrierName>
<LocationTypeValue>sample string 7</LocationTypeValue>
<MailAddress>sample string 8</MailAddress>
<MailDeliverability>
<mailDeliverabilityDescriptionField>sample string 3</mailDeliverabilityDescriptionField>
<mailDeliverabilityScoreField>1</mailDeliverabilityScoreField>
<mailDeliverabilityScoreFieldSpecified>true</mailDeliverabilityScoreFieldSpecified>
</MailDeliverability>
<MailZIPCode>sample string 11</MailZIPCode>
<MarketDataSourceCode>sample string 29</MarketDataSourceCode>
<NAICSCode>sample string 16</NAICSCode>
<NAICSDirectoryTitle>sample string 17</NAICSDirectoryTitle>
<Nixed>sample string 12</Nixed>
<NixedReason>sample string 13</NixedReason>
<NoMarketData>true</NoMarketData>
<NumberofEmployeesActual>sample string 27</NumberofEmployeesActual>
<ParentActualEmployeeCount>sample string 26</ParentActualEmployeeCount>
<Phone>sample string 6</Phone>
<SalesVolume>sample string 22</SalesVolume>
<SegmentName>sample string 15</SegmentName>
<ServiceReturnStatus>
<currentPeriodRequestsAvailableField>7</currentPeriodRequestsAvailableField>
<currentPeriodRequestsUsedField>6</currentPeriodRequestsUsedField>
<responseTypeCodeField>3</responseTypeCodeField>
<responseTypeCodeFieldSpecified>true</responseTypeCodeFieldSpecified>
<responseTypeMessageField>sample string 5</responseTypeMessageField>
<returnCodeField>1</returnCodeField>
<returnMessageField>sample string 2</returnMessageField>
</ServiceReturnStatus>
<State>Item</State>
<Suite>sample string 9</Suite>
<TrackingID>sample string 1</TrackingID>
<VerticalName>sample string 14</VerticalName>
<WorkAtHomeFlag>true</WorkAtHomeFlag>
<YellowPageHeading>sample string 18</YellowPageHeading>
</BusinessDetailResponse>