D&B Direct Documentation

REST Version 1.7

By D&B SparkLab - Customer Solutions Lab

Overview

Endpoints & WADL

Partially Scrambled Sandbox API (Use your "Sales and Marketing API - Sandbox" credentials)

WADL http://api.dnbdirectapps.com/dev/DnBAPI-17/rest/application.wadl
Endpoint http://api.dnbdirectapps.com/dev/DnBAPI-17/rest

Legacy Scrambled Sandbox API (Use your "Sales and Marketing API - Sandbox" credentials)

WADL http://dnbdirect-sandbox.dnb.com/DnBAPI-17/rest/application.wadl
Endpoint http://dnbdirect-sandbox.dnb.com/DnBAPI-17/rest

Production API (Use your "Sales and Marketing API - Production" credentials)

WADL http://dnbdirect-api.dnb.com/DnBAPI-17/rest/application.wadl
Endpoint http://dnbdirect-api.dnb.com/DnBAPI-17/rest

For SSL, substitute https for http in the endpoint URLs.

Services

Primary Entity Service Name Package REST Resource SOAP Method
Company Get Company Detail Add-on: Full Company Profile company/{unique_id} GetCompanyDetail
Company Get Company Comparison Data Add-on: Advanced Financial Information company/{unique_id}/comparisonData GetCompanyComparisonData
Company Find Competitors Base Package company/{unique_id}/competitors FindCompetitorsByCompanyID
Company Get Company Financial Detail Add-on: Advanced Financial Information company/{unique_id}/financial/detail GetCompanyFinancialDetail
Company Get Company Financial Summary Add-on: Advanced Financial Information company/{unique_id}/financial/summary GetCompanyFinancialSummary
Company Get Market Analysis Report Base Package company/{unique_id}/market/analysis_report GetMarketAnalysisReport
Company Get Company Market Data Add-on: Advanced Financial Information company/{unique_id}/market/data GetCompanyMarketData
Company Get Company News Add-on: News Information company/{unique_id}/news GetCompanyNews
Company Get Company Detail Optional Data Add-on: Full Company Profile company/{unique_id}/optional GetCompanyDetailOptionalData
Company Order Company Report Add-on: D&B Data Contract company/{DUNSNumber}/report/{DNBProductID} OrderCompanyReport
Company Cleanse And Standardize Add-on: Match Service company/cleanseAndStandardize CleanseAndStandardize
Company Get Family Tree Add-on: Family Tree Information company/familytree/{unique_id} GetFamilyTree
Company Find Company Cleanse Match Add-on: Match Service company/findcompanycleansematch FindCompanyCleanseMatch
Company Get Cleanse Match Add-on: Match Service company/getCleanseMatch GetCleanseMatch
Company Match Add-on: Match Service company/match Match
Company Get Company Refresh by Company List Base Package company/refresh/companyList GetCompanyRefreshByCompanyList
Company Get Company Refresh by Date Add-on: Enterprise Services company/refresh/date/{refreshed_since_date} GetCompanyRefreshByDate
Company Find Company by Keyword Base Package search/company/{keyword} FindCompanyByKeyword
Company Advanced Company Search Base Package search/company/advanced AdvancedCompanySearch
Company Advanced Company Search Optional Data Base Package search/company/advanced/optional AdvancedCompanySearchOptionalData
Person Get Person Detail Base Package person/{unique_company_id}/{co_official_id} GetPersonDetail
Person Find Person by Keyword Base Package search/person/{keyword} FindPersonByKeyword
Person Advanced Person Search Base Package search/person/advanced AdvancedPersonSearch
Industry Get Industry Add-on: First Research industry/{dnb_industry_code} GetIndustry
Industry Get Call Prep Sheet Add-on: First Research industry/{dnb_industry_code}/call_prep GetCallPrepSheet
Industry Get D&B Industry Add-on: First Research industry/{dnb_industry_code}/dnb GetDnBIndustry
Industry Find Industry by Keyword Base Package search/industry/{keyword} FindIndustryByKeyword
Industry Advanced Industry Search Base Package search/industry/advanced AdvancedIndustrySearch
Industry Get Industry for State Province Add-on: First Research search/industry/province/{province_id} GetIndustryForStateProvince
Utility Get Advanced Search Lookups Base Package referenceData GetAdvancedSearchLookups
Utility Get Credit Counts Base Package user/credits GetCreditCounts

Release Notes

Release Notes

Authentication

All API calls require the following credentials to be sent in the HTTP request header:

Name
API-KEY
username
password
CURL example
curl -H 'API-KEY:Enter_your_API_KEY_here'\
     -H 'username:Enter_your_API_username_here'\
     -H 'password:Enter_your_API_password_here'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609'
Python example
import urllib2
req = urllib2.Request('http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609')
req.add_header('API-KEY', 'Enter_your_API_KEY_here')
req.add_header('username', 'Enter_your_API_username_here')
req.add_header('password', 'Enter_your_API_password_here')
req.add_header('Accept-Encoding', 'UTF-8')
req.add_header('Content-Type', 'application/json')
req.add_header('Accept', '*/*')
resp = urllib2.urlopen(req)
resp = resp.read()
print resp
PHP example
$opts = array(
  'http'=>array(
    'method'=>'GET',
    'ignore_errors' => true,
    'header'=>"API-KEY: Enter_your_API_KEY_here\r\nusername: Enter_your_API_username_here\r\npassword:Enter_your_API_password_here",
    )
  );
$fp = fopen('http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609', 'rb', false, stream_context_create($opts));
$response = stream_get_contents($fp);
print $response;

Resources

/company/{unique_id} Available in Add-on: Full Company Profile

Returns detailed company information for a single company."

Representation

/company/{unique_id}
?view={view}
&return_in_reported_currency={return_in_reported_currency}

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId
view String (full | simple | optional)
return_in_reported_currency Boolean New for 1.7

Sample Request

URL
GET /company/884114609

Sample Response

{
  "otherURLs": {
    "url": []
  }, 
  "manufacturingIndicator": "", 
  "bankName": "", 
  "marketingPreScreenScore": "H", 
  "phones": {
    "phoneNumber": [
      {
        "areaCode": "973", 
        "doNotCallRegistry": false, 
        "phoneNumber": "9215500", 
        "countryCode": "1"
      }
    ], 
    "faxNumber": []
  }, 
  "nonMarketableCompany": null, 
  "parentName": "THE DUN & BRADSTREET CORPORATION", 
  "locations": {
    "location": [
      {
        "city": "Short Hills", 
        "addressType": "PRIMARY_ADDRESS", 
        "countryId": 76, 
        "stateOfIncorporation": null, 
        "zip": "07078", 
        "address1": "103 Jfk Pkwy", 
        "address2": "", 
        "longitude": -74.354241, 
        "county": "Essex County", 
        "state": "NJ", 
        "country": "United States", 
        "latitude": 40.742406, 
        "metroArea": "New York-Newark-Jersey City NY-NJ-PA", 
        "latLongAccuracy": "0", 
        "zip4": "2708"
      }
    ]
  }, 
  "yearFounded": "1841", 
  "foreignTrades": null, 
  "keyNumbersHistory": {
    "quarterlyKeyNumbersHistory": {
      "keyNumbers": [
        {
          "salesAccuracy": "ACTUAL", 
          "employeesAtThisLocationAccuracy": null, 
          "employeesTotalAccuracy": null, 
          "sales": 376.2, 
          "periodEndMonth": "Mar 2015", 
          "fiscalPeriod": "1Q2015", 
          "researchAndDevelopment": null, 
          "advertising": null, 
          "employeesAtThisLocation": null, 
          "totalEmployeeGrowthPercent": null, 
          "employeesTotal": null
        }, 
        {
          "salesAccuracy": "ACTUAL", 
          "employeesAtThisLocationAccuracy": null, 
          "employeesTotalAccuracy": null, 
          "sales": 489.8, 
          "periodEndMonth": "Dec 2014", 
          "fiscalPeriod": "4Q2014", 
          "researchAndDevelopment": null, 
          "advertising": null, 
          "employeesAtThisLocation": null, 
          "totalEmployeeGrowthPercent": null, 
          "employeesTotal": null
        }, 
        ...
      ]
    }, 
    "annualKeyNumbersHistory": {
      "keyNumbers": [
        {
          "salesAccuracy": null, 
          "employeesAtThisLocationAccuracy": "ACTUAL", 
          "employeesTotalAccuracy": null, 
          "sales": null, 
          "periodEndMonth": "", 
          "fiscalPeriod": "FY", 
          "researchAndDevelopment": null, 
          "advertising": null, 
          "employeesAtThisLocation": 400, 
          "totalEmployeeGrowthPercent": null, 
          "employeesTotal": null
        }, 
        {
          "salesAccuracy": "ACTUAL", 
          "employeesAtThisLocationAccuracy": null, 
          "employeesTotalAccuracy": "ACTUAL", 
          "sales": 1681.8, 
          "periodEndMonth": "Dec 2014", 
          "fiscalPeriod": "FY2014", 
          "researchAndDevelopment": null, 
          "advertising": null, 
          "employeesAtThisLocation": null, 
          "totalEmployeeGrowthPercent": 6.52, 
          "employeesTotal": 4900
        }, 
        ...
      ]
    }
  }, 
  "fein": "223725387", 
  "legalStatus": "Corporation", 
  "companyType": "PUBLIC", 
  "historicalText": "", 
  "industries": {
    "primaryDnBIC": "1714", 
    "primaryUKSIC": "74.871", 
    "allNAICS": {
      "item": [
        {
          "description": "Credit Bureaus", 
          "naics": "561450"
        }
      ]
    }, 
    "allUSSIC": {
      "item": [
        {
          "ussic": "73239901", 
          "description": "Commercial (mercantile) credit reporting bureau"
        }
      ]
    }, 
    "lineOfBusiness": "Credit reporting services", 
    "allUKSIC": {
      "item": [
        {
          "uksic": "74.871", 
          "description": "Credit reporting and collection agency activities"
        }
      ]
    }, 
    "primaryNAICS": "561450", 
    "allDnBIC": {
      "item": [
        {
          "dnbic": "1058", 
          "description": "Market Research & Polling Services"
        }, 
        {
          "dnbic": "1424", 
          "description": "Insurance Agencies & Brokerages"
        }, 
        ...
      ]
    }, 
    "primaryUSSIC": "73239901"
  }, 
  "dbaNames": {
    "dba": [
      "D&B"
    ]
  }, 
  "legalStructureDescription": null, 
  "companyId": 10483000000000, 
  "rankings": {
    "rank": [
      {
        "definition": "S&P 500", 
        "rankNumber": null
      }
    ]
  }, 
  "ukSpecs": {
    "ukRegistration": null, 
    "ukVAT": null, 
    "numberOfSubsidiaries": null
  }, 
  "minorityOwned": false, 
  "ownershipYear": "1841", 
  "topExecutives": {
    "official": [
      {
        "person": {
          "suffix": "", 
          "firstName": "Robert", 
          "middleName": "", 
          "lastName": "Carrigan", 
          "age": 49, 
          "prefix": "Mr.", 
          "gender": "", 
          "fullName": "Robert Carrigan"
        }, 
        "connectMail": {
          "connectMailEmailSource": false, 
          "connectMailPhoneSource": false, 
          "connectMailNameSource": false, 
          "connectMailSource": "None"
        }, 
        "latestPosition": {
          "endYear": "Present", 
          "jobFunction": {
            "jobFunctionId": [
              125, 
              15
            ]
          }, 
          "mrc": {
            "mrcId": []
          }, 
          "startYear": "2013", 
          "title": "President and CEO"
        }, 
        "coOfficialId": 2556870000000000, 
        "latestSalary": {
          "salary": 850000.0, 
          "bonus": null, 
          "totalSalary": 4198663.0, 
          "year": 2014
        }
      }, 
      {
        "person": {
          "suffix": "", 
          "firstName": "Christopher", 
          "middleName": "J.", 
          "lastName": "Coughlin", 
          "age": 62, 
          "prefix": "Mr.", 
          "gender": "", 
          "fullName": "Christopher J. Coughlin"
        }, 
        "connectMail": {
          "connectMailEmailSource": false, 
          "connectMailPhoneSource": false, 
          "connectMailNameSource": false, 
          "connectMailSource": "None"
        }, 
        "latestPosition": {
          "endYear": "Present", 
          "jobFunction": {
            "jobFunctionId": [
              55
            ]
          }, 
          "mrc": {
            "mrcId": []
          }, 
          "startYear": "2013", 
          "title": "Chairman"
        }, 
        "coOfficialId": 1605724000000000, 
        "latestSalary": {
          "salary": null, 
          "bonus": null, 
          "totalSalary": null, 
          "year": null
        }
      }, 
      ...
    ]
  }, 
  "ethnicity": "Unknown", 
  "accountingFirm": "Pricewaterhousecoopers LLP Ne", 
  "historicalIndicator": false, 
  "ultimateDomesticParentName": "THE DUN & BRADSTREET CORPORATION", 
  "vat": null, 
  "spaceAtAddress": 123000, 
  "keyFinancials": {
    "incomeAssets": {
      "netIncome": 294.4, 
      "netIncomeGrowthPercent": 13.89, 
      "period": "FY2014", 
      "salesGrowthPercent": 1.61, 
      "assets": 1986.2
    }, 
    "marketValueInfo": {
      "marketValue": 4564.9138, 
      "marketValueDate": "2015-06-04"
    }
  }, 
  "numberOfPCs": null, 
  "primaryURLs": {
    "primaryUrl": [
      {
        "url": "http://www.dnb.com", 
        "sortOrder": 0
      }
    ]
  }, 
  "womenOwned": false, 
  "ultimateDomesticParent": "884114609", 
  "smallBusinessIndicator": false, 
  "duns": "884114609", 
  "spaceAtAddressUnitOfMeasurement": "sq ft", 
  "stocks": {
    "tickerUS": "DNB", 
    "exchangeInfoList": {
      "exchangeInfo": [
        {
          "country": "Germany", 
          "exchangeName": "Dusseldorf", 
          "tickerSymbol": "DB5"
        }, 
        {
          "country": "Germany", 
          "exchangeName": "German", 
          "tickerSymbol": "DB5"
        }, 
        ...
      ]
    }, 
    "exchangePrimary": {
      "country": "United States", 
      "exchangeName": "NYSE", 
      "tickerSymbol": "DNB"
    }
  }, 
  "spaceAtAddressAccuracy": 0, 
  "ultimateParentDuns": "884114609", 
  "name": "THE DUN & BRADSTREET CORPORATION", 
  "locationType": "HEADQUARTERS", 
  "fullDescription": "<p>For The Dun &amp; Bradstreet Corporation, there...", 
  "ultimateParentName": "THE DUN & BRADSTREET CORPORATION", 
  "currencyType": "USD", 
  "franchiseOperationType": "", 
  "synopsis": "<p>For The Dun &amp; Bradstreet Corporation, there...", 
  "legalStructureCode": null, 
  "parentDuns": "884114609", 
  "subsidiaryStatus": false, 
  "crn": null, 
  "ownedOrLeased": "Location Is Rented By This Company"
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609'

/company/{unique_id}/comparisonData Available in Add-on: Advanced Financial Information

This call returns financial comparison data for a given company."

Representation

/company/{unique_id}/comparisonData

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId

Sample Request

URL
GET /company/884114609/comparisonData

Sample Response

{
  "operationsComparison": {
    "company": {
      "daysCostOfGoodsSoldInInventory": null, 
      "pctEffectiveTaxRate": 29.38, 
      "netReceivablesTurnoverFlow": 3.63, 
      "assetTurnover": 0.87, 
      "inventoryTurnover": null, 
      "daysOfSalesOutstanding": 101.63
    }, 
    "marketMedian": {
      "daysCostOfGoodsSoldInInventory": 61.96, 
      "pctEffectiveTaxRate": 30.68, 
      "netReceivablesTurnoverFlow": 7.29, 
      "assetTurnover": 0.54, 
      "inventoryTurnover": 9.22, 
      "daysOfSalesOutstanding": 49.22
    }, 
    "industryMedian": {
      "daysCostOfGoodsSoldInInventory": 0.01, 
      "pctEffectiveTaxRate": 33.11, 
      "netReceivablesTurnoverFlow": 5.4, 
      "assetTurnover": 0.57, 
      "inventoryTurnover": 2.59, 
      "daysOfSalesOutstanding": 42.97
    }
  }, 
  "perShareDataComparison": {
    "company": {
      "bookValuePerShare": -33.63, 
      "totalAssetsPerShare": 56.33, 
      "longTermDebtPerShare": 38.96, 
      "workingCapitalPerShare": -7.69, 
      "dividendsPerShare": 1.78, 
      "cashFlowPerShare": 8.72, 
      "revenuePerShare": 46.56
    }, 
    "marketMedian": {
      "bookValuePerShare": 9.25, 
      "totalAssetsPerShare": 21.9, 
      "longTermDebtPerShare": 6.23, 
      "workingCapitalPerShare": 1.78, 
      "dividendsPerShare": 0.8, 
      "cashFlowPerShare": 1.38, 
      "revenuePerShare": 10.52
    }, 
    "industryMedian": {
      "bookValuePerShare": 1.79, 
      "totalAssetsPerShare": 23.87, 
      "longTermDebtPerShare": 6.27, 
      "workingCapitalPerShare": 0.0, 
      "dividendsPerShare": 1.06, 
      "cashFlowPerShare": 4.45, 
      "revenuePerShare": 5.9
    }
  }, 
  "valuationComparison": {
    "company": {
      "priceSalesRatio": null, 
      "priceCashFlowRatio": 14.73, 
      "priceEarningsRatio": 18.58, 
      "priceBookRatio": null
    }, 
    "marketMedian": {
      "priceSalesRatio": 1.67, 
      "priceCashFlowRatio": 12.6, 
      "priceEarningsRatio": 20.59, 
      "priceBookRatio": 1.96
    }, 
    "industryMedian": {
      "priceSalesRatio": 2.92, 
      "priceCashFlowRatio": 17.86, 
      "priceEarningsRatio": 26.2, 
      "priceBookRatio": 4.79
    }
  }, 
  "growthComparison": {
    "company": {
      "pctTwelveMonthNetIncomeGrowth": -14.03, 
      "pctThirtySixMonthEpsGrowth": 7.0, 
      "pctTwelveMonthRevenueGrowth": 1.21, 
      "pctTwelveMonthDividendGrowth": 8.54, 
      "pctThirtySixMonthNetIncomeGrowth": -2.97, 
      "pctThirtySixMonthDividendGrowth": 6.83, 
      "pctTwelveMonthEpsGrowth": -9.08, 
      "pctThirtySixMonthRevenueGrowth": -1.57
    }, 
    "marketMedian": {
      "pctTwelveMonthNetIncomeGrowth": 7.45, 
      "pctThirtySixMonthEpsGrowth": 6.03, 
      "pctTwelveMonthRevenueGrowth": 5.67, 
      "pctTwelveMonthDividendGrowth": 8.79, 
      "pctThirtySixMonthNetIncomeGrowth": 6.69, 
      "pctThirtySixMonthDividendGrowth": 8.17, 
      "pctTwelveMonthEpsGrowth": 6.66, 
      "pctThirtySixMonthRevenueGrowth": 4.38
    }, 
    "industryMedian": {
      "pctTwelveMonthNetIncomeGrowth": 12.73, 
      "pctThirtySixMonthEpsGrowth": 14.92, 
      "pctTwelveMonthRevenueGrowth": 5.64, 
      "pctTwelveMonthDividendGrowth": 10.0, 
      "pctThirtySixMonthNetIncomeGrowth": 7.21, 
      "pctThirtySixMonthDividendGrowth": 11.48, 
      "pctTwelveMonthEpsGrowth": 17.96, 
      "pctThirtySixMonthRevenueGrowth": 5.55
    }
  }, 
  "financialComparison": {
    "company": {
      "currentRatio": 0.76, 
      "interestCoverage": 9.56, 
      "totalDebtToEquity": null, 
      "leverageRatio": null, 
      "quickRatio": null
    }, 
    "marketMedian": {
      "currentRatio": 1.9, 
      "interestCoverage": 5.92, 
      "totalDebtToEquity": 0.54, 
      "leverageRatio": 0.57, 
      "quickRatio": 1.31
    }, 
    "industryMedian": {
      "currentRatio": 1.25, 
      "interestCoverage": 7.3, 
      "totalDebtToEquity": 0.35, 
      "leverageRatio": 0.55, 
      "quickRatio": 1.35
    }
  }, 
  "profitabilityComparison": {
    "company": {
      "pctReturnOnEquity": null, 
      "pctPreTaxProfitMargin": 21.26, 
      "pctReturnOnInvestedCapital": null, 
      "pctReturnOnAssets": 13.04, 
      "pctNetProfitMargin": 14.92, 
      "pctGrossProfitMargin": 66.36
    }, 
    "marketMedian": {
      "pctReturnOnEquity": 5.93, 
      "pctPreTaxProfitMargin": 6.76, 
      "pctReturnOnInvestedCapital": 4.96, 
      "pctReturnOnAssets": 1.85, 
      "pctNetProfitMargin": 5.68, 
      "pctGrossProfitMargin": 39.35
    }, 
    "industryMedian": {
      "pctReturnOnEquity": 0.14, 
      "pctPreTaxProfitMargin": 0.56, 
      "pctReturnOnInvestedCapital": 0.01, 
      "pctReturnOnAssets": 0.05, 
      "pctNetProfitMargin": 10.68, 
      "pctGrossProfitMargin": 61.25
    }
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/comparisonData'

/company/{unique_id}/competitors Included in Base Package

Returns all the competitors for a given company."

Representation

/company/{unique_id}/competitors
?top_competitor={top_competitor}

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId
top_competitor Boolean

Sample Request

URL
GET /company/884114609/competitors

Sample Response

{
  "competitor": [
    {
      "addrstateprov": "Hauts De Seine", 
      "topcompetitor": false, 
      "companyId": 101016000000000, 
      "companyName": "CIE FCAISE ASSURANCES COMMERCE E", 
      "addrcountryid": 27, 
      "addrcountry": "France", 
      "parentDuns": "395709947", 
      "duns": "275253524", 
      "addrcity": "Bois Colombes", 
      "finsales": 935.8944216623998, 
      "ultimateParentDuns": "291588544"
    }, 
    {
      "addrstateprov": "Co Dublin", 
      "topcompetitor": true, 
      "companyId": 154281000000000, 
      "companyName": "EXPERIAN PLC", 
      "addrcountryid": 39, 
      "addrcountry": "Ireland", 
      "parentDuns": "365214688", 
      "duns": "896612129", 
      "addrcity": "Dublin", 
      "finsales": 4840.0, 
      "ultimateParentDuns": "365214688"
    }, 
    ...
  ]
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/competitors'

/company/{unique_id}/financial/detail Available in Add-on: Advanced Financial Information

This call returns a detail of financial data for a given company."

Representation

/company/{unique_id}/financial/detail
?return_in_reported_currency={return_in_reported_currency}

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId
return_in_reported_currency Boolean

Sample Request

URL
GET /company/884114609/financial/detail

Sample Response

{
  "quarterlyCashFlowStatements": {
    "previousQuarters": [
      {
        "netCashProvidedByInvestingActivities": -70.0, 
        "cashAndCashEquivalentsAtTheEndOfTheQuarter": 319.4, 
        "cashAndCashEquivalentsAtTheBeginningOfTheQuarter": 310.0, 
        "quarterYear": "2014", 
        "netCashProvidedByOperatingActivities": 315.5, 
        "quarterMonth": "December", 
        "netIncreaseDecreaseInCashAndCashEquivalents": 83.5, 
        "netCashProvidedByFinancingActivities": -144.4, 
        "capitalExpenditure": -12.2
      }, 
      {
        "netCashProvidedByInvestingActivities": -51.4, 
        "cashAndCashEquivalentsAtTheEndOfTheQuarter": 310.0, 
        "cashAndCashEquivalentsAtTheBeginningOfTheQuarter": 285.9, 
        "quarterYear": "2014", 
        "netCashProvidedByOperatingActivities": 276.7, 
        "quarterMonth": "September", 
        "netIncreaseDecreaseInCashAndCashEquivalents": 74.1, 
        "netCashProvidedByFinancingActivities": -149.4, 
        "capitalExpenditure": -9.7
      }, 
      ...
    ], 
    "latestQuarter": {
      "netCashProvidedByInvestingActivities": -147.4, 
      "cashAndCashEquivalentsAtTheEndOfTheQuarter": 355.2, 
      "cashAndCashEquivalentsAtTheBeginningOfTheQuarter": 319.4, 
      "quarterYear": "2015", 
      "netCashProvidedByOperatingActivities": 158.8, 
      "quarterMonth": "March", 
      "netIncreaseDecreaseInCashAndCashEquivalents": 35.8, 
      "netCashProvidedByFinancingActivities": 36.5, 
      "capitalExpenditure": -2.1
    }
  }, 
  "annualCashFlowStatements": {
    "latestYear": {
      "netCashProvidedByInvestingActivities": -70.0, 
      "year": "2014", 
      "capitalExpenditure": -12.2, 
      "netCashProvidedByOperatingActivities": 315.5, 
      "cashAndCashEquivalentsAtTheBeginningOfTheYear": 235.9, 
      "netIncreaseDecreaseInCashAndCashEquivalents": 83.5, 
      "netCashProvidedByFinancingActivities": -144.4, 
      "cashAndCashEquivalentsAtTheEndOfTheYear": 319.4
    }, 
    "previousYears": [
      {
        "netCashProvidedByInvestingActivities": -61.6, 
        "year": "2013", 
        "capitalExpenditure": -9.5, 
        "netCashProvidedByOperatingActivities": 333.3, 
        "cashAndCashEquivalentsAtTheBeginningOfTheYear": 149.1, 
        "netIncreaseDecreaseInCashAndCashEquivalents": 86.8, 
        "netCashProvidedByFinancingActivities": -184.3, 
        "cashAndCashEquivalentsAtTheEndOfTheYear": 235.9
      }, 
      {
        "netCashProvidedByInvestingActivities": -59.0, 
        "year": "2012", 
        "capitalExpenditure": -7.0, 
        "netCashProvidedByOperatingActivities": 357.8, 
        "cashAndCashEquivalentsAtTheBeginningOfTheYear": 84.4, 
        "netIncreaseDecreaseInCashAndCashEquivalents": 64.7, 
        "netCashProvidedByFinancingActivities": -235.9, 
        "cashAndCashEquivalentsAtTheEndOfTheYear": 149.1
      }, 
      ...
    ]
  }, 
  "annualIncomeStatements": {
    "latestYear": {
      "incomeTaxes": 52.6, 
      "revenue": 1681.8, 
      "nonOperatingExpense": null, 
      "incomeBeforeTax": 348.6, 
      "interestExpense": null, 
      "dilutedEPS": 7.99, 
      "totalNetIncomeAccuracy": "RESERVED", 
      "grossProfit": 1124.1999999999998, 
      "sgaExpense": 624.7, 
      "year": "2014", 
      "revenueAccuracy": "ACTUAL", 
      "operatingIncome": 421.5, 
      "totalNetIncome": 294.4
    }, 
    "previousYears": [
      {
        "incomeTaxes": 135.5, 
        "revenue": 1655.2, 
        "nonOperatingExpense": null, 
        "incomeBeforeTax": 396.0, 
        "interestExpense": null, 
        "dilutedEPS": 6.54, 
        "totalNetIncomeAccuracy": "RESERVED", 
        "grossProfit": 1104.7, 
        "sgaExpense": 582.5, 
        "year": "2013", 
        "revenueAccuracy": "ACTUAL", 
        "operatingIncome": 437.1, 
        "totalNetIncome": 258.5
      }, 
      {
        "incomeTaxes": 83.1, 
        "revenue": 1663.0, 
        "nonOperatingExpense": null, 
        "incomeBeforeTax": 378.3, 
        "interestExpense": null, 
        "dilutedEPS": 6.43, 
        "totalNetIncomeAccuracy": "RESERVED", 
        "grossProfit": 1142.0, 
        "sgaExpense": 602.2, 
        "year": "2012", 
        "revenueAccuracy": "ACTUAL", 
        "operatingIncome": 432.1, 
        "totalNetIncome": 295.5
      }, 
      ...
    ]
  }, 
  "currencyType": "USD", 
  "quarterlyIncomeStatements": {
    "previousQuarters": [
      {
        "incomeTaxes": 53.3, 
        "revenue": 489.8, 
        "nonOperatingExpense": null, 
        "incomeBeforeTax": 146.6, 
        "quarterYear": "2014", 
        "dilutedEPS": 2.52, 
        "totalNetIncomeAccuracy": "RESERVED", 
        "grossProfit": 340.0, 
        "quarterMonth": "December", 
        "sgaExpense": 164.5, 
        "interestExpense": null, 
        "revenueAccuracy": "ACTUAL", 
        "operatingIncome": 157.4, 
        "totalNetIncome": 91.7
      }, 
      {
        "incomeTaxes": 11.4, 
        "revenue": 417.1, 
        "nonOperatingExpense": null, 
        "incomeBeforeTax": 78.8, 
        "quarterYear": "2014", 
        "dilutedEPS": 1.85, 
        "totalNetIncomeAccuracy": "RESERVED", 
        "grossProfit": 269.3, 
        "quarterMonth": "September", 
        "sgaExpense": 154.5, 
        "interestExpense": null, 
        "revenueAccuracy": "ACTUAL", 
        "operatingIncome": 96.8, 
        "totalNetIncome": 67.5
      }, 
      ...
    ], 
    "latestQuarter": {
      "incomeTaxes": 15.4, 
      "revenue": 376.2, 
      "nonOperatingExpense": null, 
      "incomeBeforeTax": 56.6, 
      "quarterYear": "2015", 
      "dilutedEPS": 1.13, 
      "totalNetIncomeAccuracy": "RESERVED", 
      "grossProfit": 241.6, 
      "quarterMonth": "March", 
      "sgaExpense": 155.7, 
      "interestExpense": null, 
      "revenueAccuracy": "ACTUAL", 
      "operatingIncome": 66.2, 
      "totalNetIncome": 41.0
    }
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/financial/detail'

/company/{unique_id}/financial/summary Available in Add-on: Advanced Financial Information

This call returns a summary of finalized financial data for a given company."

Representation

/company/{unique_id}/financial/summary
?return_in_reported_currency={return_in_reported_currency}

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId
return_in_reported_currency Boolean

Sample Request

URL
GET /company/884114609/financial/summary

Sample Response

{
  "quarterlyBalanceSheets": {
    "previousQuarters": [
      {
        "liabilities": {
          "currentLiabilities": {
            "otherCurrentLiabilities": 584.9, 
            "shortTermDebt": 301.1, 
            "accountsPayable": 31.4
          }, 
          "liabilitySummary": {
            "totalCurrentLiabilities": 1158.9, 
            "totalLiabilities": 3189.5, 
            "otherNonCurrentLiabilities": 81.5, 
            "longTermDebt": 1352.2
          }
        }, 
        "assets": {
          "assetSummary": {
            "otherNonCurrentAssets": 50.8, 
            "netFixedAssets": 27.4, 
            "totalCurrentAssets": 935.9, 
            "totalAssets": 1986.2
          }, 
          "currentAssets": {
            "netReceivables": 533.0, 
            "inventories": null, 
            "cash": 319.4, 
            "otherIncomeAssets": 15.2
          }
        }, 
        "quarterYear": "2014", 
        "quarterMonth": "December", 
        "shareholdersEquity": {
          "equitySummary": {
            "totalEquity": -1203.3, 
            "sharesOutstanding": 35.9
          }, 
          "equity": {
            "preferredStockEquity": null, 
            "commonStockEquity": 0.8
          }
        }, 
        "year": null
      }, 
      {
        "liabilities": {
          "currentLiabilities": {
            "otherCurrentLiabilities": 594.5, 
            "shortTermDebt": 0.1, 
            "accountsPayable": 39.0
          }, 
          "liabilitySummary": {
            "totalCurrentLiabilities": 785.7, 
            "totalLiabilities": 2881.2, 
            "otherNonCurrentLiabilities": 84.6, 
            "longTermDebt": 1633.3
          }
        }, 
        "assets": {
          "assetSummary": {
            "otherNonCurrentAssets": 47.0, 
            "netFixedAssets": 36.1, 
            "totalCurrentAssets": 785.4, 
            "totalAssets": 1789.2
          }, 
          "currentAssets": {
            "netReceivables": 408.0, 
            "inventories": null, 
            "cash": 310.0, 
            "otherIncomeAssets": 14.2
          }
        }, 
        "quarterYear": "2014", 
        "quarterMonth": "September", 
        "shareholdersEquity": {
          "equitySummary": {
            "totalEquity": -1092.0, 
            "sharesOutstanding": 35.9
          }, 
          "equity": {
            "preferredStockEquity": null, 
            "commonStockEquity": 0.8
          }
        }, 
        "year": null
      }, 
      ...
    ], 
    "latestQuarter": {
      "liabilities": {
        "currentLiabilities": {
          "otherCurrentLiabilities": 690.3, 
          "shortTermDebt": 300.8, 
          "accountsPayable": 56.9
        }, 
        "liabilitySummary": {
          "totalCurrentLiabilities": 1172.5, 
          "totalLiabilities": 3238.3, 
          "otherNonCurrentLiabilities": 77.6, 
          "longTermDebt": 1402.7
        }
      }, 
      "assets": {
        "assetSummary": {
          "otherNonCurrentAssets": 45.0, 
          "netFixedAssets": 27.2, 
          "totalCurrentAssets": 895.8, 
          "totalAssets": 2027.7
        }, 
        "currentAssets": {
          "netReceivables": 466.7, 
          "inventories": null, 
          "cash": 355.2, 
          "otherIncomeAssets": 12.4
        }
      }, 
      "quarterYear": "2015", 
      "quarterMonth": "March", 
      "shareholdersEquity": {
        "equitySummary": {
          "totalEquity": -1210.6, 
          "sharesOutstanding": 36.0
        }, 
        "equity": {
          "preferredStockEquity": null, 
          "commonStockEquity": 0.8
        }
      }, 
      "year": null
    }
  }, 
  "quarterlyCashFlowStatements": {
    "previousQuarters": [
      {
        "netCashProvidedByInvestingActivities": -70.0, 
        "cashAndCashEquivalentsAtTheEndOfTheQuarter": 319.4, 
        "cashAndCashEquivalentsAtTheBeginningOfTheQuarter": 310.0, 
        "quarterYear": "2014", 
        "netCashProvidedByOperatingActivities": 315.5, 
        "quarterMonth": "December", 
        "netIncreaseDecreaseInCashAndCashEquivalents": 83.5, 
        "netCashProvidedByFinancingActivities": -144.4, 
        "capitalExpenditure": -12.2
      }, 
      {
        "netCashProvidedByInvestingActivities": -51.4, 
        "cashAndCashEquivalentsAtTheEndOfTheQuarter": 310.0, 
        "cashAndCashEquivalentsAtTheBeginningOfTheQuarter": 285.9, 
        "quarterYear": "2014", 
        "netCashProvidedByOperatingActivities": 276.7, 
        "quarterMonth": "September", 
        "netIncreaseDecreaseInCashAndCashEquivalents": 74.1, 
        "netCashProvidedByFinancingActivities": -149.4, 
        "capitalExpenditure": -9.7
      }, 
      ...
    ], 
    "latestQuarter": {
      "netCashProvidedByInvestingActivities": -147.4, 
      "cashAndCashEquivalentsAtTheEndOfTheQuarter": 355.2, 
      "cashAndCashEquivalentsAtTheBeginningOfTheQuarter": 319.4, 
      "quarterYear": "2015", 
      "netCashProvidedByOperatingActivities": 158.8, 
      "quarterMonth": "March", 
      "netIncreaseDecreaseInCashAndCashEquivalents": 35.8, 
      "netCashProvidedByFinancingActivities": 36.5, 
      "capitalExpenditure": -2.1
    }
  }, 
  "annualCashFlowStatements": {
    "latestYear": {
      "netCashProvidedByInvestingActivities": -70.0, 
      "year": "2014", 
      "capitalExpenditure": -12.2, 
      "netCashProvidedByOperatingActivities": 315.5, 
      "cashAndCashEquivalentsAtTheBeginningOfTheYear": 235.9, 
      "netIncreaseDecreaseInCashAndCashEquivalents": 83.5, 
      "netCashProvidedByFinancingActivities": -144.4, 
      "cashAndCashEquivalentsAtTheEndOfTheYear": 319.4
    }, 
    "previousYears": [
      {
        "netCashProvidedByInvestingActivities": -61.6, 
        "year": "2013", 
        "capitalExpenditure": -9.5, 
        "netCashProvidedByOperatingActivities": 333.3, 
        "cashAndCashEquivalentsAtTheBeginningOfTheYear": 149.1, 
        "netIncreaseDecreaseInCashAndCashEquivalents": 86.8, 
        "netCashProvidedByFinancingActivities": -184.3, 
        "cashAndCashEquivalentsAtTheEndOfTheYear": 235.9
      }, 
      {
        "netCashProvidedByInvestingActivities": -59.0, 
        "year": "2012", 
        "capitalExpenditure": -7.0, 
        "netCashProvidedByOperatingActivities": 357.8, 
        "cashAndCashEquivalentsAtTheBeginningOfTheYear": 84.4, 
        "netIncreaseDecreaseInCashAndCashEquivalents": 64.7, 
        "netCashProvidedByFinancingActivities": -235.9, 
        "cashAndCashEquivalentsAtTheEndOfTheYear": 149.1
      }, 
      ...
    ]
  }, 
  "topCompetitors": {
    "competitor1": {
      "marketCap": 11612.6055, 
      "employees": 7500, 
      "annualSales": 2436.4, 
      "companyName": "EQUIFAX INC."
    }, 
    "competitor3": {
      "marketCap": 18719.424, 
      "employees": 16820, 
      "annualSales": 4840.0, 
      "companyName": "EXPERIAN PLC"
    }, 
    "competitor2": {
      "marketCap": 463.68, 
      "employees": 2100, 
      "annualSales": 150.1, 
      "companyName": "Infogroup Inc."
    }
  }, 
  "marketAnalysis": {
    "morningStar": {
      "bullsSay": "Management's increased use of debt is appropriate,...", 
      "bearsSay": "The company's pension plan is significantly underf..."
    }
  }, 
  "basicFinancialInformation": {
    "fiscalYearEnd": "December", 
    "latestYearNetIncome": {
      "netIncome": 294.4, 
      "year": "2014"
    }, 
    "oneYearSalesGrowthPct": 1.61, 
    "latestYearSales": {
      "salesAccuracy": "ACTUAL", 
      "sales": 1681.8, 
      "year": "2014"
    }, 
    "location": "HEADQUARTERS", 
    "exchanges": [
      {
        "exchangeName": "Dusseldorf", 
        "tickerSymbol": "DB5"
      }, 
      {
        "exchangeName": "German", 
        "tickerSymbol": "DB5"
      }, 
      ...
    ], 
    "oneYearNetIncomeGrowthPct": 13.89, 
    "currencyType": "USD", 
    "companyType": "PUBLIC", 
    "auditor": "PricewaterhouseCoopers LLP"
  }, 
  "comparisonToIndustryAndMarket": {
    "company": {
      "priceSalesRatio": null, 
      "priceBookRatio": null, 
      "priceCashFlowRatio": 14.73, 
      "priceEarningRatio": 18.58
    }, 
    "marketMedian": {
      "priceSalesRatio": 1.67, 
      "priceBookRatio": 1.96, 
      "priceCashFlowRatio": 12.6, 
      "priceEarningRatio": 20.59
    }, 
    "industryMedian": {
      "priceSalesRatio": 2.92, 
      "priceBookRatio": 4.79, 
      "priceCashFlowRatio": 17.86, 
      "priceEarningRatio": 26.2
    }
  }, 
  "annualBalanceSheets": {
    "latestYear": {
      "liabilities": {
        "currentLiabilities": {
          "otherCurrentLiabilities": 584.9, 
          "shortTermDebt": 301.1, 
          "accountsPayable": 31.4
        }, 
        "liabilitySummary": {
          "totalCurrentLiabilities": 1158.9, 
          "totalLiabilities": 3189.5, 
          "otherNonCurrentLiabilities": 81.5, 
          "longTermDebt": 1352.2
        }
      }, 
      "assets": {
        "assetSummary": {
          "otherNonCurrentAssets": 50.8, 
          "netFixedAssets": 27.4, 
          "totalCurrentAssets": 935.9, 
          "totalAssets": 1986.2
        }, 
        "currentAssets": {
          "netReceivables": 533.0, 
          "inventories": null, 
          "cash": 319.4, 
          "otherIncomeAssets": 15.2
        }
      }, 
      "quarterYear": null, 
      "quarterMonth": null, 
      "shareholdersEquity": {
        "equitySummary": {
          "totalEquity": -1203.3, 
          "sharesOutstanding": 35.9
        }, 
        "equity": {
          "preferredStockEquity": null, 
          "commonStockEquity": 0.8
        }
      }, 
      "year": "2014"
    }, 
    "previousYears": [
      {
        "liabilities": {
          "currentLiabilities": {
            "otherCurrentLiabilities": 600.8, 
            "shortTermDebt": 0.1, 
            "accountsPayable": 41.4
          }, 
          "liabilitySummary": {
            "totalCurrentLiabilities": 852.3, 
            "totalLiabilities": 2938.7, 
            "otherNonCurrentLiabilities": 170.2, 
            "longTermDebt": 1516.0
          }
        }, 
        "assets": {
          "assetSummary": {
            "otherNonCurrentAssets": 60.6, 
            "netFixedAssets": 39.6, 
            "totalCurrentAssets": 822.4, 
            "totalAssets": 1890.3
          }, 
          "currentAssets": {
            "netReceivables": 524.8, 
            "inventories": null, 
            "cash": 235.9, 
            "otherIncomeAssets": 17.4
          }
        }, 
        "quarterYear": null, 
        "quarterMonth": null, 
        "shareholdersEquity": {
          "equitySummary": {
            "totalEquity": -1048.4, 
            "sharesOutstanding": 37.8
          }, 
          "equity": {
            "preferredStockEquity": null, 
            "commonStockEquity": 0.8
          }
        }, 
        "year": "2013"
      }, 
      {
        "liabilities": {
          "currentLiabilities": {
            "otherCurrentLiabilities": 610.7, 
            "shortTermDebt": 0.2, 
            "accountsPayable": 40.9
          }, 
          "liabilitySummary": {
            "totalCurrentLiabilities": 876.7, 
            "totalLiabilities": 3009.2, 
            "otherNonCurrentLiabilities": 170.4, 
            "longTermDebt": 1290.7
          }
        }, 
        "assets": {
          "assetSummary": {
            "otherNonCurrentAssets": 57.6, 
            "netFixedAssets": 40.6, 
            "totalCurrentAssets": 747.4, 
            "totalAssets": 1991.8
          }, 
          "currentAssets": {
            "netReceivables": 520.8, 
            "inventories": null, 
            "cash": 149.1, 
            "otherIncomeAssets": 4.4
          }
        }, 
        "quarterYear": null, 
        "quarterMonth": null, 
        "shareholdersEquity": {
          "equitySummary": {
            "totalEquity": -1017.4, 
            "sharesOutstanding": 41.3
          }, 
          "equity": {
            "preferredStockEquity": null, 
            "commonStockEquity": 0.8
          }
        }, 
        "year": "2012"
      }, 
      ...
    ]
  }, 
  "annualIncomeStatements": {
    "latestYear": {
      "incomeTaxes": 52.6, 
      "revenue": 1681.8, 
      "nonOperatingExpense": null, 
      "incomeBeforeTax": 348.6, 
      "interestExpense": null, 
      "dilutedEPS": 7.99, 
      "totalNetIncomeAccuracy": "RESERVED", 
      "grossProfit": 1124.1999999999998, 
      "sgaExpense": 624.7, 
      "year": "2014", 
      "revenueAccuracy": "ACTUAL", 
      "operatingIncome": 421.5, 
      "totalNetIncome": 294.4
    }, 
    "previousYears": [
      {
        "incomeTaxes": 135.5, 
        "revenue": 1655.2, 
        "nonOperatingExpense": null, 
        "incomeBeforeTax": 396.0, 
        "interestExpense": null, 
        "dilutedEPS": 6.54, 
        "totalNetIncomeAccuracy": "RESERVED", 
        "grossProfit": 1104.7, 
        "sgaExpense": 582.5, 
        "year": "2013", 
        "revenueAccuracy": "ACTUAL", 
        "operatingIncome": 437.1, 
        "totalNetIncome": 258.5
      }, 
      {
        "incomeTaxes": 83.1, 
        "revenue": 1663.0, 
        "nonOperatingExpense": null, 
        "incomeBeforeTax": 378.3, 
        "interestExpense": null, 
        "dilutedEPS": 6.43, 
        "totalNetIncomeAccuracy": "RESERVED", 
        "grossProfit": 1142.0, 
        "sgaExpense": 602.2, 
        "year": "2012", 
        "revenueAccuracy": "ACTUAL", 
        "operatingIncome": 432.1, 
        "totalNetIncome": 295.5
      }, 
      ...
    ]
  }, 
  "quarterlyIncomeStatements": {
    "previousQuarters": [
      {
        "incomeTaxes": 53.3, 
        "revenue": 489.8, 
        "nonOperatingExpense": null, 
        "incomeBeforeTax": 146.6, 
        "quarterYear": "2014", 
        "dilutedEPS": 2.52, 
        "totalNetIncomeAccuracy": "RESERVED", 
        "grossProfit": 340.0, 
        "quarterMonth": "December", 
        "sgaExpense": 164.5, 
        "interestExpense": null, 
        "revenueAccuracy": "ACTUAL", 
        "operatingIncome": 157.4, 
        "totalNetIncome": 91.7
      }, 
      {
        "incomeTaxes": 11.4, 
        "revenue": 417.1, 
        "nonOperatingExpense": null, 
        "incomeBeforeTax": 78.8, 
        "quarterYear": "2014", 
        "dilutedEPS": 1.85, 
        "totalNetIncomeAccuracy": "RESERVED", 
        "grossProfit": 269.3, 
        "quarterMonth": "September", 
        "sgaExpense": 154.5, 
        "interestExpense": null, 
        "revenueAccuracy": "ACTUAL", 
        "operatingIncome": 96.8, 
        "totalNetIncome": 67.5
      }, 
      ...
    ], 
    "latestQuarter": {
      "incomeTaxes": 15.4, 
      "revenue": 376.2, 
      "nonOperatingExpense": null, 
      "incomeBeforeTax": 56.6, 
      "quarterYear": "2015", 
      "dilutedEPS": 1.13, 
      "totalNetIncomeAccuracy": "RESERVED", 
      "grossProfit": 241.6, 
      "quarterMonth": "March", 
      "sgaExpense": 155.7, 
      "interestExpense": null, 
      "revenueAccuracy": "ACTUAL", 
      "operatingIncome": 66.2, 
      "totalNetIncome": 41.0
    }
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/financial/summary'

/company/{unique_id}/market/analysis_report Included in Base Package

This call returns a Morningstar market analysis for the specified company. Please note not all companies have reports.

Representation

/company/{unique_id}/market/analysis_report

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId

Sample Request

URL
GET /company/884114609/market/analysis_report

Sample Response

{
  "report": "JVBERi0xLjYKJeTjz9IKNzkgMCBvYmoKPDwKL0xpbmVhcml6ZW...", 
  "message": "The market analysis report is attached."
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/market/analysis_report'

/company/{unique_id}/market/data Available in Add-on: Advanced Financial Information

This call returns financial market data for a given company.

Representation

/company/{unique_id}/market/data
?return_in_reported_currency={return_in_reported_currency}

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId
return_in_reported_currency Boolean New for 1.7

Sample Request

URL
GET /company/884114609/market/data

Sample Response

{
  "currencyType": "USD", 
  "growthRates": {
    "thirtySixMonth": {
      "pctEpsGrowth": 7.0, 
      "pctDividendGrowth": 6.83, 
      "pctRevenueGrowth": -1.57
    }, 
    "sixtyMonth": {
      "pctEpsGrowth": 6.56, 
      "pctDividendGrowth": 5.84, 
      "pctRevenueGrowth": -0.01
    }, 
    "twelveMonth": {
      "pctEpsGrowth": -9.08, 
      "pctDividendGrowth": 8.54, 
      "pctRevenueGrowth": 1.21
    }
  }, 
  "currentInformation": {
    "pctReturnOnEquity": null, 
    "priceSalesRatio": null, 
    "longTermDebtToEquity": null, 
    "latestNetInsiderTransactions": 7283, 
    "lastCloseAmount": 126.68, 
    "pctOwnedByInstitutions": 86.99, 
    "fiftyTwoWeekLow": 102.7, 
    "pctReturnOnAssets": 13.04, 
    "sixtyMonthBeta": 0.01, 
    "dividendYield": 0.0141, 
    "priceCashFlowRatio": 14.73, 
    "currentRatio": 0.76, 
    "fiftyTwoWeekHigh": 135.92, 
    "sharesOutstanding": 36035, 
    "priceEarningsRatio": 18.58, 
    "latestShortInterestRatio": null, 
    "numOfInstitutionalHolders": 514, 
    "marketCap": 4564.9138, 
    "priceBookRatio": null, 
    "lastCloseDate": "2015-06-04", 
    "dividendRate": 1.85
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/market/data'

/company/{unique_id}/news Available in Add-on: News Information

Returns news items for a given DUNS number. This service requires a username and password in addition to the API-Key.

Representation

/company/{unique_id}/news
?start_date={start_date}
&end_date={end_date}
&filter={filter}

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId
start_date String YYYY-MM-DD
end_date String YYYY-MM-DD
filter String (ExecutiveActivity | GeneralIndustry | ManagementChange | MergerAndAcquisition | NewProductOrAlliance | RegulationOrLitigation | WinsOrAwards)

Sample Request

URL
GET /company/884114609/news

Sample Response

{
  "companyNews": {
    "duns": "884114609", 
    "newsItems": {
      "newsItem": [
        {
          "category": [
            "Executive Quote"
          ], 
          "title": "CG Announced as No.1 Company in Power Equipments b...", 
          "text": "Category: Business/ Finance, Banking & Financial s...", 
          "source": "WebIndia123.com", 
          "link": "http://news.webindia123.com/news/press_showdetails...", 
          "date": "Mon Jun 01 04:00:48 PDT 2015"
        }, 
        {
          "category": [
            "Executive Quote"
          ], 
          "title": "TCS rated best company in India: Dun & Bradstreet", 
          "text": "Tata Consultancy Services (TCS) has been rated as ...", 
          "source": "Sify", 
          "link": "http://www.sify.com/finance/tcs-rated-best-company...", 
          "date": "Fri May 29 03:27:22 PDT 2015"
        }, 
        ...
      ]
    }, 
    "name": "Dun & Bradstreet Corporation"
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/news'

/company/{unique_id}/optional Available in Add-on: Full Company Profile

Returns detailed company information for a single company, with the ability to specify the components that are to be returned."

Representation

/company/{unique_id}/optional

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId

Body Representation

Element Type Notes
optionalResponseFields Object
optionalResponseFields​.includeIndustries Boolean If true, the return will include industries the company is affiliated with such as: lineOfBusiness, primaryDnBIC, primaryNAICS, primaryUSSIC, primaryUKSIC, allUKSIC, allUSSIC, allNAICS, allDnBIC
optionalResponseFields​.includeKeyNumbers Boolean If true, the return will include annual and quarterly key numbers and affiliated values such as: sales, salesAccuracy, employeesAtThisLocation, employeesAtThisLocationAccuracy, totalEmployeeGrowthPercent, employeesTotal, researchAndDevelopment, advertising, fiscal-period, and periodEndMonth
optionalResponseFields​.includeLocations Boolean If true, the return will include location data such aas address, city, county, state, country, countryId, zip, zip4, latitude, longitude, latLongAcuracy, addressType, and metroArea
optionalResponseFields​.includePhones Boolean If true, the return will include: faxNumber, countryCode, areaCode, phoneNumber, and whether or not the phone number is listed in the doNotCallRegistry
optionalResponseFields​.includeRankings Boolean If true, the return will include details about rankings such as the type of ranking system and the rankNumber
optionalResponseFields​.includeStocks Boolean If true, the return will include stock information such as tickerUS, exchangeInfoList , exchangeInfo, exchangePrimary country, tickerSymbol, and exchangeName
optionalResponseFields​.includeTopExecutives Boolean If true, the return will include official information about the company's top executives such as Chairman and CEO and include jobFunctionId's, start and end year, compensation details, age, and the full name of these executives
optionalResponseFields​.includeURLs Boolean If true, the return will include a company's official website address such as http://www.thecoca-colacompany.com, the sortorder, and other official URL addresses
optionalResponseFields​.includeSocialMedia Array of String Type of social media data to include for the company. Options: all, twitter, facebook, youtube, wikipedia Available Values:
all
twitter
youtube
facebook
wikipedia

Sample Request

URL
POST /company/884114609/optional
Body
{}

Sample Response

{
  "otherURLs": null, 
  "manufacturingIndicator": "", 
  "bankName": "", 
  "marketingPreScreenScore": "H", 
  "phones": null, 
  "nonMarketableCompany": null, 
  "parentName": "THE DUN & BRADSTREET CORPORATION", 
  "socialMedia": null, 
  "locations": null, 
  "yearFounded": "1841", 
  "foreignTrades": null, 
  "keyNumbersHistory": null, 
  "fein": "223725387", 
  "legalStatus": "Corporation", 
  "companyType": "PUBLIC", 
  "historicalText": "", 
  "industries": null, 
  "dbaNames": {
    "dba": [
      "D&B"
    ]
  }, 
  "legalStructureDescription": null, 
  "companyId": 10483000000000, 
  "rankings": null, 
  "ukSpecs": {
    "ukRegistration": null, 
    "ukVAT": null, 
    "numberOfSubsidiaries": null
  }, 
  "minorityOwned": false, 
  "ownershipYear": "1841", 
  "topExecutives": null, 
  "ethnicity": "Unknown", 
  "accountingFirm": "Pricewaterhousecoopers LLP Ne", 
  "historicalIndicator": false, 
  "ultimateDomesticParentName": "THE DUN & BRADSTREET CORPORATION", 
  "vat": null, 
  "spaceAtAddress": 123000, 
  "keyFinancials": {
    "incomeAssets": {
      "netIncome": null, 
      "netIncomeGrowthPercent": null, 
      "period": null, 
      "salesGrowthPercent": null, 
      "assets": null
    }, 
    "marketValueInfo": {
      "marketValue": 4564.9138, 
      "marketValueDate": "2015-06-04"
    }
  }, 
  "numberOfPCs": null, 
  "primaryURLs": null, 
  "womenOwned": false, 
  "ultimateDomesticParent": "884114609", 
  "smallBusinessIndicator": false, 
  "duns": "884114609", 
  "spaceAtAddressUnitOfMeasurement": "sq ft", 
  "stocks": null, 
  "spaceAtAddressAccuracy": 0, 
  "ultimateParentDuns": "884114609", 
  "name": "THE DUN & BRADSTREET CORPORATION", 
  "locationType": "HEADQUARTERS", 
  "fullDescription": "<p>For The Dun &amp; Bradstreet Corporation, there...", 
  "ultimateParentName": "THE DUN & BRADSTREET CORPORATION", 
  "currencyType": "USD", 
  "franchiseOperationType": "", 
  "synopsis": "<p>For The Dun &amp; Bradstreet Corporation, there...", 
  "legalStructureCode": null, 
  "parentDuns": "884114609", 
  "subsidiaryStatus": false, 
  "crn": null, 
  "ownedOrLeased": "Location Is Rented By This Company"
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     -d '{}'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/optional'

/company/{DUNSNumber}/report/{DNBProductID} Available in Add-on: D&B Data Contract

This call returns specified business information reports (BIR), Comprehensive Reports (COMPR), and Compact Reports (CPTR) for a DUNS Number in text format. Required inputs are indicated.

Prerequisites: A user should have an active D&B contract before accessing this web service. If the user does not know the D&B DUNS Number for the organization there are several web services that can retrieve the DUNS Number such as Get Company Detail and Find Company By Keyword. Once the DUNS Number is retrieved, a user can check the product availability in this call.

This web service will only return the products that the customer is contractually enabled to purchase. The report will be delivered as base64 encoded data in the ContentObject tag of the response.

At present, only text reports are supported. Reports in other formats (HTML, PDF etc) are not currently supported.

Countries and languages supported:

[ BIR - USA: English (39) | Canada: English (39) and French (40) | Belgium, Netherlands, Luxembourg, UK, Ireland, Germany, France, Italy: English (39), French (40), Spanish (44), German (41), Portuguese (43), Italian (42), Dutch (38), Belgian Dutch (36), Belgian French (37) | Brazil: English (39) and Portuguese (43), Mexico, Paraguay, Uruguay: English (39) and Spanish (44) | All other countries: English (39) ]

[ COMPR - Australia, American Samoa, Christmas Island, Cook Islands, Fiji, Guam, Kiribati, Mariana Islands, Marshall Islands, Nauru, Norfolk Island, Papua New Guinea, Solomon Islands, Tokelau, Tonga, Tuvalu, USA, and Vanuatu: English | Belgium, France, Germany, Ireland, Italy, Luxembourg, Netherlands, and United Kingdom: Belgian Dutch, Belgian French, Dutch, English, French, German, Italian, Portuguese, and Spanish | Canada: English and French | All other countries: Not supported ]

[ CPTR - Belgium, France, Germany, Ireland, Italy, Luxembourg, Netherlands, and United Kingdom: Belgian Dutch, Belgian French, Dutch, English, French, German, Italian, Portuguese, and Spanish | All other countries: Not supported ]

Representation

/company/{DUNSNumber}/report/{DNBProductID}
?ApplicationTransactionID={ApplicationTransactionID}
&TransactionTimestamp={TransactionTimestamp}
&SubmittingOfficeID={SubmittingOfficeID}
&CountryISOAlpha2Code={CountryISOAlpha2Code}
&OrganizationIdentificationNumber={OrganizationIdentificationNumber}
&OrganizationIdentificationNumberTypeCode={OrganizationIdentificationNumberTypeCode}
&DNBProductModuleCode={DNBProductModuleCode}
&MergeModuleAttachmentsIndicator={MergeModuleAttachmentsIndicator}
&ProductFormatPreferenceCode={ProductFormatPreferenceCode}
&CharacterSetPreferenceCode={CharacterSetPreferenceCode}
&LanguagePreferenceCode={LanguagePreferenceCode}
&OrderReasonCode={OrderReasonCode}
&TradeUpIndicator={TradeUpIndicator}
&ReturnOnlyInDateDataIndicator={ReturnOnlyInDateDataIndicator}
&ArchiveProductOptOutIndicator={ArchiveProductOptOutIndicator}
&ExtendArchivePeriodIndicator={ExtendArchivePeriodIndicator}
&PortfolioAssetContainerID={PortfolioAssetContainerID}
&CustomerReferenceText={CustomerReferenceText}
&CustomerBillingEndorsementText={CustomerBillingEndorsementText}

URL Parameters

Element Type Notes
DNBProductID String Required
DUNSNumber String Required
ApplicationTransactionID String
TransactionTimestamp String
SubmittingOfficeID String
CountryISOAlpha2Code String
OrganizationIdentificationNumber String
OrganizationIdentificationNumberTypeCode Number
DNBProductModuleCode Number
MergeModuleAttachmentsIndicator Boolean
ProductFormatPreferenceCode Number
CharacterSetPreferenceCode Number
LanguagePreferenceCode Number
OrderReasonCode Number
TradeUpIndicator Boolean
ReturnOnlyInDateDataIndicator Boolean
ArchiveProductOptOutIndicator Boolean
ExtendArchivePeriodIndicator Boolean
PortfolioAssetContainerID Number
CustomerReferenceText String
CustomerBillingEndorsementText String

Sample Request

URL
GET /company/884114609/report/BIR

Sample Response

/* response not available */

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/884114609/report/BIR'

/company/cleanseAndStandardize Available in Add-on: Match Service

Representation

/company/cleanseAndStandardize
?ApplicationTransactionID={ApplicationTransactionID}
&TransactionTimestamp={TransactionTimestamp}
&SubmittingOfficeID={SubmittingOfficeID}
&OrganizationName ={OrganizationName }
&LineText={LineText}
&DisplaySequence={DisplaySequence}
&PrimaryTownName={PrimaryTownName}
&CountyName={CountyName}
&CountryISOAlpha2Code={CountryISOAlpha2Code}
&TerritoryName={TerritoryName}
&PostalCode={PostalCode}
&CustomerReferenceText={CustomerReferenceText}
&CustomerBillingEndorsementText={CustomerBillingEndorsementText}

URL Parameters

Element Type Notes
ApplicationTransactionID String
TransactionTimestamp String
SubmittingOfficeID String
OrganizationName String
LineText String
DisplaySequence Number
PrimaryTownName String
CountyName String
CountryISOAlpha2Code String
TerritoryName String
PostalCode String
CustomerReferenceText String
CustomerBillingEndorsementText String

Sample Request

URL
GET /company/cleanseAndStandardize?OrganizationName=AMR%20Corporation&LineText=4333%20Amon%20Carter%20Blvd.&TerritoryName=TX&PostalCode=76155&CountryISOAlpha2Code=US

Sample Response

{
  "CleanseAndStandardizeResponse": {
    "CleanseAndStandardizeResponseDetail": {
      "StandardizedName": {
        "OrganizationName": {
          "$": "AMR Corp"
        }
      }, 
      "StandardizedAddress": {
        "PostalCode": "76155", 
        "TerritoryAbbreviatedName": "TX", 
        "AddressTypeValue": "Unknown", 
        "InexactAddressIndicator": false, 
        "CountyName": "Tarrant", 
        "TerritoryName": "Texas", 
        "CountryName": "United States", 
        "CountryISOAlpha2Code": "US", 
        "DeliveryPointValidationDetail": {
          "StatusValue": "No DPV Address", 
          "CMRAValue": "No DPV Address"
        }, 
        "PrimaryTownName": "Fort Worth"
      }, 
      "InquiryDetail": {
        "OrganizationName": {
          "$": "AMR Corporation"
        }, 
        "Address": {
          "CountryISOAlpha2Code": "US", 
          "PostalCode": "76155", 
          "TerritoryName": "TX"
        }
      }
    }, 
    "TransactionDetail": {
      "TransactionTimestamp": "2015-06-05T13:09:00", 
      "ServiceTransactionID": "Id-acd7715520813f00c6f71000358f4348-1"
    }, 
    "TransactionResult": {
      "ResultID": "CM000", 
      "ResultText": "Success", 
      "SeverityText": "Information"
    }, 
    "@ServiceVersionNumber": "3.0"
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/cleanseAndStandardize?OrganizationName=AMR%20Corporation&LineText=4333%20Amon%20Carter%20Blvd.&TerritoryName=TX&PostalCode=76155&CountryISOAlpha2Code=US'

/company/familytree/{unique_id} Available in Add-on: Family Tree Information

Returns ultimate parent of the given company and all its children or descendants. Access to this service is restricted - please contact your sales representative for access.

Representation

/company/familytree/{unique_id}
?include_primary_sic={include_primary_sic}

URL Parameters

Element Type Notes
unique_id Number Required D-U-N-S number or companyId
include_primary_sic Boolean New for 1.7

Body Representation

Element Type Notes
depthLimit Number The number of layers or levels of the family tree structure to return.
locationType Array of String Company Location Type such as Single Location (0), Headquarters (1), Branch (2), Branch/Division (4), Subsidiary (5)
city Array of String City
state Array of String (1-30 characters) State
country Array of String Country
includeUndeliverableAddress Boolean
includeOutOfBusiness Boolean
includeIncompleteData Boolean If true, will return all the unmarketable company records which have incomplete data.
includeDoNotMarketTo Boolean If true, will return all the unmarketable company records which indicated do not market to.
includeAll Boolean

Sample Request

URL
POST /company/familytree/884114609
Body
{}

Sample Response

{
  "primarySic": null, 
  "revenue": 1681.8, 
  "number": null, 
  "children": {
    "child": [
      {
        "primarySic": null, 
        "revenue": null, 
        "number": 1, 
        "children": null, 
        "city": "Waltham", 
        "companyId": 79681810, 
        "postalCode1": "02451", 
        "postalCode2": "7525", 
        "state": "MA", 
        "currencyType": null, 
        "dbaNames": {
          "dba": [
            "D&B", 
            "NETPROSPEX"
          ]
        }, 
        "address1": "300 3rd Ave", 
        "address2": "", 
        "ultimateDomesticParent": null, 
        "primarySicDescription": null, 
        "duns": "079681810", 
        "totalChildren": null, 
        "ultimateParentDuns": "884114609", 
        "additionalData": {
          "outOfBusiness": false, 
          "incompleteData": false, 
          "undeliverableAddress": false, 
          "doNotMarketTo": false
        }, 
        "name": "The Dun & Bradstreet Corporation", 
        "locationType": "BRANCH", 
        "parentDuns": "884114609", 
        "country": "United States", 
        "employeesAtThisLocation": 2
      }, 
      {
        "primarySic": null, 
        "revenue": 5.13, 
        "number": 2, 
        "children": null, 
        "city": "Vancouver", 
        "companyId": 250949638, 
        "postalCode1": "", 
        "postalCode2": "V6Z 1A3", 
        "state": "BC", 
        "currencyType": "USD", 
        "dbaNames": {
          "dba": [
            "D&B Cloud Innovation Centre", 
            "INDICEE"
          ]
        }, 
        "address1": "720 Robson St Suite 300", 
        "address2": "", 
        "ultimateDomesticParent": null, 
        "primarySicDescription": null, 
        "duns": "250949638", 
        "totalChildren": null, 
        "ultimateParentDuns": "884114609", 
        "additionalData": {
          "outOfBusiness": false, 
          "incompleteData": false, 
          "undeliverableAddress": false, 
          "doNotMarketTo": false
        }, 
        "name": "4447808 Canada Inc", 
        "locationType": "SINGLE_LOCATION", 
        "parentDuns": "884114609", 
        "country": "Canada", 
        "employeesAtThisLocation": 53
      }, 
      ...
    ]
  }, 
  "city": "Short Hills", 
  "companyId": 10483000000000, 
  "postalCode1": "07078", 
  "postalCode2": "2708", 
  "state": "NJ", 
  "currencyType": "USD", 
  "dbaNames": {
    "dba": [
      "D&B"
    ]
  }, 
  "address1": "103 Jfk Pkwy", 
  "address2": "", 
  "ultimateDomesticParent": null, 
  "primarySicDescription": null, 
  "duns": "884114609", 
  "totalChildren": 77, 
  "ultimateParentDuns": "884114609", 
  "additionalData": {
    "outOfBusiness": false, 
    "incompleteData": false, 
    "undeliverableAddress": false, 
    "doNotMarketTo": false
  }, 
  "name": "THE DUN & BRADSTREET CORPORATION", 
  "locationType": "HEADQUARTERS", 
  "parentDuns": "884114609", 
  "country": "United States", 
  "employeesAtThisLocation": 400
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     -d '{}'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/familytree/884114609'

/company/findcompanycleansematch Available in Add-on: Match Service

The Cleanse Match Service acts as an interface for matching a name and address of a business for identity resolution. The response typically consists of response candidates that are identified as the best matches for the input criteria based on D&B's match algorithms. This service seeks a single known entity, typically based on a combination of name, address, and phone number or a unique identifier. Use the Cleanse Match service to retrieve an organization's DUNS Number. Once the DUNS Number is obtained, a user can retrieve the D&B data for that organization by invoking other services. Once the DUNS Number is obtained, a user can retrieve more information from GetCompanyDetail and GetFamilyTree. Enter the required Cleanse Match fields such as organization name, state, and country. The service cleanses the output to perform a match. If the match returns candidates below a Confidence Code 8 using the cleansed information, the Cleanse Match performs the match again using actual user input. The service returns the highest confidence candidates by merging both matches (cleansed input and actual user input) into a result. Users can retrieve the D&B DUNS Number of the organization, using the following match types: Match using Business Name, Match using Organization Name and Organization Address, Match using Organization Address, Match using Telephone Number, For USA and Canada search Organizations nationwide. It is default for all other countries.

Representation

/company/findcompanycleansematch

URL Parameters

none

Body Representation

Element Type Notes
dataAreaRequest Object Required
dataAreaRequest​.orderRequest Object Required
dataAreaRequest​.orderRequest​.primaryName String (1-90 characters) Required Required Primary Company Name
dataAreaRequest​.orderRequest​.address String (1-64 characters) Physical street address of the business
dataAreaRequest​.orderRequest​.city String (1-30 characters) City
dataAreaRequest​.orderRequest​.state String (1-30 characters) State
dataAreaRequest​.orderRequest​.postalCode String (1-10 characters) Postal Code
dataAreaRequest​.orderRequest​.country String (2 characters) Required The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO), identifying the country for this address. Refer to Country Codes - ISO 3166 for a complete list.
dataAreaRequest​.orderRequest​.phone String (1-16 characters) Telephone Number
dataAreaRequest​.orderRequest​.internationalDialingCode Number (up to 7 characters) The country calling code assigned by the International Telecommunication Union (ITU) required to connect to this Telecommunication Number of the subject country when dialing from outside the subject country; e.g., '1' for the US, '44' for the UK, '91' for India.
dataAreaRequest​.orderRequest​.confidenceCode Number (1-10 characters) Confidence Codes range from 00 (no match) to 10 in order of increasing confidence that the customer record was matched to the correct D&B record. A score of 10 is the highest confidence code.
dataAreaRequest​.matchSpecification Object (3 characters) The match specification can be based on the CandidateMaximumQuanity which is an integer 3 digits long.
dataAreaRequest​.matchSpecification​.candidateMaximumQuantity Number The limit on the number of candidates returned. Maximum of 25 candidates will be returned for the following countries: Spain, Ireland, Belgium, San Marino, Andorra, Italy, United Kingdom, Portugal, Netherlands, Luxembourg, Virgin Islands U.S., Puerto Rico, United States of America and Canada. For these countries, if the user specifies a value more than 25 in the 'CandidateMaximumQuantity' field of the request, CandidateMaximumQuantity will be considered as 25. Maximum of 100 candidates will be returned for all other countries. For these countries, if the user specifies a value more than 100 in the 'CandidateMaximumQuantity' field of the request, CandidateMaximumQuantity will be considered as 100.
dataAreaRequest​.matchSpecification​.exclusionCriteria Array of String An entry loop which can repeat multiple times to allow the recording of filtering requirements that a service should apply to prevent subjects from being returned in a match response. For example, exclude subjects from the candidate list that are out of business. Possible enumeration values are: "Exclude Non HeadQuarters", "Exclude Non Marketable", "Exact Match", "Exclude Out of Business", "Exclude Unreachable", and "Exclude Undeliverable" Available Values:
Exclude Non HeadQuarters
Exclude Non Marketable
Exact Match
Exclude Out of Business
Exclude Unreachable
Exclude Undeliverable
dataAreaRequest​.matchSpecification​.orderReasonCode Number A D&B code value that defines the grounds for the customer requesting the product, such as a required to support a credit decision. In order to comply with German data protection laws, any enquiry on a German business must be accompanied by a Reason Code that details the basis for the enquiry. For example, Credit Decisions, Debt Collections, Insurance, or Leasing Agreement. This element is only required for Germany. A D&B code value that defines the grounds for the customer requesting the product. For example, if the request is required to support a credit decision. Use the following: Credit Decision (6332), Assessment of credit solvency for intended business connection (6333), Assessment of credit solvency for ongoing business connection (6334), Debt Collection (6335), Commercial Credit Insurance (6336), Insurance contract (6337), Leasing Agreement (6338), Rental Agreement (6339). Up to 7 digits.
dataAreaRequest​.matchSpecification​.candidateMaximumQuantity Number The limit on the number of candidates returned. Maximum of 25 candidates will be returned for the following countries: Spain, Ireland, Belgium, San Marino, Andorra, Italy, United Kingdom, Portugal, Netherlands, Luxembourg, Virgin Islands U.S., Puerto Rico, United States of America and Canada. For these countries, if the user specifies a value more than 25 in the 'CandidateMaximumQuantity' field of the request, CandidateMaximumQuantity will be considered as 25. Maximum of 100 candidates will be returned for all other countries. For these countries, if the user specifies a value more than 100 in the 'CandidateMaximumQuantity' field of the request, CandidateMaximumQuantity will be considered as 100.
dataAreaRequest​.matchSpecification​.confidenceLowerLevelThresholdValue Number
dataAreaRequest​.matchSpecification​.exclusionCriteria Array of Object An entry loop which can repeat multiple times to allow the recording of filtering requirements that a service should apply to prevent subjects from being returned in a match response. For example, exclude subjects from the candidate list that are out of business. Possible enumeration values are: "Exclude Non HeadQuarters", "Exclude Non Marketable", "Exact Match", "Exclude Out of Business", "Exclude Unreachable", and "Exclude Undeliverable"
dataAreaRequest​.matchSpecification​.exclusionCriteria[]​.exclusionDataDescription String Available Values:
Exclude Non HeadQuarters
Exclude Non Marketable
Exact Match
Exclude Out of Business
Exclude Unreachable
Exclude Undeliverable
dataAreaRequest​.matchSpecification​.orderReasonCode Number A D&B code value that defines the grounds for the customer requesting the product, such as a required to support a credit decision. In order to comply with German data protection laws, any enquiry on a German business must be accompanied by a Reason Code that details the basis for the enquiry. For example, Credit Decisions, Debt Collections, Insurance, or Leasing Agreement. This element is only required for Germany. A D&B code value that defines the grounds for the customer requesting the product. For example, if the request is required to support a credit decision. Use the following: Credit Decision (6332), Assessment of credit solvency for intended business connection (6333), Assessment of credit solvency for ongoing business connection (6334), Debt Collection (6335), Commercial Credit Insurance (6336), Insurance contract (6337), Leasing Agreement (6338), Rental Agreement (6339). Up to 7 digits.
dataAreaRequest​.matchSpecification​.includeCleansedAndStandardizedInformationIndicator Boolean
dataAreaRequest​.inquiryReferenceDetail Object Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.
dataAreaRequest​.inquiryReferenceDetail​.customerReferenceText Array of String Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided. This text is a reference used during the billing process. Max array length: 5
dataAreaRequest​.inquiryReferenceDetail​.customerReferenceText Array of String (up to 240 characters) Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided. This text is a reference used during the billing process. Max array length: 5
dataAreaRequest​.inquiryReferenceDetail​.customerBillingEndorsementText String (1-240 characters)
dataAreaRequest​.inquiryReferenceDetail​.customerReferenceText Array of String Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided. This text is a reference used during the billing process. Max array length: 5
dataAreaRequest​.inquiryReferenceDetail​.customerBillingEndorsementText String (1-240 characters)

Sample Request

URL
POST /company/findcompanycleansematch
Body
{
  "optionalResponseFields": {
    "includeMatchQualityInformation": true
  }, 
  "dataAreaRequest": {
    "matchSpecification": {
      "exclusionCriteria": [
        "Exclude Non HeadQuarters"
      ], 
      "candidateMaximumQuantity": "25"
    }, 
    "inquiryReferenceDetail": {
      "customerReferenceText": [
        "case number 123"
      ]
    }, 
    "orderRequest": {
      "city": "Fort Worth", 
      "phone": "817-963-1234", 
      "country": "US", 
      "internationalDialingCode": "1", 
      "confidenceCode": "9", 
      "state": "TX", 
      "primaryName": "AMR Corporation", 
      "address": "4333 Amon Carter Blvd.", 
      "postalCode": "76155"
    }
  }
}

Sample Response

{
  "dataAreaResponse": {
    "orderResponse": {
      "inquiryReferenceDetail": {
        "customerReferenceText": [
          "case number 123"
        ]
      }, 
      "candidates": {
        "candidate": [
          {
            "physicalAddressLine": "4333 AMON CARTER BLVD", 
            "matchQualityInformation": {
              "matchDataProfileComponentCount": 14, 
              "matchDataProfileComponent": [
                {
                  "text": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Name"
                  }, 
                  "displaySequence": 0, 
                  "value": "33"
                }, 
                {
                  "text": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Street Number"
                  }, 
                  "displaySequence": 0, 
                  "value": "00"
                }, 
                ...
              ], 
              "matchGradeText": "AAAAAZAAFFZ", 
              "confidenceCodeValue": 10, 
              "matchBasis": [
                {
                  "matchBasisText": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Primary Name"
                  }, 
                  "seniorPrincipalIndicator": false, 
                  "subjectTypeText": "Business", 
                  "endIndicator": true
                }, 
                {
                  "matchBasisText": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Primary Address"
                  }, 
                  "seniorPrincipalIndicator": false, 
                  "subjectTypeText": "Business", 
                  "endIndicator": false
                }, 
                ...
              ], 
              "matchGradeComponent": [
                {
                  "text": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Name"
                  }, 
                  "displaySequence": 0, 
                  "score": 100.0, 
                  "rating": "A"
                }, 
                {
                  "text": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Street Number"
                  }, 
                  "displaySequence": 0, 
                  "score": 100.0, 
                  "rating": "A"
                }, 
                ...
              ], 
              "matchDataProfileText": "3300000000980000000000009898", 
              "matchGradeComponentCount": 11
            }, 
            "countryCode": "US", 
            "phone": "8179631234", 
            "tradeStyle": null, 
            "internationalDialingCode": null, 
            "primaryBusinessName": "AMERICAN AIRLINES GROUP INC.", 
            "countryName": "United States", 
            "confidenceCode": 10, 
            "matchBasis": [], 
            "matchGradeString": "AAAAAZAAFFZ", 
            "subjectDetails": "Headquarters", 
            "mdpprofile": "3300000000980000000000009898", 
            "webPageAddress": null, 
            "duns": "072560154", 
            "physicalCity": "FORT WORTH", 
            "physicalPostalCode": "761552605", 
            "bestMatchFlag": "true", 
            "physicalState": "TX"
          }, 
          {
            "physicalAddressLine": "4333 AMON CARTER BLVD", 
            "matchQualityInformation": {
              "matchDataProfileComponentCount": 14, 
              "matchDataProfileComponent": [
                {
                  "text": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Name"
                  }, 
                  "displaySequence": 0, 
                  "value": "00"
                }, 
                {
                  "text": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Street Number"
                  }, 
                  "displaySequence": 0, 
                  "value": "00"
                }, 
                ...
              ], 
              "matchGradeText": "BAAAAZAAFFZ", 
              "confidenceCodeValue": 9, 
              "matchBasis": [
                {
                  "matchBasisText": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Primary Name"
                  }, 
                  "seniorPrincipalIndicator": false, 
                  "subjectTypeText": "Business", 
                  "endIndicator": false
                }, 
                {
                  "matchBasisText": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Primary Address"
                  }, 
                  "seniorPrincipalIndicator": false, 
                  "subjectTypeText": "Business", 
                  "endIndicator": false
                }, 
                ...
              ], 
              "matchGradeComponent": [
                {
                  "text": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Name"
                  }, 
                  "displaySequence": 0, 
                  "score": 66.020226, 
                  "rating": "B"
                }, 
                {
                  "text": {
                    "dnbcodeTableNumber": null, 
                    "dnbcodeValue": null, 
                    "value": "Street Number"
                  }, 
                  "displaySequence": 0, 
                  "score": 100.0, 
                  "rating": "A"
                }, 
                ...
              ], 
              "matchDataProfileText": "0000000000980200000000009898", 
              "matchGradeComponentCount": 11
            }, 
            "countryCode": "US", 
            "phone": "2149276016", 
            "tradeStyle": null, 
            "internationalDialingCode": null, 
            "primaryBusinessName": "AMR EAGLE INC", 
            "countryName": "United States", 
            "confidenceCode": 9, 
            "matchBasis": [], 
            "matchGradeString": "BAAAAZAAFFZ", 
            "subjectDetails": "Headquarters", 
            "mdpprofile": "0000000000980200000000009898", 
            "webPageAddress": null, 
            "duns": "189700206", 
            "physicalCity": "FORT WORTH", 
            "physicalPostalCode": "761552605", 
            "bestMatchFlag": null, 
            "physicalState": "TX"
          }, 
          ...
        ]
      }, 
      "candidatesReturned": 5
    }, 
    "orderResponseHeader": {
      "status": {
        "code": 1, 
        "description": "Success"
      }, 
      "tranID": "Id-a8d7715538663f0091dd1000d9716740-1"
    }
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     -d '{
  "optionalResponseFields": {
    "includeMatchQualityInformation": true
  }, 
  "dataAreaRequest": {
    "matchSpecification": {
      "exclusionCriteria": [
        "Exclude Non HeadQuarters"
      ], 
      "candidateMaximumQuantity": "25"
    }, 
    "inquiryReferenceDetail": {
      "customerReferenceText": [
        "case number 123"
      ]
    }, 
    "orderRequest": {
      "city": "Fort Worth", 
      "phone": "817-963-1234", 
      "country": "US", 
      "internationalDialingCode": "1", 
      "confidenceCode": "9", 
      "state": "TX", 
      "primaryName": "AMR Corporation", 
      "address": "4333 Amon Carter Blvd.", 
      "postalCode": "76155"
    }
  }
}'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/findcompanycleansematch'

/company/getCleanseMatch Available in Add-on: Match Service

The Cleanse Match Service acts as an interface for matching a name and address of a business for identity resolution. The response typically consists of response candidates that are identified as the best matches for the input criteria based on D&B's match algorithms. This service seeks a single known entity, typically based on a combination of name, address, and phone number or a unique identifier. Use the Cleanse Match service to retrieve an organization's DUNS Number. Once the DUNS Number is obtained, a user can retrieve the D&B data for that organization by invoking other services. Once the DUNS Number is obtained, a user can retrieve more information from GetCompanyDetail and GetFamilyTree. Enter the required Cleanse Match fields such as organization name, state, and country. The service cleanses the output to perform a match. If the match returns candidates below a Confidence Code 8 using the cleansed information, the Cleanse Match performs the match again using actual user input. The service returns the highest confidence candidates by merging both matches (cleansed input and actual user input) into a result. Users can retrieve the D&B DUNS Number of the organization, using the following match types: Match using Business Name, Match using Organization Name and Organization Address, Match using Organization Address, Match using Telephone Number, For USA and Canada search Organizations nationwide. It is default for all other countries.

Representation

/company/getCleanseMatch
?ApplicationTransactionID={ApplicationTransactionID}
&TransactionTimestamp={TransactionTimestamp}
&SubmittingOfficeID={SubmittingOfficeID}
&DUNSNumber={DUNSNumber}
&SubjectName ={SubjectName }
&StreetAddressLine={StreetAddressLine}
&DisplaySequence={DisplaySequence}
&PrimaryTownName={PrimaryTownName}
&CountryISOAlpha2Code={CountryISOAlpha2Code}
&TerritoryName={TerritoryName}
&FullPostalCode={FullPostalCode}
&TelecommunicationNumber={TelecommunicationNumber}
&InternationalDialingCode={InternationalDialingCode}
&OrganizationIdentificationNumber={OrganizationIdentificationNumber}
&CandidateMaximumQuantity={CandidateMaximumQuantity}
&ConfidenceLowerLevelThresholdValue={ConfidenceLowerLevelThresholdValue}
&ExclusionDataDescription={ExclusionDataDescription}
&IncludeCleansedAndStandardizedInformationIndicator={IncludeCleansedAndStandardizedInformationIndicator}
&OrderReasonCode={OrderReasonCode}
&CustomerReferenceText={CustomerReferenceText}
&CustomerBillingEndorsementText={CustomerBillingEndorsementText}

URL Parameters

Element Type Notes
ApplicationTransactionID String
TransactionTimestamp String
SubmittingOfficeID String
DUNSNumber String
SubjectName String
StreetAddressLine String
DisplaySequence Number
PrimaryTownName String
CountryISOAlpha2Code String
TerritoryName String
FullPostalCode String
TelecommunicationNumber String
InternationalDialingCode String
OrganizationIdentificationNumber String
CandidateMaximumQuantity String
ConfidenceLowerLevelThresholdValue String
ExclusionDataDescription String
IncludeCleansedAndStandardizedInformationIndicator String
OrderReasonCode String
CustomerReferenceText String
CustomerBillingEndorsementText String

Sample Request

URL
GET /company/getCleanseMatch?SubjectName=AMR%20Corporation&StreetAddressLine=4333%20Amon%20Carter%20Blvd.&TerritoryName=TX&FullPostalCode=76155&CountryISOAlpha2Code=US

Sample Response

{
  "GetCleanseMatchResponse": {
    "TransactionDetail": {
      "TransactionTimestamp": "2015-06-05T13:08:58", 
      "ServiceTransactionID": "Id-aad7715547663f0092dd10005c93d1a2-1"
    }, 
    "TransactionResult": {
      "ResultID": "CM000", 
      "ResultText": "Success", 
      "SeverityText": "Information"
    }, 
    "@ServiceVersionNumber": "3.0", 
    "GetCleanseMatchResponseDetail": {
      "MatchResponseDetail": {
        "MatchDataCriteriaText": {
          "$": "Name and Address Lookup"
        }, 
        "CandidateMatchedQuantity": 22, 
        "MatchCandidate": [
          {
            "TelephoneNumber": {
              "TelecommunicationNumber": "8179672000", 
              "UnreachableIndicator": false
            }, 
            "OrganizationPrimaryName": {
              "OrganizationName": {
                "$": "A M R TRAINING GROUP INC"
              }
            }, 
            "FamilyTreeMemberRole": [
              {
                "FamilyTreeMemberRoleText": {
                  "$": "Headquarters"
                }
              }
            ], 
            "MailingAddress": {
              "CountryISOAlpha2Code": "US", 
              "UndeliverableIndicator": false
            }, 
            "PrimaryAddress": {
              "PostalCode": "76155", 
              "TerritoryAbbreviatedName": "TX", 
              "UndeliverableIndicator": false, 
              "PostalCodeExtensionCode": "2605", 
              "CountryISOAlpha2Code": "US", 
              "StreetAddressLine": [
                {
                  "LineText": "4333 AMON CARTER BLVD"
                }
              ], 
              "PrimaryTownName": "FORT WORTH"
            }, 
            "DUNSNumber": "788138980", 
            "MatchQualityInformation": {
              "MatchDataProfileComponent": [
                {
                  "MatchDataProfileComponentValue": "02", 
                  "MatchDataProfileComponentTypeText": {
                    "$": "Name"
                  }
                }, 
                {
                  "MatchDataProfileComponentValue": "00", 
                  "MatchDataProfileComponentTypeText": {
                    "$": "Street Number"
                  }
                }, 
                ...
              ], 
              "MatchGradeText": "AAAAAZZAFFZ", 
              "ConfidenceCodeValue": 10, 
              "MatchBasis": [
                {
                  "MatchBasisText": {
                    "$": "Trade style"
                  }, 
                  "SeniorPrincipalIndicator": false, 
                  "SubjectTypeText": "Business", 
                  "EndIndicator": false
                }, 
                {
                  "MatchBasisText": {
                    "$": "Primary Address"
                  }, 
                  "SeniorPrincipalIndicator": false, 
                  "SubjectTypeText": "Business", 
                  "EndIndicator": false
                }
              ], 
              "MatchDataProfileComponentCount": 14, 
              "MatchGradeComponent": [
                {
                  "MatchGradeComponentRating": "A", 
                  "MatchGradeComponentScore": 100, 
                  "MatchGradeComponentTypeText": {
                    "$": "Name"
                  }
                }, 
                {
                  "MatchGradeComponentRating": "A", 
                  "MatchGradeComponentScore": 100, 
                  "MatchGradeComponentTypeText": {
                    "$": "Street Number"
                  }
                }, 
                ...
              ], 
              "MatchDataProfileText": "0200009900989800000000009898", 
              "MatchGradeComponentCount": 11
            }, 
            "OperatingStatusText": {
              "$": "Active"
            }, 
            "TradeStyleName": {
              "OrganizationName": {
                "$": "A M R"
              }
            }, 
            "StandaloneOrganizationIndicator": false, 
            "DisplaySequence": 1
          }, 
          {
            "TelephoneNumber": {
              "TelecommunicationNumber": "8179631234", 
              "UnreachableIndicator": false
            }, 
            "OrganizationPrimaryName": {
              "OrganizationName": {
                "$": "AMERICAN AIRLINES GROUP INC."
              }
            }, 
            "FamilyTreeMemberRole": [
              {
                "FamilyTreeMemberRoleText": {
                  "$": "Headquarters"
                }
              }
            ], 
            "MailingAddress": {
              "PostalCode": "75261", 
              "TerritoryAbbreviatedName": "TX", 
              "UndeliverableIndicator": false, 
              "CountryISOAlpha2Code": "US", 
              "StreetAddressLine": [
                {
                  "LineText": "PO BOX 619616"
                }
              ], 
              "PrimaryTownName": "DALLAS"
            }, 
            "PrimaryAddress": {
              "PostalCode": "76155", 
              "TerritoryAbbreviatedName": "TX", 
              "UndeliverableIndicator": false, 
              "PostalCodeExtensionCode": "2605", 
              "CountryISOAlpha2Code": "US", 
              "StreetAddressLine": [
                {
                  "LineText": "4333 AMON CARTER BLVD"
                }
              ], 
              "PrimaryTownName": "FORT WORTH"
            }, 
            "DUNSNumber": "072560154", 
            "MatchQualityInformation": {
              "MatchDataProfileComponent": [
                {
                  "MatchDataProfileComponentValue": "33", 
                  "MatchDataProfileComponentTypeText": {
                    "$": "Name"
                  }
                }, 
                {
                  "MatchDataProfileComponentValue": "00", 
                  "MatchDataProfileComponentTypeText": {
                    "$": "Street Number"
                  }
                }, 
                ...
              ], 
              "MatchGradeText": "AAAAAZZAFFZ", 
              "ConfidenceCodeValue": 10, 
              "MatchBasis": [
                {
                  "MatchBasisText": {
                    "$": "Primary Name"
                  }, 
                  "SeniorPrincipalIndicator": false, 
                  "SubjectTypeText": "Business", 
                  "EndIndicator": true
                }, 
                {
                  "MatchBasisText": {
                    "$": "Primary Address"
                  }, 
                  "SeniorPrincipalIndicator": false, 
                  "SubjectTypeText": "Business", 
                  "EndIndicator": false
                }
              ], 
              "MatchDataProfileComponentCount": 14, 
              "MatchGradeComponent": [
                {
                  "MatchGradeComponentRating": "A", 
                  "MatchGradeComponentScore": 100, 
                  "MatchGradeComponentTypeText": {
                    "$": "Name"
                  }
                }, 
                {
                  "MatchGradeComponentRating": "A", 
                  "MatchGradeComponentScore": 100, 
                  "MatchGradeComponentTypeText": {
                    "$": "Street Number"
                  }
                }, 
                ...
              ], 
              "MatchDataProfileText": "3300009900989800000000009898", 
              "MatchGradeComponentCount": 11
            }, 
            "OperatingStatusText": {
              "$": "Active"
            }, 
            "StandaloneOrganizationIndicator": false, 
            "DisplaySequence": 2
          }, 
          ...
        ]
      }, 
      "InquiryDetail": {
        "SubjectName": "AMR Corporation", 
        "Address": {
          "CountryISOAlpha2Code": "US", 
          "TerritoryName": "TX", 
          "FullPostalCode": "76155", 
          "StreetAddressLine": [
            {
              "LineText": "4333 Amon Carter Blvd."
            }
          ]
        }
      }
    }
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/getCleanseMatch?SubjectName=AMR%20Corporation&StreetAddressLine=4333%20Amon%20Carter%20Blvd.&TerritoryName=TX&FullPostalCode=76155&CountryISOAlpha2Code=US'

/company/match Available in Add-on: Match Service

Representation

/company/match
?ApplicationTransactionID={ApplicationTransactionID}
&TransactionTimestamp={TransactionTimestamp}
&SubmittingOfficeID={SubmittingOfficeID}
&DUNSNumber={DUNSNumber}
&SubjectName ={SubjectName }
&LineText={LineText}
&DisplaySequence={DisplaySequence}
&PrimaryTownName={PrimaryTownName}
&CountryISOAlpha2Code={CountryISOAlpha2Code}
&TerritoryName={TerritoryName}
&FullPostalCode={FullPostalCode}
&TelecommunicationNumber={TelecommunicationNumber}
&InternationalDialingCode={InternationalDialingCode}
&OrganizationIdentificationNumber={OrganizationIdentificationNumber}
&CandidateMaximumQuantity={CandidateMaximumQuantity}
&ConfidenceLowerLevelThresholdValue={ConfidenceLowerLevelThresholdValue}
&ExclusionDataDescription={ExclusionDataDescription}
&OrderReasonCode={OrderReasonCode}
&CustomerReferenceText={CustomerReferenceText}
&CustomerBillingEndorsementText={CustomerBillingEndorsementText}

URL Parameters

Element Type Notes
ApplicationTransactionID String
TransactionTimestamp String
SubmittingOfficeID String
DUNSNumber String
SubjectName String
LineText String
DisplaySequence Number
PrimaryTownName String
CountryISOAlpha2Code String
TerritoryName String
FullPostalCode String
TelecommunicationNumber String
InternationalDialingCode String
OrganizationIdentificationNumber String
CandidateMaximumQuantity String
ConfidenceLowerLevelThresholdValue String
ExclusionDataDescription String
OrderReasonCode String
CustomerReferenceText String
CustomerBillingEndorsementText String

Sample Request

URL
GET /company/match?SubjectName=AMR%20Corporation&StreetAddressLine=4333%20Amon%20Carter%20Blvd.&TerritoryName=TX&FullPostalCode=76155&CountryISOAlpha2Code=US

Sample Response

{
  "MatchResponse": {
    "MatchResponseDetail": {
      "MatchDataCriteriaText": {
        "$": "Name and Address Lookup"
      }, 
      "CandidateMatchedQuantity": 4, 
      "MatchCandidate": [
        {
          "TelephoneNumber": {
            "TelecommunicationNumber": "8179672000", 
            "UnreachableIndicator": false
          }, 
          "OrganizationPrimaryName": {
            "OrganizationName": {
              "$": "A M R TRAINING GROUP INC"
            }
          }, 
          "FamilyTreeMemberRole": [
            {
              "FamilyTreeMemberRoleText": {
                "$": "Headquarters"
              }
            }
          ], 
          "MailingAddress": {
            "CountryISOAlpha2Code": "US", 
            "UndeliverableIndicator": false
          }, 
          "PrimaryAddress": {
            "PostalCode": "76155", 
            "TerritoryAbbreviatedName": "TX", 
            "UndeliverableIndicator": false, 
            "PostalCodeExtensionCode": "2605", 
            "CountryISOAlpha2Code": "US", 
            "StreetAddressLine": [
              {
                "LineText": "4333 AMON CARTER BLVD"
              }
            ], 
            "PrimaryTownName": "FORT WORTH"
          }, 
          "DUNSNumber": "788138980", 
          "MatchQualityInformation": {
            "MatchDataProfileComponent": [
              {
                "MatchDataProfileComponentValue": "02", 
                "MatchDataProfileComponentTypeText": {
                  "$": "Name"
                }
              }, 
              {
                "MatchDataProfileComponentValue": "99", 
                "MatchDataProfileComponentTypeText": {
                  "$": "Street Number"
                }
              }, 
              ...
            ], 
            "MatchGradeText": "AZZAAZZAFFZ", 
            "ConfidenceCodeValue": 8, 
            "MatchBasis": [
              {
                "MatchBasisText": {
                  "$": "Trade style"
                }, 
                "SeniorPrincipalIndicator": false, 
                "SubjectTypeText": "Business", 
                "EndIndicator": false
              }, 
              {
                "MatchBasisText": {
                  "$": "Primary Address"
                }, 
                "SeniorPrincipalIndicator": false, 
                "SubjectTypeText": "Business", 
                "EndIndicator": false
              }
            ], 
            "MatchDataProfileComponentCount": 14, 
            "MatchGradeComponent": [
              {
                "MatchGradeComponentRating": "A", 
                "MatchGradeComponentScore": 100, 
                "MatchGradeComponentTypeText": {
                  "$": "Name"
                }
              }, 
              {
                "MatchGradeComponentRating": "Z", 
                "MatchGradeComponentScore": 0, 
                "MatchGradeComponentTypeText": {
                  "$": "Street Number"
                }
              }, 
              ...
            ], 
            "MatchDataProfileText": "0299999900999800000000009898", 
            "MatchGradeComponentCount": 11
          }, 
          "OperatingStatusText": {
            "$": "Active"
          }, 
          "TradeStyleName": {
            "OrganizationName": {
              "$": "A M R"
            }
          }, 
          "StandaloneOrganizationIndicator": false, 
          "DisplaySequence": 1
        }, 
        {
          "TelephoneNumber": {
            "TelecommunicationNumber": "8179631234", 
            "UnreachableIndicator": false
          }, 
          "OrganizationPrimaryName": {
            "OrganizationName": {
              "$": "AMERICAN AIRLINES GROUP INC."
            }
          }, 
          "FamilyTreeMemberRole": [
            {
              "FamilyTreeMemberRoleText": {
                "$": "Headquarters"
              }
            }
          ], 
          "MailingAddress": {
            "PostalCode": "75261", 
            "TerritoryAbbreviatedName": "TX", 
            "UndeliverableIndicator": false, 
            "CountryISOAlpha2Code": "US", 
            "StreetAddressLine": [
              {
                "LineText": "PO BOX 619616"
              }
            ], 
            "PrimaryTownName": "DALLAS"
          }, 
          "PrimaryAddress": {
            "PostalCode": "76155", 
            "TerritoryAbbreviatedName": "TX", 
            "UndeliverableIndicator": false, 
            "PostalCodeExtensionCode": "2605", 
            "CountryISOAlpha2Code": "US", 
            "StreetAddressLine": [
              {
                "LineText": "4333 AMON CARTER BLVD"
              }
            ], 
            "PrimaryTownName": "FORT WORTH"
          }, 
          "DUNSNumber": "072560154", 
          "MatchQualityInformation": {
            "MatchDataProfileComponent": [
              {
                "MatchDataProfileComponentValue": "33", 
                "MatchDataProfileComponentTypeText": {
                  "$": "Name"
                }
              }, 
              {
                "MatchDataProfileComponentValue": "99", 
                "MatchDataProfileComponentTypeText": {
                  "$": "Street Number"
                }
              }, 
              ...
            ], 
            "MatchGradeText": "AZZAAZZAFFZ", 
            "ConfidenceCodeValue": 8, 
            "MatchBasis": [
              {
                "MatchBasisText": {
                  "$": "Primary Name"
                }, 
                "SeniorPrincipalIndicator": false, 
                "SubjectTypeText": "Business", 
                "EndIndicator": true
              }, 
              {
                "MatchBasisText": {
                  "$": "Primary Address"
                }, 
                "SeniorPrincipalIndicator": false, 
                "SubjectTypeText": "Business", 
                "EndIndicator": false
              }
            ], 
            "MatchDataProfileComponentCount": 14, 
            "MatchGradeComponent": [
              {
                "MatchGradeComponentRating": "A", 
                "MatchGradeComponentScore": 100, 
                "MatchGradeComponentTypeText": {
                  "$": "Name"
                }
              }, 
              {
                "MatchGradeComponentRating": "Z", 
                "MatchGradeComponentScore": 0, 
                "MatchGradeComponentTypeText": {
                  "$": "Street Number"
                }
              }, 
              ...
            ], 
            "MatchDataProfileText": "3399999900999800000000009898", 
            "MatchGradeComponentCount": 11
          }, 
          "OperatingStatusText": {
            "$": "Active"
          }, 
          "StandaloneOrganizationIndicator": false, 
          "DisplaySequence": 2
        }, 
        ...
      ]
    }, 
    "TransactionDetail": {
      "TransactionTimestamp": "2015-06-05T13:09:02", 
      "ServiceTransactionID": "Id-add7715569663f0092dd10004620b1b0-1"
    }, 
    "TransactionResult": {
      "ResultID": "CM000", 
      "ResultText": "Success", 
      "SeverityText": "Information"
    }, 
    "@ServiceVersionNumber": "3.0"
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/match?SubjectName=AMR%20Corporation&StreetAddressLine=4333%20Amon%20Carter%20Blvd.&TerritoryName=TX&FullPostalCode=76155&CountryISOAlpha2Code=US'

/company/refresh/companyList Included in Base Package

This call returns a list of the companies that have been updated in the last 90 days.

Representation

/company/refresh/companyList
?unique_id={unique_id}

URL Parameters

Element Type Notes
unique_id String D-U-N-S number or companyId

Sample Request

URL
GET /company/refresh/companyList?unique_id=884114609&unique_id=611241688

Sample Response

{
  "failure": null, 
  "success": {
    "result": [
      {
        "lastRefreshDate": "2015-06-05", 
        "uniqueId": "884114609"
      }, 
      {
        "lastRefreshDate": "2015-06-05", 
        "uniqueId": "611241688"
      }
    ]
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/refresh/companyList?unique_id=884114609&unique_id=611241688'

/company/refresh/date/{refreshed_since_date} Available in Add-on: Enterprise Services

Returns a list of companies that have been updated as of the specified date. After the initial call, use the pageNumber parameter to request the next set of companies until zero results are returned. The specified date may be any time within the last two weeks.

Representation

/company/refresh/date/{refreshed_since_date}
?page_number={page_number}

URL Parameters

Element Type Notes
refreshed_since_date String Required
page_number Number Required

Sample Request

URL
GET /company/refresh/date/2015-06-07?page_number=1

Sample Response

/* response not available */

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/company/refresh/date/2015-06-07?page_number=1'

/search/company/{keyword} Included in Base Package

Returns a set of companies based on keyword, along with basic identifying data for each company.

Representation

/search/company/{keyword}
?duns_from={duns_from}
&duns_to={duns_to}
&hit_offset={hit_offset}
&max_records={max_records}
&sort_direction={sort_direction}
&search_by={search_by}
&order_by={order_by}
&match_by={match_by}
&return_search_navigation={return_search_navigation}

URL Parameters

Element Type Notes
keyword String Required
duns_from Number
duns_to Number
hit_offset Number
max_records Number
sort_direction String (ascending | descending)
search_by String (companyName | stockSymbol | companyNameORstockSymbol)
order_by String (CompanyName | CompanyType | CountryName | CityName | StateName | PhoneNumber | FaxNumber | SalesGrowth12Mon | TotalAssets | SalesUS | EmployeesTotal | EmployeesHere | FiscalYearEndMonth | MarketCap | NetIncomeGrowth12Mon | EmployeeGrowth12Mon | ROE | ROA | EarningsComparison | BookValueComparison | NetIncome | PersonFirstName | PersonLastName | PersonTitle | None)
match_by String New for 1.7
return_search_navigation String (true | false)

Sample Request

URL
GET /search/company/hoovers

Sample Response

{
  "navigators": {
    "locationNavigators": null, 
    "employeeNavigators": null, 
    "ownershipTypeNavigators": null, 
    "salesNavigators": null, 
    "locationTypeNavigators": null, 
    "industryNavigators": null
  }, 
  "resultSet": {
    "lastHit": 20, 
    "totalHits": 176, 
    "hits": 20, 
    "hit": [
      {
        "hitNumber": 1, 
        "companyResults": {
          "nonMarketableCompany": null, 
          "parentName": "The Dun & Bradstreet Corporation", 
          "sales": 118.2, 
          "primaryTicker": null, 
          "dbas": {
            "dba": [
              "Hoover's"
            ]
          }, 
          "stateOrProvince": "TX", 
          "city": "Austin", 
          "ownershipTypeDescription": null, 
          "countryId": 76, 
          "companyId": 41416000000000, 
          "companyTypeDescription": null, 
          "postalCode": "78752-3826", 
          "primaryUrl": "http://www.hoovers.com", 
          "historicalIndicator": false, 
          "companyName": "HOOVER'S, INC.", 
          "address1": "5800 Airport Blvd", 
          "address2": "", 
          "ownershipTypeValue": null, 
          "familyTreeSize": 200, 
          "doNotCallRegistry": false, 
          "exchanges": [], 
          "duns": "611241688", 
          "employeesTotal": 380, 
          "ultimateParentDuns": "884114609", 
          "locationType": "Single Location", 
          "companyTypeValue": null, 
          "ultimateParentName": "The Dun & Bradstreet Corporation", 
          "hqPhone": "512-374-4500", 
          "parentDuns": "884114609", 
          "country": "United States", 
          "employeesAtThisLocation": 380
        }
      }, 
      {
        "hitNumber": 2, 
        "companyResults": {
          "nonMarketableCompany": null, 
          "parentName": "", 
          "sales": 0.35, 
          "primaryTicker": null, 
          "dbas": {
            "dba": [
              "HOOVER'S PUB & GRILL"
            ]
          }, 
          "stateOrProvince": "OR", 
          "city": "Newport", 
          "ownershipTypeDescription": null, 
          "countryId": 76, 
          "companyId": 108765504, 
          "companyTypeDescription": null, 
          "postalCode": "97366-9652", 
          "primaryUrl": "www.hooverspubandgrill.net", 
          "historicalIndicator": false, 
          "companyName": "Hoovers Pub and Grill LLC", 
          "address1": "3539 S Coast Hwy # 101", 
          "address2": "", 
          "ownershipTypeValue": null, 
          "familyTreeSize": null, 
          "doNotCallRegistry": false, 
          "exchanges": [], 
          "duns": "108765504", 
          "employeesTotal": 7, 
          "ultimateParentDuns": null, 
          "locationType": "Single Location", 
          "companyTypeValue": null, 
          "ultimateParentName": "", 
          "hqPhone": "541-867-3303", 
          "parentDuns": null, 
          "country": "United States", 
          "employeesAtThisLocation": 7
        }
      }, 
      ...
    ], 
    "firstHit": 1
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/company/hoovers'

/search/company/advanced/ Included in Base Package

Returns search result of companies based on various criteria.

Representation

/search/company/advanced
?hit_offset={hit_offset}
&max_records={max_records}
&sort_direction={sort_direction}
&order_by={order_by}
&return_search_navigation={return_search_navigation}

URL Parameters

Element Type Notes
hit_offset Number
max_records Number
sort_direction String (ascending | descending)
order_by String (CompanyName | CompanyType | CountryName | CityName | StateName | PhoneNumber | FaxNumber | SalesGrowth12Mon | TotalAssets | SalesUS | EmployeesTotal | EmployeesHere | FiscalYearEndMonth | MarketCap | NetIncomeGrowth12Mon | EmployeeGrowth12Mon | ROE | ROA | EarningsComparison | BookValueComparison | NetIncome | PersonFirstName | PersonLastName | PersonTitle | None)
return_search_navigation Boolean (true | false)

Body Representation

Element Type Notes
companySize Object
companySize​.employeesFrom Number Employees Lower Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
companySize​.employeesTo Number Employees Upper Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
companySize​.employeesGrowthFrom Number Total Employees Growth Percentage Lower Bound
companySize​.employeesGrowthTo Number Total Employees Growth Percentage Upper Bound
companySize​.employeesThisLocationFrom Number Employees at this Location Lower Bound
companySize​.employeesThisLocationTo Number Employees at this Location Upper Bound
companySize​.marketCapFrom Number Market Cap (Capitalization) lower bound expressed in USD millions is the value of a company. Convert local currency into millions of US Dollars. To find a company's Market Cap, multiply the last closing price of a share by the number of shares outstanding.
companySize​.marketCapTo Number Market Cap (Capitalization) upper bound expressed in USD millions is the value of a company. Convert local currency into millions of US Dollars. To find a company's Market Cap, multiply the last closing price of a share by the number of shares outstanding.
companySize​.salesFrom Number Annual Sales ($ mil) Lower Bound
companySize​.salesTo Number Annual Sales ($ mil) Upper Bound
companySize​.salesGrowthFrom Number Annual Sales Growth (%) Lower Bound
companySize​.salesGrowthTo Number Annual Sales Growth (%) Upper Bound
companyType Object Company Types include Public (1), Private (2), Private_Association (3), Private_Consortium (4), Private_Cooperative (5), or Subsidiary (15); OR available as a container element for locationType, ownershipType, subsidiaryStatus, and franchiseStatus.
companyType​.locationType Array of Number Company Location Type such as Single Location (0), Headquarters (1), Branch (2), Branch/Division (4), Subsidiary (5)
companyType​.ownershipType Array of Number Ownership Type. A code value which describes the legal ownership status of the company. Indicates whether or not a company without its own stock information has a parent company that receives stock information. Values are 1 (Public), 21 (Owned by a Public Company or Public_By_Association) or 0 (Unknown).
companyType​.subsidiaryStatus Array of Number Subsidiary status is entered either as 0 = not a subsidiary or 1 = is a subsidiary: subsidiaryStatus [#] These integers indicate whether or not the corporate stock of the site location is at least 50% owned by another company. A subsidiary company is controlled by another company or corporation that owns more than 50% of its stock and may own all of it (called a parent company).
companyType​.franchiseStatus Boolean Franchise Status: If set to true, If set to false. Franchises are independently owned and operated businesses granted the right to use a brand owner's (franchisor's) name, products, and trademarks in exchange for a fee.
financialData Object
financialData​.advertisingExpenseFrom Number Advertising Expense (expressed in millions of US Dollars) Lower Bound
financialData​.advertisingExpenseTo Number Advertising Expense (expressed in millions of US Dollars) Upper Bound
financialData​.assetsFrom Number Assets (expressed in millions of US Dollars) Lower Bound
financialData​.assetsTo Number Assets (expressed in millions of US Dollars) Upper Bound
financialData​.filingDateFrom String Filing Date Lower Bound
financialData​.filingDateTo String Filing Date Upper Bound
financialData​.fiscalYearEnd Array of Number The month the fiscal year ends. Not all financial fiscal year ranges end in December, for example.
financialData​.incomeFrom Number Net Income (expressed in millions of US Dollars) Lower Bound
financialData​.incomeGrowthFrom Number Net Income Growth (%) Lower Bound
financialData​.incomeGrowthTo Number Net Income Growth (%) Upper Bound
financialData​.incomeTo Number Net Income (expressed in millions of US Dollars) Upper Bound
financialData​.offerFrom Number US IPO Data - Offer Amount (expressed in milions of USD) Lower Bound
financialData​.offerTo Number US IPO Data - Offer Amount (expressed in milions of USD) Upper Bound
financialData​.priceRangeFrom Number US IPO Data - Price Range ($) Lower Bound
financialData​.priceRangeTo Number US IPO Data - Price Range ($) Upper Bound
financialData​.researchExpenseFrom Number R&D Expense ($ mil) Lower Bound
financialData​.researchExpenseTo Number R&D Expense ($ mil) Upper Bound
financialData​.tradingDateFrom String Trading Date Lower Bound
financialData​.tradingDateTo String Trading Date Upper Bound
financialData​.underwriterId Array of Number Underwriter ID. A brokerage firm that buys shares from the company and sells them to the public in the IPO. We provide almost 900 of these organizations.
financialData​.marketingPreScreenScore Array of String Max array length: 3 Available Values:
L
L stands for Low
M
M stands for Medium
H
H stands for High
industry Object
industry​.dnbIndustryCode Array of Number D&B Industry Code
industry​.primaryOnly Boolean Restricts the search to only the primary company industry
industry​.nAICS Array of String NAICS Code: "NAICS" (North American Industry Classification System) was jointly created by Canada, Mexico and the US in the 1990s. Enter only one code per element. Use multiple elements for multiple codes. Enter at least two digits per code. No CSV or Ranges can be specified.
industry​.nAICSRange Array of Object
industry​.nAICSRange[]​.from String NAICS Code Range Lower Bound
industry​.nAICSRange[]​.to String NAICS Code Range Upper Bound
industry​.uSSIC Array of String US SIC Code: "SIC" (Standard Industrial Classification) is an industry code system developed by the US Government.
industry​.uSSICRange Array of Object
industry​.uSSICRange[]​.from String SIC Code Range Lower Bound
industry​.uSSICRange[]​.to String SIC Code Range Upper Bound
industry​.uKSIC Array of String UK SIC Code: The United Kingdom's Standard Industrial Classification (SIC) was first introduced in 1948 for use in classifying business establishments and other statistical units by the type of economic activity in which they are engaged. The classification provides a framework for the collection, tabulation, presentation and analysis of data, and its use promotes uniformity. In addition, it can be used for administrative purposes and by non-government bodies as a convenient way of classifying industrial activities into a common structure. Since 1948 the classification has been revised in 1958, 1968, 1980, 1992, 1997, and 2003.
industry​.uKSICRange Array of Object
industry​.uKSICRange[]​.from String UKSIC Code Range Lower Bound
industry​.uKSICRange[]​.to String UKSIC Code Range Upper Bound
location Object Type of location for the company; headquarters, branch office, etc.
location​.areaCode Array of String US or Canadian Phone Number Area Code
location​.streetAddress Array of String Street Address
location​.county Array of Object Company County
location​.county[]​.countyId String County ID
location​.county[]​.state String State
location​.county[]​.countryId Number Country ID - D&B-assigned code which identifies the country where the business is located.
location​.city Array of String City
location​.countryId Array of Number Country ID - D&B-assigned code which identifies the country where the business is located.
location​.globalState Array of String Global State/Province
location​.metropolitanId Array of Number US Metropolitan Area
location​.regionId Array of Number D&B world region code which identifies the region where the business is located.
location​.usStateCanadaProvince Array of String US State/Canada Province
location​.postalCode Array of String Postal Code
location​.usZipCodeRange Array of Object
location​.usZipCodeRange[]​.from Number US ZIP Code Range Lower Bound
location​.usZipCodeRange[]​.to Number US ZIP Code Range Upper Bound
location​.zipAreaSearch Object
location​.zipAreaSearch​.scale String Units to search in: miles or kilometers Available Values:
miles
kilometers
location​.zipAreaSearch​.radius Number Number of miles or kilometers to search within
location​.zipAreaSearch​.zipCode String Zipcode to search within (78745 in the example)
location​.latLongSearch Object
location​.latLongSearch​.scale String Units to search in: miles or kilometers Available Values:
miles
kilometers
location​.latLongSearch​.radius Number Number of miles or kilometers to search within
location​.latLongSearch​.latitude Number
location​.latLongSearch​.longitude Number Longitude component of geo location
location​.allAny String Denotes whether all or any company location criteria are matched Available Values:
all
any
location​.ukCounty Array of String UK County name
specialtyCriteria Object
specialtyCriteria​.auditorId Array of Number Obtain the Auditors ID value from the GetAdvancedSearchLookups call. Example: 'id' 1551 corresponds to PricewaterhouseCoopers AB
specialtyCriteria​.companyKeyword String Company Keyword
specialtyCriteria​.duns Array of Number D-U-N-S Number. The Data Universal Numbering System (DUNS) Number is a non-indicative, nine-digit number assigned to each business location in the D&amp;B database having a unique, separate, and distinct operation, and is maintained solely by D&amp;B. The D&amp;B D-U-N-S Number is used by industries and organizations around the world as a global standard for business identification and tracking. Pattern Value: "([0-9a-zA-Z]*)".
specialtyCriteria​.dunsFrom Number D-U-N-S Number lower limit
specialtyCriteria​.dunsTo Number D-U-N-S Number upper limit
specialtyCriteria​.fein Array of String US Federal Tax ID issued by the IRS. Unique nine-digit Federal Employer Identification Number.
specialtyCriteria​.crn Array of String Seven-digit Company Registration Number recognized by the United Kingdom
specialtyCriteria​.exchangeId Array of Number The ID associated with the exchange where the company's stock is traded.
specialtyCriteria​.rankingId Array of Number Ranking ID
specialtyCriteria​.ukRegistration Array of String UK Registration Number. Unique identifier assigned to UK companies by the government's Companies House. Example: 3443456
specialtyCriteria​.ukVat Array of String United Kingdom's Value Added Tax Number. Example: 906565610
specialtyCriteria​.yearFoundingFrom Number Year of Founding or Change in Control Lower Bound
specialtyCriteria​.yearFoundingTo Number Year of Founding or Change in Control (YYYY) Upper Bound
specialtyCriteria​.ultimateParentDuns Array of Number The ultimate parent company D-U-N-S Number for a family of companies
specialtyCriteria​.primaryUrl Array of String Primary URL for the company
specialtyCriteria​.mustContainPrimaryUrl Boolean
specialtyCriteria​.companyName String Company Name
specialtyCriteria​.stockTicker Array of String Stock Ticker
specialtyCriteria​.minorityOwned Boolean A true or false indication of whether or not a company's owners are minorities. A business that is at least 51% owned by, and whose management and daily business operations are controlled by, one or more members of a socially and economically disadvantaged minority group, namely U.S. citizens who are: African American, Asian American, Hispanic American, Native American, Indian Subcontinent American.
specialtyCriteria​.womenOwned Boolean A true or false indication of whether or not a company's owners are women. A business that is at least 51% owned by, and whose management and daily business operations are controlled by one or more women who are U.S. citizens.
specialtyCriteria​.squareFootageFrom Number Company square foot range from
specialtyCriteria​.squareFootageTo Number Company square foot range to
specialtyCriteria​.ethnicity Array of String Ethnicity of the company owner: Chinese, Filipino, Japanese, Korean, Vietnamese, or other Asian origin (ASN), Black or African American (BLK), Hispanic, Latino, or Spanish origin (HSP), Indian Subcontinent origin (ISU), American Indian, Alaska Native, or Native Hawaiian (NAT), Unknown (UNK) Available Values:
ASN
Chinese, Filipino, Japanese, Korean, Vietnamese, or other Asian origin
BLK
Black or African American
HSP
Hispanic, Latino, or Spanish origin
ISU
Indian Subcontinent origin
NAT
American Indian, Alaska Native, or Native Hawaiian
UNK
Unknown
specialtyCriteria​.legalStatus Array of String Legal Status of the company Available Values:
Corporation
Partnership
Proprietorship
NationalGovernmentEntity
RegionalLocalGovernmentEntity
JointVenture
NonProfitOrganization
CooperativeMutualOrganization
ForeignCompany
specialtyCriteria​.ownsOrRents String Company resides in Owned or Rented Space Available Values:
Owned
Location is rented by this company
Rented
Location is owned by this company
specialtyCriteria​.importer Boolean Importer flag which identifies whether or not a company imports for re-manufacture or sale
specialtyCriteria​.exporter Boolean Exporter flag which identifies whether or not a company exports products to other countries.
nonMarketableCompanyFilterOptions Object
nonMarketableCompanyFilterOptions​.includeUndeliverableAddress Boolean If true, will return all the unmarketable company records which have undeliverable addresses.
nonMarketableCompanyFilterOptions​.includeOutOfBusiness Boolean If true, will return all the unmarketable company records that are out of business.
nonMarketableCompanyFilterOptions​.includeIncompleteData Boolean If true, will return all the unmarketable company records which have incomplete data.
nonMarketableCompanyFilterOptions​.includeDoNotMarketTo Boolean If true, will return all the unmarketable company records which indicated do not market to.
nonMarketableCompanyFilterOptions​.includeAll Boolean
searchNavigation Object
searchNavigation​.employeeSearchNavigation Object
searchNavigation​.employeeSearchNavigation​.employeeSearchNavigationValue Array of String An employee navigation link that can be fed back into other calls
searchNavigation​.ownershipTypeSearchNavigation Object
searchNavigation​.ownershipTypeSearchNavigation​.ownershipTypeSearchNavigationValue Array of String
searchNavigation​.locationTypeSearchNavigation Object
searchNavigation​.locationTypeSearchNavigation​.locationTypeSearchNavigationValue Array of String A location type navigation link that can be fed back into other calls
searchNavigation​.salesSearchNavigation Object
searchNavigation​.salesSearchNavigation​.salesSearchNavigationValue Array of String A sales navigation link that can be fed back into other calls
searchNavigation​.locationSearchNavigation Object
searchNavigation​.locationSearchNavigation​.countryNavigation Array of Object
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.countryNavigationValue String A country navigation link that can be fed back into other calls.
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation Array of Object
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.stateNavigationValue String A state/province navigation link that can be fed back into other calls.
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation Array of Object
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation[]​.cityNavigationValue String A city navigation link that can be fed back into other calls
searchNavigation​.industrySearchNavigation Object
searchNavigation​.industrySearchNavigation​.industrySearchNavigationValue Array of String An industry navigation link that can be fed back into other calls. If set to true, navigators will be returned in the response to enable drill down into search results.
searchNavigation​.industrySearchNavigation​.ussicSearchNavigationValue Array of String A US SIC navigation link that can be fed back into other calls.
searchNavigation​.industrySearchNavigation​.naicsSearchNavigationValue Array of String A NAICS navigation link that can be fed back into other calls.

Sample Request

URL
POST /search/company/advanced?return_search_navigation=true
Body
{
  "companySize": {
    "employeesTo": 1000, 
    "employeesFrom": 100
  }
}

Sample Response

{
  "navigators": {
    "locationNavigators": {
      "countryNavigators": {
        "countryNavigator": [
          {
            "stateProvinceNavigators": {
              "stateProvinceNavigator": [
                {
                  "stateProvinceNavigatorDescription": "AK (390)", 
                  "cityNavigators": {
                    "cityNavigator": [
                      {
                        "cityNavigatorValue": "Anchorage~AK~76", 
                        "cityNavigatorDescription": "Anchorage, AK United States (221)"
                      }, 
                      {
                        "cityNavigatorValue": "Fairbanks~AK~76", 
                        "cityNavigatorDescription": "Fairbanks, AK United States (30)"
                      }, 
                      ...
                    ]
                  }, 
                  "stateProvinceNavigatorValue": "AK~76"
                }, 
                {
                  "stateProvinceNavigatorDescription": "AL (1925)", 
                  "cityNavigators": {
                    "cityNavigator": [
                      {
                        "cityNavigatorValue": "Birmingham~AL~76", 
                        "cityNavigatorDescription": "Birmingham, AL United States (295)"
                      }, 
                      {
                        "cityNavigatorValue": "Huntsville~AL~76", 
                        "cityNavigatorDescription": "Huntsville, AL United States (156)"
                      }, 
                      ...
                    ]
                  }, 
                  "stateProvinceNavigatorValue": "AL~76"
                }, 
                ...
              ]
            }, 
            "countryNavigatorValue": "76", 
            "countryNavigatorDescription": "United States (142667)"
          }, 
          {
            "stateProvinceNavigators": {
              "stateProvinceNavigator": [
                {
                  "stateProvinceNavigatorDescription": "AB (1940)", 
                  "cityNavigators": {
                    "cityNavigator": [
                      {
                        "cityNavigatorValue": "Calgary~AB~14", 
                        "cityNavigatorDescription": "Calgary, AB Canada (829)"
                      }, 
                      {
                        "cityNavigatorValue": "Edmonton~AB~14", 
                        "cityNavigatorDescription": "Edmonton, AB Canada (549)"
                      }, 
                      ...
                    ]
                  }, 
                  "stateProvinceNavigatorValue": "AB~14"
                }, 
                {
                  "stateProvinceNavigatorDescription": "BC (1794)", 
                  "cityNavigators": {
                    "cityNavigator": [
                      {
                        "cityNavigatorValue": "Vancouver~BC~14", 
                        "cityNavigatorDescription": "Vancouver, BC Canada (500)"
                      }, 
                      {
                        "cityNavigatorValue": "Richmond~BC~14", 
                        "cityNavigatorDescription": "Richmond, BC Canada (149)"
                      }, 
                      ...
                    ]
                  }, 
                  "stateProvinceNavigatorValue": "BC~14"
                }, 
                ...
              ]
            }, 
            "countryNavigatorValue": "14", 
            "countryNavigatorDescription": "Canada (15478)"
          }, 
          ...
        ]
      }
    }, 
    "employeeNavigators": {
      "employeeNavigator": [
        {
          "employeeNavigatorDescription": "&lt; 4 (0)", 
          "employeeNavigatorValue": "[;4]"
        }, 
        {
          "employeeNavigatorDescription": "5-10 (0)", 
          "employeeNavigatorValue": "[5;10]"
        }, 
        ...
      ]
    }, 
    "ownershipTypeNavigators": {
      "ownershipTypeNavigator": [
        {
          "ownershipTypeNavigatorDescription": "Subsidiary/Branch Location of a Public Company (78...", 
          "ownershipTypeNavigatorValue": "21"
        }, 
        {
          "ownershipTypeNavigatorDescription": "Public (11908)", 
          "ownershipTypeNavigatorValue": "1"
        }, 
        ...
      ]
    }, 
    "salesNavigators": {
      "salesNavigator": [
        {
          "salesNavigatorValue": "[;1>", 
          "salesNavigatorDescription": "&lt; $1 million (41839)"
        }, 
        {
          "salesNavigatorValue": "[1;5>", 
          "salesNavigatorDescription": "$1 - $5 million (90397)"
        }, 
        ...
      ]
    }, 
    "locationTypeNavigators": {
      "locationTypeNavigator": [
        {
          "locationTypeNavigatorValue": "2", 
          "locationTypeNavigatorDescription": "Branch (224)"
        }, 
        {
          "locationTypeNavigatorValue": "1", 
          "locationTypeNavigatorDescription": "Headquarters (319267)"
        }, 
        ...
      ]
    }, 
    "industryNavigators": {
      "ussicNavigator": [
        {
          "ussicNavigatorDescription": "01110000 Wheat (76)", 
          "ussicNavigatorValue": "^01110000$"
        }, 
        {
          "ussicNavigatorDescription": "01120000 Rice (69)", 
          "ussicNavigatorValue": "^01120000$"
        }, 
        ...
      ], 
      "naicsNavigator": [
        {
          "naicsNavigatorDescription": "111110 Soybean Farming (30)", 
          "naicsNavigatorValue": "^111110$"
        }, 
        {
          "naicsNavigatorDescription": "111120 Oilseed (except Soybean) Farming (5)", 
          "naicsNavigatorValue": "^111120$"
        }, 
        ...
      ], 
      "industryNavigator": [
        {
          "industryNavigatorValue": "1413", 
          "industryNavigatorDescription": " (1)"
        }, 
        {
          "industryNavigatorValue": "1357", 
          "industryNavigatorDescription": " (1)"
        }, 
        ...
      ]
    }
  }, 
  "companies": {
    "lastHit": 20, 
    "totalHits": 980469, 
    "hits": 20, 
    "hit": [
      {
        "hitNumber": 1, 
        "companyResults": {
          "nonMarketableCompany": null, 
          "parentName": "INDO INVESTMENTS PTE. LTD.", 
          "sales": 86198.0, 
          "primaryTicker": null, 
          "dbas": {
            "dba": []
          }, 
          "stateOrProvince": "East Java", 
          "city": "Sidoarjo", 
          "ownershipTypeDescription": "UNKNOWN", 
          "countryId": 38, 
          "companyId": 728678798, 
          "companyTypeDescription": null, 
          "postalCode": "61257 61257", 
          "primaryUrl": "", 
          "historicalIndicator": false, 
          "companyName": "ISPAT INDO, PT", 
          "address1": "Desa Kedungturi", 
          "address2": null, 
          "ownershipTypeValue": "0", 
          "familyTreeSize": 4, 
          "doNotCallRegistry": false, 
          "exchanges": null, 
          "duns": "728678798", 
          "employeesTotal": 780, 
          "ultimateParentDuns": "937453871", 
          "locationType": "Headquarters", 
          "companyTypeValue": null, 
          "ultimateParentName": "INDO INVESTMENTS PTE. LTD.", 
          "hqPhone": "317887000", 
          "parentDuns": "937453871", 
          "country": "Indonesia", 
          "employeesAtThisLocation": null
        }
      }, 
      {
        "hitNumber": 2, 
        "companyResults": {
          "nonMarketableCompany": null, 
          "parentName": "BOLLORE", 
          "sales": 2442.0884, 
          "primaryTicker": null, 
          "dbas": {
            "dba": []
          }, 
          "stateOrProvince": "Hauts De Seine", 
          "city": "Puteaux Cedex", 
          "ownershipTypeDescription": "PUBLIC", 
          "countryId": 27, 
          "companyId": 91826000000000, 
          "companyTypeDescription": "PUBLIC", 
          "postalCode": "92817", 
          "primaryUrl": "http://www.havas.com", 
          "historicalIndicator": false, 
          "companyName": "HAVAS", 
          "address1": "29 Quai De Dion Bouton", 
          "address2": null, 
          "ownershipTypeValue": "1", 
          "familyTreeSize": 1225, 
          "doNotCallRegistry": false, 
          "exchanges": null, 
          "duns": "381632538", 
          "employeesTotal": 125, 
          "ultimateParentDuns": "764691010", 
          "locationType": "Headquarters", 
          "companyTypeValue": "1", 
          "ultimateParentName": "BOLLORE PARTICIPATIONS", 
          "hqPhone": "158478000", 
          "parentDuns": "260182365", 
          "country": "France", 
          "employeesAtThisLocation": 125
        }
      }, 
      ...
    ], 
    "firstHit": 1
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     -d '{
  "companySize": {
    "employeesTo": 1000, 
    "employeesFrom": 100
  }
}'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/company/advanced?return_search_navigation=true'

/search/company/advanced/optional Included in Base Package

Returns search result of companies based on various criteria.

Representation

/search/company/advanced/optional
?hit_offset={hit_offset}
&max_records={max_records}
&sort_direction={sort_direction}
&order_by={order_by}
&return_search_navigation={return_search_navigation}

URL Parameters

Element Type Notes
hit_offset Number
max_records Number
sort_direction String (ascending | descending)
order_by String (CompanyName | CompanyType | CountryName | CityName | StateName | PhoneNumber | FaxNumber | SalesGrowth12Mon | TotalAssets | SalesUS | EmployeesTotal | EmployeesHere | FiscalYearEndMonth | MarketCap | NetIncomeGrowth12Mon | EmployeeGrowth12Mon | ROE | ROA | EarningsComparison | BookValueComparison | NetIncome | PersonFirstName | PersonLastName | PersonTitle | None)
return_search_navigation Boolean (true | false)

Body Representation

Element Type Notes
companySize Object
companySize​.employeesFrom Number Employees Lower Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
companySize​.employeesTo Number Employees Upper Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
companySize​.employeesGrowthFrom Number Total Employees Growth Percentage Lower Bound
companySize​.employeesGrowthTo Number Total Employees Growth Percentage Upper Bound
companySize​.employeesThisLocationFrom Number Employees at this Location Lower Bound
companySize​.employeesThisLocationTo Number Employees at this Location Upper Bound
companySize​.marketCapFrom Number Market Cap (Capitalization) lower bound expressed in USD millions is the value of a company. Convert local currency into millions of US Dollars. To find a company's Market Cap, multiply the last closing price of a share by the number of shares outstanding.
companySize​.marketCapTo Number Market Cap (Capitalization) upper bound expressed in USD millions is the value of a company. Convert local currency into millions of US Dollars. To find a company's Market Cap, multiply the last closing price of a share by the number of shares outstanding.
companySize​.salesFrom Number Annual Sales ($ mil) Lower Bound
companySize​.salesTo Number Annual Sales ($ mil) Upper Bound
companySize​.salesGrowthFrom Number Annual Sales Growth (%) Lower Bound
companySize​.salesGrowthTo Number Annual Sales Growth (%) Upper Bound
companyType Object Company Types include Public (1), Private (2), Private_Association (3), Private_Consortium (4), Private_Cooperative (5), or Subsidiary (15); OR available as a container element for locationType, ownershipType, subsidiaryStatus, and franchiseStatus.
companyType​.locationType Array of Number Company Location Type such as Single Location (0), Headquarters (1), Branch (2), Branch/Division (4), Subsidiary (5)
companyType​.ownershipType Array of Number Ownership Type. A code value which describes the legal ownership status of the company. Indicates whether or not a company without its own stock information has a parent company that receives stock information. Values are 1 (Public), 21 (Owned by a Public Company or Public_By_Association) or 0 (Unknown).
companyType​.subsidiaryStatus Array of Number Subsidiary status is entered either as 0 = not a subsidiary or 1 = is a subsidiary: subsidiaryStatus [#] These integers indicate whether or not the corporate stock of the site location is at least 50% owned by another company. A subsidiary company is controlled by another company or corporation that owns more than 50% of its stock and may own all of it (called a parent company).
companyType​.franchiseStatus Boolean Franchise Status: If set to true, If set to false. Franchises are independently owned and operated businesses granted the right to use a brand owner's (franchisor's) name, products, and trademarks in exchange for a fee.
financialData Object
financialData​.advertisingExpenseFrom Number Advertising Expense (expressed in millions of US Dollars) Lower Bound
financialData​.advertisingExpenseTo Number Advertising Expense (expressed in millions of US Dollars) Upper Bound
financialData​.assetsFrom Number Assets (expressed in millions of US Dollars) Lower Bound
financialData​.assetsTo Number Assets (expressed in millions of US Dollars) Upper Bound
financialData​.filingDateFrom String Filing Date Lower Bound
financialData​.filingDateTo String Filing Date Upper Bound
financialData​.fiscalYearEnd Array of Number The month the fiscal year ends. Not all financial fiscal year ranges end in December, for example.
financialData​.incomeFrom Number Net Income (expressed in millions of US Dollars) Lower Bound
financialData​.incomeGrowthFrom Number Net Income Growth (%) Lower Bound
financialData​.incomeGrowthTo Number Net Income Growth (%) Upper Bound
financialData​.incomeTo Number Net Income (expressed in millions of US Dollars) Upper Bound
financialData​.offerFrom Number US IPO Data - Offer Amount (expressed in milions of USD) Lower Bound
financialData​.offerTo Number US IPO Data - Offer Amount (expressed in milions of USD) Upper Bound
financialData​.priceRangeFrom Number US IPO Data - Price Range ($) Lower Bound
financialData​.priceRangeTo Number US IPO Data - Price Range ($) Upper Bound
financialData​.researchExpenseFrom Number R&D Expense ($ mil) Lower Bound
financialData​.researchExpenseTo Number R&D Expense ($ mil) Upper Bound
financialData​.tradingDateFrom String Trading Date Lower Bound
financialData​.tradingDateTo String Trading Date Upper Bound
financialData​.underwriterId Array of Number Underwriter ID. A brokerage firm that buys shares from the company and sells them to the public in the IPO. We provide almost 900 of these organizations.
financialData​.marketingPreScreenScore Array of String Max array length: 3 Available Values:
L
L stands for Low
M
M stands for Medium
H
H stands for High
industry Object
industry​.dnbIndustryCode Array of Number D&B Industry Code
industry​.primaryOnly Boolean Restricts the search to only the primary company industry
industry​.nAICS Array of String NAICS Code: "NAICS" (North American Industry Classification System) was jointly created by Canada, Mexico and the US in the 1990s. Enter only one code per element. Use multiple elements for multiple codes. Enter at least two digits per code. No CSV or Ranges can be specified.
industry​.nAICSRange Array of Object
industry​.nAICSRange[]​.from String NAICS Code Range Lower Bound
industry​.nAICSRange[]​.to String NAICS Code Range Upper Bound
industry​.uSSIC Array of String US SIC Code: "SIC" (Standard Industrial Classification) is an industry code system developed by the US Government.
industry​.uSSICRange Array of Object
industry​.uSSICRange[]​.from String SIC Code Range Lower Bound
industry​.uSSICRange[]​.to String SIC Code Range Upper Bound
industry​.uKSIC Array of String UK SIC Code: The United Kingdom's Standard Industrial Classification (SIC) was first introduced in 1948 for use in classifying business establishments and other statistical units by the type of economic activity in which they are engaged. The classification provides a framework for the collection, tabulation, presentation and analysis of data, and its use promotes uniformity. In addition, it can be used for administrative purposes and by non-government bodies as a convenient way of classifying industrial activities into a common structure. Since 1948 the classification has been revised in 1958, 1968, 1980, 1992, 1997, and 2003.
industry​.uKSICRange Array of Object
industry​.uKSICRange[]​.from String UKSIC Code Range Lower Bound
industry​.uKSICRange[]​.to String UKSIC Code Range Upper Bound
location Object Type of location for the company; headquarters, branch office, etc.
location​.areaCode Array of String US or Canadian Phone Number Area Code
location​.streetAddress Array of String Street Address
location​.county Array of Object Company County
location​.county[]​.countyId String County ID
location​.county[]​.state String State
location​.county[]​.countryId Number Country ID - D&B-assigned code which identifies the country where the business is located.
location​.city Array of String City
location​.countryId Array of Number Country ID - D&B-assigned code which identifies the country where the business is located.
location​.globalState Array of String Global State/Province
location​.metropolitanId Array of Number US Metropolitan Area
location​.regionId Array of Number D&B world region code which identifies the region where the business is located.
location​.usStateCanadaProvince Array of String US State/Canada Province
location​.postalCode Array of String Postal Code
location​.usZipCodeRange Array of Object
location​.usZipCodeRange[]​.from Number US ZIP Code Range Lower Bound
location​.usZipCodeRange[]​.to Number US ZIP Code Range Upper Bound
location​.zipAreaSearch Object
location​.zipAreaSearch​.scale String Units to search in: miles or kilometers Available Values:
miles
kilometers
location​.zipAreaSearch​.radius Number Number of miles or kilometers to search within
location​.zipAreaSearch​.zipCode String Zipcode to search within (78745 in the example)
location​.latLongSearch Object
location​.latLongSearch​.scale String Units to search in: miles or kilometers Available Values:
miles
kilometers
location​.latLongSearch​.radius Number Number of miles or kilometers to search within
location​.latLongSearch​.latitude Number
location​.latLongSearch​.longitude Number Longitude component of geo location
location​.allAny String Denotes whether all or any company location criteria are matched Available Values:
all
any
location​.ukCounty Array of String UK County name
specialtyCriteria Object
specialtyCriteria​.auditorId Array of Number Obtain the Auditors ID value from the GetAdvancedSearchLookups call. Example: 'id' 1551 corresponds to PricewaterhouseCoopers AB
specialtyCriteria​.companyKeyword String Company Keyword
specialtyCriteria​.duns Array of Number D-U-N-S Number. The Data Universal Numbering System (DUNS) Number is a non-indicative, nine-digit number assigned to each business location in the D&amp;B database having a unique, separate, and distinct operation, and is maintained solely by D&amp;B. The D&amp;B D-U-N-S Number is used by industries and organizations around the world as a global standard for business identification and tracking. Pattern Value: "([0-9a-zA-Z]*)".
specialtyCriteria​.dunsFrom Number D-U-N-S Number lower limit
specialtyCriteria​.dunsTo Number D-U-N-S Number upper limit
specialtyCriteria​.fein Array of String US Federal Tax ID issued by the IRS. Unique nine-digit Federal Employer Identification Number.
specialtyCriteria​.crn Array of String Seven-digit Company Registration Number recognized by the United Kingdom
specialtyCriteria​.exchangeId Array of Number The ID associated with the exchange where the company's stock is traded.
specialtyCriteria​.rankingId Array of Number Ranking ID
specialtyCriteria​.ukRegistration Array of String UK Registration Number. Unique identifier assigned to UK companies by the government's Companies House. Example: 3443456
specialtyCriteria​.ukVat Array of String United Kingdom's Value Added Tax Number. Example: 906565610
specialtyCriteria​.yearFoundingFrom Number Year of Founding or Change in Control Lower Bound
specialtyCriteria​.yearFoundingTo Number Year of Founding or Change in Control (YYYY) Upper Bound
specialtyCriteria​.ultimateParentDuns Array of Number The ultimate parent company D-U-N-S Number for a family of companies
specialtyCriteria​.primaryUrl Array of String Primary URL for the company
specialtyCriteria​.mustContainPrimaryUrl Boolean
specialtyCriteria​.companyName String Company Name
specialtyCriteria​.stockTicker Array of String Stock Ticker
specialtyCriteria​.minorityOwned Boolean A true or false indication of whether or not a company's owners are minorities. A business that is at least 51% owned by, and whose management and daily business operations are controlled by, one or more members of a socially and economically disadvantaged minority group, namely U.S. citizens who are: African American, Asian American, Hispanic American, Native American, Indian Subcontinent American.
specialtyCriteria​.womenOwned Boolean A true or false indication of whether or not a company's owners are women. A business that is at least 51% owned by, and whose management and daily business operations are controlled by one or more women who are U.S. citizens.
specialtyCriteria​.squareFootageFrom Number Company square foot range from
specialtyCriteria​.squareFootageTo Number Company square foot range to
specialtyCriteria​.ethnicity Array of String Ethnicity of the company owner: Chinese, Filipino, Japanese, Korean, Vietnamese, or other Asian origin (ASN), Black or African American (BLK), Hispanic, Latino, or Spanish origin (HSP), Indian Subcontinent origin (ISU), American Indian, Alaska Native, or Native Hawaiian (NAT), Unknown (UNK) Available Values:
ASN
Chinese, Filipino, Japanese, Korean, Vietnamese, or other Asian origin
BLK
Black or African American
HSP
Hispanic, Latino, or Spanish origin
ISU
Indian Subcontinent origin
NAT
American Indian, Alaska Native, or Native Hawaiian
UNK
Unknown
specialtyCriteria​.legalStatus Array of String Legal Status of the company Available Values:
Corporation
Partnership
Proprietorship
NationalGovernmentEntity
RegionalLocalGovernmentEntity
JointVenture
NonProfitOrganization
CooperativeMutualOrganization
ForeignCompany
specialtyCriteria​.ownsOrRents String Company resides in Owned or Rented Space Available Values:
Owned
Location is rented by this company
Rented
Location is owned by this company
specialtyCriteria​.importer Boolean Importer flag which identifies whether or not a company imports for re-manufacture or sale
specialtyCriteria​.exporter Boolean Exporter flag which identifies whether or not a company exports products to other countries.
nonMarketableCompanyFilterOptions Object
nonMarketableCompanyFilterOptions​.includeUndeliverableAddress Boolean If true, will return all the unmarketable company records which have undeliverable addresses.
nonMarketableCompanyFilterOptions​.includeOutOfBusiness Boolean If true, will return all the unmarketable company records that are out of business.
nonMarketableCompanyFilterOptions​.includeIncompleteData Boolean If true, will return all the unmarketable company records which have incomplete data.
nonMarketableCompanyFilterOptions​.includeDoNotMarketTo Boolean If true, will return all the unmarketable company records which indicated do not market to.
nonMarketableCompanyFilterOptions​.includeAll Boolean
optionalResponseFields Object
optionalResponseFields​.includeHistoricalInfo Boolean Optional Response Field to indicate that the historical information should be returned with in the results
optionalResponseFields​.includeGeoLocationInfo Boolean Optional Response Field to indicate that geo location information should be returned with in the results
optionalResponseFields​.includeExchangeInfo Boolean Optional Response Field to indicate that Exchange information should be returned with in the results
optionalResponseFields​.includeOptionalCompanyInfo Boolean Optional Response Field to indicate that Optional Company information should be returned with in the results
searchNavigation Object
searchNavigation​.employeeSearchNavigation Object
searchNavigation​.employeeSearchNavigation​.employeeSearchNavigationValue Array of String An employee navigation link that can be fed back into other calls
searchNavigation​.ownershipTypeSearchNavigation Object
searchNavigation​.ownershipTypeSearchNavigation​.ownershipTypeSearchNavigationValue Array of String
searchNavigation​.locationTypeSearchNavigation Object
searchNavigation​.locationTypeSearchNavigation​.locationTypeSearchNavigationValue Array of String A location type navigation link that can be fed back into other calls
searchNavigation​.salesSearchNavigation Object
searchNavigation​.salesSearchNavigation​.salesSearchNavigationValue Array of String A sales navigation link that can be fed back into other calls
searchNavigation​.locationSearchNavigation Object
searchNavigation​.locationSearchNavigation​.countryNavigation Array of Object
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.countryNavigationValue String A country navigation link that can be fed back into other calls.
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation Array of Object
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.stateNavigationValue String A state/province navigation link that can be fed back into other calls.
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation Array of Object
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation[]​.cityNavigationValue String A city navigation link that can be fed back into other calls
searchNavigation​.industrySearchNavigation Object
searchNavigation​.industrySearchNavigation​.industrySearchNavigationValue Array of String An industry navigation link that can be fed back into other calls. If set to true, navigators will be returned in the response to enable drill down into search results.
searchNavigation​.industrySearchNavigation​.ussicSearchNavigationValue Array of String A US SIC navigation link that can be fed back into other calls.
searchNavigation​.industrySearchNavigation​.naicsSearchNavigationValue Array of String A NAICS navigation link that can be fed back into other calls.

Sample Request

URL
POST /search/company/advanced/optional?return_search_navigation=true
Body
{
  "optionalResponseFields": {
    "includeGeoLocationInfo": true, 
    "includeHistoricalInfo": true, 
    "includeExchangeInfo": true, 
    "includeOptionalCompanyInfo": true
  }, 
  "companySize": {
    "employeesTo": 1000, 
    "employeesFrom": 100
  }
}

Sample Response

{
  "navigators": {
    "locationNavigators": {
      "countryNavigators": {
        "countryNavigator": [
          {
            "stateProvinceNavigators": {
              "stateProvinceNavigator": [
                {
                  "stateProvinceNavigatorDescription": "AK (390)", 
                  "cityNavigators": {
                    "cityNavigator": [
                      {
                        "cityNavigatorValue": "Anchorage~AK~76", 
                        "cityNavigatorDescription": "Anchorage, AK United States (221)"
                      }, 
                      {
                        "cityNavigatorValue": "Fairbanks~AK~76", 
                        "cityNavigatorDescription": "Fairbanks, AK United States (30)"
                      }, 
                      ...
                    ]
                  }, 
                  "stateProvinceNavigatorValue": "AK~76"
                }, 
                {
                  "stateProvinceNavigatorDescription": "AL (1925)", 
                  "cityNavigators": {
                    "cityNavigator": [
                      {
                        "cityNavigatorValue": "Birmingham~AL~76", 
                        "cityNavigatorDescription": "Birmingham, AL United States (295)"
                      }, 
                      {
                        "cityNavigatorValue": "Huntsville~AL~76", 
                        "cityNavigatorDescription": "Huntsville, AL United States (156)"
                      }, 
                      ...
                    ]
                  }, 
                  "stateProvinceNavigatorValue": "AL~76"
                }, 
                ...
              ]
            }, 
            "countryNavigatorValue": "76", 
            "countryNavigatorDescription": "United States (142667)"
          }, 
          {
            "stateProvinceNavigators": {
              "stateProvinceNavigator": [
                {
                  "stateProvinceNavigatorDescription": "AB (1940)", 
                  "cityNavigators": {
                    "cityNavigator": [
                      {
                        "cityNavigatorValue": "Calgary~AB~14", 
                        "cityNavigatorDescription": "Calgary, AB Canada (829)"
                      }, 
                      {
                        "cityNavigatorValue": "Edmonton~AB~14", 
                        "cityNavigatorDescription": "Edmonton, AB Canada (549)"
                      }, 
                      ...
                    ]
                  }, 
                  "stateProvinceNavigatorValue": "AB~14"
                }, 
                {
                  "stateProvinceNavigatorDescription": "BC (1794)", 
                  "cityNavigators": {
                    "cityNavigator": [
                      {
                        "cityNavigatorValue": "Vancouver~BC~14", 
                        "cityNavigatorDescription": "Vancouver, BC Canada (500)"
                      }, 
                      {
                        "cityNavigatorValue": "Richmond~BC~14", 
                        "cityNavigatorDescription": "Richmond, BC Canada (149)"
                      }, 
                      ...
                    ]
                  }, 
                  "stateProvinceNavigatorValue": "BC~14"
                }, 
                ...
              ]
            }, 
            "countryNavigatorValue": "14", 
            "countryNavigatorDescription": "Canada (15478)"
          }, 
          ...
        ]
      }
    }, 
    "employeeNavigators": {
      "employeeNavigator": [
        {
          "employeeNavigatorDescription": "&lt; 4 (0)", 
          "employeeNavigatorValue": "[;4]"
        }, 
        {
          "employeeNavigatorDescription": "5-10 (0)", 
          "employeeNavigatorValue": "[5;10]"
        }, 
        ...
      ]
    }, 
    "ownershipTypeNavigators": {
      "ownershipTypeNavigator": [
        {
          "ownershipTypeNavigatorDescription": "Subsidiary/Branch Location of a Public Company (78...", 
          "ownershipTypeNavigatorValue": "21"
        }, 
        {
          "ownershipTypeNavigatorDescription": "Public (11908)", 
          "ownershipTypeNavigatorValue": "1"
        }, 
        ...
      ]
    }, 
    "salesNavigators": {
      "salesNavigator": [
        {
          "salesNavigatorValue": "[;1>", 
          "salesNavigatorDescription": "&lt; $1 million (41839)"
        }, 
        {
          "salesNavigatorValue": "[1;5>", 
          "salesNavigatorDescription": "$1 - $5 million (90397)"
        }, 
        ...
      ]
    }, 
    "locationTypeNavigators": {
      "locationTypeNavigator": [
        {
          "locationTypeNavigatorValue": "2", 
          "locationTypeNavigatorDescription": "Branch (224)"
        }, 
        {
          "locationTypeNavigatorValue": "1", 
          "locationTypeNavigatorDescription": "Headquarters (319267)"
        }, 
        ...
      ]
    }, 
    "industryNavigators": {
      "ussicNavigator": [
        {
          "ussicNavigatorDescription": "01110000 Wheat (76)", 
          "ussicNavigatorValue": "^01110000$"
        }, 
        {
          "ussicNavigatorDescription": "01120000 Rice (69)", 
          "ussicNavigatorValue": "^01120000$"
        }, 
        ...
      ], 
      "naicsNavigator": [
        {
          "naicsNavigatorDescription": "111110 Soybean Farming (30)", 
          "naicsNavigatorValue": "^111110$"
        }, 
        {
          "naicsNavigatorDescription": "111120 Oilseed (except Soybean) Farming (5)", 
          "naicsNavigatorValue": "^111120$"
        }, 
        ...
      ], 
      "industryNavigator": [
        {
          "industryNavigatorValue": "1413", 
          "industryNavigatorDescription": " (1)"
        }, 
        {
          "industryNavigatorValue": "1357", 
          "industryNavigatorDescription": " (1)"
        }, 
        ...
      ]
    }
  }, 
  "companies": {
    "lastHit": 20, 
    "totalHits": 980469, 
    "hits": 20, 
    "hit": [
      {
        "hitNumber": 1, 
        "companyResults": {
          "nonMarketableCompany": null, 
          "parentName": "INDO INVESTMENTS PTE. LTD.", 
          "sales": 86198.0, 
          "primaryTicker": null, 
          "dbas": {
            "dba": []
          }, 
          "stateOrProvince": "East Java", 
          "city": "Sidoarjo", 
          "ownershipTypeDescription": "UNKNOWN", 
          "countryId": 38, 
          "companyId": 728678798, 
          "primaryUSSIC": "33150000", 
          "primaryContact": "Baldeo Prasad Banka", 
          "companyTypeDescription": null, 
          "postalCode": "61257 61257", 
          "numberOfEmployeesTotal": 780, 
          "primaryUrl": "", 
          "historicalIndicator": false, 
          "companyName": "ISPAT INDO, PT", 
          "address1": "Desa Kedungturi", 
          "address2": null, 
          "ownershipTypeValue": "0", 
          "familyTreeSize": 4, 
          "doNotCallRegistry": false, 
          "exchangeInfoList": null, 
          "exchanges": null, 
          "duns": "728678798", 
          "primaryContactTitle": "Managing Director", 
          "employeesTotal": 780, 
          "optionalCompanyInfo": {
            "yearFounding": "1975", 
            "minorityOwned": false, 
            "franchiseOperationType": "", 
            "womenOwned": false, 
            "postalCode": "61257 61257", 
            "legalStatus": "CORPORATION", 
            "ethnicity": null
          }, 
          "ultimateParentDuns": "937453871", 
          "historicalInfo": null, 
          "locationType": "Headquarters", 
          "primaryUSSICDescription": "Steel wire and related products", 
          "companyTypeValue": null, 
          "ultimateParentName": "INDO INVESTMENTS PTE. LTD.", 
          "hqPhone": "317887000", 
          "geoLocationInfo": {
            "latitude": null, 
            "latLongAccuracy": "2", 
            "longitude": null
          }, 
          "parentDuns": "937453871", 
          "country": "Indonesia", 
          "employeesAtThisLocation": null
        }
      }, 
      {
        "hitNumber": 2, 
        "companyResults": {
          "nonMarketableCompany": null, 
          "parentName": "BOLLORE", 
          "sales": 2442.0884, 
          "primaryTicker": null, 
          "dbas": {
            "dba": []
          }, 
          "stateOrProvince": "Hauts De Seine", 
          "city": "Puteaux Cedex", 
          "ownershipTypeDescription": "PUBLIC", 
          "countryId": 27, 
          "companyId": 91826000000000, 
          "primaryUSSIC": "73110000", 
          "primaryContact": "Yannick Bollor\u00e9", 
          "companyTypeDescription": "PUBLIC", 
          "postalCode": "92817", 
          "numberOfEmployeesTotal": 125, 
          "primaryUrl": "http://www.havas.com", 
          "historicalIndicator": false, 
          "companyName": "HAVAS", 
          "address1": "29 Quai De Dion Bouton", 
          "address2": null, 
          "ownershipTypeValue": "1", 
          "familyTreeSize": 1225, 
          "doNotCallRegistry": false, 
          "exchangeInfoList": {
            "exchangeInfo": [
              {
                "country": "FR", 
                "exchangeName": "Euronext Paris", 
                "tickerSymbol": "HAV "
              }, 
              {
                "country": " DE", 
                "exchangeName": "German", 
                "tickerSymbol": "HAV "
              }, 
              ...
            ]
          }, 
          "exchanges": null, 
          "duns": "381632538", 
          "primaryContactTitle": "Chairman and CEO", 
          "employeesTotal": 125, 
          "optionalCompanyInfo": {
            "yearFounding": "1900", 
            "minorityOwned": false, 
            "franchiseOperationType": "", 
            "womenOwned": false, 
            "postalCode": "92817", 
            "legalStatus": "CORPORATION", 
            "ethnicity": null
          }, 
          "ultimateParentDuns": "764691010", 
          "historicalInfo": null, 
          "locationType": "Headquarters", 
          "primaryUSSICDescription": "Advertising agencies", 
          "companyTypeValue": "1", 
          "ultimateParentName": "BOLLORE PARTICIPATIONS", 
          "hqPhone": "158478000", 
          "geoLocationInfo": {
            "latitude": null, 
            "latLongAccuracy": "2", 
            "longitude": null
          }, 
          "parentDuns": "260182365", 
          "country": "France", 
          "employeesAtThisLocation": 125
        }
      }, 
      ...
    ], 
    "firstHit": 1
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     -d '{
  "optionalResponseFields": {
    "includeGeoLocationInfo": true, 
    "includeHistoricalInfo": true, 
    "includeExchangeInfo": true, 
    "includeOptionalCompanyInfo": true
  }, 
  "companySize": {
    "employeesTo": 1000, 
    "employeesFrom": 100
  }
}'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/company/advanced/optional?return_search_navigation=true'

/person/{unique_company_id}/{co_official_id} Included in Base Package

Returns detailed person information.

Representation

/person/{unique_company_id}/{co_official_id}
?connect_mail={connect_mail}
&convert_currency_to={convert_currency_to}
&view={view}

URL Parameters

Element Type Notes
unique_company_id Number Required
co_official_id Number Required
connect_mail Boolean
convert_currency_to String (usd | gbp | cad | eur | jpy | sek)
view String (full | simple | optional)

Sample Request

URL
GET /person/884114609/1073021000000000

Sample Response

/* response not available */

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/person/884114609/1073021000000000'

/search/person/{keyword} Included in Base Package

Returns search result of people based on keyword. The keyword may be a person's name or part of a name.

Representation

/search/person/{keyword}
?duns_from={duns_from}
&duns_to={duns_to}
&hit_offset={hit_offset}
&max_records={max_records}
&sort_direction={sort_direction}
&order_by={order_by}
&return_search_navigation={return_search_navigation}
&match_by={match_by}

URL Parameters

Element Type Notes
keyword String Required
duns_from Number
duns_to Number
hit_offset Number
max_records Number
sort_direction String (ascending | descending)
order_by String (CompanyName | CompanyType | CountryName | CityName | StateName | PhoneNumber | FaxNumber | SalesGrowth12Mon | TotalAssets | SalesUS | EmployeesTotal | EmployeesHere | FiscalYearEndMonth | MarketCap | NetIncomeGrowth12Mon | EmployeeGrowth12Mon | ROE | ROA | EarningsComparison | BookValueComparison | NetIncome | PersonFirstName | PersonLastName | PersonTitle | None)
return_search_navigation Boolean (true | false)
match_by String New for 1.7

Sample Request

URL
GET /search/person/mathew

Sample Response

{
  "navigators": null, 
  "resultSet": {
    "lastHit": 20, 
    "totalHits": 251228, 
    "hits": 20, 
    "hit": [
      {
        "coOfficialResults": {
          "firstName": "Mathew", 
          "coOfficialId": 241107843, 
          "companyName": "GENERAL MOTORS COMPANY", 
          "middleName": "", 
          "lastName": "Goebel", 
          "nonMarketableCompany": null, 
          "companyId": 10640000000000, 
          "connectMail": {
            "connectMailEmailSource": true, 
            "connectMailPhoneSource": false, 
            "connectMailNameSource": true, 
            "connectMailSource": "D&B"
          }, 
          "duns": "832447812", 
          "title": "Lean Warehousing Project Manager", 
          "fullName": "Mathew Goebel", 
          "jobFunction": {
            "jobFunctionId": [
              275
            ]
          }, 
          "suffix": ""
        }, 
        "hitNumber": 1
      }, 
      {
        "coOfficialResults": {
          "firstName": "Mathew", 
          "coOfficialId": 229351653, 
          "companyName": "APPLE INC.", 
          "middleName": "", 
          "lastName": "Krohnert", 
          "nonMarketableCompany": null, 
          "companyId": 12644000000000, 
          "connectMail": {
            "connectMailEmailSource": true, 
            "connectMailPhoneSource": false, 
            "connectMailNameSource": true, 
            "connectMailSource": "D&B"
          }, 
          "duns": "060704780", 
          "title": "Supervisor", 
          "fullName": "Mathew Krohnert", 
          "jobFunction": {
            "jobFunctionId": [
              280
            ]
          }, 
          "suffix": ""
        }, 
        "hitNumber": 2
      }, 
      ...
    ], 
    "firstHit": 1
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/person/mathew'

/search/person/advanced Included in Base Package

Returns search result of people based on various criteria.

Representation

/search/person/advanced
?hit_offset={hit_offset}
&max_records={max_records}
&sort_direction={sort_direction}
&order_by={order_by}

URL Parameters

Element Type Notes
hit_offset Number
max_records Number
sort_direction String (ascending | descending)
order_by String (CompanyName | CompanyType | CountryName | CityName | StateName | PhoneNumber | FaxNumber | SalesGrowth12Mon | TotalAssets | SalesUS | EmployeesTotal | EmployeesHere | FiscalYearEndMonth | MarketCap | NetIncomeGrowth12Mon | EmployeeGrowth12Mon | ROE | ROA | EarningsComparison | BookValueComparison | NetIncome | PersonFirstName | PersonLastName | PersonTitle | None)

Body Representation

Element Type Notes
companySize Object
companySize​.employeesFrom Number Employees Lower Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
companySize​.employeesTo Number Employees Upper Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
companySize​.employeesGrowthFrom Number Total Employees Growth Percentage Lower Bound
companySize​.employeesGrowthTo Number Total Employees Growth Percentage Upper Bound
companySize​.employeesThisLocationFrom Number Employees at this Location Lower Bound
companySize​.employeesThisLocationTo Number Employees at this Location Upper Bound
companySize​.marketCapFrom Number Market Cap (Capitalization) lower bound expressed in USD millions is the value of a company. Convert local currency into millions of US Dollars. To find a company's Market Cap, multiply the last closing price of a share by the number of shares outstanding.
companySize​.marketCapTo Number Market Cap (Capitalization) upper bound expressed in USD millions is the value of a company. Convert local currency into millions of US Dollars. To find a company's Market Cap, multiply the last closing price of a share by the number of shares outstanding.
companySize​.salesFrom Number Annual Sales ($ mil) Lower Bound
companySize​.salesTo Number Annual Sales ($ mil) Upper Bound
companySize​.salesGrowthFrom Number Annual Sales Growth (%) Lower Bound
companySize​.salesGrowthTo Number Annual Sales Growth (%) Upper Bound
companyType Object Company Types include Public (1), Private (2), Private_Association (3), Private_Consortium (4), Private_Cooperative (5), or Subsidiary (15); OR available as a container element for locationType, ownershipType, subsidiaryStatus, and franchiseStatus.
companyType​.locationType Array of Number Company Location Type such as Single Location (0), Headquarters (1), Branch (2), Branch/Division (4), Subsidiary (5)
companyType​.ownershipType Array of Number Ownership Type. A code value which describes the legal ownership status of the company. Indicates whether or not a company without its own stock information has a parent company that receives stock information. Values are 1 (Public), 21 (Owned by a Public Company or Public_By_Association) or 0 (Unknown).
companyType​.subsidiaryStatus Array of Number Subsidiary status is entered either as 0 = not a subsidiary or 1 = is a subsidiary: subsidiaryStatus [#] These integers indicate whether or not the corporate stock of the site location is at least 50% owned by another company. A subsidiary company is controlled by another company or corporation that owns more than 50% of its stock and may own all of it (called a parent company).
companyType​.franchiseStatus Boolean Franchise Status: If set to true, If set to false. Franchises are independently owned and operated businesses granted the right to use a brand owner's (franchisor's) name, products, and trademarks in exchange for a fee.
financialData Object
financialData​.advertisingExpenseFrom Number Advertising Expense (expressed in millions of US Dollars) Lower Bound
financialData​.advertisingExpenseTo Number Advertising Expense (expressed in millions of US Dollars) Upper Bound
financialData​.assetsFrom Number Assets (expressed in millions of US Dollars) Lower Bound
financialData​.assetsTo Number Assets (expressed in millions of US Dollars) Upper Bound
financialData​.filingDateFrom String Filing Date Lower Bound
financialData​.filingDateTo String Filing Date Upper Bound
financialData​.fiscalYearEnd Array of Number The month the fiscal year ends. Not all financial fiscal year ranges end in December, for example.
financialData​.incomeFrom Number Net Income (expressed in millions of US Dollars) Lower Bound
financialData​.incomeGrowthFrom Number Net Income Growth (%) Lower Bound
financialData​.incomeGrowthTo Number Net Income Growth (%) Upper Bound
financialData​.incomeTo Number Net Income (expressed in millions of US Dollars) Upper Bound
financialData​.offerFrom Number US IPO Data - Offer Amount (expressed in milions of USD) Lower Bound
financialData​.offerTo Number US IPO Data - Offer Amount (expressed in milions of USD) Upper Bound
financialData​.priceRangeFrom Number US IPO Data - Price Range ($) Lower Bound
financialData​.priceRangeTo Number US IPO Data - Price Range ($) Upper Bound
financialData​.researchExpenseFrom Number R&D Expense ($ mil) Lower Bound
financialData​.researchExpenseTo Number R&D Expense ($ mil) Upper Bound
financialData​.tradingDateFrom String Trading Date Lower Bound
financialData​.tradingDateTo String Trading Date Upper Bound
financialData​.underwriterId Array of Number Underwriter ID. A brokerage firm that buys shares from the company and sells them to the public in the IPO. We provide almost 900 of these organizations.
financialData​.marketingPreScreenScore Array of String Max array length: 3 Available Values:
L
L stands for Low
M
M stands for Medium
H
H stands for High
industry Object
industry​.dnbIndustryCode Array of Number D&B Industry Code
industry​.primaryOnly Boolean Restricts the search to only the primary company industry
industry​.nAICS Array of String NAICS Code: "NAICS" (North American Industry Classification System) was jointly created by Canada, Mexico and the US in the 1990s. Enter only one code per element. Use multiple elements for multiple codes. Enter at least two digits per code. No CSV or Ranges can be specified.
industry​.nAICSRange Array of Object
industry​.nAICSRange[]​.from String NAICS Code Range Lower Bound
industry​.nAICSRange[]​.to String NAICS Code Range Upper Bound
industry​.uSSIC Array of String US SIC Code: "SIC" (Standard Industrial Classification) is an industry code system developed by the US Government.
industry​.uSSICRange Array of Object
industry​.uSSICRange[]​.from String SIC Code Range Lower Bound
industry​.uSSICRange[]​.to String SIC Code Range Upper Bound
industry​.uKSIC Array of String UK SIC Code: The United Kingdom's Standard Industrial Classification (SIC) was first introduced in 1948 for use in classifying business establishments and other statistical units by the type of economic activity in which they are engaged. The classification provides a framework for the collection, tabulation, presentation and analysis of data, and its use promotes uniformity. In addition, it can be used for administrative purposes and by non-government bodies as a convenient way of classifying industrial activities into a common structure. Since 1948 the classification has been revised in 1958, 1968, 1980, 1992, 1997, and 2003.
industry​.uKSICRange Array of Object
industry​.uKSICRange[]​.from String UKSIC Code Range Lower Bound
industry​.uKSICRange[]​.to String UKSIC Code Range Upper Bound
location Object Type of location for the company; headquarters, branch office, etc.
location​.areaCode Array of String US or Canadian Phone Number Area Code
location​.streetAddress Array of String Street Address
location​.county Array of Object Company County
location​.county[]​.countyId String County ID
location​.county[]​.state String State
location​.county[]​.countryId Number Country ID - D&B-assigned code which identifies the country where the business is located.
location​.city Array of String City
location​.countryId Array of Number Country ID - D&B-assigned code which identifies the country where the business is located.
location​.globalState Array of String Global State/Province
location​.metropolitanId Array of Number US Metropolitan Area
location​.regionId Array of Number D&B world region code which identifies the region where the business is located.
location​.usStateCanadaProvince Array of String US State/Canada Province
location​.postalCode Array of String Postal Code
location​.usZipCodeRange Array of Object
location​.usZipCodeRange[]​.from Number US ZIP Code Range Lower Bound
location​.usZipCodeRange[]​.to Number US ZIP Code Range Upper Bound
location​.zipAreaSearch Object
location​.zipAreaSearch​.scale String Units to search in: miles or kilometers Available Values:
miles
kilometers
location​.zipAreaSearch​.radius Number Number of miles or kilometers to search within
location​.zipAreaSearch​.zipCode String Zipcode to search within (78745 in the example)
location​.latLongSearch Object
location​.latLongSearch​.scale String Units to search in: miles or kilometers Available Values:
miles
kilometers
location​.latLongSearch​.radius Number Number of miles or kilometers to search within
location​.latLongSearch​.latitude Number
location​.latLongSearch​.longitude Number Longitude component of geo location
location​.allAny String Denotes whether all or any company location criteria are matched Available Values:
all
any
location​.ukCounty Array of String UK County name
specialtyCriteria Object
specialtyCriteria​.auditorId Array of Number Obtain the Auditors ID value from the GetAdvancedSearchLookups call. Example: 'id' 1551 corresponds to PricewaterhouseCoopers AB
specialtyCriteria​.companyKeyword String Company Keyword
specialtyCriteria​.duns Array of Number D-U-N-S Number. The Data Universal Numbering System (DUNS) Number is a non-indicative, nine-digit number assigned to each business location in the D&amp;B database having a unique, separate, and distinct operation, and is maintained solely by D&amp;B. The D&amp;B D-U-N-S Number is used by industries and organizations around the world as a global standard for business identification and tracking. Pattern Value: "([0-9a-zA-Z]*)".
specialtyCriteria​.dunsFrom Number D-U-N-S Number lower limit
specialtyCriteria​.dunsTo Number D-U-N-S Number upper limit
specialtyCriteria​.fein Array of String US Federal Tax ID issued by the IRS. Unique nine-digit Federal Employer Identification Number.
specialtyCriteria​.crn Array of String Seven-digit Company Registration Number recognized by the United Kingdom
specialtyCriteria​.exchangeId Array of Number The ID associated with the exchange where the company's stock is traded.
specialtyCriteria​.rankingId Array of Number Ranking ID
specialtyCriteria​.ukRegistration Array of String UK Registration Number. Unique identifier assigned to UK companies by the government's Companies House. Example: 3443456
specialtyCriteria​.ukVat Array of String United Kingdom's Value Added Tax Number. Example: 906565610
specialtyCriteria​.yearFoundingFrom Number Year of Founding or Change in Control Lower Bound
specialtyCriteria​.yearFoundingTo Number Year of Founding or Change in Control (YYYY) Upper Bound
specialtyCriteria​.ultimateParentDuns Array of Number The ultimate parent company D-U-N-S Number for a family of companies
specialtyCriteria​.primaryUrl Array of String Primary URL for the company
specialtyCriteria​.mustContainPrimaryUrl Boolean
specialtyCriteria​.companyName String Company Name
specialtyCriteria​.stockTicker Array of String Stock Ticker
specialtyCriteria​.minorityOwned Boolean A true or false indication of whether or not a company's owners are minorities. A business that is at least 51% owned by, and whose management and daily business operations are controlled by, one or more members of a socially and economically disadvantaged minority group, namely U.S. citizens who are: African American, Asian American, Hispanic American, Native American, Indian Subcontinent American.
specialtyCriteria​.womenOwned Boolean A true or false indication of whether or not a company's owners are women. A business that is at least 51% owned by, and whose management and daily business operations are controlled by one or more women who are U.S. citizens.
specialtyCriteria​.squareFootageFrom Number Company square foot range from
specialtyCriteria​.squareFootageTo Number Company square foot range to
specialtyCriteria​.ethnicity Array of String Ethnicity of the company owner: Chinese, Filipino, Japanese, Korean, Vietnamese, or other Asian origin (ASN), Black or African American (BLK), Hispanic, Latino, or Spanish origin (HSP), Indian Subcontinent origin (ISU), American Indian, Alaska Native, or Native Hawaiian (NAT), Unknown (UNK) Available Values:
ASN
Chinese, Filipino, Japanese, Korean, Vietnamese, or other Asian origin
BLK
Black or African American
HSP
Hispanic, Latino, or Spanish origin
ISU
Indian Subcontinent origin
NAT
American Indian, Alaska Native, or Native Hawaiian
UNK
Unknown
specialtyCriteria​.legalStatus Array of String Legal Status of the company Available Values:
Corporation
Partnership
Proprietorship
NationalGovernmentEntity
RegionalLocalGovernmentEntity
JointVenture
NonProfitOrganization
CooperativeMutualOrganization
ForeignCompany
specialtyCriteria​.ownsOrRents String Company resides in Owned or Rented Space Available Values:
Owned
Location is rented by this company
Rented
Location is owned by this company
specialtyCriteria​.importer Boolean Importer flag which identifies whether or not a company imports for re-manufacture or sale
specialtyCriteria​.exporter Boolean Exporter flag which identifies whether or not a company exports products to other countries.
people Object
people​.lastName Array of String (up to 64 characters) Person Last Name
people​.firstName Array of String (up to 64 characters) Person First Name
people​.ageFrom Number Person Age Lower Bound
people​.ageTo Number Person Age Upper Bound
people​.bonusFrom Number Person Bonus ($) Lower Bound
people​.bonusTo Number Person Bonus ($) Upper Bound
people​.salaryFrom Number Person Salary ($) Lower Bound
people​.salaryTo Number Person Salary ($) Upper Bound
people​.totalPayFrom Number Person Total Pay ($) Lower Bound
people​.totalPayTo Number Person Total Pay ($) Upper Bound
people​.jobFunctionId Array of Number Identifies a job function that may be independent of job title. Management Responsibility Code (MRC) identifies the title of the principal or manager for the subject.
people​.keywordsIn Array of String Keywords In. When relating to PeopleKeywordsInType, the enumeration values are "title" and "bio" strings. Available Values:
title
bio
people​.keywordSelect String Person Keyword

Sample Request

URL
POST /search/person/advanced?return_search_navigation=true
Body
{
  "specialtyCriteria": {
    "duns": [
      "884114609"
    ]
  }, 
  "people": {
    "lastName": [
      "Mathew"
    ], 
    "keywordSelect": "CEO", 
    "firstName": [
      "Sara"
    ], 
    "keywordsIn": [
      "title"
    ]
  }
}

Sample Response

{
  "people": {
    "lastHit": 0, 
    "totalHits": 0, 
    "hits": 0, 
    "hit": [], 
    "firstHit": 0
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     -d '{
  "specialtyCriteria": {
    "duns": [
      "884114609"
    ]
  }, 
  "people": {
    "lastName": [
      "Mathew"
    ], 
    "keywordSelect": "CEO", 
    "firstName": [
      "Sara"
    ], 
    "keywordsIn": [
      "title"
    ]
  }
}'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/person/advanced?return_search_navigation=true'

/industry/{dnb_industry_code} Available in Add-on: First Research

Returns DnB's and First Research industry information.

Representation

/industry/{dnb_industry_code}
?chapter_name={chapter_name}

URL Parameters

Element Type Notes
dnb_industry_code Number Required
chapter_name String (All | IndustryOverview | QuarterlyIndustryUpdate | BusinessChallenges | TrendsAndOpportunities | ExecutiveInsight | CallPreparationQuestions | FinancialInformation | IndustryForecast | IndustryWebsites | GlossaryOfAcronyms | IndustryIndicators)

Sample Request

URL
GET /industry/1904

Sample Response

{
  "naicsCodes": {
    "naics": [
      "519130"
    ]
  }, 
  "industryName": "Internet Publishing, Broadcasting & Search Portals", 
  "relatedIndustries": {
    "relatedIndustry": [
      {
        "dnbIndustryCode": 1068, 
        "industryName": "Commercial Printing"
      }, 
      {
        "dnbIndustryCode": 1462, 
        "industryName": "Book Publishers"
      }, 
      ...
    ]
  }, 
  "chapters": {
    "chapter": []
  }, 
  "uksicCodes": {
    "uksic": []
  }, 
  "whiteCollarWorkerRatios": {
    "whiteCollarWorkerRatio": []
  }, 
  "dnbIndustryCode": 1904, 
  "industryDescription": "Companies in this industry publish content on the ...", 
  "ussicCodes": {
    "ussic": []
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/industry/1904'

/industry/{dnb_industry_code}/call_prep Available in Add-on: First Research

Returns useful First Research industry information to assist in preparation for calling a client in a certain industry.

Representation

/industry/{dnb_industry_code}/call_prep

URL Parameters

Element Type Notes
dnb_industry_code Number Required

Sample Request

URL
GET /industry/1904/call_prep

Sample Response

{
  "industryName": "Internet Publishing, Broadcasting & Search Portals", 
  "keyBusinessChallenges": {
    "challenge": [
      {
        "orderNumber": 1, 
        "question": "What are the company's primary sources of revenue?...", 
        "description": "Many Internet publishing companies depend on adver...", 
        "title": "Reliance on Advertising "
      }, 
      {
        "orderNumber": 2, 
        "question": "How much of the company's resources are invested i...", 
        "description": "Companies dedicate significant resources to the de...", 
        "title": "Technology Development"
      }, 
      ...
    ]
  }, 
  "fastFacts": {
    "fastFact": [
      {
        "orderNumber": 1, 
        "fact": "Companies in this industry publish content on the ..."
      }, 
      {
        "orderNumber": 2, 
        "fact": " Major companies include Facebook, Google, and Yah..."
      }, 
      ...
    ]
  }, 
  "keyBusinessOpportunities": {
    "opportunity": [
      {
        "orderNumber": 1, 
        "question": "How is the company adapting its products for consu...", 
        "description": "Increasingly, consumers are using hand-held device...", 
        "title": "New Internet Access Platforms"
      }, 
      {
        "orderNumber": 2, 
        "question": "What sources of revenue beyond advertising is the ...", 
        "description": "Recognizing the limited revenue potential of conve...", 
        "title": "New Revenue Streams"
      }, 
      ...
    ]
  }, 
  "dnbIndustryCode": 1904, 
  "executiveTalkingPoints": {
    "talkingPoint": [
      {
        "orderNumber": 1, 
        "focusIssue": "Strengthening Advertising Opportunities While Dive...", 
        "role": "Chief Executive Officer - CEO", 
        "callPrepQuestion": "How is the company diversifying its revenue source..."
      }, 
      {
        "orderNumber": 2, 
        "focusIssue": "Increasing Legal Costs", 
        "role": "Chief Financial Officer - CFO", 
        "callPrepQuestion": "How is the company planning for rising legal costs..."
      }, 
      ...
    ]
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/industry/1904/call_prep'

/industry/{dnb_industry_code}/dnb Available in Add-on: First Research

Returns First Research industry information.

Representation

/industry/{dnb_industry_code}/dnb

URL Parameters

Element Type Notes
dnb_industry_code Number Required

Sample Request

URL
GET /industry/1904/dnb

Sample Response

{
  "naicsCodes": {
    "naics": [
      "519130"
    ]
  }, 
  "industryName": "Internet Publishing, Broadcasting & Search Portals", 
  "relatedIndustries": {
    "relatedIndustry": []
  }, 
  "uksicCodes": {
    "uksic": []
  }, 
  "dnbIndustryCode": 1904, 
  "industryDescription": "Companies in this industry publish content on the ...", 
  "ussicCodes": {
    "ussic": []
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/industry/1904/dnb'

/search/industry/{keyword} Included in Base Package

Returns industries that match the specified keyword.

Representation

/search/industry/{keyword}
?sort_direction={sort_direction}
&order_by={order_by}
&premium_industry_only={premium_industry_only}

URL Parameters

Element Type Notes
keyword String Required
sort_direction String (ascending | descending)
order_by String (CompanyName | CompanyType | CountryName | CityName | StateName | PhoneNumber | FaxNumber | SalesGrowth12Mon | TotalAssets | SalesUS | EmployeesTotal | EmployeesHere | FiscalYearEndMonth | MarketCap | NetIncomeGrowth12Mon | EmployeeGrowth12Mon | ROE | ROA | EarningsComparison | BookValueComparison | NetIncome | PersonFirstName | PersonLastName | PersonTitle | None)
premium_industry_only Boolean

Sample Request

URL
GET /search/industry/aerospace

Sample Response

{
  "resultSet": {
    "hit": [
      {
        "industryResult": {
          "dnbIndustryCode": "1001", 
          "industryName": "Aerospace Products & Parts Manufacturing", 
          "shortOverview": "aerospace or defense products, including complete ..."
        }
      }, 
      {
        "industryResult": {
          "dnbIndustryCode": "1601", 
          "industryName": "Airport Operations", 
          "shortOverview": "airports and provide other services in support of ..."
        }
      }, 
      ...
    ]
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/industry/aerospace'

/search/industry/advanced Included in Base Package

Returns industries that match the specified input criteria.

Representation

/search/industry/advanced
?sort_direction={sort_direction}
&order_by={order_by}

URL Parameters

Element Type Notes
sort_direction String (ascending | descending)
order_by String (CompanyName | CompanyType | CountryName | CityName | StateName | PhoneNumber | FaxNumber | SalesGrowth12Mon | TotalAssets | SalesUS | EmployeesTotal | EmployeesHere | FiscalYearEndMonth | MarketCap | NetIncomeGrowth12Mon | EmployeeGrowth12Mon | ROE | ROA | EarningsComparison | BookValueComparison | NetIncome | PersonFirstName | PersonLastName | PersonTitle | None)

Body Representation

Element Type Notes
nAICS Array of String NAICS Code: "NAICS" (North American Industry Classification System) was jointly created by Canada, Mexico and the US in the 1990s. Enter only one code per element. Use multiple elements for multiple codes. Enter at least two digits per code. No CSV or Ranges can be specified.
uSSIC Array of String US SIC Code: "SIC" (Standard Industrial Classification) is an industry code system developed by the US Government.
uKSIC Array of String UK SIC Code: The United Kingdom's Standard Industrial Classification (SIC) was first introduced in 1948 for use in classifying business establishments and other statistical units by the type of economic activity in which they are engaged. The classification provides a framework for the collection, tabulation, presentation and analysis of data, and its use promotes uniformity. In addition, it can be used for administrative purposes and by non-government bodies as a convenient way of classifying industrial activities into a common structure. Since 1948 the classification has been revised in 1958, 1968, 1980, 1992, 1997, and 2003.

Sample Request

URL
POST /search/industry/advanced
Body
{
  "uSSIC": [
    "01", 
    "02", 
    "50"
  ], 
  "uKSIC": [
    "01", 
    "02", 
    "50"
  ], 
  "nAICS": [
    "11", 
    "21", 
    "56"
  ]
}

Sample Response

{
  "resultSet": {
    "hit": [
      {
        "industryResult": {
          "dnbIndustryCode": "1950", 
          "industryName": "Nursery & Floriculture Production", 
          "shortOverview": "nursery and floriculture products."
        }
      }, 
      {
        "industryResult": {
          "dnbIndustryCode": "1877", 
          "industryName": "Fruit & Tree Nut Farming", 
          "shortOverview": "fruit or tree nut crops."
        }
      }, 
      ...
    ]
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     -d '{
  "uSSIC": [
    "01", 
    "02", 
    "50"
  ], 
  "uKSIC": [
    "01", 
    "02", 
    "50"
  ], 
  "nAICS": [
    "11", 
    "21", 
    "56"
  ]
}'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/industry/advanced'

/search/industry/province/{province_id} Available in Add-on: First Research

Returns a First Research profile for one of the United States of America or a Canadian Province. Some data returned may be encoded HTML.

Representation

/search/industry/province/{province_id}

URL Parameters

Element Type Notes
province_id String Required

Sample Request

URL
GET /search/industry/province/al

Sample Response

{
  "relatedIndustries": {
    "relatedIndustry": [
      {
        "dnbIndustryCode": 1014, 
        "industryName": "Animal Production"
      }, 
      {
        "dnbIndustryCode": 1015, 
        "industryName": "Crop Production"
      }, 
      ...
    ]
  }, 
  "stateProvinceProfile": {
    "imageUrl": "https://access.firstresearch.com/images/flags/AL.g...", 
    "id": "AL", 
    "chapters": {
      "chapter": [
        {
          "name": "Big Picture", 
          "paragraphs": {
            "paragraph": [
              {
                "siteUrl": "", 
                "title": "", 
                "orderNumber": 1, 
                "imageUrl": "", 
                "bullets": {
                  "bullet": [
                    "<B>Exports</B> fell 18.3% to $25.1 billion in the ...", 
                    "<B>Average weekly earnings</B> rose 3.3% to $1,167...", 
                    ...
                  ]
                }, 
                "contents": ""
              }
            ]
          }
        }, 
        {
          "name": "Employment Data", 
          "paragraphs": {
            "paragraph": [
              {
                "siteUrl": "", 
                "title": "Minimum wage of $10.20 is below the national avera...", 
                "orderNumber": 1, 
                "imageUrl": "", 
                "bullets": {
                  "bullet": []
                }, 
                "contents": ""
              }, 
              {
                "siteUrl": "", 
                "title": "Alberta Unemployment and Job Growth Rates", 
                "orderNumber": 2, 
                "imageUrl": "", 
                "bullets": {
                  "bullet": []
                }, 
                "contents": "April 2015 <br><br><table border=\"0\" cellspacing=\"..."
              }, 
              ...
            ]
          }
        }, 
        ...
      ]
    }, 
    "name": "Alberta"
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/industry/province/al'

/referenceData Included in Base Package

This service returns search lookup values for various web service calls. This call does not require any input parameters. We recommend caching this data due to the object size and relatively static nature of the response.

Representation

/referenceData

URL Parameters

none

Sample Request

URL
GET /referenceData

Sample Response

{
  "companyTypes": {
    "coType": [
      {
        "sortOrder": null, 
        "id": 0, 
        "name": "No Public Indicator"
      }, 
      {
        "sortOrder": null, 
        "id": 1, 
        "name": "Public"
      }, 
      ...
    ]
  }, 
  "states": {
    "stateName": [
      {
        "state": "AB", 
        "countryId": 14, 
        "name": "Alberta", 
        "taxRate": null
      }, 
      {
        "state": "AK", 
        "countryId": 76, 
        "name": "Alaska", 
        "taxRate": null
      }, 
      ...
    ]
  }, 
  "stockExchanges": {
    "exchange": [
      {
        "displayFlag": 0, 
        "countryId": 76, 
        "name": "NASDAQ OMX", 
        "isMajor": 0, 
        "offsite": 1, 
        "quoteLink": "", 
        "exchangeType": 0, 
        "id": 356
      }, 
      {
        "displayFlag": 0, 
        "countryId": 69, 
        "name": "Swiss GBP", 
        "isMajor": 0, 
        "offsite": 1, 
        "quoteLink": "", 
        "exchangeType": 0, 
        "id": 357
      }, 
      ...
    ]
  }, 
  "underwriters": {
    "underwriter": [
      {
        "source": "China Life F-1/A#2 12/5/2003", 
        "id": 616, 
        "name": "Nomura International plc"
      }, 
      {
        "source": "China Life F-1/A#2 12/5/2003", 
        "id": 617, 
        "name": "Samsung Securities Co. Ltd."
      }, 
      ...
    ]
  }, 
  "countries": {
    "country": [
      {
        "name": "Algeria", 
        "shortName": "DZ", 
        "regionId": 12, 
        "mapLink": false, 
        "continentId": 6, 
        "sortOrder": 60, 
        "parentId": 1, 
        "phoneCode": 213, 
        "displayFlag": 1, 
        "id": 1, 
        "sortName": "algeria"
      }, 
      {
        "name": "Antigua and Barbuda", 
        "shortName": "AG", 
        "regionId": 3, 
        "mapLink": false, 
        "continentId": 1, 
        "sortOrder": 110, 
        "parentId": 2, 
        "phoneCode": 1, 
        "displayFlag": 1, 
        "id": 2, 
        "sortName": "antigua"
      }, 
      ...
    ]
  }, 
  "metroAreas": {
    "metroArea": [
      {
        "shortName": "", 
        "majorMetroFlag": 0, 
        "displayFlag": 0, 
        "id": 42660, 
        "name": "Seattle-Tacoma-Bellevue WA"
      }, 
      {
        "shortName": "", 
        "majorMetroFlag": 0, 
        "displayFlag": 0, 
        "id": 17020, 
        "name": "Chico CA"
      }, 
      ...
    ]
  }, 
  "dnbIndustries": {
    "dnbicInfo": [
      {
        "code": 2026, 
        "childIndustries": {
          "dnbicInfo": [
            {
              "code": 1014, 
              "childIndustries": {
                "dnbicInfo": [
                  {
                    "code": 1808, 
                    "childIndustries": {
                      "dnbicInfo": []
                    }, 
                    "name": "Aquaculture "
                  }, 
                  {
                    "code": 1819, 
                    "childIndustries": {
                      "dnbicInfo": []
                    }, 
                    "name": "Cattle Ranching"
                  }, 
                  ...
                ]
              }, 
              "name": "Animal Production"
            }, 
            {
              "code": 1839, 
              "childIndustries": {
                "dnbicInfo": []
              }, 
              "name": "Commercial Fishing"
            }, 
            ...
          ]
        }, 
        "name": "Agriculture & Forestry Sector"
      }, 
      {
        "code": 1425, 
        "childIndustries": {
          "dnbicInfo": [
            {
              "code": 2053, 
              "childIndustries": {
                "dnbicInfo": []
              }, 
              "name": "Amusement Parks & Arcades"
            }, 
            {
              "code": 1825, 
              "childIndustries": {
                "dnbicInfo": []
              }, 
              "name": "Bowling Centers"
            }, 
            ...
          ]
        }, 
        "name": "Arts, Entertainment & Recreation Sector"
      }, 
      ...
    ]
  }, 
  "auditors": {
    "auditor": [
      {
        "displayFlag": 0, 
        "id": 1349, 
        "name": "Ian Duckworth & Co."
      }, 
      {
        "displayFlag": 1, 
        "id": 1351, 
        "name": "Hallidays"
      }, 
      ...
    ]
  }, 
  "regions": {
    "region": [
      {
        "displayFlag": 1, 
        "id": 1, 
        "parent": 1, 
        "name": "Africa"
      }, 
      {
        "displayFlag": 1, 
        "id": 2, 
        "parent": 2, 
        "name": "Asia"
      }, 
      ...
    ]
  }, 
  "locationTypes": {
    "locationType": [
      {
        "id": 0, 
        "name": "Single Location"
      }, 
      {
        "id": 1, 
        "name": "Headquarters"
      }, 
      ...
    ]
  }, 
  "jobFunctions": {
    "officialFunction": [
      {
        "functionTypeId": 1, 
        "displayFlag": 1, 
        "id": "10", 
        "displayOrder": 50, 
        "name": "Business Development"
      }, 
      {
        "functionTypeId": 1, 
        "displayFlag": 1, 
        "id": "100", 
        "displayOrder": 50, 
        "name": "Investor Relations"
      }, 
      ...
    ]
  }, 
  "rankingTypes": {
    "rankType": [
      {
        "partialDescription": "The world's largest public companies, ranked by ma...", 
        "description": "The <I>Financial Times</I>' listing of the world's...", 
        "url": "http://www.ft.com/intl/cms/s/0/988051be-fdee-11e3-...", 
        "sortName": "FT Global 500", 
        "dnbDisplay": 43, 
        "currentYear": 2014, 
        "hasPosition": 1, 
        "editLevel": 0, 
        "recordStatus": 1, 
        "id": 34, 
        "displayOrder": null, 
        "name": "FT Global 500 (June 2014)"
      }, 
      {
        "partialDescription": "The senior index drawn from the exchanges of Amste...", 
        "description": "The following companies are components of the Euro...", 
        "url": "https://indices.nyx.com/en/products/indices/FR0003...", 
        "sortName": "Euronext 100", 
        "dnbDisplay": 40, 
        "currentYear": 0, 
        "hasPosition": 0, 
        "editLevel": 0, 
        "recordStatus": 1, 
        "id": 36, 
        "displayOrder": null, 
        "name": "Euronext 100"
      }, 
      ...
    ]
  }, 
  "counties": {
    "county": [
      {
        "state": "AL", 
        "countryId": 76, 
        "id": "1", 
        "name": "Autauga County"
      }, 
      {
        "state": "AR", 
        "countryId": 76, 
        "id": "1", 
        "name": "Arkansas County"
      }, 
      ...
    ]
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/referenceData'

/user/credits Included in Base Package

Returns the number of ConnectMail credit that have been purchased, been used, and are remaining.

Representation

/user/credits

URL Parameters

none

Sample Request

URL
GET /user/credits

Sample Response

{
  "connectMailCredits": {
    "creditsUsed": 0, 
    "creditsPurchased": 250001, 
    "creditsRemaining": 250001
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/user/credits'

/search/company/basic/{keyword} Included in Base Package

Representation

/search/company/basic/{keyword}
?limit={limit}

URL Parameters

Element Type Notes
keyword String Required
limit String

Sample Request

URL
GET /search/company/basic/hoovers

Sample Response

{
  "companies": [
    {
      "city": "Austin", 
      "companyId": 41416000000000, 
      "companyName": "HOOVER'S, INC.", 
      "revenue": 118.2, 
      "state": "TX", 
      "link": {
        "http": "/company/41416000000000?view=basic", 
        "rel": "self"
      }, 
      "duns": "611241688"
    }, 
    {
      "city": "Newport", 
      "companyId": 108765504, 
      "companyName": "Hoovers Pub and Grill LLC", 
      "revenue": 0.35, 
      "state": "OR", 
      "link": {
        "http": "/company/108765504?view=basic", 
        "rel": "self"
      }, 
      "duns": "108765504"
    }, 
    ...
  ]
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/company/basic/hoovers'

/search/industry/state/{state_id} Included in Base Package

Representation

/search/industry/state/{state_id}

URL Parameters

Element Type Notes
state_id String Required

Sample Request

URL
GET /search/industry/state/tx

Sample Response

{
  "relatedIndustries": {
    "relatedIndustry": [
      {
        "dnbIndustryCode": 1014, 
        "industryName": "Animal Production"
      }, 
      {
        "dnbIndustryCode": 1085, 
        "industryName": "Chemical Manufacturing"
      }, 
      ...
    ]
  }, 
  "stateProvinceProfile": {
    "imageUrl": "https://access.firstresearch.com/images/flags/texa...", 
    "id": "TX", 
    "chapters": {
      "chapter": [
        {
          "name": "Big Picture", 
          "paragraphs": {
            "paragraph": [
              {
                "siteUrl": "", 
                "title": "", 
                "orderNumber": 1, 
                "imageUrl": "", 
                "bullets": {
                  "bullet": [
                    "<B>Exports</B> fell 11.5% to $34.3 billion in the ...", 
                    "<B>Tax revenue</B> increased 1.1% in Q4 2014 from ...", 
                    ...
                  ]
                }, 
                "contents": ""
              }
            ]
          }
        }, 
        {
          "name": "Employment Data", 
          "paragraphs": {
            "paragraph": [
              {
                "siteUrl": "", 
                "title": "Minimum wage of $7.25 mirrors the national rate.", 
                "orderNumber": 1, 
                "imageUrl": "", 
                "bullets": {
                  "bullet": []
                }, 
                "contents": ""
              }, 
              {
                "siteUrl": "", 
                "title": "Texas Unemployment and Job Growth Rates", 
                "orderNumber": 2, 
                "imageUrl": "", 
                "bullets": {
                  "bullet": []
                }, 
                "contents": "March 2015 <br><br><table border=\"0\" cellspacing=\"..."
              }, 
              ...
            ]
          }
        }, 
        ...
      ]
    }, 
    "name": "Texas"
  }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     -H 'API-KEY:YOUR-API-KEY-HERE'\
     -H 'username:YOUR-USERNAME-HERE'\
     -H 'password:YOUR-PASSWORD-HERE'\
     'http://dnbdirect-api.dnb.com/DnBAPI-17/rest/search/industry/state/tx'
© Dun & Bradstreet, Inc. 2000-2015. All rights reserved. © 2015 Morningstar. Financial Data provided by Morningstar.