D&B Direct Documentation

Supply Management API

By D&B SparkLab - Customer Solutions Lab

Overview

Endpoints & WSDL

Production API

WADL https://dnbdirect-api.dnb.com/SMSAPI/rest/services.wadl
Endpoint https://dnbdirect-api.dnb.com/SMSAPI/rest/

Authentication

All API calls require the following credentials to be sent in as URL parameters:

Name Value
appid mashery
api_key Your D&B Direct SMS API Key

Resources

getCurrentRisk

This service provides risk insight regarding a suppliers current business standing including such things as payment performance, indicators of criminal or financial embarrassment activity, presence of suits, liens or judgments, events such as natural disasters or operational activities like ownership change or merger/acquisition.

Representation

supplier/getCurrentRisk/{dunsNumber}?appid=mashery&api_key={api_key}

Request Parameters

Element Type
dunsNumber String

Response Representation

Element Type
SupplierCurrentRiskResponse Object
SupplierCurrentRiskResponse.Organization Object
SupplierCurrentRiskResponse.Organization.SubjectHeader Object
SupplierCurrentRiskResponse.Organization.SubjectHeader.EnquiryDUNSNumber String
SupplierCurrentRiskResponse.Organization.SubjectHeader.DUNSNumber String
SupplierCurrentRiskResponse.Organization.Assessment Object
SupplierCurrentRiskResponse.Organization.Assessment.DNBStandardRating Object
SupplierCurrentRiskResponse.Organization.Assessment.DNBStandardRating.DNBStandardRating String
SupplierCurrentRiskResponse.Organization.Events Object
SupplierCurrentRiskResponse.Organization.Events.OtherSpecialEventsIndicator String
SupplierCurrentRiskResponse.Organization.Events.LegalEvents Object
SupplierCurrentRiskResponse.Organization.Events.LegalEvents.SuitsAndOrJudgmentsIndicator String
SupplierCurrentRiskResponse.Organization.Events.FinancingEvents Object
SupplierCurrentRiskResponse.Organization.Events.FinancingEvents.SecuredFilingsIndicator String
SupplierCurrentRiskResponse.Organization.BusinessTrading Object
SupplierCurrentRiskResponse.Organization.BusinessTrading.Purchaser Object
SupplierCurrentRiskResponse.Organization.BusinessTrading.Purchaser.CurrentPaydexScore Object
SupplierCurrentRiskResponse.Organization.BusinessTrading.Purchaser.CurrentPaydexScore.TwelveMonthsPaydex Object
SupplierCurrentRiskResponse.Organization.BusinessTrading.Purchaser.CurrentPaydexScore.TwelveMonthsPaydex.PaydexScore String

Sample Request

URL
GET supplier/getCurrentRisk/884114609?appid=mashery&api_key={api_key}

Sample Response

{
   "SupplierCurrentRiskResponse": {
      "Organization": {
         "SubjectHeader": {
            "EnquiryDUNSNumber": "884114609", 
            "DUNSNumber": "884114609"
         }, 
         "Assessment": {
            "DNBStandardRating": {
               "DNBStandardRating": "--"
            }
         }, 
         "Events": {
            "OtherSpecialEventsIndicator": "true", 
            "LegalEvents": {
               "SuitsAndOrJudgmentsIndicator": "true"
            }, 
            "SignificantEvents": null, 
            "FinancingEvents": {
               "SecuredFilingsIndicator": "true"
            }
         }, 
         "BusinessTrading": {
            "Purchaser": {
               "CurrentPaydexScore": {
                  "TwelveMonthsPaydex": {
                     "PaydexScore": "69"
                  }
               }
            }, 
            "PaydexScoreNorms": null
         }
      }
   }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     'https://dnbdirect-api.dnb.com/SMSAPI/rest/supplier/getCurrentRisk/884114609?appid=mashery&api_key={api_key}'

getPredictiveRisk

This service provides predictive risk insight regarding a suppliers possible future business standing including such things as Credit Score, Financial Stress Score (FSS), Supplier Evaluation Risk (SER) Rating and Debarment indicator.

Representation

supplier/getPredictiveRisk/{dunsNumber}?appid=mashery&api_key={api_key}

Request Parameters

Element Type
dunsNumber String

Response Representation

Element Type
SupplierPredictiveRiskResponse Object
SupplierPredictiveRiskResponse.Organization Object
SupplierPredictiveRiskResponse.Organization.SubjectHeader Object
SupplierPredictiveRiskResponse.Organization.SubjectHeader.EnquiryDUNSNumber String
SupplierPredictiveRiskResponse.Organization.SubjectHeader.DUNSNumber String
SupplierPredictiveRiskResponse.Organization.Assessment Object
SupplierPredictiveRiskResponse.Organization.Assessment.GlobalFailureRiskScoreType Object
SupplierPredictiveRiskResponse.Organization.Assessment.GlobalFailureRiskScoreType.RawScore String
SupplierPredictiveRiskResponse.Organization.Assessment.CommercialCreditScore Object
SupplierPredictiveRiskResponse.Organization.Assessment.CommercialCreditScore.RawScore String
SupplierPredictiveRiskResponse.Organization.Assessment.CommercialCreditScore.ScoreCommentary Array
SupplierPredictiveRiskResponse.Organization.Assessment.CommercialCreditScore.ScoreCommentary.n Object
SupplierPredictiveRiskResponse.Organization.Assessment.CommercialCreditScore.ScoreCommentary[].CommentaryText String
SupplierPredictiveRiskResponse.Organization.Assessment.FinancialStressScore Object
SupplierPredictiveRiskResponse.Organization.Assessment.FinancialStressScore.RawScore String
SupplierPredictiveRiskResponse.Organization.Assessment.FinancialStressScore.NationalPercentile String
SupplierPredictiveRiskResponse.Organization.Assessment.FinancialStressScore.ScoreCommentary Array
SupplierPredictiveRiskResponse.Organization.Assessment.FinancialStressScore.ScoreCommentary.n Object
SupplierPredictiveRiskResponse.Organization.Assessment.FinancialStressScore.ScoreCommentary[].CommentaryText String
SupplierPredictiveRiskResponse.Organization.Events Object
SupplierPredictiveRiskResponse.Organization.Events.LegalEvents Object
SupplierPredictiveRiskResponse.Organization.Events.LegalEvents.DebarmentsInformation Object

Sample Request

URL
GET supplier/getPredictiveRisk/884114609?appid=mashery&api_key={api_key}

Sample Response

{
   "SupplierPredictiveRiskResponse": {
      "Organization": {
         "SubjectHeader": {
            "EnquiryDUNSNumber": "884114609", 
            "DUNSNumber": "884114609"
         }, 
         "Assessment": {
            "GlobalFailureRiskScoreType": {
               "RawScore": "1455"
            }, 
            "CommercialCreditScore": {
               "RawScore": "433", 
               "ScoreCommentary": [
                  {
                     "CommentaryText": "BG/NM2"
                  }, 
                  {
                     "CommentaryText": "BG/NL1"
                  }, 
                  {
                     "CommentaryText": "BG/NK7"
                  }, 
                  {
                     "CommentaryText": "BG/NU9"
                  }
               ]
            }, 
            "FinancialStressScore": {
               "RawScore": "1455", 
               "NationalPercentile": "37", 
               "ScoreCommentary": [
                  {
                     "CommentaryText": "BG/NL1"
                  }, 
                  {
                     "CommentaryText": "BG/NK7"
                  }, 
                  {
                     "CommentaryText": "BG/NK5"
                  }, 
                  {
                     "CommentaryText": "BG/NK9"
                  }, 
                  {
                     "CommentaryText": "BG/NL3"
                  }, 
                  {
                     "CommentaryText": "BG/NL0"
                  }
               ]
            }
         }, 
         "Events": {
            "LegalEvents": {
               "DebarmentsInformation": {
                  "DebarmentsSummary": null
               }
            }
         }
      }
   }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     'https://dnbdirect-api.dnb.com/SMSAPI/rest/supplier/getPredictiveRisk/884114609?appid=mashery&api_key={api_key}'

getSupplierLinkage

This service provides the D-U-N-S Number and legal company name connected to a supplier and its upward corporate family relationships including headquarters, parent, local country ultimate and global ultimate (the top most member of a corporate family tree), as well as total employees at the global ultimate level.

Representation

supplier/getSupplierLinkage/{dunsNumber}?appid=mashery&api_key={api_key}

Request Parameters

Element Type
dunsNumber String

Response Representation

Element Type
SupplierLinkageResponse Object
SupplierLinkageResponse.Organization Object
SupplierLinkageResponse.Organization.SubjectHeader Object
SupplierLinkageResponse.Organization.SubjectHeader.EnquiryDUNSNumber String
SupplierLinkageResponse.Organization.SubjectHeader.DUNSNumber String
SupplierLinkageResponse.Organization.EmployeeFigures Object
SupplierLinkageResponse.Organization.EmployeeFigures.ConsolidatedEmployeeDetail Object
SupplierLinkageResponse.Organization.EmployeeFigures.ConsolidatedEmployeeDetail.TotalEmployeeQuantity String
SupplierLinkageResponse.Organization.Linkage Object
SupplierLinkageResponse.Organization.Linkage.DomesticUltimateOrganization Object
SupplierLinkageResponse.Organization.Linkage.DomesticUltimateOrganization.CountryISOAlpha2Code String
SupplierLinkageResponse.Organization.Linkage.DomesticUltimateOrganization.OrganizationPrimaryName Object
SupplierLinkageResponse.Organization.Linkage.DomesticUltimateOrganization.OrganizationPrimaryName.OrganizationName String
SupplierLinkageResponse.Organization.Linkage.DomesticUltimateOrganization.DUNSNumber String
SupplierLinkageResponse.Organization.Linkage.ParentOrganization Object
SupplierLinkageResponse.Organization.Linkage.ParentOrganization.CountryISOAlpha2Code String
SupplierLinkageResponse.Organization.Linkage.ParentOrganization.OrganizationPrimaryName Object
SupplierLinkageResponse.Organization.Linkage.ParentOrganization.OrganizationPrimaryName.OrganizationName String
SupplierLinkageResponse.Organization.Linkage.ParentOrganization.DUNSNumber String
SupplierLinkageResponse.Organization.Linkage.GlobalUltimateOrganization Object
SupplierLinkageResponse.Organization.Linkage.GlobalUltimateOrganization.CountryISOAlpha2Code String
SupplierLinkageResponse.Organization.Linkage.GlobalUltimateOrganization.OrganizationPrimaryName Object
SupplierLinkageResponse.Organization.Linkage.GlobalUltimateOrganization.OrganizationPrimaryName.OrganizationName String
SupplierLinkageResponse.Organization.Linkage.GlobalUltimateOrganization.DUNSNumber String

Sample Request

URL
GET supplier/getSupplierLinkage/884114609?appid=mashery&api_key={api_key}

Sample Response

{
   "SupplierLinkageResponse": {
      "Organization": {
         "SubjectHeader": {
            "EnquiryDUNSNumber": "884114609", 
            "DUNSNumber": "884114609"
         }, 
         "EmployeeFigures": {
            "ConsolidatedEmployeeDetail": {
               "TotalEmployeeQuantity": "4600"
            }
         }, 
         "Linkage": {
            "DomesticUltimateOrganization": {
               "CountryISOAlpha2Code": "US", 
               "OrganizationPrimaryName": {
                  "OrganizationName": "THE DUN & BRADSTREET CORPORATION"
               }, 
               "DUNSNumber": "884114609"
            }, 
            "ParentOrganization": {
               "CountryISOAlpha2Code": "US", 
               "OrganizationPrimaryName": {
                  "OrganizationName": "THE DUN & BRADSTREET CORPORATION"
               }, 
               "DUNSNumber": "884114609"
            }, 
            "HeadquartersOrganization": null, 
            "GlobalUltimateOrganization": {
               "CountryISOAlpha2Code": "US", 
               "OrganizationPrimaryName": {
                  "OrganizationName": "THE DUN & BRADSTREET CORPORATION"
               }, 
               "DUNSNumber": "884114609"
            }
         }
      }
   }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     'https://dnbdirect-api.dnb.com/SMSAPI/rest/supplier/getSupplierLinkage/884114609?appid=mashery&api_key={api_key}'

getSupplierBasic

Representation

supplier/getSupplierBasic/{dunsNumber}?appid=mashery&api_key={api_key}

Request Parameters

Element Type
dunsNumber String

Response Representation

Element Type
SupplierBasicResponse Object
SupplierBasicResponse.Organization Object
SupplierBasicResponse.Organization.OrganizationName Object
SupplierBasicResponse.Organization.OrganizationName.OrganizationPrimaryName Object
SupplierBasicResponse.Organization.OrganizationName.OrganizationPrimaryName.OrganizationName String
SupplierBasicResponse.Organization.OrganizationName.TradeStyleName Object
SupplierBasicResponse.Organization.OrganizationName.TradeStyleName.OrganizationName String
SupplierBasicResponse.Organization.Telecommunication Object
SupplierBasicResponse.Organization.Telecommunication.TelephoneNumber Object
SupplierBasicResponse.Organization.Telecommunication.TelephoneNumber.TelecommunicationNumber String
SupplierBasicResponse.Organization.Telecommunication.FacsimileNumber Object
SupplierBasicResponse.Organization.Telecommunication.FacsimileNumber.InternationalDialingCode String
SupplierBasicResponse.Organization.SocioEconomicIdentification Object
SupplierBasicResponse.Organization.SocioEconomicIdentification.LaborSurplusAreaIndicator String
SupplierBasicResponse.Organization.EmployeeFigures Object
SupplierBasicResponse.Organization.EmployeeFigures.ConsolidatedEmployeeDetail Object
SupplierBasicResponse.Organization.EmployeeFigures.ConsolidatedEmployeeDetail.TotalEmployeeQuantity String
SupplierBasicResponse.Organization.EmployeeFigures.ConsolidatedEmployeeDetail.TotalEmployeeIndicator String
SupplierBasicResponse.Organization.EmployeeFigures.IndividualEntityEmployeeDetail Object
SupplierBasicResponse.Organization.EmployeeFigures.IndividualEntityEmployeeDetail.TotalEmployeeQuantity String
SupplierBasicResponse.Organization.PrincipalsAndManagement Object
SupplierBasicResponse.Organization.PrincipalsAndManagement.MostSeniorPrincipal Object
SupplierBasicResponse.Organization.PrincipalsAndManagement.MostSeniorPrincipal.PrincipalName Object
SupplierBasicResponse.Organization.PrincipalsAndManagement.MostSeniorPrincipal.PrincipalName.FullName String
SupplierBasicResponse.Organization.PrincipalsAndManagement.MostSeniorPrincipal.PrincipalName.@type String
SupplierBasicResponse.Organization.SubjectHeader Object
SupplierBasicResponse.Organization.SubjectHeader.EnquiryDUNSNumber String
SupplierBasicResponse.Organization.SubjectHeader.DUNSNumber String
SupplierBasicResponse.Organization.SubjectHeader.CurrencyISOAlpha3Code String
SupplierBasicResponse.Organization.Location Object
SupplierBasicResponse.Organization.Location.PrimaryAddress Object
SupplierBasicResponse.Organization.Location.PrimaryAddress.PostalCode String
SupplierBasicResponse.Organization.Location.PrimaryAddress.GeoLocation Object
SupplierBasicResponse.Organization.Location.PrimaryAddress.GeoLocation.Latitude String
SupplierBasicResponse.Organization.Location.PrimaryAddress.GeoLocation.GeoAccuracyCode String
SupplierBasicResponse.Organization.Location.PrimaryAddress.GeoLocation.Longitude String
SupplierBasicResponse.Organization.Location.PrimaryAddress.TerritoryOfficialName String
SupplierBasicResponse.Organization.Location.PrimaryAddress.CountryISOAlpha2Code String
SupplierBasicResponse.Organization.Location.PrimaryAddress.StreetAddressLine Object
SupplierBasicResponse.Organization.Location.PrimaryAddress.StreetAddressLine.LineText String
SupplierBasicResponse.Organization.Location.PrimaryAddress.PrimaryTownName String
SupplierBasicResponse.Organization.Location.PrimaryAddress.PoliticalDistrict Object
SupplierBasicResponse.Organization.Location.PrimaryAddress.PoliticalDistrict.PoliticalDistrictText String
SupplierBasicResponse.Organization.OrganizationDetail Object
SupplierBasicResponse.Organization.OrganizationDetail.ControlOwnershipTypeText String
SupplierBasicResponse.Organization.OrganizationDetail.FamilyTreeMemberRole Array
SupplierBasicResponse.Organization.OrganizationDetail.FamilyTreeMemberRole.n Object
SupplierBasicResponse.Organization.OrganizationDetail.FamilyTreeMemberRole[].FamilyTreeMemberRoleText String
SupplierBasicResponse.Organization.OrganizationDetail.CharterTypeText String
SupplierBasicResponse.Organization.OrganizationDetail.CompanySynopsis String
SupplierBasicResponse.Organization.OrganizationDetail.OrganizationStartYear String
SupplierBasicResponse.Organization.OrganizationDetail.MajorIndustryCategory String
SupplierBasicResponse.Organization.OrganizationDetail.LocationOwnership String
SupplierBasicResponse.Organization.OrganizationDetail.LegalStructure String
SupplierBasicResponse.Organization.OrganizationDetail.FederalTaxId String
SupplierBasicResponse.Organization.OrganizationDetail.StandaloneOrganizationIndicator String
SupplierBasicResponse.Organization.OrganizationDetail.ControlOwnershipDate String
SupplierBasicResponse.Organization.RegisteredDetail Object
SupplierBasicResponse.Organization.RegisteredDetail.LegalFormDetails Object
SupplierBasicResponse.Organization.RegisteredDetail.LegalFormDetails.LegalFormText String
SupplierBasicResponse.Organization.RegisteredDetail.IncorporationYear String
SupplierBasicResponse.Organization.RegisteredDetail.RegisteredOrganisationStatusText String
SupplierBasicResponse.Organization.IndustryCode Object
SupplierBasicResponse.Organization.IndustryCode.IndustryCode Array
SupplierBasicResponse.Organization.IndustryCode.IndustryCode.n Object
SupplierBasicResponse.Organization.IndustryCode.IndustryCode[].@TypeText String
SupplierBasicResponse.Organization.IndustryCode.IndustryCode[].IndustryCode String
SupplierBasicResponse.Organization.IndustryCode.IndustryCode[].IndustryCodeDescription String

Sample Request

URL
GET supplier/getSupplierBasic/884114609?appid=mashery&api_key={api_key}

Sample Response

{
   "SupplierBasicResponse": {
      "Organization": {
         "ActivitiesAndOperations": null, 
         "OrganizationName": {
            "OrganizationPrimaryName": {
               "OrganizationName": "Dun & Bradstreet Corporation, The "
            }, 
            "TradeStyleName": {
               "OrganizationName": "D&B "
            }
         }, 
         "Telecommunication": {
            "TelephoneNumber": {
               "TelecommunicationNumber": "973 921-5500"
            }, 
            "FacsimileNumber": {
               "InternationalDialingCode": "1"
            }
         }, 
         "SocioEconomicIdentification": {
            "LaborSurplusAreaIndicator": "true"
         }, 
         "EmployeeFigures": {
            "ConsolidatedEmployeeDetail": {
               "TotalEmployeeQuantity": "4600", 
               "TotalEmployeeIndicator": "B"
            }, 
            "IndividualEntityEmployeeDetail": {
               "TotalEmployeeQuantity": "400"
            }
         }, 
         "PrincipalsAndManagement": {
            "MostSeniorPrincipal": {
               "PrincipalName": {
                  "FullName": "SARA MATHEW, CHB-CEO+", 
                  "@type": "IndividualNameType"
               }
            }
         }, 
         "SubjectHeader": {
            "EnquiryDUNSNumber": "884114609", 
            "DUNSNumber": "884114609", 
            "CurrencyISOAlpha3Code": "USD"
         }, 
         "Location": {
            "PrimaryAddress": {
               "PostalCode": "07078", 
               "GeoLocation": {
                  "Latitude": "+40.742406", 
                  "GeoAccuracyCode": "D", 
                  "Longitude": "-074.354241"
               }, 
               "TerritoryOfficialName": "NJ", 
               "CountryISOAlpha2Code": "US", 
               "StreetAddressLine": {
                  "LineText": "103 JFK Parkway "
               }, 
               "PrimaryTownName": "Short Hills", 
               "PoliticalDistrict": {
                  "PoliticalDistrictText": "11"
               }
            }
         }, 
         "OrganizationDetail": {
            "ControlOwnershipTypeText": "true", 
            "FamilyTreeMemberRole": [
               {
                  "FamilyTreeMemberRoleText": "N"
               }, 
               {
                  "FamilyTreeMemberRoleText": "HQ"
               }
            ], 
            "CharterTypeText": "RTC/4", 
            "CompanySynopsis": "<p>For The Dun &amp; Bradstreet Corporation, there's no business like \"know\" business. The company, known as D&amp;B,\u00a0is one of the world's leading suppliers of business information and research. Its global database contains\u00a0commercial data\u00a0on\u00a0more than 220\u00a0million companies. D&amp;B also holds the largest volume of business-credit information in the world.\u00a0The company\u00a0mines\u00a0its data to create software products, web-based applications,\u00a0and marketing information and purchasing-support services for its customers. Operations are split into\u00a0two main segments: risk management and\u00a0sales and marketing solutions.\u00a0<Company ID=\"41416\">Hoover's</Company>, the publisher of this profile, is part of D&amp;B.</p>", 
            "OrganizationStartYear": "1841", 
            "MajorIndustryCategory": "9", 
            "LocationOwnership": "C", 
            "LegalStructure": "003", 
            "FederalTaxId": "223725387", 
            "StandaloneOrganizationIndicator": "false", 
            "ControlOwnershipDate": "1841"
         }, 
         "RegisteredDetail": {
            "LegalFormDetails": {
               "LegalFormText": "LSC/3"
            }, 
            "IncorporationYear": "2000", 
            "RegisteredOrganisationStatusText": "1"
         }, 
         "IndustryCode": {
            "IndustryCode": [
               {
                  "@TypeText": "1987", 
                  "IndustryCode": "7323"
               }, 
               {
                  "IndustryCodeDescription": "Credit reporting services                                   ", 
                  "@TypeText": "PrimarySIC", 
                  "IndustryCode": "7323"
               }, 
               {
                  "IndustryCodeDescription": "Credit Bureaus                                                                                                          ", 
                  "@TypeText": "PrimaryNAICS", 
                  "IndustryCode": "561450"
               }
            ]
         }
      }
   }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     'https://dnbdirect-api.dnb.com/SMSAPI/rest/supplier/getSupplierBasic/884114609?appid=mashery&api_key={api_key}'

getCompanyFinancialSummary

This service provides detailed financial statement information when available about a supplier including but not limited to Cash and Liquid Assets, Total Assets, Total Liabilities, Net Worth, Sales, Net Income, Statement Date, and more.

Representation

supplier/getCompanyFinancialSummary/{dunsNumber}?appid=mashery&api_key={api_key}

Request Parameters

Element Type
dunsNumber String

Response Representation

Element Type
SupplierFinancialsResponse Object
SupplierFinancialsResponse.Organization Object
SupplierFinancialsResponse.Organization.SubjectHeader Object
SupplierFinancialsResponse.Organization.SubjectHeader.EnquiryDUNSNumber String
SupplierFinancialsResponse.Organization.SubjectHeader.DUNSNumber String
SupplierFinancialsResponse.Organization.Financial Object
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview Object
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.TotalAssetsAmount String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.TotalCurrentLiabilitiesAmount String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.TotalCurrentAssetsAmount String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.TotalEquityAmount String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.TotalLiabilitiesAmount String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.CashAndLiquidAssetsAmount String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.ProfitOrLossAmount Array
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.ProfitOrLossAmount.n String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.AccountsReceivableAmount String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.StatementHeaderDetails Object
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.StatementHeaderDetails.FiscalIndicator String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.StatementHeaderDetails.InformationScopeText String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.StatementHeaderDetails.StatementDate String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.StatementHeaderDetails.ReliabilityText String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.StatementHeaderDetails.FinancialStatementToDate String
SupplierFinancialsResponse.Organization.Financial.KeyFinancialFiguresOverview.StatementHeaderDetails.FinancialStatementFromDate String

Sample Request

URL
GET supplier/getCompanyFinancialSummary/884114609?appid=mashery&api_key={api_key}

Sample Response

{
   "SupplierFinancialsResponse": {
      "Organization": {
         "SubjectHeader": {
            "EnquiryDUNSNumber": "884114609", 
            "DUNSNumber": "884114609"
         }, 
         "Financial": {
            "KeyFinancialFiguresOverview": {
               "TotalAssetsAmount": "1991800000", 
               "TotalCurrentLiabilitiesAmount": "876700000", 
               "TotalCurrentAssetsAmount": "747400000", 
               "TotalEquityAmount": "-1014300000", 
               "TotalLiabilitiesAmount": "3006100000", 
               "CashAndLiquidAssetsAmount": "149100000", 
               "ProfitOrLossAmount": [
                  "295500000", 
                  "1663000000"
               ], 
               "TangibleNetWorthAmount": null, 
               "AccountsReceivableAmount": "514300000", 
               "StatementHeaderDetails": {
                  "FiscalIndicator": "true", 
                  "InformationScopeText": "false", 
                  "StatementDate": "20121231", 
                  "ReliabilityText": "false", 
                  "FinancialStatementToDate": "20121231", 
                  "FinancialStatementFromDate": "20120101"
               }, 
               "SalesRevenueAmount": null
            }
         }
      }
   }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     'https://dnbdirect-api.dnb.com/SMSAPI/rest/supplier/getCompanyFinancialSummary/884114609?appid=mashery&api_key={api_key}'

getCompanyLookup

The Cleanse Match Service acts as an interface for matching a name and address of a business. The response typically consists of response candidates that are identified as the best matches for the input criteria based on D&Bs match algorithms.

Representation

supplier/getCompanyLookup?appid=mashery&api_key={api_key}

Request Parameters

Element Type
MatchRequest Object
MatchRequest.MatchRequestDetail Object
MatchRequest.MatchRequestDetail.MatchSpecification Object
MatchRequest.MatchRequestDetail.MatchSpecification.OrderReasonCode Number
MatchRequest.MatchRequestDetail.MatchSpecification.ExclusionCriteria Object
MatchRequest.MatchRequestDetail.MatchSpecification.ExclusionCriteria.ExclusionDataDescription String
MatchRequest.MatchRequestDetail.MatchSpecification.CandidateMaximumQuantity Number
MatchRequest.MatchRequestDetail.InquiryDetail Object
MatchRequest.MatchRequestDetail.InquiryDetail.TelephoneNumber Object
MatchRequest.MatchRequestDetail.InquiryDetail.TelephoneNumber.TelecommunicationNumber String
MatchRequest.MatchRequestDetail.InquiryDetail.TelephoneNumber.InternationalDialingCode String
MatchRequest.MatchRequestDetail.InquiryDetail.SubjectName String
MatchRequest.MatchRequestDetail.InquiryDetail.Address Object
MatchRequest.MatchRequestDetail.InquiryDetail.Address.PrimaryTownName String
MatchRequest.MatchRequestDetail.InquiryDetail.Address.CountryISOAlpha2Code String
MatchRequest.MatchRequestDetail.InquiryDetail.Address.TerritoryName String
MatchRequest.MatchRequestDetail.InquiryDetail.Address.FullPostalCode String
MatchRequest.MatchRequestDetail.InquiryDetail.Address.StreetAddressLine Object
MatchRequest.MatchRequestDetail.InquiryDetail.Address.StreetAddressLine.LineText String

Response Representation

Element Type
MatchResponseDetail Object
MatchResponseDetail.CandidateMatchedQuantity String
MatchResponseDetail.MatchCandidate Array
MatchResponseDetail.MatchCandidate.n Object
MatchResponseDetail.MatchCandidate[].TelephoneNumber Object
MatchResponseDetail.MatchCandidate[].TelephoneNumber.TelecommunicationNumber String
MatchResponseDetail.MatchCandidate[].OrganizationPrimaryName Object
MatchResponseDetail.MatchCandidate[].OrganizationPrimaryName.OrganizationName String
MatchResponseDetail.MatchCandidate[].FamilyTreeMemberRole Object
MatchResponseDetail.MatchCandidate[].FamilyTreeMemberRole.FamilyTreeMemberRoleText String
MatchResponseDetail.MatchCandidate[].PrimaryAddress Object
MatchResponseDetail.MatchCandidate[].PrimaryAddress.PrimaryTownName String
MatchResponseDetail.MatchCandidate[].PrimaryAddress.PostalCode String
MatchResponseDetail.MatchCandidate[].PrimaryAddress.TerritoryAbbreviatedName String
MatchResponseDetail.MatchCandidate[].PrimaryAddress.StreetAddressLine Object
MatchResponseDetail.MatchCandidate[].PrimaryAddress.StreetAddressLine.LineText String
MatchResponseDetail.MatchCandidate[].PrimaryAddress.CountryCode String
MatchResponseDetail.MatchCandidate[].DUNSNumber String

Sample Request

URL
POST supplier/getCompanyLookup?appid=mashery&api_key={api_key}
Body
{
   "MatchRequest": {
      "MatchRequestDetail": {
         "MatchSpecification": {
            "OrderReasonCode": 2, 
            "ExclusionCriteria": {
               "ExclusionDataDescription": "Out Of Business"
            }, 
            "CandidateMaximumQuantity": 3
         }, 
         "InquiryDetail": {
            "TelephoneNumber": {
               "TelecommunicationNumber": "", 
               "InternationalDialingCode": ""
            }, 
            "SubjectName": "AMR Corporation", 
            "Address": {
               "PrimaryTownName": "Fort Worth", 
               "CountryISOAlpha2Code": "US", 
               "TerritoryName": "TX", 
               "FullPostalCode": "76155", 
               "StreetAddressLine": {
                  "LineText": "AMON CARTER BLVD"
               }
            }
         }
      }
   }
}

Sample Response

{
   "MatchResponseDetail": {
      "CandidateMatchedQuantity": "0", 
      "MatchCandidate": [
         {
            "TelephoneNumber": {
               "TelecommunicationNumber": "8179631234"
            }, 
            "OrganizationPrimaryName": {
               "OrganizationName": "AMR CORPORATION"
            }, 
            "FamilyTreeMemberRole": {
               "FamilyTreeMemberRoleText": "H"
            }, 
            "MatchQualityInformation": null, 
            "PrimaryAddress": {
               "PrimaryTownName": "FORT WORTH", 
               "PostalCode": "76155", 
               "TerritoryAbbreviatedName": "TX", 
               "StreetAddressLine": {
                  "LineText": "4333 AMON CARTER BLVD"
               }, 
               "CountryCode": "840"
            }, 
            "DUNSNumber": "072560154"
         }, 
         {
            "TelephoneNumber": {
               "TelecommunicationNumber": "8179672000"
            }, 
            "OrganizationPrimaryName": {
               "OrganizationName": "A M R TRAINING GROUP INC"
            }, 
            "FamilyTreeMemberRole": {
               "FamilyTreeMemberRoleText": "H"
            }, 
            "MatchQualityInformation": null, 
            "PrimaryAddress": {
               "PrimaryTownName": "FORT WORTH", 
               "PostalCode": "76155", 
               "TerritoryAbbreviatedName": "TX", 
               "StreetAddressLine": {
                  "LineText": "4333 AMON CARTER BLVD"
               }, 
               "CountryCode": "840"
            }, 
            "DUNSNumber": "788138980"
         }
      ]
   }
}

CURL Example

curl -H 'Accept: application/json'\
     -H 'Content-type: application/json'\
     'https://dnbdirect-api.dnb.com/SMSAPI/rest/supplier/getCompanyLookup?appid=mashery&api_key={api_key}'
© Dun & Bradstreet, Inc. 2000-2013. All rights reserved.