D&B Direct Documentation

SOAP Version 1.7

By D&B SparkLab - Customer Solutions Lab

Overview

Endpoints & WSDL

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

WSDL http://api.dnbdirectapps.com/dev/DnBAPI-17/dnbAPI/dnbAPI.wsdl
Endpoint http://api.dnbdirectapps.com/dev/DnBAPI-17

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

WSDL http://dnbdirect-sandbox.dnb.com/DnBAPI-17/dnbAPI/dnbAPI.wsdl
Endpoint http://dnbdirect-sandbox.dnb.com/DnBAPI-17

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

WSDL http://dnbdirect-api.dnb.com/DnBAPI-17/dnbAPI/dnbAPI.wsdl
Endpoint http://dnbdirect-api.dnb.com/DnBAPI-17

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 your API-KEY to be sent in the SOAP header.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://applications.dnb.com/webservice/schema/">
   <soapenv:Header>
      <sch:API-KEY>YOUR-API-KEY-HERE</sch:API-KEY>
   </soapenv:Header>
   <soapenv:Body>
    ...
   </soapenv:Body>
</soapenv:Envelope>
Certain entitled premium or add-on calls may require your username and password as well.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://applications.dnb.com/webservice/schema/">
   <soapenv:Header>
      <sch:API-KEY>YOUR-API-KEY-HERE</sch:API-KEY>
      <sch:username>YOUR-USERNAME-HERE</sch:username>
      <sch:password>YOUR-PASSWORD-HERE</sch:password>
   </soapenv:Header>
   <soapenv:Body>
    ...
   </soapenv:Body>
</soapenv:Envelope>

SOAP Operations

AdvancedCompanySearch Included in Base Package

Returns search result of companies based on various criteria.

Request

Element Type Notes
bal Required
bal​.maxRecords integer Maximum records to retrieve (1-200).
bal​.hitOffset integer Zero-based offset used to indicate at what record to start returning results.
bal​.sortDirection string Sort direction types are Ascending or Descending Available Values:
Ascending
Descending
bal​.companySize CompanySize
bal​.companySize​.employeesFrom long Employees Lower Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
bal​.companySize​.employeesTo long Employees Upper Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
bal​.companySize​.employeesGrowthFrom double Total Employees Growth Percentage Lower Bound
bal​.companySize​.employeesGrowthTo double Total Employees Growth Percentage Upper Bound
bal​.companySize​.employeesThisLocationFrom long Employees at this Location Lower Bound
bal​.companySize​.employeesThisLocationTo long Employees at this Location Upper Bound
bal​.companySize​.marketCapFrom decimal 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.
bal​.companySize​.marketCapTo decimal 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.
bal​.companySize​.salesFrom decimal Annual Sales ($ mil) Lower Bound
bal​.companySize​.salesTo decimal Annual Sales ($ mil) Upper Bound
bal​.companySize​.salesGrowthFrom double Annual Sales Growth (%) Lower Bound
bal​.companySize​.salesGrowthTo double Annual Sales Growth (%) Upper Bound
bal​.companyType CompanyType 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.
bal​.companyType​.locationType Array of integer Company Location Type such as Single Location (0), Headquarters (1), Branch (2), Branch/Division (4), Subsidiary (5)
bal​.companyType​.ownershipType Array of integer 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).
bal​.companyType​.subsidiaryStatus Array of integer 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).
bal​.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.
bal​.financialData FinancialData
bal​.financialData​.advertisingExpenseFrom decimal Advertising Expense (expressed in millions of US Dollars) Lower Bound
bal​.financialData​.advertisingExpenseTo decimal Advertising Expense (expressed in millions of US Dollars) Upper Bound
bal​.financialData​.assetsFrom decimal Assets (expressed in millions of US Dollars) Lower Bound
bal​.financialData​.assetsTo decimal Assets (expressed in millions of US Dollars) Upper Bound
bal​.financialData​.filingDateFrom date Filing Date Lower Bound
bal​.financialData​.filingDateTo date Filing Date Upper Bound
bal​.financialData​.fiscalYearEnd Array of long The month the fiscal year ends. Not all financial fiscal year ranges end in December, for example.
bal​.financialData​.incomeFrom decimal Net Income (expressed in millions of US Dollars) Lower Bound
bal​.financialData​.incomeGrowthFrom double Net Income Growth (%) Lower Bound
bal​.financialData​.incomeGrowthTo double Net Income Growth (%) Upper Bound
bal​.financialData​.incomeTo decimal Net Income (expressed in millions of US Dollars) Upper Bound
bal​.financialData​.offerFrom decimal US IPO Data - Offer Amount (expressed in milions of USD) Lower Bound
bal​.financialData​.offerTo decimal US IPO Data - Offer Amount (expressed in milions of USD) Upper Bound
bal​.financialData​.priceRangeFrom decimal US IPO Data - Price Range ($) Lower Bound
bal​.financialData​.priceRangeTo decimal US IPO Data - Price Range ($) Upper Bound
bal​.financialData​.researchExpenseFrom decimal R&D Expense ($ mil) Lower Bound
bal​.financialData​.researchExpenseTo decimal R&D Expense ($ mil) Upper Bound
bal​.financialData​.tradingDateFrom date Trading Date Lower Bound
bal​.financialData​.tradingDateTo date Trading Date Upper Bound
bal​.financialData​.underwriterId Array of long 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.
bal​.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
bal​.industry Industry
bal​.industry​.dnbIndustryCode Array of integer D&B Industry Code
bal​.industry​.primaryOnly boolean Restricts the search to only the primary company industry
bal​.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.
bal​.industry​.nAICSRange Array of StringRange
bal​.industry​.nAICSRange[]​.from string NAICS Code Range Lower Bound
bal​.industry​.nAICSRange[]​.to string NAICS Code Range Upper Bound
bal​.industry​.uSSIC Array of string US SIC Code: "SIC" (Standard Industrial Classification) is an industry code system developed by the US Government.
bal​.industry​.uSSICRange Array of StringRange
bal​.industry​.uSSICRange[]​.from string SIC Code Range Lower Bound
bal​.industry​.uSSICRange[]​.to string SIC Code Range Upper Bound
bal​.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.
bal​.industry​.uKSICRange Array of StringRange
bal​.industry​.uKSICRange[]​.from string UKSIC Code Range Lower Bound
bal​.industry​.uKSICRange[]​.to string UKSIC Code Range Upper Bound
bal​.location CompanyLocation Type of location for the company; headquarters, branch office, etc.
bal​.location​.areaCode Array of string US or Canadian Phone Number Area Code
bal​.location​.streetAddress Array of string Street Address
bal​.location​.county Array of County Company County
bal​.location​.county[]​.countyId string County ID
bal​.location​.county[]​.state string State
bal​.location​.county[]​.countryId long Country ID - D&B-assigned code which identifies the country where the business is located.
bal​.location​.city Array of string City
bal​.location​.countryId Array of long Country ID - D&B-assigned code which identifies the country where the business is located.
bal​.location​.globalState Array of string Global State/Province
bal​.location​.metropolitanId Array of long US Metropolitan Area
bal​.location​.regionId Array of long D&B world region code which identifies the region where the business is located.
bal​.location​.usStateCanadaProvince Array of string US State/Canada Province
bal​.location​.postalCode Array of string Postal Code
bal​.location​.usZipCodeRange Array of Range
bal​.location​.usZipCodeRange[]​.from long US ZIP Code Range Lower Bound
bal​.location​.usZipCodeRange[]​.to long US ZIP Code Range Upper Bound
bal​.location​.zipAreaSearch ZipAreaSearch
bal​.location​.zipAreaSearch​.scale string Units to search in: miles or kilometers Available Values:
miles
kilometers
bal​.location​.zipAreaSearch​.radius double Number of miles or kilometers to search within
bal​.location​.zipAreaSearch​.zipCode string Zipcode to search within (78745 in the example)
bal​.location​.latLongSearch LatLongSearch
bal​.location​.latLongSearch​.scale string Units to search in: miles or kilometers Available Values:
miles
kilometers
bal​.location​.latLongSearch​.radius double Number of miles or kilometers to search within
bal​.location​.latLongSearch​.latitude double
bal​.location​.latLongSearch​.longitude double Longitude component of geo location
bal​.location​.allAny string Denotes whether all or any company location criteria are matched Available Values:
all
any
bal​.location​.ukCounty Array of string UK County name
bal​.specialtyCriteria SpecialtyCriteria
bal​.specialtyCriteria​.auditorId Array of long Obtain the Auditors ID value from the GetAdvancedSearchLookups call. Example: 'id' 1551 corresponds to PricewaterhouseCoopers AB
bal​.specialtyCriteria​.companyKeyword string Company Keyword
bal​.specialtyCriteria​.duns Array of long 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]*)".
bal​.specialtyCriteria​.dunsFrom long D-U-N-S Number lower limit
bal​.specialtyCriteria​.dunsTo long D-U-N-S Number upper limit
bal​.specialtyCriteria​.fein Array of string US Federal Tax ID issued by the IRS. Unique nine-digit Federal Employer Identification Number.
bal​.specialtyCriteria​.crn Array of string Seven-digit Company Registration Number recognized by the United Kingdom
bal​.specialtyCriteria​.exchangeId Array of long The ID associated with the exchange where the company's stock is traded.
bal​.specialtyCriteria​.rankingId Array of long Ranking ID
bal​.specialtyCriteria​.ukRegistration Array of string UK Registration Number. Unique identifier assigned to UK companies by the government's Companies House. Example: 3443456
bal​.specialtyCriteria​.ukVat Array of string United Kingdom's Value Added Tax Number. Example: 906565610
bal​.specialtyCriteria​.yearFoundingFrom long Year of Founding or Change in Control Lower Bound
bal​.specialtyCriteria​.yearFoundingTo long Year of Founding or Change in Control (YYYY) Upper Bound
bal​.specialtyCriteria​.ultimateParentDuns Array of long The ultimate parent company D-U-N-S Number for a family of companies
bal​.specialtyCriteria​.primaryUrl Array of string Primary URL for the company
bal​.specialtyCriteria​.mustContainPrimaryUrl boolean
bal​.specialtyCriteria​.companyName string Company Name
bal​.specialtyCriteria​.stockTicker Array of string Stock Ticker
bal​.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.
bal​.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.
bal​.specialtyCriteria​.squareFootageFrom long Company square foot range from
bal​.specialtyCriteria​.squareFootageTo long Company square foot range to
bal​.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
bal​.specialtyCriteria​.legalStatus Array of string Legal Status of the company Available Values:
Corporation
Partnership
Proprietorship
NationalGovernmentEntity
RegionalLocalGovernmentEntity
JointVenture
NonProfitOrganization
CooperativeMutualOrganization
ForeignCompany
bal​.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
bal​.specialtyCriteria​.importer boolean Importer flag which identifies whether or not a company imports for re-manufacture or sale
bal​.specialtyCriteria​.exporter boolean Exporter flag which identifies whether or not a company exports products to other countries.
bal​.nonMarketableCompanyFilterOptions NonMarketableFilterOptions
bal​.nonMarketableCompanyFilterOptions​.includeUndeliverableAddress boolean If true, will return all the unmarketable company records which have undeliverable addresses.
bal​.nonMarketableCompanyFilterOptions​.includeOutOfBusiness boolean If true, will return all the unmarketable company records that are out of business.
bal​.nonMarketableCompanyFilterOptions​.includeIncompleteData boolean If true, will return all the unmarketable company records which have incomplete data.
bal​.nonMarketableCompanyFilterOptions​.includeDoNotMarketTo boolean If true, will return all the unmarketable company records which indicated do not market to.
bal​.nonMarketableCompanyFilterOptions​.includeAll boolean New for 1.7
bal​.orderBy BaseOrderByTypes Order by orderByTypes: CompanyName, CompanyType, CountryName, CityName, StateName, PhoneNumber, FaxNumber, SalesGrowth12Mon, TotalAssets, SalesUS, EmployeesTotal, EmployeesHere, FiscalYearEndMonth, MarketCap, NetIncomeGrowth12Mon, EmployeeGrowth12Mon, ROE, ROA, EarningsComparison, BookValueComparison, NetIncome, PersonFirstName, PersonLastName, PersonTitle Available Values:
CompanyName
CompanyType
CountryName
CityName
StateName
PhoneNumber
FaxNumber
SalesGrowth12Mon
TotalAssets
SalesUS
EmployeesTotal
EmployeesHere
FiscalYearEndMonth
MarketCap
NetIncomeGrowth12Mon
EmployeeGrowth12Mon
ROE
ROA
EarningsComparison
BookValueComparison
NetIncome
None
bal​.returnSearchNavigation boolean If set to true, navigators will be returned in the response which can be used to enable drill down into search results for additional refinement. Navigators are additional criteria available for a set of results.
bal​.searchNavigation SearchNavigation
bal​.searchNavigation​.employeeSearchNavigation EmployeeSearchNavigation
bal​.searchNavigation​.employeeSearchNavigation​.employeeSearchNavigationValue Array of string An employee navigation link that can be fed back into other calls
bal​.searchNavigation​.ownershipTypeSearchNavigation OwnershipTypeSearchNavigation
bal​.searchNavigation​.ownershipTypeSearchNavigation​.ownershipTypeSearchNavigationValue Array of string
bal​.searchNavigation​.locationTypeSearchNavigation LocationTypeSearchNavigation
bal​.searchNavigation​.locationTypeSearchNavigation​.locationTypeSearchNavigationValue Array of string A location type navigation link that can be fed back into other calls
bal​.searchNavigation​.salesSearchNavigation SalesSearchNavigation
bal​.searchNavigation​.salesSearchNavigation​.salesSearchNavigationValue Array of string A sales navigation link that can be fed back into other calls
bal​.searchNavigation​.locationSearchNavigation LocationSearchNavigation
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation Array of CountryNavigation
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.countryNavigationValue string A country navigation link that can be fed back into other calls.
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation Array of StateNavigation
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.stateNavigationValue string A state/province navigation link that can be fed back into other calls.
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation Array of CityNavigation
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation[]​.cityNavigationValue string A city navigation link that can be fed back into other calls
bal​.searchNavigation​.industrySearchNavigation IndustrySearchNavigation
bal​.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.
bal​.searchNavigation​.industrySearchNavigation​.ussicSearchNavigationValue Array of string A US SIC navigation link that can be fed back into other calls.
bal​.searchNavigation​.industrySearchNavigation​.naicsSearchNavigationValue Array of string A NAICS navigation link that can be fed back into other calls.

Response

Element Type Notes
return CompanyResponseWrapper
return​.companies
return​.companies​.firstHit integer First Hit
return​.companies​.hits integer The total number of hits in this response.
return​.companies​.lastHit integer 1-based last hit number
return​.companies​.totalHits integer
return​.companies​.hit Array of CompanySearchResultHit
return​.companies​.hit[]​.hitNumber integer The hit number indicates the result number in the search.
return​.companies​.hit[]​.companyResults CompanyResultFields Company Results
return​.companies​.hit[]​.companyResults​.companyName string Company Name
return​.companies​.hit[]​.companyResults​.nonMarketableCompany NonMarketableReasons Non-marketable company reason such as 'Invalid address', 'Out of business', 'Key data missing/needing revision', 'Requested no marketing contact'
return​.companies​.hit[]​.companyResults​.locationType string Company Location Type such as Single Location (0), Headquarters (1), Branch (2), Branch/Division (4), Subsidiary (5)
return​.companies​.hit[]​.companyResults​.address1 string (up to 150 characters) Company address line 1
return​.companies​.hit[]​.companyResults​.address2 string (up to 70 characters) Company address line 2
return​.companies​.hit[]​.companyResults​.city string City
return​.companies​.hit[]​.companyResults​.country string Country
return​.companies​.hit[]​.companyResults​.countryId integer Country ID - D&B-assigned code which identifies the country where the business is located.
return​.companies​.hit[]​.companyResults​.stateOrProvince string Address State/Province
return​.companies​.hit[]​.companyResults​.postalCode string Postal Code
return​.companies​.hit[]​.companyResults​.primaryUrl string Primary URL for the company
return​.companies​.hit[]​.companyResults​.parentDuns string The parent company D-U-N-S Number. A parent is a corporation that owns more than 50 percent of another corporation. The parent company may also be a subsidiary of another corporation. If the parent also has branches/divisions, then it is also a headquarters. Parents can have both direct and indirect subsidiaries, indirect subsidiaries being those that have another company in between the subsidiary and the parent.
return​.companies​.hit[]​.companyResults​.parentName string The company name of the company's immediate parent company.
return​.companies​.hit[]​.companyResults​.ultimateParentDuns string The ultimate parent company D-U-N-S Number for a family of companies
return​.companies​.hit[]​.companyResults​.ultimateParentName string The ultimate parent company name corresponding to the ultimate parent DUNS Number
return​.companies​.hit[]​.companyResults​.sales decimal Annual Sales in millions
return​.companies​.hit[]​.companyResults​.hqPhone string Headquarters Phone Number
return​.companies​.hit[]​.companyResults​.doNotCallRegistry boolean Indicates whether company is listed on a UK Do Not Call registry
return​.companies​.hit[]​.companyResults​.dbas Dbas
return​.companies​.hit[]​.companyResults​.historicalIndicator boolean Indicates that the company has ceased operations and is no longer covered by editors.
return​.companies​.hit[]​.companyResults​.exchanges ExchangeList
return​.companies​.hit[]​.companyResults​.familyTreeSize integer The number of records in a family tree record.
return​.companies​.hit[]​.companyResults​.employeesAtThisLocation integer The number of employees at this location. The total number of individuals engaged by a business entity at the location of the DUNS numbered subject entity.
return​.companies​.hit[]​.companyResults​.employeesTotal integer Total number of employees. The total number of people employed by all branches and subsidiaries of a business.
return​.companies​.hit[]​.companyResults​.primaryTicker string
return​.companies​.hit[]​.companyResults​.ownershipTypeValue string New for 1.7
return​.companies​.hit[]​.companyResults​.ownershipTypeDescription string New for 1.7
return​.companies​.hit[]​.companyResults​.companyTypeValue string New for 1.7
return​.companies​.hit[]​.companyResults​.companyTypeDescription string New for 1.7
return​.navigators CompanyNavigators Contains lists of navigation links
return​.navigators​.employeeNavigators EmployeeNavigators
return​.navigators​.employeeNavigators​.employeeNavigator Array of EmployeeNavigator
return​.navigators​.employeeNavigators​.employeeNavigator[]​.employeeNavigatorValue string
return​.navigators​.employeeNavigators​.employeeNavigator[]​.employeeNavigatorDescription string
return​.navigators​.locationTypeNavigators LocationTypeNavigators
return​.navigators​.locationTypeNavigators​.locationTypeNavigator Array of LocationTypeNavigator
return​.navigators​.locationTypeNavigators​.locationTypeNavigator[]​.locationTypeNavigatorValue string
return​.navigators​.locationTypeNavigators​.locationTypeNavigator[]​.locationTypeNavigatorDescription string
return​.navigators​.ownershipTypeNavigators OwnershipTypeNavigators
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator Array of OwnershipTypeNavigator
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator[]​.ownershipTypeNavigatorValue string
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator[]​.ownershipTypeNavigatorDescription string
return​.navigators​.salesNavigators SalesNavigators
return​.navigators​.salesNavigators​.salesNavigator Array of SalesNavigator
return​.navigators​.salesNavigators​.salesNavigator[]​.salesNavigatorValue string
return​.navigators​.salesNavigators​.salesNavigator[]​.salesNavigatorDescription string
return​.navigators​.locationNavigators LocationNavigators
return​.navigators​.locationNavigators​.countryNavigators CountryNavigators
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator Array of CountryNavigator
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.countryNavigatorValue string The value of a navigation link for country
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.countryNavigatorDescription string The description of a navigation link for country description
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.stateProvinceNavigators StateProvinceNavigators
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.stateProvinceNavigators​.stateProvinceNavigator Array of StateProvinceNavigator
return​.navigators​.industryNavigators IndustryNavigators
return​.navigators​.industryNavigators​.industryNavigator Array of IndustryNavigator
return​.navigators​.industryNavigators​.industryNavigator[]​.industryNavigatorValue string The value of a navigation link an for industry.
return​.navigators​.industryNavigators​.industryNavigator[]​.industryNavigatorDescription string The description of a navigation link for industry.
return​.navigators​.industryNavigators​.ussicNavigator Array of UsSicNavigator
return​.navigators​.industryNavigators​.ussicNavigator[]​.ussicNavigatorValue string The value of a navigation link for US SIC
return​.navigators​.industryNavigators​.ussicNavigator[]​.ussicNavigatorDescription string The description of a navigation link for US SIC
return​.navigators​.industryNavigators​.naicsNavigator Array of NaicsNavigator
return​.navigators​.industryNavigators​.naicsNavigator[]​.naicsNavigatorValue string The value of a navigation link for NAICS
return​.navigators​.industryNavigators​.naicsNavigator[]​.naicsNavigatorDescription string The description of a navigation link for NAICS

Sample Request XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:AdvancedCompanySearchRequest>
         <ns0:bal>
            <ns0:maxRecords>10</ns0:maxRecords>
            <ns0:hitOffset>0</ns0:hitOffset>
            <ns0:sortDirection>Ascending</ns0:sortDirection>
            <ns0:companySize>
               <ns0:employeesFrom>10</ns0:employeesFrom>
               <ns0:employeesTo>999</ns0:employeesTo>
            </ns0:companySize>
            <ns0:companyType>
               <ns0:locationType>1</ns0:locationType>
            </ns0:companyType>
            <ns0:financialData>
               <ns0:assetsFrom>1</ns0:assetsFrom>
            </ns0:financialData>
            <ns0:industry>
               <ns0:primaryOnly>false</ns0:primaryOnly>
               <ns0:uSSIC>08</ns0:uSSIC>
            </ns0:industry>
            <ns0:location>
               <ns0:countryId>76</ns0:countryId>
            </ns0:location>
            <ns0:specialtyCriteria>
               <ns0:legalStatus>Corporation</ns0:legalStatus>
            </ns0:specialtyCriteria>
            <ns0:orderBy>SalesUS</ns0:orderBy>
            <ns0:returnSearchNavigation>true</ns0:returnSearchNavigation>
         </ns0:bal>
      </ns0:AdvancedCompanySearchRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>

Sample Response XML

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope>
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <sch:AdvancedCompanySearchResponse>
         <sch:return>
            <sch:companies>
               <sch:firstHit>1</sch:firstHit>
               <sch:hits>4</sch:hits>
               <sch:lastHit>4</sch:lastHit>
               <sch:totalHits>4</sch:totalHits>
               <sch:hit>
                  <sch:hitNumber>1</sch:hitNumber>
                  <sch:companyResults>
                     <sch:companyId>180821000000000</sch:companyId>
                     <sch:duns>112491555</sch:duns>
                     <sch:companyName>Plandai Biotechnology, In...</sch:companyName>
                     <sch:locationType>Headquarters</sch:locationType>
                     <sch:address1>1451 N 200 E Ste 130c</sch:address1>
                     <sch:city>Logan</sch:city>
                     <sch:country>United States</sch:country>
                     <sch:countryId>76</sch:countryId>
                     <sch:stateOrProvince>UT</sch:stateOrProvince>
                     <sch:postalCode>84341-7576</sch:postalCode>
                     <sch:primaryUrl/>
                     <sch:parentDuns>112491555</sch:parentDuns>
                     <sch:parentName>Plandai Biotechnology, In...</sch:parentName>
                     <sch:ultimateParentDuns>112491555</sch:ultimateParentDuns>
                     <sch:ultimateParentName>Plandai Biotechnology, In...</sch:ultimateParentName>
                     <sch:sales>0.265748</sch:sales>
                     <sch:hqPhone>801-209-1227</sch:hqPhone>
                     <sch:doNotCallRegistry>false</sch:doNotCallRegistry>
                     <sch:dbas/>
                     <sch:historicalIndicator>false</sch:historicalIndicator>
                     <sch:familyTreeSize>3</sch:familyTreeSize>
                     <sch:employeesTotal>100</sch:employeesTotal>
                     <sch:ownershipTypeValue>1</sch:ownershipTypeValue>
                     <sch:ownershipTypeDescription>PUBLIC</sch:ownershipTypeDescription>
                     <sch:companyTypeValue>1</sch:companyTypeValue>
                     <sch:companyTypeDescription>PUBLIC</sch:companyTypeDescription>
                  </sch:companyResults>
               </sch:hit>
               <sch:hit>
                  <sch:hitNumber>2</sch:hitNumber>
                  <sch:companyResults>
                     <sch:companyId>53173000000000</sch:companyId>
                     <sch:duns>006902878</sch:duns>
                     <sch:companyName>DELTIC TIMBER CORPORATION</sch:companyName>
                     <sch:locationType>Headquarters</sch:locationType>
                     <sch:address1>210 E Elm St</sch:address1>
                     <sch:city>El Dorado</sch:city>
                     <sch:country>United States</sch:country>
                     <sch:countryId>76</sch:countryId>
                     <sch:stateOrProvince>AR</sch:stateOrProvince>
                     <sch:postalCode>71730-6104</sch:postalCode>
                     <sch:primaryUrl>http://www.deltic.com</sch:primaryUrl>
                     <sch:parentDuns>006902878</sch:parentDuns>
                     <sch:parentName>DELTIC TIMBER CORPORATION</sch:parentName>
                     <sch:ultimateParentDuns>006902878</sch:ultimateParentDuns>
                     <sch:ultimateParentName>DELTIC TIMBER CORPORATION</sch:ultimateParentName>
                     <sch:sales>227.355</sch:sales>
                     <sch:hqPhone>870-881-9400</sch:hqPhone>
                     <sch:doNotCallRegistry>false</sch:doNotCallRegistry>
                     <sch:dbas>
                        <sch:dba>Deltic</sch:dba>
                     </sch:dbas>
                     <sch:historicalIndicator>false</sch:historicalIndicator>
                     <sch:familyTreeSize>15</sch:familyTreeSize>
                     <sch:employeesTotal>541</sch:employeesTotal>
                     <sch:ownershipTypeValue>1</sch:ownershipTypeValue>
                     <sch:ownershipTypeDescription>PUBLIC</sch:ownershipTypeDescription>
                     <sch:companyTypeValue>1</sch:companyTypeValue>
                     <sch:companyTypeDescription>PUBLIC</sch:companyTypeDescription>
                  </sch:companyResults>
               </sch:hit>
               ...
               </sch:companies>
            <sch:navigators>
               <sch:employeeNavigators>
                  <sch:employeeNavigator>
                     <sch:employeeNavigatorValue>[;4]</sch:employeeNavigatorValue>
                     <sch:employeeNavigatorDescription>&lt; 4 (0)</sch:employeeNavigatorDescription>
                  </sch:employeeNavigator>
                  <sch:employeeNavigator>
                     <sch:employeeNavigatorValue>[5;10]</sch:employeeNavigatorValue>
                     <sch:employeeNavigatorDescription>5-10 (0)</sch:employeeNavigatorDescription>
                  </sch:employeeNavigator>
                  ...
                  </sch:employeeNavigators>
               <sch:locationTypeNavigators>
                  <sch:locationTypeNavigator>
                     <sch:locationTypeNavigatorValue>1</sch:locationTypeNavigatorValue>
                     <sch:locationTypeNavigatorDescription>Headquarters (4)</sch:locationTypeNavigatorDescription>
                  </sch:locationTypeNavigator>
               </sch:locationTypeNavigators>
               <sch:ownershipTypeNavigators>
                  <sch:ownershipTypeNavigator>
                     <sch:ownershipTypeNavigatorValue>1</sch:ownershipTypeNavigatorValue>
                     <sch:ownershipTypeNavigatorDescription>Public (4)</sch:ownershipTypeNavigatorDescription>
                  </sch:ownershipTypeNavigator>
               </sch:ownershipTypeNavigators>
               <sch:salesNavigators>
                  <sch:salesNavigator>
                     <sch:salesNavigatorValue>[;1&gt;</sch:salesNavigatorValue>
                     <sch:salesNavigatorDescription>&lt; $1 million (1)</sch:salesNavigatorDescription>
                  </sch:salesNavigator>
                  <sch:salesNavigator>
                     <sch:salesNavigatorValue>[1;5&gt;</sch:salesNavigatorValue>
                     <sch:salesNavigatorDescription>$1 - $5 million (0)</sch:salesNavigatorDescription>
                  </sch:salesNavigator>
                  ...
                  </sch:salesNavigators>
               <sch:locationNavigators>
                  <sch:countryNavigators>
                     <sch:countryNavigator>
                        <sch:countryNavigatorValue>76</sch:countryNavigatorValue>
                        <sch:countryNavigatorDescription>United States (4)</sch:countryNavigatorDescription>
                        <sch:stateProvinceNavigators>
                           <sch:stateProvinceNavigator>
                              <sch:stateProvinceNavigatorValue>AR~76</sch:stateProvinceNavigatorValue>
                              <sch:stateProvinceNavigatorDescription>AR (1)</sch:stateProvinceNavigatorDescription>
                              <sch:cityNavigators>
                                 <sch:cityNavigator>
                                    <sch:cityNavigatorValue>"El Dorado~AR~76"</sch:cityNavigatorValue>
                                    <sch:cityNavigatorDescription>El Dorado, AR United Stat...</sch:cityNavigatorDescription>
                                 </sch:cityNavigator>
                              </sch:cityNavigators>
                           </sch:stateProvinceNavigator>
                           <sch:stateProvinceNavigator>
                              <sch:stateProvinceNavigatorValue>FL~76</sch:stateProvinceNavigatorValue>
                              <sch:stateProvinceNavigatorDescription>FL (1)</sch:stateProvinceNavigatorDescription>
                              <sch:cityNavigators>
                                 <sch:cityNavigator>
                                    <sch:cityNavigatorValue>Watersound~FL~76</sch:cityNavigatorValue>
                                    <sch:cityNavigatorDescription>Watersound, FL United Sta...</sch:cityNavigatorDescription>
                                 </sch:cityNavigator>
                              </sch:cityNavigators>
                           </sch:stateProvinceNavigator>
                           ...
                           </sch:stateProvinceNavigators>
                     </sch:countryNavigator>
                  </sch:countryNavigators>
               </sch:locationNavigators>
               <sch:industryNavigators>
                  <sch:industryNavigator>
                     <sch:industryNavigatorValue>1015</sch:industryNavigatorValue>
                     <sch:industryNavigatorDescription>Crop Production (1)</sch:industryNavigatorDescription>
                  </sch:industryNavigator>
                  <sch:industryNavigator>
                     <sch:industryNavigatorValue>1503</sch:industryNavigatorValue>
                     <sch:industryNavigatorDescription>Real Estate Investment Tr...</sch:industryNavigatorDescription>
                  </sch:industryNavigator>
                  ...
                  <sch:ussicNavigator>
                     <sch:ussicNavigatorValue>^01829901$</sch:ussicNavigatorValue>
                     <sch:ussicNavigatorDescription>01829901 Fruits, grown un...</sch:ussicNavigatorDescription>
                  </sch:ussicNavigator>
                  <sch:ussicNavigator>
                     <sch:ussicNavigatorValue>^08110000$</sch:ussicNavigatorValue>
                     <sch:ussicNavigatorDescription>08110000 Timber tracts (1...</sch:ussicNavigatorDescription>
                  </sch:ussicNavigator>
                  ...
                  <sch:naicsNavigator>
                     <sch:naicsNavigatorValue>^111419$</sch:naicsNavigatorValue>
                     <sch:naicsNavigatorDescription>111419 Other Food Crops G...</sch:naicsNavigatorDescription>
                  </sch:naicsNavigator>
                  <sch:naicsNavigator>
                     <sch:naicsNavigatorValue>^113110$</sch:naicsNavigatorValue>
                     <sch:naicsNavigatorDescription>113110 Timber Tract Opera...</sch:naicsNavigatorDescription>
                  </sch:naicsNavigator>
                  ...
                  </sch:industryNavigators>
            </sch:navigators>
         </sch:return>
      </sch:AdvancedCompanySearchResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CURL Example

curl -d '<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:AdvancedCompanySearchRequest>
         <ns0:bal>
            <ns0:maxRecords>10</ns0:maxRecords>
            <ns0:hitOffset>0</ns0:hitOffset>
            <ns0:sortDirection>Ascending</ns0:sortDirection>
            <ns0:companySize>
               <ns0:employeesFrom>10</ns0:employeesFrom>
               <ns0:employeesTo>999</ns0:employeesTo>
            </ns0:companySize>
            <ns0:companyType>
               <ns0:locationType>1</ns0:locationType>
            </ns0:companyType>
            <ns0:financialData>
               <ns0:assetsFrom>1</ns0:assetsFrom>
            </ns0:financialData>
            <ns0:industry>
               <ns0:primaryOnly>false</ns0:primaryOnly>
               <ns0:uSSIC>08</ns0:uSSIC>
            </ns0:industry>
            <ns0:location>
               <ns0:countryId>76</ns0:countryId>
            </ns0:location>
            <ns0:specialtyCriteria>
               <ns0:legalStatus>Corporation</ns0:legalStatus>
            </ns0:specialtyCriteria>
            <ns0:orderBy>SalesUS</ns0:orderBy>
            <ns0:returnSearchNavigation>true</ns0:returnSearchNavigation>
         </ns0:bal>
      </ns0:AdvancedCompanySearchRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>' -H "SOAPAction: sch:AdvancedCompanySearch" -H "Content-Type: text/xml" -i 'http://dnbdirect-api.dnb.com/DnBAPI-17'

AdvancedCompanySearchOptionalData Included in Base Package

Returns search result of companies based on various criteria.

Request

Element Type Notes
bal Required
bal​.maxRecords integer Maximum records to retrieve (1-200).
bal​.hitOffset integer Zero-based offset used to indicate at what record to start returning results.
bal​.sortDirection string Sort direction types are Ascending or Descending Available Values:
Ascending
Descending
bal​.companySize CompanySize
bal​.companySize​.employeesFrom long Employees Lower Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
bal​.companySize​.employeesTo long Employees Upper Bound. The definition of employee depends on which part of the organization is referenced in the family tree.
bal​.companySize​.employeesGrowthFrom double Total Employees Growth Percentage Lower Bound
bal​.companySize​.employeesGrowthTo double Total Employees Growth Percentage Upper Bound
bal​.companySize​.employeesThisLocationFrom long Employees at this Location Lower Bound
bal​.companySize​.employeesThisLocationTo long Employees at this Location Upper Bound
bal​.companySize​.marketCapFrom decimal 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.
bal​.companySize​.marketCapTo decimal 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.
bal​.companySize​.salesFrom decimal Annual Sales ($ mil) Lower Bound
bal​.companySize​.salesTo decimal Annual Sales ($ mil) Upper Bound
bal​.companySize​.salesGrowthFrom double Annual Sales Growth (%) Lower Bound
bal​.companySize​.salesGrowthTo double Annual Sales Growth (%) Upper Bound
bal​.companyType CompanyType 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.
bal​.companyType​.locationType Array of integer Company Location Type such as Single Location (0), Headquarters (1), Branch (2), Branch/Division (4), Subsidiary (5)
bal​.companyType​.ownershipType Array of integer 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).
bal​.companyType​.subsidiaryStatus Array of integer 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).
bal​.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.
bal​.financialData FinancialData
bal​.financialData​.advertisingExpenseFrom decimal Advertising Expense (expressed in millions of US Dollars) Lower Bound
bal​.financialData​.advertisingExpenseTo decimal Advertising Expense (expressed in millions of US Dollars) Upper Bound
bal​.financialData​.assetsFrom decimal Assets (expressed in millions of US Dollars) Lower Bound
bal​.financialData​.assetsTo decimal Assets (expressed in millions of US Dollars) Upper Bound
bal​.financialData​.filingDateFrom date Filing Date Lower Bound
bal​.financialData​.filingDateTo date Filing Date Upper Bound
bal​.financialData​.fiscalYearEnd Array of long The month the fiscal year ends. Not all financial fiscal year ranges end in December, for example.
bal​.financialData​.incomeFrom decimal Net Income (expressed in millions of US Dollars) Lower Bound
bal​.financialData​.incomeGrowthFrom double Net Income Growth (%) Lower Bound
bal​.financialData​.incomeGrowthTo double Net Income Growth (%) Upper Bound
bal​.financialData​.incomeTo decimal Net Income (expressed in millions of US Dollars) Upper Bound
bal​.financialData​.offerFrom decimal US IPO Data - Offer Amount (expressed in milions of USD) Lower Bound
bal​.financialData​.offerTo decimal US IPO Data - Offer Amount (expressed in milions of USD) Upper Bound
bal​.financialData​.priceRangeFrom decimal US IPO Data - Price Range ($) Lower Bound
bal​.financialData​.priceRangeTo decimal US IPO Data - Price Range ($) Upper Bound
bal​.financialData​.researchExpenseFrom decimal R&D Expense ($ mil) Lower Bound
bal​.financialData​.researchExpenseTo decimal R&D Expense ($ mil) Upper Bound
bal​.financialData​.tradingDateFrom date Trading Date Lower Bound
bal​.financialData​.tradingDateTo date Trading Date Upper Bound
bal​.financialData​.underwriterId Array of long 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.
bal​.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
bal​.industry Industry
bal​.industry​.dnbIndustryCode Array of integer D&B Industry Code
bal​.industry​.primaryOnly boolean Restricts the search to only the primary company industry
bal​.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.
bal​.industry​.nAICSRange Array of StringRange
bal​.industry​.nAICSRange[]​.from string NAICS Code Range Lower Bound
bal​.industry​.nAICSRange[]​.to string NAICS Code Range Upper Bound
bal​.industry​.uSSIC Array of string US SIC Code: "SIC" (Standard Industrial Classification) is an industry code system developed by the US Government.
bal​.industry​.uSSICRange Array of StringRange
bal​.industry​.uSSICRange[]​.from string SIC Code Range Lower Bound
bal​.industry​.uSSICRange[]​.to string SIC Code Range Upper Bound
bal​.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.
bal​.industry​.uKSICRange Array of StringRange
bal​.industry​.uKSICRange[]​.from string UKSIC Code Range Lower Bound
bal​.industry​.uKSICRange[]​.to string UKSIC Code Range Upper Bound
bal​.location CompanyLocation Type of location for the company; headquarters, branch office, etc.
bal​.location​.areaCode Array of string US or Canadian Phone Number Area Code
bal​.location​.streetAddress Array of string Street Address
bal​.location​.county Array of County Company County
bal​.location​.county[]​.countyId string County ID
bal​.location​.county[]​.state string State
bal​.location​.county[]​.countryId long Country ID - D&B-assigned code which identifies the country where the business is located.
bal​.location​.city Array of string City
bal​.location​.countryId Array of long Country ID - D&B-assigned code which identifies the country where the business is located.
bal​.location​.globalState Array of string Global State/Province
bal​.location​.metropolitanId Array of long US Metropolitan Area
bal​.location​.regionId Array of long D&B world region code which identifies the region where the business is located.
bal​.location​.usStateCanadaProvince Array of string US State/Canada Province
bal​.location​.postalCode Array of string Postal Code
bal​.location​.usZipCodeRange Array of Range
bal​.location​.usZipCodeRange[]​.from long US ZIP Code Range Lower Bound
bal​.location​.usZipCodeRange[]​.to long US ZIP Code Range Upper Bound
bal​.location​.zipAreaSearch ZipAreaSearch
bal​.location​.zipAreaSearch​.scale string Units to search in: miles or kilometers Available Values:
miles
kilometers
bal​.location​.zipAreaSearch​.radius double Number of miles or kilometers to search within
bal​.location​.zipAreaSearch​.zipCode string Zipcode to search within (78745 in the example)
bal​.location​.latLongSearch LatLongSearch
bal​.location​.latLongSearch​.scale string Units to search in: miles or kilometers Available Values:
miles
kilometers
bal​.location​.latLongSearch​.radius double Number of miles or kilometers to search within
bal​.location​.latLongSearch​.latitude double
bal​.location​.latLongSearch​.longitude double Longitude component of geo location
bal​.location​.allAny string Denotes whether all or any company location criteria are matched Available Values:
all
any
bal​.location​.ukCounty Array of string UK County name
bal​.specialtyCriteria SpecialtyCriteria
bal​.specialtyCriteria​.auditorId Array of long Obtain the Auditors ID value from the GetAdvancedSearchLookups call. Example: 'id' 1551 corresponds to PricewaterhouseCoopers AB
bal​.specialtyCriteria​.companyKeyword string Company Keyword
bal​.specialtyCriteria​.duns Array of long 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]*)".
bal​.specialtyCriteria​.dunsFrom long D-U-N-S Number lower limit
bal​.specialtyCriteria​.dunsTo long D-U-N-S Number upper limit
bal​.specialtyCriteria​.fein Array of string US Federal Tax ID issued by the IRS. Unique nine-digit Federal Employer Identification Number.
bal​.specialtyCriteria​.crn Array of string Seven-digit Company Registration Number recognized by the United Kingdom
bal​.specialtyCriteria​.exchangeId Array of long The ID associated with the exchange where the company's stock is traded.
bal​.specialtyCriteria​.rankingId Array of long Ranking ID
bal​.specialtyCriteria​.ukRegistration Array of string UK Registration Number. Unique identifier assigned to UK companies by the government's Companies House. Example: 3443456
bal​.specialtyCriteria​.ukVat Array of string United Kingdom's Value Added Tax Number. Example: 906565610
bal​.specialtyCriteria​.yearFoundingFrom long Year of Founding or Change in Control Lower Bound
bal​.specialtyCriteria​.yearFoundingTo long Year of Founding or Change in Control (YYYY) Upper Bound
bal​.specialtyCriteria​.ultimateParentDuns Array of long The ultimate parent company D-U-N-S Number for a family of companies
bal​.specialtyCriteria​.primaryUrl Array of string Primary URL for the company
bal​.specialtyCriteria​.mustContainPrimaryUrl boolean
bal​.specialtyCriteria​.companyName string Company Name
bal​.specialtyCriteria​.stockTicker Array of string Stock Ticker
bal​.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.
bal​.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.
bal​.specialtyCriteria​.squareFootageFrom long Company square foot range from
bal​.specialtyCriteria​.squareFootageTo long Company square foot range to
bal​.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
bal​.specialtyCriteria​.legalStatus Array of string Legal Status of the company Available Values:
Corporation
Partnership
Proprietorship
NationalGovernmentEntity
RegionalLocalGovernmentEntity
JointVenture
NonProfitOrganization
CooperativeMutualOrganization
ForeignCompany
bal​.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
bal​.specialtyCriteria​.importer boolean Importer flag which identifies whether or not a company imports for re-manufacture or sale
bal​.specialtyCriteria​.exporter boolean Exporter flag which identifies whether or not a company exports products to other countries.
bal​.nonMarketableCompanyFilterOptions NonMarketableFilterOptions
bal​.nonMarketableCompanyFilterOptions​.includeUndeliverableAddress boolean If true, will return all the unmarketable company records which have undeliverable addresses.
bal​.nonMarketableCompanyFilterOptions​.includeOutOfBusiness boolean If true, will return all the unmarketable company records that are out of business.
bal​.nonMarketableCompanyFilterOptions​.includeIncompleteData boolean If true, will return all the unmarketable company records which have incomplete data.
bal​.nonMarketableCompanyFilterOptions​.includeDoNotMarketTo boolean If true, will return all the unmarketable company records which indicated do not market to.
bal​.nonMarketableCompanyFilterOptions​.includeAll boolean New for 1.7
bal​.orderBy BaseOrderByTypes Order by orderByTypes: CompanyName, CompanyType, CountryName, CityName, StateName, PhoneNumber, FaxNumber, SalesGrowth12Mon, TotalAssets, SalesUS, EmployeesTotal, EmployeesHere, FiscalYearEndMonth, MarketCap, NetIncomeGrowth12Mon, EmployeeGrowth12Mon, ROE, ROA, EarningsComparison, BookValueComparison, NetIncome, PersonFirstName, PersonLastName, PersonTitle Available Values:
CompanyName
CompanyType
CountryName
CityName
StateName
PhoneNumber
FaxNumber
SalesGrowth12Mon
TotalAssets
SalesUS
EmployeesTotal
EmployeesHere
FiscalYearEndMonth
MarketCap
NetIncomeGrowth12Mon
EmployeeGrowth12Mon
ROE
ROA
EarningsComparison
BookValueComparison
NetIncome
None
bal​.optionalResponseFields OptionalResponseFields
bal​.optionalResponseFields​.includeHistoricalInfo boolean Optional Response Field to indicate that the historical information should be returned with in the results
bal​.optionalResponseFields​.includeGeoLocationInfo boolean Optional Response Field to indicate that geo location information should be returned with in the results
bal​.optionalResponseFields​.includeExchangeInfo boolean Optional Response Field to indicate that Exchange information should be returned with in the results
bal​.optionalResponseFields​.includeOptionalCompanyInfo boolean Optional Response Field to indicate that Optional Company information should be returned with in the results
bal​.returnSearchNavigation boolean If set to true, navigators will be returned in the response which can be used to enable drill down into search results for additional refinement. Navigators are additional criteria available for a set of results.
bal​.searchNavigation SearchNavigation
bal​.searchNavigation​.employeeSearchNavigation EmployeeSearchNavigation
bal​.searchNavigation​.employeeSearchNavigation​.employeeSearchNavigationValue Array of string An employee navigation link that can be fed back into other calls
bal​.searchNavigation​.ownershipTypeSearchNavigation OwnershipTypeSearchNavigation
bal​.searchNavigation​.ownershipTypeSearchNavigation​.ownershipTypeSearchNavigationValue Array of string
bal​.searchNavigation​.locationTypeSearchNavigation LocationTypeSearchNavigation
bal​.searchNavigation​.locationTypeSearchNavigation​.locationTypeSearchNavigationValue Array of string A location type navigation link that can be fed back into other calls
bal​.searchNavigation​.salesSearchNavigation SalesSearchNavigation
bal​.searchNavigation​.salesSearchNavigation​.salesSearchNavigationValue Array of string A sales navigation link that can be fed back into other calls
bal​.searchNavigation​.locationSearchNavigation LocationSearchNavigation
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation Array of CountryNavigation
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.countryNavigationValue string A country navigation link that can be fed back into other calls.
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation Array of StateNavigation
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.stateNavigationValue string A state/province navigation link that can be fed back into other calls.
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation Array of CityNavigation
bal​.searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation[]​.cityNavigationValue string A city navigation link that can be fed back into other calls
bal​.searchNavigation​.industrySearchNavigation IndustrySearchNavigation
bal​.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.
bal​.searchNavigation​.industrySearchNavigation​.ussicSearchNavigationValue Array of string A US SIC navigation link that can be fed back into other calls.
bal​.searchNavigation​.industrySearchNavigation​.naicsSearchNavigationValue Array of string A NAICS navigation link that can be fed back into other calls.

Response

Element Type Notes
return CompanyOptionalDataResponseWrapper
return​.companies
return​.companies​.firstHit integer First Hit
return​.companies​.hits integer The total number of hits in this response.
return​.companies​.lastHit integer 1-based last hit number
return​.companies​.totalHits integer
return​.companies​.hit Array of CompanySearchOptionalDataResultHit
return​.companies​.hit[]​.hitNumber integer The hit number indicates the result number in the search.
return​.companies​.hit[]​.companyResults CompanyResultOptionalDataFields Company Results
return​.companies​.hit[]​.companyResults​.primaryContact string
return​.companies​.hit[]​.companyResults​.primaryContactTitle string
return​.companies​.hit[]​.companyResults​.primaryUSSIC string Primary US SIC Code. "SIC" (Standard Industrial Classification) is an industry code system developed by the US Government. 2 to 8 digit SIC codes are supported.
return​.companies​.hit[]​.companyResults​.primaryUSSICDescription string
return​.companies​.hit[]​.companyResults​.numberOfEmployeesTotal integer
return​.companies​.hit[]​.companyResults​.historicalInfo HistoricalInfo
return​.companies​.hit[]​.companyResults​.geoLocationInfo GeoLocationInfo
return​.companies​.hit[]​.companyResults​.exchangeInfoList ExchangeInfoList
return​.companies​.hit[]​.companyResults​.optionalCompanyInfo OptionalCompanyInfo
return​.navigators CompanyNavigators Contains lists of navigation links
return​.navigators​.employeeNavigators EmployeeNavigators
return​.navigators​.employeeNavigators​.employeeNavigator Array of EmployeeNavigator
return​.navigators​.employeeNavigators​.employeeNavigator[]​.employeeNavigatorValue string
return​.navigators​.employeeNavigators​.employeeNavigator[]​.employeeNavigatorDescription string
return​.navigators​.locationTypeNavigators LocationTypeNavigators
return​.navigators​.locationTypeNavigators​.locationTypeNavigator Array of LocationTypeNavigator
return​.navigators​.locationTypeNavigators​.locationTypeNavigator[]​.locationTypeNavigatorValue string
return​.navigators​.locationTypeNavigators​.locationTypeNavigator[]​.locationTypeNavigatorDescription string
return​.navigators​.ownershipTypeNavigators OwnershipTypeNavigators
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator Array of OwnershipTypeNavigator
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator[]​.ownershipTypeNavigatorValue string
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator[]​.ownershipTypeNavigatorDescription string
return​.navigators​.salesNavigators SalesNavigators
return​.navigators​.salesNavigators​.salesNavigator Array of SalesNavigator
return​.navigators​.salesNavigators​.salesNavigator[]​.salesNavigatorValue string
return​.navigators​.salesNavigators​.salesNavigator[]​.salesNavigatorDescription string
return​.navigators​.locationNavigators LocationNavigators
return​.navigators​.locationNavigators​.countryNavigators CountryNavigators
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator Array of CountryNavigator
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.countryNavigatorValue string The value of a navigation link for country
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.countryNavigatorDescription string The description of a navigation link for country description
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.stateProvinceNavigators StateProvinceNavigators
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.stateProvinceNavigators​.stateProvinceNavigator Array of StateProvinceNavigator
return​.navigators​.industryNavigators IndustryNavigators
return​.navigators​.industryNavigators​.industryNavigator Array of IndustryNavigator
return​.navigators​.industryNavigators​.industryNavigator[]​.industryNavigatorValue string The value of a navigation link an for industry.
return​.navigators​.industryNavigators​.industryNavigator[]​.industryNavigatorDescription string The description of a navigation link for industry.
return​.navigators​.industryNavigators​.ussicNavigator Array of UsSicNavigator
return​.navigators​.industryNavigators​.ussicNavigator[]​.ussicNavigatorValue string The value of a navigation link for US SIC
return​.navigators​.industryNavigators​.ussicNavigator[]​.ussicNavigatorDescription string The description of a navigation link for US SIC
return​.navigators​.industryNavigators​.naicsNavigator Array of NaicsNavigator
return​.navigators​.industryNavigators​.naicsNavigator[]​.naicsNavigatorValue string The value of a navigation link for NAICS
return​.navigators​.industryNavigators​.naicsNavigator[]​.naicsNavigatorDescription string The description of a navigation link for NAICS

Sample Request XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:AdvancedCompanySearchOptionalDataRequest>
         <ns0:bal>
            <ns0:maxRecords>10</ns0:maxRecords>
            <ns0:hitOffset>0</ns0:hitOffset>
            <ns0:sortDirection>Ascending</ns0:sortDirection>
            <ns0:companySize>
               <ns0:employeesFrom>10</ns0:employeesFrom>
               <ns0:employeesTo>999</ns0:employeesTo>
            </ns0:companySize>
            <ns0:companyType>
               <ns0:locationType>1</ns0:locationType>
            </ns0:companyType>
            <ns0:financialData>
               <ns0:assetsFrom>1</ns0:assetsFrom>
            </ns0:financialData>
            <ns0:industry>
               <ns0:primaryOnly>false</ns0:primaryOnly>
               <ns0:uSSIC>08</ns0:uSSIC>
            </ns0:industry>
            <ns0:location>
               <ns0:countryId>76</ns0:countryId>
            </ns0:location>
            <ns0:specialtyCriteria>
               <ns0:legalStatus>Corporation</ns0:legalStatus>
            </ns0:specialtyCriteria>
            <ns0:orderBy>SalesUS</ns0:orderBy>
            <ns0:optionalResponseFields>
               <ns0:includeHistoricalInfo>true</ns0:includeHistoricalInfo>
               <ns0:includeGeoLocationInfo>true</ns0:includeGeoLocationInfo>
               <ns0:includeExchangeInfo>false</ns0:includeExchangeInfo>
            </ns0:optionalResponseFields>
            <ns0:returnSearchNavigation>true</ns0:returnSearchNavigation>
         </ns0:bal>
      </ns0:AdvancedCompanySearchOptionalDataRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>

Sample Response XML

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope>
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <sch:AdvancedCompanySearchOptionalDataResponse>
         <sch:return>
            <sch:companies>
               <sch:firstHit>1</sch:firstHit>
               <sch:hits>4</sch:hits>
               <sch:lastHit>4</sch:lastHit>
               <sch:totalHits>4</sch:totalHits>
               <sch:hit>
                  <sch:hitNumber>1</sch:hitNumber>
                  <sch:companyResults>
                     <sch:companyId>180821000000000</sch:companyId>
                     <sch:duns>112491555</sch:duns>
                     <sch:companyName>Plandai Biotechnology, In...</sch:companyName>
                     <sch:locationType>Headquarters</sch:locationType>
                     <sch:address1>1451 N 200 E Ste 130c</sch:address1>
                     <sch:city>Logan</sch:city>
                     <sch:country>United States</sch:country>
                     <sch:countryId>76</sch:countryId>
                     <sch:stateOrProvince>UT</sch:stateOrProvince>
                     <sch:postalCode>84341-7576</sch:postalCode>
                     <sch:primaryUrl/>
                     <sch:parentDuns>112491555</sch:parentDuns>
                     <sch:parentName>Plandai Biotechnology, In...</sch:parentName>
                     <sch:ultimateParentDuns>112491555</sch:ultimateParentDuns>
                     <sch:ultimateParentName>Plandai Biotechnology, In...</sch:ultimateParentName>
                     <sch:sales>0.265748</sch:sales>
                     <sch:hqPhone>801-209-1227</sch:hqPhone>
                     <sch:doNotCallRegistry>false</sch:doNotCallRegistry>
                     <sch:dbas/>
                     <sch:historicalIndicator>false</sch:historicalIndicator>
                     <sch:familyTreeSize>3</sch:familyTreeSize>
                     <sch:employeesTotal>100</sch:employeesTotal>
                     <sch:ownershipTypeValue>1</sch:ownershipTypeValue>
                     <sch:ownershipTypeDescription>PUBLIC</sch:ownershipTypeDescription>
                     <sch:companyTypeValue>1</sch:companyTypeValue>
                     <sch:companyTypeDescription>PUBLIC</sch:companyTypeDescription>
                     <sch:primaryContact>Roger Duffield</sch:primaryContact>
                     <sch:primaryContactTitle>Chb-pres-sec-cfo</sch:primaryContactTitle>
                     <sch:primaryUSSIC>01829901</sch:primaryUSSIC>
                     <sch:primaryUSSICDescription>Fruits, grown under cover</sch:primaryUSSICDescription>
                     <sch:numberOfEmployeesTotal>100</sch:numberOfEmployeesTotal>
                     <sch:historicalInfo xsi:nil="true"/>
                     <sch:geoLocationInfo>
                        <sch:latitude>41.75826</sch:latitude>
                        <sch:longitude>-111.829181</sch:longitude>
                        <sch:latLongAccuracy>0</sch:latLongAccuracy>
                     </sch:geoLocationInfo>
                  </sch:companyResults>
               </sch:hit>
               <sch:hit>
                  <sch:hitNumber>2</sch:hitNumber>
                  <sch:companyResults>
                     <sch:companyId>53173000000000</sch:companyId>
                     <sch:duns>006902878</sch:duns>
                     <sch:companyName>DELTIC TIMBER CORPORATION</sch:companyName>
                     <sch:locationType>Headquarters</sch:locationType>
                     <sch:address1>210 E Elm St</sch:address1>
                     <sch:city>El Dorado</sch:city>
                     <sch:country>United States</sch:country>
                     <sch:countryId>76</sch:countryId>
                     <sch:stateOrProvince>AR</sch:stateOrProvince>
                     <sch:postalCode>71730-6104</sch:postalCode>
                     <sch:primaryUrl>http://www.deltic.com</sch:primaryUrl>
                     <sch:parentDuns>006902878</sch:parentDuns>
                     <sch:parentName>DELTIC TIMBER CORPORATION</sch:parentName>
                     <sch:ultimateParentDuns>006902878</sch:ultimateParentDuns>
                     <sch:ultimateParentName>DELTIC TIMBER CORPORATION</sch:ultimateParentName>
                     <sch:sales>227.355</sch:sales>
                     <sch:hqPhone>870-881-9400</sch:hqPhone>
                     <sch:doNotCallRegistry>false</sch:doNotCallRegistry>
                     <sch:dbas>
                        <sch:dba>Deltic</sch:dba>
                     </sch:dbas>
                     <sch:historicalIndicator>false</sch:historicalIndicator>
                     <sch:familyTreeSize>15</sch:familyTreeSize>
                     <sch:employeesTotal>541</sch:employeesTotal>
                     <sch:ownershipTypeValue>1</sch:ownershipTypeValue>
                     <sch:ownershipTypeDescription>PUBLIC</sch:ownershipTypeDescription>
                     <sch:companyTypeValue>1</sch:companyTypeValue>
                     <sch:companyTypeDescription>PUBLIC</sch:companyTypeDescription>
                     <sch:primaryContact>Robert C. Nolan</sch:primaryContact>
                     <sch:primaryContactTitle>Chairman</sch:primaryContactTitle>
                     <sch:primaryUSSIC>08110000</sch:primaryUSSIC>
                     <sch:primaryUSSICDescription>Timber tracts</sch:primaryUSSICDescription>
                     <sch:numberOfEmployeesTotal>541</sch:numberOfEmployeesTotal>
                     <sch:historicalInfo xsi:nil="true"/>
                     <sch:geoLocationInfo>
                        <sch:latitude>33.212699</sch:latitude>
                        <sch:longitude>-92.662665</sch:longitude>
                        <sch:latLongAccuracy>0</sch:latLongAccuracy>
                     </sch:geoLocationInfo>
                  </sch:companyResults>
               </sch:hit>
               ...
               </sch:companies>
            <sch:navigators>
               <sch:employeeNavigators>
                  <sch:employeeNavigator>
                     <sch:employeeNavigatorValue>[;4]</sch:employeeNavigatorValue>
                     <sch:employeeNavigatorDescription>&lt; 4 (0)</sch:employeeNavigatorDescription>
                  </sch:employeeNavigator>
                  <sch:employeeNavigator>
                     <sch:employeeNavigatorValue>[5;10]</sch:employeeNavigatorValue>
                     <sch:employeeNavigatorDescription>5-10 (0)</sch:employeeNavigatorDescription>
                  </sch:employeeNavigator>
                  ...
                  </sch:employeeNavigators>
               <sch:locationTypeNavigators>
                  <sch:locationTypeNavigator>
                     <sch:locationTypeNavigatorValue>1</sch:locationTypeNavigatorValue>
                     <sch:locationTypeNavigatorDescription>Headquarters (4)</sch:locationTypeNavigatorDescription>
                  </sch:locationTypeNavigator>
               </sch:locationTypeNavigators>
               <sch:ownershipTypeNavigators>
                  <sch:ownershipTypeNavigator>
                     <sch:ownershipTypeNavigatorValue>1</sch:ownershipTypeNavigatorValue>
                     <sch:ownershipTypeNavigatorDescription>Public (4)</sch:ownershipTypeNavigatorDescription>
                  </sch:ownershipTypeNavigator>
               </sch:ownershipTypeNavigators>
               <sch:salesNavigators>
                  <sch:salesNavigator>
                     <sch:salesNavigatorValue>[;1&gt;</sch:salesNavigatorValue>
                     <sch:salesNavigatorDescription>&lt; $1 million (1)</sch:salesNavigatorDescription>
                  </sch:salesNavigator>
                  <sch:salesNavigator>
                     <sch:salesNavigatorValue>[1;5&gt;</sch:salesNavigatorValue>
                     <sch:salesNavigatorDescription>$1 - $5 million (0)</sch:salesNavigatorDescription>
                  </sch:salesNavigator>
                  ...
                  </sch:salesNavigators>
               <sch:locationNavigators>
                  <sch:countryNavigators>
                     <sch:countryNavigator>
                        <sch:countryNavigatorValue>76</sch:countryNavigatorValue>
                        <sch:countryNavigatorDescription>United States (4)</sch:countryNavigatorDescription>
                        <sch:stateProvinceNavigators>
                           <sch:stateProvinceNavigator>
                              <sch:stateProvinceNavigatorValue>AR~76</sch:stateProvinceNavigatorValue>
                              <sch:stateProvinceNavigatorDescription>AR (1)</sch:stateProvinceNavigatorDescription>
                              <sch:cityNavigators>
                                 <sch:cityNavigator>
                                    <sch:cityNavigatorValue>"El Dorado~AR~76"</sch:cityNavigatorValue>
                                    <sch:cityNavigatorDescription>El Dorado, AR United Stat...</sch:cityNavigatorDescription>
                                 </sch:cityNavigator>
                              </sch:cityNavigators>
                           </sch:stateProvinceNavigator>
                           <sch:stateProvinceNavigator>
                              <sch:stateProvinceNavigatorValue>FL~76</sch:stateProvinceNavigatorValue>
                              <sch:stateProvinceNavigatorDescription>FL (1)</sch:stateProvinceNavigatorDescription>
                              <sch:cityNavigators>
                                 <sch:cityNavigator>
                                    <sch:cityNavigatorValue>Watersound~FL~76</sch:cityNavigatorValue>
                                    <sch:cityNavigatorDescription>Watersound, FL United Sta...</sch:cityNavigatorDescription>
                                 </sch:cityNavigator>
                              </sch:cityNavigators>
                           </sch:stateProvinceNavigator>
                           ...
                           </sch:stateProvinceNavigators>
                     </sch:countryNavigator>
                  </sch:countryNavigators>
               </sch:locationNavigators>
               <sch:industryNavigators>
                  <sch:industryNavigator>
                     <sch:industryNavigatorValue>1015</sch:industryNavigatorValue>
                     <sch:industryNavigatorDescription>Crop Production (1)</sch:industryNavigatorDescription>
                  </sch:industryNavigator>
                  <sch:industryNavigator>
                     <sch:industryNavigatorValue>1503</sch:industryNavigatorValue>
                     <sch:industryNavigatorDescription>Real Estate Investment Tr...</sch:industryNavigatorDescription>
                  </sch:industryNavigator>
                  ...
                  <sch:ussicNavigator>
                     <sch:ussicNavigatorValue>^01829901$</sch:ussicNavigatorValue>
                     <sch:ussicNavigatorDescription>01829901 Fruits, grown un...</sch:ussicNavigatorDescription>
                  </sch:ussicNavigator>
                  <sch:ussicNavigator>
                     <sch:ussicNavigatorValue>^08110000$</sch:ussicNavigatorValue>
                     <sch:ussicNavigatorDescription>08110000 Timber tracts (1...</sch:ussicNavigatorDescription>
                  </sch:ussicNavigator>
                  ...
                  <sch:naicsNavigator>
                     <sch:naicsNavigatorValue>^111419$</sch:naicsNavigatorValue>
                     <sch:naicsNavigatorDescription>111419 Other Food Crops G...</sch:naicsNavigatorDescription>
                  </sch:naicsNavigator>
                  <sch:naicsNavigator>
                     <sch:naicsNavigatorValue>^113110$</sch:naicsNavigatorValue>
                     <sch:naicsNavigatorDescription>113110 Timber Tract Opera...</sch:naicsNavigatorDescription>
                  </sch:naicsNavigator>
                  ...
                  </sch:industryNavigators>
            </sch:navigators>
         </sch:return>
      </sch:AdvancedCompanySearchOptionalDataResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CURL Example

curl -d '<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:AdvancedCompanySearchOptionalDataRequest>
         <ns0:bal>
            <ns0:maxRecords>10</ns0:maxRecords>
            <ns0:hitOffset>0</ns0:hitOffset>
            <ns0:sortDirection>Ascending</ns0:sortDirection>
            <ns0:companySize>
               <ns0:employeesFrom>10</ns0:employeesFrom>
               <ns0:employeesTo>999</ns0:employeesTo>
            </ns0:companySize>
            <ns0:companyType>
               <ns0:locationType>1</ns0:locationType>
            </ns0:companyType>
            <ns0:financialData>
               <ns0:assetsFrom>1</ns0:assetsFrom>
            </ns0:financialData>
            <ns0:industry>
               <ns0:primaryOnly>false</ns0:primaryOnly>
               <ns0:uSSIC>08</ns0:uSSIC>
            </ns0:industry>
            <ns0:location>
               <ns0:countryId>76</ns0:countryId>
            </ns0:location>
            <ns0:specialtyCriteria>
               <ns0:legalStatus>Corporation</ns0:legalStatus>
            </ns0:specialtyCriteria>
            <ns0:orderBy>SalesUS</ns0:orderBy>
            <ns0:optionalResponseFields>
               <ns0:includeHistoricalInfo>true</ns0:includeHistoricalInfo>
               <ns0:includeGeoLocationInfo>true</ns0:includeGeoLocationInfo>
               <ns0:includeExchangeInfo>false</ns0:includeExchangeInfo>
            </ns0:optionalResponseFields>
            <ns0:returnSearchNavigation>true</ns0:returnSearchNavigation>
         </ns0:bal>
      </ns0:AdvancedCompanySearchOptionalDataRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>' -H "SOAPAction: sch:AdvancedCompanySearchOptionalData" -H "Content-Type: text/xml" -i 'http://dnbdirect-api.dnb.com/DnBAPI-17'

CleanseAndStandardize Available in Add-on: Match Service

Request

Element Type Notes
TransactionDetail RequestTransactionDetail Records information necessary to process this request.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.TransactionTimestamp dateTime The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionDetail​.SubmittingOfficeID string (up to 64 characters) For internal D&B use. A default value is used. A number that identifies the system or the software application from where this request originated. / A number used to uniquely identify the D&B business segment or delivery channel from where this request originated.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.TransactionTimestamp dateTime The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionDetail​.SubmittingOfficeID string (up to 64 characters) For internal D&B use. A default value is used. A number that identifies the system or the software application from where this request originated. / A number used to uniquely identify the D&B business segment or delivery channel from where this request originated.
ServiceVersionNumber string (up to 10 characters) Required A number assigned by D&B which either uniquely identifies or helps to identify the state of this software deliverable. These numbers are generally assigned in increasing order and correspond to new releases in the software such as "2.0".
TransactionDetail RequestTransactionDetail Records information necessary to process this request.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.TransactionTimestamp dateTime The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionDetail​.SubmittingOfficeID string (up to 64 characters) For internal D&B use. A default value is used. A number that identifies the system or the software application from where this request originated. / A number used to uniquely identify the D&B business segment or delivery channel from where this request originated.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.TransactionTimestamp dateTime The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionDetail​.SubmittingOfficeID string (up to 64 characters) For internal D&B use. A default value is used. A number that identifies the system or the software application from where this request originated. / A number used to uniquely identify the D&B business segment or delivery channel from where this request originated.
ServiceVersionNumber string (up to 10 characters) Required A number assigned by D&B which either uniquely identifies or helps to identify the state of this software deliverable. These numbers are generally assigned in increasing order and correspond to new releases in the software such as "2.0".
CleanseAndStandardizeRequestDetail CleanseAndStandardizeRequestDetail Required
CleanseAndStandardizeRequestDetail​.InquiryDetail CleanseAndStandardizeInquiryDetail Required Records data that allows the customer to specify identifying information about the subject being inquired such as the DUNS Number, the address, the telephone number.
CleanseAndStandardizeRequestDetail​.InquiryDetail​.OrganizationName DNBStringType256
CleanseAndStandardizeRequestDetail​.InquiryDetail​.OrganizationName​.LanguageCode integer
CleanseAndStandardizeRequestDetail​.InquiryDetail​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
CleanseAndStandardizeRequestDetail​.InquiryDetail​.OrganizationName​.LanguageCode integer
CleanseAndStandardizeRequestDetail​.InquiryDetail​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
CleanseAndStandardizeRequestDetail​.InquiryDetail​.Address CleanseAndStandardizeRequestAddress (1-64 characters) Required Physical street address of the business
CleanseAndStandardizeRequestDetail​.InquiryDetail​.Address​.StreetAddressLine Array of StreetAddressLine Max array length: 2
CleanseAndStandardizeRequestDetail​.InquiryDetail​.Address​.StreetAddressLine[]​.LineText string (up to 240 characters)
CleanseAndStandardizeRequestDetail​.InquiryDetail​.Address​.PrimaryTownName string (up to 64 characters)
CleanseAndStandardizeRequestDetail​.InquiryDetail​.Address​.CountryISOAlpha2Code 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
CleanseAndStandardizeRequestDetail​.InquiryDetail​.Address​.CountyName string (up to 64 characters)
CleanseAndStandardizeRequestDetail​.InquiryDetail​.Address​.TerritoryName string (up to 64 characters)
CleanseAndStandardizeRequestDetail​.InquiryDetail​.Address​.PostalCode string (up to 32 characters) Postal Code
CleanseAndStandardizeRequestDetail​.InquiryReferenceDetail InquiryReferenceDetail Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.
CleanseAndStandardizeRequestDetail​.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
CleanseAndStandardizeRequestDetail​.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
CleanseAndStandardizeRequestDetail​.InquiryReferenceDetail​.CustomerBillingEndorsementText string (1-240 characters)
CleanseAndStandardizeRequestDetail​.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
CleanseAndStandardizeRequestDetail​.InquiryReferenceDetail​.CustomerBillingEndorsementText string (1-240 characters)

Response

Element Type Notes
TransactionResult TransactionResult Required
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultID string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultID string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultCode string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
ServiceVersionNumber string (up to 10 characters) Required A number assigned by D&B which either uniquely identifies or helps to identify the state of this software deliverable. These numbers are generally assigned in increasing order and correspond to new releases in the software such as "2.0".
TransactionDetail ResponseTransactionDetail Required Records information necessary to process this request.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.ServiceTransactionID string (up to 64 characters) Required
TransactionDetail​.TransactionTimestamp dateTime Required The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionResult TransactionResult Required
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultID string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultID string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultCode string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
ServiceVersionNumber string (up to 10 characters) Required A number assigned by D&B which either uniquely identifies or helps to identify the state of this software deliverable. These numbers are generally assigned in increasing order and correspond to new releases in the software such as "2.0".
CleanseAndStandardizeResponseDetail CleanseAndStandardizeResponseDetail
CleanseAndStandardizeResponseDetail​.InquiryDetail CleanseAndStandardizeInquiryDetail Records data that allows the customer to specify identifying information about the subject being inquired such as the DUNS Number, the address, the telephone number.
CleanseAndStandardizeResponseDetail​.InquiryDetail​.OrganizationName DNBStringType256
CleanseAndStandardizeResponseDetail​.InquiryDetail​.OrganizationName​.LanguageCode integer
CleanseAndStandardizeResponseDetail​.InquiryDetail​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
CleanseAndStandardizeResponseDetail​.InquiryDetail​.OrganizationName​.LanguageCode integer
CleanseAndStandardizeResponseDetail​.InquiryDetail​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
CleanseAndStandardizeResponseDetail​.InquiryDetail​.Address CleanseAndStandardizeRequestAddress (1-64 characters) Physical street address of the business
CleanseAndStandardizeResponseDetail​.InquiryDetail​.Address​.StreetAddressLine Array of StreetAddressLine Max array length: 2
CleanseAndStandardizeResponseDetail​.InquiryDetail​.Address​.StreetAddressLine[]​.LineText string (up to 240 characters)
CleanseAndStandardizeResponseDetail​.InquiryDetail​.Address​.PrimaryTownName string (up to 64 characters)
CleanseAndStandardizeResponseDetail​.InquiryDetail​.Address​.CountryISOAlpha2Code string (2 characters) 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
CleanseAndStandardizeResponseDetail​.InquiryDetail​.Address​.CountyName string (up to 64 characters)
CleanseAndStandardizeResponseDetail​.InquiryDetail​.Address​.TerritoryName string (up to 64 characters)
CleanseAndStandardizeResponseDetail​.InquiryDetail​.Address​.PostalCode string (up to 32 characters) Postal Code
CleanseAndStandardizeResponseDetail​.StandardizedName StandardizedNameType
CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName DNBStringType256
CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName​.LanguageCode integer
CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName​.LanguageCode integer
CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
CleanseAndStandardizeResponseDetail​.StandardizedAddress StandardizedAddress
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.StreetAddressLine Array of StreetAddressLine
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.StreetAddressLine[]​.LineText string (up to 240 characters)
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.PrimaryTownName string (up to 64 characters)
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.CountyName string (up to 64 characters)
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.TerritoryAbbreviatedName string (up to 64 characters)
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.TerritoryName string (up to 64 characters)
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.PostalCode string (up to 16 characters) Postal Code
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.PostalCodeExtensionCode string (up to 16 characters)
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.CountryISOAlpha2Code string (2 characters) 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.CountryName string (1-30 characters) Name of the country where the business is located
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.DeliveryPointValidationDetail DeliveryPointValidationDetail
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.DeliveryPointValidationDetail​.StatusValue string (up to 64 characters) Available Values:
Delivery Point Validated
DPV STE Bad
Invalid Address
Missing STE
No DPV
No DPV Address
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.DeliveryPointValidationDetail​.CMRAValue string (up to 64 characters) Available Values:
Delivery Point Validated
Invalid Address
No DPV
No DPV Address
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.AddressTypeValue string Available Values:
Firm
General Delivery
High Rise
Military
PO Box
Rural or Highway Route
Street
Unknown
CleanseAndStandardizeResponseDetail​.StandardizedAddress​.InexactAddressIndicator boolean
CleanseAndStandardizeResponseDetail​.InquiryReferenceDetail InquiryReferenceDetail Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.
CleanseAndStandardizeResponseDetail​.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
CleanseAndStandardizeResponseDetail​.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
CleanseAndStandardizeResponseDetail​.InquiryReferenceDetail​.CustomerBillingEndorsementText string (1-240 characters)
CleanseAndStandardizeResponseDetail​.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
CleanseAndStandardizeResponseDetail​.InquiryReferenceDetail​.CustomerBillingEndorsementText string (1-240 characters)

Sample Request XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:AdvancedCompanySearchOptionalDataRequest>
         <ns0:bal>
            <ns0:maxRecords>10</ns0:maxRecords>
            <ns0:hitOffset>0</ns0:hitOffset>
            <ns0:sortDirection>Ascending</ns0:sortDirection>
            <ns0:companySize>
               <ns0:employeesFrom>10</ns0:employeesFrom>
               <ns0:employeesTo>999</ns0:employeesTo>
            </ns0:companySize>
            <ns0:companyType>
               <ns0:locationType>1</ns0:locationType>
            </ns0:companyType>
            <ns0:financialData>
               <ns0:assetsFrom>1</ns0:assetsFrom>
            </ns0:financialData>
            <ns0:industry>
               <ns0:primaryOnly>false</ns0:primaryOnly>
               <ns0:uSSIC>08</ns0:uSSIC>
            </ns0:industry>
            <ns0:location>
               <ns0:countryId>76</ns0:countryId>
            </ns0:location>
            <ns0:specialtyCriteria>
               <ns0:legalStatus>Corporation</ns0:legalStatus>
            </ns0:specialtyCriteria>
            <ns0:orderBy>SalesUS</ns0:orderBy>
            <ns0:optionalResponseFields>
               <ns0:includeHistoricalInfo>true</ns0:includeHistoricalInfo>
               <ns0:includeGeoLocationInfo>true</ns0:includeGeoLocationInfo>
               <ns0:includeExchangeInfo>false</ns0:includeExchangeInfo>
            </ns0:optionalResponseFields>
            <ns0:returnSearchNavigation>true</ns0:returnSearchNavigation>
         </ns0:bal>
      </ns0:AdvancedCompanySearchOptionalDataRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>

Sample Response XML

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope>
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <sch:AdvancedCompanySearchOptionalDataResponse>
         <sch:return>
            <sch:companies>
               <sch:firstHit>1</sch:firstHit>
               <sch:hits>4</sch:hits>
               <sch:lastHit>4</sch:lastHit>
               <sch:totalHits>4</sch:totalHits>
               <sch:hit>
                  <sch:hitNumber>1</sch:hitNumber>
                  <sch:companyResults>
                     <sch:companyId>180821000000000</sch:companyId>
                     <sch:duns>112491555</sch:duns>
                     <sch:companyName>Plandai Biotechnology, In...</sch:companyName>
                     <sch:locationType>Headquarters</sch:locationType>
                     <sch:address1>1451 N 200 E Ste 130c</sch:address1>
                     <sch:city>Logan</sch:city>
                     <sch:country>United States</sch:country>
                     <sch:countryId>76</sch:countryId>
                     <sch:stateOrProvince>UT</sch:stateOrProvince>
                     <sch:postalCode>84341-7576</sch:postalCode>
                     <sch:primaryUrl/>
                     <sch:parentDuns>112491555</sch:parentDuns>
                     <sch:parentName>Plandai Biotechnology, In...</sch:parentName>
                     <sch:ultimateParentDuns>112491555</sch:ultimateParentDuns>
                     <sch:ultimateParentName>Plandai Biotechnology, In...</sch:ultimateParentName>
                     <sch:sales>0.265748</sch:sales>
                     <sch:hqPhone>801-209-1227</sch:hqPhone>
                     <sch:doNotCallRegistry>false</sch:doNotCallRegistry>
                     <sch:dbas/>
                     <sch:historicalIndicator>false</sch:historicalIndicator>
                     <sch:familyTreeSize>3</sch:familyTreeSize>
                     <sch:employeesTotal>100</sch:employeesTotal>
                     <sch:ownershipTypeValue>1</sch:ownershipTypeValue>
                     <sch:ownershipTypeDescription>PUBLIC</sch:ownershipTypeDescription>
                     <sch:companyTypeValue>1</sch:companyTypeValue>
                     <sch:companyTypeDescription>PUBLIC</sch:companyTypeDescription>
                     <sch:primaryContact>Roger Duffield</sch:primaryContact>
                     <sch:primaryContactTitle>Chb-pres-sec-cfo</sch:primaryContactTitle>
                     <sch:primaryUSSIC>01829901</sch:primaryUSSIC>
                     <sch:primaryUSSICDescription>Fruits, grown under cover</sch:primaryUSSICDescription>
                     <sch:numberOfEmployeesTotal>100</sch:numberOfEmployeesTotal>
                     <sch:historicalInfo xsi:nil="true"/>
                     <sch:geoLocationInfo>
                        <sch:latitude>41.75826</sch:latitude>
                        <sch:longitude>-111.829181</sch:longitude>
                        <sch:latLongAccuracy>0</sch:latLongAccuracy>
                     </sch:geoLocationInfo>
                  </sch:companyResults>
               </sch:hit>
               <sch:hit>
                  <sch:hitNumber>2</sch:hitNumber>
                  <sch:companyResults>
                     <sch:companyId>53173000000000</sch:companyId>
                     <sch:duns>006902878</sch:duns>
                     <sch:companyName>DELTIC TIMBER CORPORATION</sch:companyName>
                     <sch:locationType>Headquarters</sch:locationType>
                     <sch:address1>210 E Elm St</sch:address1>
                     <sch:city>El Dorado</sch:city>
                     <sch:country>United States</sch:country>
                     <sch:countryId>76</sch:countryId>
                     <sch:stateOrProvince>AR</sch:stateOrProvince>
                     <sch:postalCode>71730-6104</sch:postalCode>
                     <sch:primaryUrl>http://www.deltic.com</sch:primaryUrl>
                     <sch:parentDuns>006902878</sch:parentDuns>
                     <sch:parentName>DELTIC TIMBER CORPORATION</sch:parentName>
                     <sch:ultimateParentDuns>006902878</sch:ultimateParentDuns>
                     <sch:ultimateParentName>DELTIC TIMBER CORPORATION</sch:ultimateParentName>
                     <sch:sales>227.355</sch:sales>
                     <sch:hqPhone>870-881-9400</sch:hqPhone>
                     <sch:doNotCallRegistry>false</sch:doNotCallRegistry>
                     <sch:dbas>
                        <sch:dba>Deltic</sch:dba>
                     </sch:dbas>
                     <sch:historicalIndicator>false</sch:historicalIndicator>
                     <sch:familyTreeSize>15</sch:familyTreeSize>
                     <sch:employeesTotal>541</sch:employeesTotal>
                     <sch:ownershipTypeValue>1</sch:ownershipTypeValue>
                     <sch:ownershipTypeDescription>PUBLIC</sch:ownershipTypeDescription>
                     <sch:companyTypeValue>1</sch:companyTypeValue>
                     <sch:companyTypeDescription>PUBLIC</sch:companyTypeDescription>
                     <sch:primaryContact>Robert C. Nolan</sch:primaryContact>
                     <sch:primaryContactTitle>Chairman</sch:primaryContactTitle>
                     <sch:primaryUSSIC>08110000</sch:primaryUSSIC>
                     <sch:primaryUSSICDescription>Timber tracts</sch:primaryUSSICDescription>
                     <sch:numberOfEmployeesTotal>541</sch:numberOfEmployeesTotal>
                     <sch:historicalInfo xsi:nil="true"/>
                     <sch:geoLocationInfo>
                        <sch:latitude>33.212699</sch:latitude>
                        <sch:longitude>-92.662665</sch:longitude>
                        <sch:latLongAccuracy>0</sch:latLongAccuracy>
                     </sch:geoLocationInfo>
                  </sch:companyResults>
               </sch:hit>
               ...
               </sch:companies>
            <sch:navigators>
               <sch:employeeNavigators>
                  <sch:employeeNavigator>
                     <sch:employeeNavigatorValue>[;4]</sch:employeeNavigatorValue>
                     <sch:employeeNavigatorDescription>&lt; 4 (0)</sch:employeeNavigatorDescription>
                  </sch:employeeNavigator>
                  <sch:employeeNavigator>
                     <sch:employeeNavigatorValue>[5;10]</sch:employeeNavigatorValue>
                     <sch:employeeNavigatorDescription>5-10 (0)</sch:employeeNavigatorDescription>
                  </sch:employeeNavigator>
                  ...
                  </sch:employeeNavigators>
               <sch:locationTypeNavigators>
                  <sch:locationTypeNavigator>
                     <sch:locationTypeNavigatorValue>1</sch:locationTypeNavigatorValue>
                     <sch:locationTypeNavigatorDescription>Headquarters (4)</sch:locationTypeNavigatorDescription>
                  </sch:locationTypeNavigator>
               </sch:locationTypeNavigators>
               <sch:ownershipTypeNavigators>
                  <sch:ownershipTypeNavigator>
                     <sch:ownershipTypeNavigatorValue>1</sch:ownershipTypeNavigatorValue>
                     <sch:ownershipTypeNavigatorDescription>Public (4)</sch:ownershipTypeNavigatorDescription>
                  </sch:ownershipTypeNavigator>
               </sch:ownershipTypeNavigators>
               <sch:salesNavigators>
                  <sch:salesNavigator>
                     <sch:salesNavigatorValue>[;1&gt;</sch:salesNavigatorValue>
                     <sch:salesNavigatorDescription>&lt; $1 million (1)</sch:salesNavigatorDescription>
                  </sch:salesNavigator>
                  <sch:salesNavigator>
                     <sch:salesNavigatorValue>[1;5&gt;</sch:salesNavigatorValue>
                     <sch:salesNavigatorDescription>$1 - $5 million (0)</sch:salesNavigatorDescription>
                  </sch:salesNavigator>
                  ...
                  </sch:salesNavigators>
               <sch:locationNavigators>
                  <sch:countryNavigators>
                     <sch:countryNavigator>
                        <sch:countryNavigatorValue>76</sch:countryNavigatorValue>
                        <sch:countryNavigatorDescription>United States (4)</sch:countryNavigatorDescription>
                        <sch:stateProvinceNavigators>
                           <sch:stateProvinceNavigator>
                              <sch:stateProvinceNavigatorValue>AR~76</sch:stateProvinceNavigatorValue>
                              <sch:stateProvinceNavigatorDescription>AR (1)</sch:stateProvinceNavigatorDescription>
                              <sch:cityNavigators>
                                 <sch:cityNavigator>
                                    <sch:cityNavigatorValue>"El Dorado~AR~76"</sch:cityNavigatorValue>
                                    <sch:cityNavigatorDescription>El Dorado, AR United Stat...</sch:cityNavigatorDescription>
                                 </sch:cityNavigator>
                              </sch:cityNavigators>
                           </sch:stateProvinceNavigator>
                           <sch:stateProvinceNavigator>
                              <sch:stateProvinceNavigatorValue>FL~76</sch:stateProvinceNavigatorValue>
                              <sch:stateProvinceNavigatorDescription>FL (1)</sch:stateProvinceNavigatorDescription>
                              <sch:cityNavigators>
                                 <sch:cityNavigator>
                                    <sch:cityNavigatorValue>Watersound~FL~76</sch:cityNavigatorValue>
                                    <sch:cityNavigatorDescription>Watersound, FL United Sta...</sch:cityNavigatorDescription>
                                 </sch:cityNavigator>
                              </sch:cityNavigators>
                           </sch:stateProvinceNavigator>
                           ...
                           </sch:stateProvinceNavigators>
                     </sch:countryNavigator>
                  </sch:countryNavigators>
               </sch:locationNavigators>
               <sch:industryNavigators>
                  <sch:industryNavigator>
                     <sch:industryNavigatorValue>1015</sch:industryNavigatorValue>
                     <sch:industryNavigatorDescription>Crop Production (1)</sch:industryNavigatorDescription>
                  </sch:industryNavigator>
                  <sch:industryNavigator>
                     <sch:industryNavigatorValue>1503</sch:industryNavigatorValue>
                     <sch:industryNavigatorDescription>Real Estate Investment Tr...</sch:industryNavigatorDescription>
                  </sch:industryNavigator>
                  ...
                  <sch:ussicNavigator>
                     <sch:ussicNavigatorValue>^01829901$</sch:ussicNavigatorValue>
                     <sch:ussicNavigatorDescription>01829901 Fruits, grown un...</sch:ussicNavigatorDescription>
                  </sch:ussicNavigator>
                  <sch:ussicNavigator>
                     <sch:ussicNavigatorValue>^08110000$</sch:ussicNavigatorValue>
                     <sch:ussicNavigatorDescription>08110000 Timber tracts (1...</sch:ussicNavigatorDescription>
                  </sch:ussicNavigator>
                  ...
                  <sch:naicsNavigator>
                     <sch:naicsNavigatorValue>^111419$</sch:naicsNavigatorValue>
                     <sch:naicsNavigatorDescription>111419 Other Food Crops G...</sch:naicsNavigatorDescription>
                  </sch:naicsNavigator>
                  <sch:naicsNavigator>
                     <sch:naicsNavigatorValue>^113110$</sch:naicsNavigatorValue>
                     <sch:naicsNavigatorDescription>113110 Timber Tract Opera...</sch:naicsNavigatorDescription>
                  </sch:naicsNavigator>
                  ...
                  </sch:industryNavigators>
            </sch:navigators>
         </sch:return>
      </sch:AdvancedCompanySearchOptionalDataResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CURL Example

curl -d '<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:AdvancedCompanySearchOptionalDataRequest>
         <ns0:bal>
            <ns0:maxRecords>10</ns0:maxRecords>
            <ns0:hitOffset>0</ns0:hitOffset>
            <ns0:sortDirection>Ascending</ns0:sortDirection>
            <ns0:companySize>
               <ns0:employeesFrom>10</ns0:employeesFrom>
               <ns0:employeesTo>999</ns0:employeesTo>
            </ns0:companySize>
            <ns0:companyType>
               <ns0:locationType>1</ns0:locationType>
            </ns0:companyType>
            <ns0:financialData>
               <ns0:assetsFrom>1</ns0:assetsFrom>
            </ns0:financialData>
            <ns0:industry>
               <ns0:primaryOnly>false</ns0:primaryOnly>
               <ns0:uSSIC>08</ns0:uSSIC>
            </ns0:industry>
            <ns0:location>
               <ns0:countryId>76</ns0:countryId>
            </ns0:location>
            <ns0:specialtyCriteria>
               <ns0:legalStatus>Corporation</ns0:legalStatus>
            </ns0:specialtyCriteria>
            <ns0:orderBy>SalesUS</ns0:orderBy>
            <ns0:optionalResponseFields>
               <ns0:includeHistoricalInfo>true</ns0:includeHistoricalInfo>
               <ns0:includeGeoLocationInfo>true</ns0:includeGeoLocationInfo>
               <ns0:includeExchangeInfo>false</ns0:includeExchangeInfo>
            </ns0:optionalResponseFields>
            <ns0:returnSearchNavigation>true</ns0:returnSearchNavigation>
         </ns0:bal>
      </ns0:AdvancedCompanySearchOptionalDataRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>' -H "SOAPAction: sch:CleanseAndStandardize" -H "Content-Type: text/xml" -i 'http://dnbdirect-api.dnb.com/DnBAPI-17'

FindCompanyByKeyword Included in Base Package

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

Request

Element Type Notes
maxRecords integer Maximum records to retrieve (1-200).
hitOffset integer Zero-based offset used to indicate at what record to start returning results.
sortDirection string Sort direction types are Ascending or Descending Available Values:
Ascending
Descending
keyword string Required Keyword or phrase
dunsFrom long D-U-N-S Number lower limit
dunsTo long D-U-N-S Number upper limit
nonMarketableCompanyFilterOptions NonMarketableFilterOptions
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 New for 1.7
searchBy Array of string One of the included enumerations called SearchByFields Available Values:
companyName
stockSymbol
companyNameORstockSymbol
returnSearchNavigation boolean If set to true, navigators will be returned in the response which can be used to enable drill down into search results for additional refinement. Navigators are additional criteria available for a set of results.
orderBy BaseOrderByTypes Order by orderByTypes: CompanyName, CompanyType, CountryName, CityName, StateName, PhoneNumber, FaxNumber, SalesGrowth12Mon, TotalAssets, SalesUS, EmployeesTotal, EmployeesHere, FiscalYearEndMonth, MarketCap, NetIncomeGrowth12Mon, EmployeeGrowth12Mon, ROE, ROA, EarningsComparison, BookValueComparison, NetIncome, PersonFirstName, PersonLastName, PersonTitle Available Values:
CompanyName
CompanyType
CountryName
CityName
StateName
PhoneNumber
FaxNumber
SalesGrowth12Mon
TotalAssets
SalesUS
EmployeesTotal
EmployeesHere
FiscalYearEndMonth
MarketCap
NetIncomeGrowth12Mon
EmployeeGrowth12Mon
ROE
ROA
EarningsComparison
BookValueComparison
NetIncome
None
searchNavigation SearchNavigation
searchNavigation​.employeeSearchNavigation EmployeeSearchNavigation
searchNavigation​.employeeSearchNavigation​.employeeSearchNavigationValue Array of string An employee navigation link that can be fed back into other calls
searchNavigation​.ownershipTypeSearchNavigation OwnershipTypeSearchNavigation
searchNavigation​.ownershipTypeSearchNavigation​.ownershipTypeSearchNavigationValue Array of string
searchNavigation​.locationTypeSearchNavigation LocationTypeSearchNavigation
searchNavigation​.locationTypeSearchNavigation​.locationTypeSearchNavigationValue Array of string A location type navigation link that can be fed back into other calls
searchNavigation​.salesSearchNavigation SalesSearchNavigation
searchNavigation​.salesSearchNavigation​.salesSearchNavigationValue Array of string A sales navigation link that can be fed back into other calls
searchNavigation​.locationSearchNavigation LocationSearchNavigation
searchNavigation​.locationSearchNavigation​.countryNavigation Array of CountryNavigation
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.countryNavigationValue string A country navigation link that can be fed back into other calls.
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation Array of StateNavigation
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 CityNavigation
searchNavigation​.locationSearchNavigation​.countryNavigation[]​.stateNavigation[]​.cityNavigation[]​.cityNavigationValue string A city navigation link that can be fed back into other calls
searchNavigation​.industrySearchNavigation IndustrySearchNavigation
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.
matchBy string New for 1.7 Available Values:
contains
endsWith
exact
startsWith

Response

Element Type Notes
return
return​.resultSet CompanySearchResultSet
return​.resultSet​.firstHit integer First Hit
return​.resultSet​.hits integer The total number of hits in this response.
return​.resultSet​.lastHit integer 1-based last hit number
return​.resultSet​.totalHits integer Total number of records matching the search criteria
return​.resultSet​.hit Array of CompanySearchResultHit
return​.resultSet​.hit[]​.hitNumber integer The hit number indicates the result number in the search.
return​.resultSet​.hit[]​.companyResults CompanyResultFields Company Results
return​.resultSet​.hit[]​.companyResults​.companyName string Company Name
return​.resultSet​.hit[]​.companyResults​.nonMarketableCompany NonMarketableReasons Non-marketable company reason such as 'Invalid address', 'Out of business', 'Key data missing/needing revision', 'Requested no marketing contact'
return​.resultSet​.hit[]​.companyResults​.locationType string Company Location Type such as Single Location (0), Headquarters (1), Branch (2), Branch/Division (4), Subsidiary (5)
return​.resultSet​.hit[]​.companyResults​.address1 string (up to 150 characters) Company address line 1
return​.resultSet​.hit[]​.companyResults​.address2 string (up to 70 characters) Company address line 2
return​.resultSet​.hit[]​.companyResults​.city string City
return​.resultSet​.hit[]​.companyResults​.country string Country
return​.resultSet​.hit[]​.companyResults​.countryId integer Country ID - D&B-assigned code which identifies the country where the business is located.
return​.resultSet​.hit[]​.companyResults​.stateOrProvince string Address State/Province
return​.resultSet​.hit[]​.companyResults​.postalCode string Postal Code
return​.resultSet​.hit[]​.companyResults​.primaryUrl string Primary URL for the company
return​.resultSet​.hit[]​.companyResults​.parentDuns string The parent company D-U-N-S Number. A parent is a corporation that owns more than 50 percent of another corporation. The parent company may also be a subsidiary of another corporation. If the parent also has branches/divisions, then it is also a headquarters. Parents can have both direct and indirect subsidiaries, indirect subsidiaries being those that have another company in between the subsidiary and the parent.
return​.resultSet​.hit[]​.companyResults​.parentName string The company name of the company's immediate parent company.
return​.resultSet​.hit[]​.companyResults​.ultimateParentDuns string The ultimate parent company D-U-N-S Number for a family of companies
return​.resultSet​.hit[]​.companyResults​.ultimateParentName string The ultimate parent company name corresponding to the ultimate parent DUNS Number
return​.resultSet​.hit[]​.companyResults​.sales decimal Annual Sales in millions
return​.resultSet​.hit[]​.companyResults​.hqPhone string Headquarters Phone Number
return​.resultSet​.hit[]​.companyResults​.doNotCallRegistry boolean Indicates whether company is listed on a UK Do Not Call registry
return​.resultSet​.hit[]​.companyResults​.dbas Dbas
return​.resultSet​.hit[]​.companyResults​.historicalIndicator boolean Indicates that the company has ceased operations and is no longer covered by editors.
return​.resultSet​.hit[]​.companyResults​.exchanges ExchangeList
return​.resultSet​.hit[]​.companyResults​.familyTreeSize integer The number of records in a family tree record.
return​.resultSet​.hit[]​.companyResults​.employeesAtThisLocation integer The number of employees at this location. The total number of individuals engaged by a business entity at the location of the DUNS numbered subject entity.
return​.resultSet​.hit[]​.companyResults​.employeesTotal integer Total number of employees. The total number of people employed by all branches and subsidiaries of a business.
return​.resultSet​.hit[]​.companyResults​.primaryTicker string
return​.resultSet​.hit[]​.companyResults​.ownershipTypeValue string New for 1.7
return​.resultSet​.hit[]​.companyResults​.ownershipTypeDescription string New for 1.7
return​.resultSet​.hit[]​.companyResults​.companyTypeValue string New for 1.7
return​.resultSet​.hit[]​.companyResults​.companyTypeDescription string New for 1.7
return​.navigators CompanyNavigators Contains lists of navigation links
return​.navigators​.employeeNavigators EmployeeNavigators
return​.navigators​.employeeNavigators​.employeeNavigator Array of EmployeeNavigator
return​.navigators​.employeeNavigators​.employeeNavigator[]​.employeeNavigatorValue string
return​.navigators​.employeeNavigators​.employeeNavigator[]​.employeeNavigatorDescription string
return​.navigators​.locationTypeNavigators LocationTypeNavigators
return​.navigators​.locationTypeNavigators​.locationTypeNavigator Array of LocationTypeNavigator
return​.navigators​.locationTypeNavigators​.locationTypeNavigator[]​.locationTypeNavigatorValue string
return​.navigators​.locationTypeNavigators​.locationTypeNavigator[]​.locationTypeNavigatorDescription string
return​.navigators​.ownershipTypeNavigators OwnershipTypeNavigators
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator Array of OwnershipTypeNavigator
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator[]​.ownershipTypeNavigatorValue string
return​.navigators​.ownershipTypeNavigators​.ownershipTypeNavigator[]​.ownershipTypeNavigatorDescription string
return​.navigators​.salesNavigators SalesNavigators
return​.navigators​.salesNavigators​.salesNavigator Array of SalesNavigator
return​.navigators​.salesNavigators​.salesNavigator[]​.salesNavigatorValue string
return​.navigators​.salesNavigators​.salesNavigator[]​.salesNavigatorDescription string
return​.navigators​.locationNavigators LocationNavigators
return​.navigators​.locationNavigators​.countryNavigators CountryNavigators
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator Array of CountryNavigator
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.countryNavigatorValue string The value of a navigation link for country
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.countryNavigatorDescription string The description of a navigation link for country description
return​.navigators​.locationNavigators​.countryNavigators​.countryNavigator[]​.stateProvinceNavigators StateProvinceNavigators
return​.navigators​.industryNavigators IndustryNavigators
return​.navigators​.industryNavigators​.industryNavigator Array of IndustryNavigator
return​.navigators​.industryNavigators​.industryNavigator[]​.industryNavigatorValue string The value of a navigation link an for industry.
return​.navigators​.industryNavigators​.industryNavigator[]​.industryNavigatorDescription string The description of a navigation link for industry.
return​.navigators​.industryNavigators​.ussicNavigator Array of UsSicNavigator
return​.navigators​.industryNavigators​.ussicNavigator[]​.ussicNavigatorValue string The value of a navigation link for US SIC
return​.navigators​.industryNavigators​.ussicNavigator[]​.ussicNavigatorDescription string The description of a navigation link for US SIC
return​.navigators​.industryNavigators​.naicsNavigator Array of NaicsNavigator
return​.navigators​.industryNavigators​.naicsNavigator[]​.naicsNavigatorValue string The value of a navigation link for NAICS
return​.navigators​.industryNavigators​.naicsNavigator[]​.naicsNavigatorDescription string The description of a navigation link for NAICS

Sample Request XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:FindCompanyByKeywordRequest>
         <ns0:keyword>Aerospace</ns0:keyword>
      </ns0:FindCompanyByKeywordRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>

Sample Response XML

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope>
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <sch:FindCompanyByKeywordResponse>
         <sch:return>
            <sch:resultSet>
               <sch:firstHit>1</sch:firstHit>
               <sch:hits>20</sch:hits>
               <sch:lastHit>20</sch:lastHit>
               <sch:totalHits>15879</sch:totalHits>
               <sch:hit>
                  <sch:hitNumber>1</sch:hitNumber>
                  <sch:companyResults>
                     <sch:companyId>47625000000000</sch:companyId>
                     <sch:duns>009553637</sch:duns>
                     <sch:companyName>The Aerospace Corporation</sch:companyName>
                     <sch:locationType>Headquarters</sch:locationType>
                     <sch:address1>2310 E El Segundo Blvd</sch:address1>
                     <sch:address2/>
                     <sch:city>El Segundo</sch:city>
                     <sch:country>United States</sch:country>
                     <sch:countryId>76</sch:countryId>
                     <sch:stateOrProvince>CA</sch:stateOrProvince>
                     <sch:postalCode>90245-4609</sch:postalCode>
                     <sch:primaryUrl>http://www.aerospace.org</sch:primaryUrl>
                     <sch:parentDuns>009553637</sch:parentDuns>
                     <sch:parentName>The Aerospace Corporation</sch:parentName>
                     <sch:ultimateParentDuns>009553637</sch:ultimateParentDuns>
                     <sch:ultimateParentName>The Aerospace Corporation</sch:ultimateParentName>
                     <sch:sales>881.907</sch:sales>
                     <sch:hqPhone>310-336-5000</sch:hqPhone>
                     <sch:doNotCallRegistry>false</sch:doNotCallRegistry>
                     <sch:dbas/>
                     <sch:historicalIndicator>false</sch:historicalIndicator>
                     <sch:exchanges/>
                     <sch:familyTreeSize>29</sch:familyTreeSize>
                     <sch:employeesAtThisLocation>2313</sch:employeesAtThisLocation>
                     <sch:employeesTotal>3920</sch:employeesTotal>
                  </sch:companyResults>
               </sch:hit>
               <sch:hit>
                  <sch:hitNumber>2</sch:hitNumber>
                  <sch:companyResults>
                     <sch:companyId>134749000000000</sch:companyId>
                     <sch:duns>379784234</sch:duns>
                     <sch:companyName>METTIS AEROSPACE LTD</sch:companyName>
                     <sch:locationType>Single Location</sch:locationType>
                     <sch:address1>Windsor Road</sch:address1>
                     <sch:address2/>
                     <sch:city>Redditch</sch:city>
                     <sch:country>England</sch:country>
                     <sch:countryId>245</sch:countryId>
                     <sch:stateOrProvince>Worcestershire</sch:stateOrProvince>
                     <sch:postalCode>B97 6EF</sch:postalCode>
                     <sch:primaryUrl>http://www.mettis-aerospa...</sch:primaryUrl>
                     <sch:parentDuns>379786304</sch:parentDuns>
                     <sch:parentName>High Duty Alloys Ltd</sch:parentName>
                     <sch:ultimateParentDuns>165691853</sch:ultimateParentDuns>
                     <sch:ultimateParentName>Saints Management LLC</sch:ultimateParentName>
                     <sch:sales>96.042122</sch:sales>
                     <sch:hqPhone>01527406400</sch:hqPhone>
                     <sch:doNotCallRegistry>false</sch:doNotCallRegistry>
                     <sch:dbas/>
                     <sch:historicalIndicator>false</sch:historicalIndicator>
                     <sch:exchanges/>
                     <sch:familyTreeSize>27</sch:familyTreeSize>
                     <sch:employeesAtThisLocation>555</sch:employeesAtThisLocation>
                     <sch:employeesTotal>555</sch:employeesTotal>
                  </sch:companyResults>
               </sch:hit>
               ...
               </sch:resultSet>
            <sch:navigators/>
         </sch:return>
      </sch:FindCompanyByKeywordResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CURL Example

curl -d '<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:FindCompanyByKeywordRequest>
         <ns0:keyword>Aerospace</ns0:keyword>
      </ns0:FindCompanyByKeywordRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>' -H "SOAPAction: sch:FindCompanyByKeyword" -H "Content-Type: text/xml" -i 'http://dnbdirect-api.dnb.com/DnBAPI-17'

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.

Request

Element Type Notes
DataAreaRequest DataAreaRequestType Required
DataAreaRequest​.OrderRequest OrderRequestType 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 integer (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 integer (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 CleanseMatchSpecification (3 characters) The match specification can be based on the CandidateMaximumQuanity which is an integer 3 digits long.
DataAreaRequest​.MatchSpecification​.CandidateMaximumQuantity integer 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 integer 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 integer 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 integer
DataAreaRequest​.MatchSpecification​.ExclusionCriteria Array of ExclusionCriteria 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 integer 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 InquiryReferenceDetail 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)
OptionalResponseFields
OptionalResponseFields​.IncludeMatchQualityInformation boolean Optional Inquiry. If True, this section is included. If False (default), this section is excluded.

Response

Element Type Notes
DataAreaResponse DataAreaResponseType Required
DataAreaResponse​.OrderResponseHeader OrderResponseHeaderType Required
DataAreaResponse​.OrderResponseHeader​.TranID string Required The transaction ID is the unique identifier of the transaction
DataAreaResponse​.OrderResponseHeader​.Status StatusType Required
DataAreaResponse​.OrderResponseHeader​.Status​.Code integer Required Response status code that describes whether a successful response is returned or an error is returned
DataAreaResponse​.OrderResponseHeader​.Status​.Description string Required Description of the status code
DataAreaResponse​.OrderResponse OrderResponseType
DataAreaResponse​.OrderResponse​.CandidatesReturned integer 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.
DataAreaResponse​.OrderResponse​.Candidates CandidatesType
DataAreaResponse​.OrderResponse​.Candidates​.Candidate CandidateType
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.DUNS string (1-9 characters) 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]*)".
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.ConfidenceCode integer (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.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.BestMatchFlag string (1-5 characters) If there are more than one candidate matched at a high confidence level such as a 10 and a differentiator is needed, this flag indicates the best possible match.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchGradeString string (1-11 characters) A MatchGrade provides a similarity score between components of customer and D&B reference info
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.PrimaryBusinessName string (1-240 characters) Primary Company Business Name
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.PhysicalAddressLine string (1-70 characters) Physical street address where the business is located
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.PhysicalCity string (1-50 characters) City where the business is located
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.PhysicalState string (1-2 characters) The state abbreviation where the company is located
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.PhysicalPostalCode string (1-10 characters) The zip code where the company is located
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.CountryCode string (1-2 characters) Dial these numbers to access the phone number in the designated country. For example, for Mitsubishi's primary phone number in Japan "81" is listed. For a New Zealand-based company "61" is listed.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.CountryName string (1-30 characters) Name of the country where the business is located
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.Phone string (1-16 characters) Telephone Number
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.InternationalDialingCode integer (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.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.TradeStyle string (1-90 characters) Doing Business As or Trade Style Name
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.SubjectDetails string SingleLocation, ParentHeadquarters, or BranchDivision
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis MatchBasisType
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis MatchBasis
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis​.EndIndicator boolean
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis​.SubjectTypeText string Available Values:
Affiliate
Branch
Business
Division
DomesticUltimate
GlobalUltimate
Headquarters
Parent
Single
Subsidiary
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis​.SeniorPrincipalIndicator boolean
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis​.MatchBasisText DNBDecodedStringType
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis​.EndIndicator boolean
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis​.SubjectTypeText string Available Values:
Affiliate
Branch
Business
Division
DomesticUltimate
GlobalUltimate
Headquarters
Parent
Single
Subsidiary
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis​.SeniorPrincipalIndicator boolean
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchBasis​.MatchBasisText DNBDecodedStringType
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MDPProfile string (1-28 characters) A series of 7 or 11 2-digit codes used to define the source of the matched record ? the kind of data to which the record was matched, within the D&B Match Reference File. Match Data Profiles are codes that appear on the output file and matching reports returned. They show the information D&B was able to match such as the type of name, address or phone that was matched. Or if no match occurred, D&B shows why we were unable to match.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.WebPageAddress string
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation MatchQualityInformation
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.ConfidenceCodeValue integer 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.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchBasis Array of MatchBasis
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchGradeText string (up to 11 characters) Code indicating the MatchGrade. A textual string that identifies the compound rating that is comprised of one rating per type of data scored by a match engine, e.g., AABZBAAAFBZ where "A" in the 1st position means that the Name scored between 80-100; "A" in the 2nd position means that the Street Number had to score exactly 100.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchGradeComponentCount integer Number that indicates how many components are in the MatchGrade
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchGradeComponent Array of MatchGradeComponent
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchDataProfileText string (up to 28 characters) A textual string that describes the information that the matching process used to arrive at a match in addition to the application's business rules and parameters specified by the requestor. This is a 28 byte string consisting of 14 components of two bytes each. The 14 components are Name, Street Number, Street Name, Town Name, Territory Name, P.O. Box, Telephone, Post Code, DUNS Number, Industry Code, Geographical Density, Location Uniqueness, Registration Number and URL respectively. Example: 0299990000999800000000009898
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchDataProfileComponentCount integer (up to 2 characters) Indicates the number of components in the Match Data Profile.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchDataProfileComponent Array of MatchDataProfileComponent
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.ConfidenceCodeValue integer 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.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchBasis Array of MatchBasis
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchGradeText string (up to 11 characters) Code indicating the MatchGrade. A textual string that identifies the compound rating that is comprised of one rating per type of data scored by a match engine, e.g., AABZBAAAFBZ where "A" in the 1st position means that the Name scored between 80-100; "A" in the 2nd position means that the Street Number had to score exactly 100.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchGradeComponentCount integer Number that indicates how many components are in the MatchGrade
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchGradeComponent Array of MatchGradeComponent
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchDataProfileText string (up to 28 characters) A textual string that describes the information that the matching process used to arrive at a match in addition to the application's business rules and parameters specified by the requestor. This is a 28 byte string consisting of 14 components of two bytes each. The 14 components are Name, Street Number, Street Name, Town Name, Territory Name, P.O. Box, Telephone, Post Code, DUNS Number, Industry Code, Geographical Density, Location Uniqueness, Registration Number and URL respectively. Example: 0299990000999800000000009898
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchDataProfileComponentCount integer (up to 2 characters) Indicates the number of components in the Match Data Profile.
DataAreaResponse​.OrderResponse​.Candidates​.Candidate​.MatchQualityInformation​.MatchDataProfileComponent Array of MatchDataProfileComponent
DataAreaResponse​.OrderResponse​.InquiryReferenceDetail InquiryReferenceDetail Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.
DataAreaResponse​.OrderResponse​.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
DataAreaResponse​.OrderResponse​.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
DataAreaResponse​.OrderResponse​.InquiryReferenceDetail​.CustomerBillingEndorsementText string (1-240 characters)
DataAreaResponse​.OrderResponse​.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
DataAreaResponse​.OrderResponse​.InquiryReferenceDetail​.CustomerBillingEndorsementText string (1-240 characters)

Sample Request XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:FindCompanyCleanseMatchRequest>
         <ns0:DataAreaRequest>
            <ns0:OrderRequest>
               <ns0:PrimaryName>AMR Corporation</ns0:PrimaryName>
               <ns0:Address>4333 Amon Carter Blvd.</ns0:Address>
               <ns0:City>Fort Worth</ns0:City>
               <ns0:Country>US</ns0:Country>
               <ns0:Phone>817-963-1234</ns0:Phone>
               <ns0:InternationalDialingCode>1</ns0:InternationalDialingCode>
               <ns0:ConfidenceCode>9</ns0:ConfidenceCode>
            </ns0:OrderRequest>
            <ns0:MatchSpecification>
               <ns0:CandidateMaximumQuantity>25</ns0:CandidateMaximumQuantity>
               <ns0:ExclusionCriteria>Exclude Non HeadQuarters</ns0:ExclusionCriteria>
            </ns0:MatchSpecification>
            <ns0:InquiryReferenceDetail>
               <ns0:CustomerReferenceText>case number 123</ns0:CustomerReferenceText>
            </ns0:InquiryReferenceDetail>
         </ns0:DataAreaRequest>
         <ns0:OptionalResponseFields>
            <ns0:IncludeMatchQualityInformation>true</ns0:IncludeMatchQualityInformation>
         </ns0:OptionalResponseFields>
      </ns0:FindCompanyCleanseMatchRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>

Sample Response XML

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope>
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <sch:FindCompanyCleanseMatchResponse>
         <sch:DataAreaResponse>
            <sch:OrderResponseHeader>
               <sch:TranID>Id-63d77155d97e3f00bff710...</sch:TranID>
               <sch:Status>
                  <sch:Code>1</sch:Code>
                  <sch:Description>Success</sch:Description>
               </sch:Status>
            </sch:OrderResponseHeader>
            <sch:OrderResponse>
               <sch:CandidatesReturned>1</sch:CandidatesReturned>
               <sch:Candidates>
                  <sch:Candidate>
                     <sch:DUNS>072560154</sch:DUNS>
                     <sch:ConfidenceCode>9</sch:ConfidenceCode>
                     <sch:BestMatchFlag>true</sch:BestMatchFlag>
                     <sch:MatchGradeString>AZZAAZAZFFZ</sch:MatchGradeString>
                     <sch:PrimaryBusinessName>AMERICAN AIRLINES GROUP I...</sch:PrimaryBusinessName>
                     <sch:PhysicalAddressLine>4333 AMON CARTER BLVD</sch:PhysicalAddressLine>
                     <sch:PhysicalCity>FORT WORTH</sch:PhysicalCity>
                     <sch:PhysicalState>TX</sch:PhysicalState>
                     <sch:PhysicalPostalCode>761552605</sch:PhysicalPostalCode>
                     <sch:CountryCode>US</sch:CountryCode>
                     <sch:CountryName>United States</sch:CountryName>
                     <sch:Phone>8179631234</sch:Phone>
                     <sch:SubjectDetails>Headquarters</sch:SubjectDetails>
                     <sch:MDPProfile>3396960099960099000000009...</sch:MDPProfile>
                     <sch:MatchQualityInformation>
                        <sch:ConfidenceCodeValue>9</sch:ConfidenceCodeValue>
                        <sch:MatchBasis>
                           <sch:EndIndicator>true</sch:EndIndicator>
                           <sch:SubjectTypeText>Business</sch:SubjectTypeText>
                           <sch:SeniorPrincipalIndicator>false</sch:SeniorPrincipalIndicator>
                           <sch:MatchBasisText>Primary Name</sch:MatchBasisText>
                        </sch:MatchBasis>
                        <sch:MatchBasis>
                           <sch:EndIndicator>false</sch:EndIndicator>
                           <sch:SubjectTypeText>Business</sch:SubjectTypeText>
                           <sch:SeniorPrincipalIndicator>false</sch:SeniorPrincipalIndicator>
                           <sch:MatchBasisText>Primary Address</sch:MatchBasisText>
                        </sch:MatchBasis>
                        ...
                        <sch:MatchGradeText>AZZAAZAZFFZ</sch:MatchGradeText>
                        <sch:MatchGradeComponentCount>11</sch:MatchGradeComponentCount>
                        <sch:MatchGradeComponent>
                           <sch:Text>Name</sch:Text>
                           <sch:Rating>A</sch:Rating>
                           <sch:Score>100.0</sch:Score>
                           <sch:DisplaySequence>0</sch:DisplaySequence>
                        </sch:MatchGradeComponent>
                        <sch:MatchGradeComponent>
                           <sch:Text>Street Number</sch:Text>
                           <sch:Rating>Z</sch:Rating>
                           <sch:Score>0</sch:Score>
                           <sch:DisplaySequence>0</sch:DisplaySequence>
                        </sch:MatchGradeComponent>
                        ...
                        <sch:MatchDataProfileText>3396960099960099000000009...</sch:MatchDataProfileText>
                        <sch:MatchDataProfileComponentCount>14</sch:MatchDataProfileComponentCount>
                        <sch:MatchDataProfileComponent>
                           <sch:Text>Name</sch:Text>
                           <sch:Value>33</sch:Value>
                           <sch:DisplaySequence>0</sch:DisplaySequence>
                        </sch:MatchDataProfileComponent>
                        <sch:MatchDataProfileComponent>
                           <sch:Text>Street Number</sch:Text>
                           <sch:Value>96</sch:Value>
                           <sch:DisplaySequence>0</sch:DisplaySequence>
                        </sch:MatchDataProfileComponent>
                        ...
                        </sch:MatchQualityInformation>
                  </sch:Candidate>
               </sch:Candidates>
               <sch:InquiryReferenceDetail>
                  <sch:CustomerReferenceText>case number 123</sch:CustomerReferenceText>
               </sch:InquiryReferenceDetail>
            </sch:OrderResponse>
         </sch:DataAreaResponse>
      </sch:FindCompanyCleanseMatchResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CURL Example

curl -d '<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:FindCompanyCleanseMatchRequest>
         <ns0:DataAreaRequest>
            <ns0:OrderRequest>
               <ns0:PrimaryName>AMR Corporation</ns0:PrimaryName>
               <ns0:Address>4333 Amon Carter Blvd.</ns0:Address>
               <ns0:City>Fort Worth</ns0:City>
               <ns0:Country>US</ns0:Country>
               <ns0:Phone>817-963-1234</ns0:Phone>
               <ns0:InternationalDialingCode>1</ns0:InternationalDialingCode>
               <ns0:ConfidenceCode>9</ns0:ConfidenceCode>
            </ns0:OrderRequest>
            <ns0:MatchSpecification>
               <ns0:CandidateMaximumQuantity>25</ns0:CandidateMaximumQuantity>
               <ns0:ExclusionCriteria>Exclude Non HeadQuarters</ns0:ExclusionCriteria>
            </ns0:MatchSpecification>
            <ns0:InquiryReferenceDetail>
               <ns0:CustomerReferenceText>case number 123</ns0:CustomerReferenceText>
            </ns0:InquiryReferenceDetail>
         </ns0:DataAreaRequest>
         <ns0:OptionalResponseFields>
            <ns0:IncludeMatchQualityInformation>true</ns0:IncludeMatchQualityInformation>
         </ns0:OptionalResponseFields>
      </ns0:FindCompanyCleanseMatchRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>' -H "SOAPAction: sch:FindCompanyCleanseMatch" -H "Content-Type: text/xml" -i 'http://dnbdirect-api.dnb.com/DnBAPI-17'

FindCompetitorsByCompanyID Included in Base Package

Returns all the competitors for a given company."

Request

Element Type Notes
uniqueId long Required Company ID or D-U-N-S Number
topCompetitor boolean Top competitor indicator

Response

Element Type Notes
return CompetitorSearchResult
return​.competitor Array of CompetitorSearchResultHit
return​.competitor[]​.addrcity string (up to 50 characters) Competitor City
return​.competitor[]​.addrcountry string (up to 70 characters) Competitor Country
return​.competitor[]​.addrcountryid unsignedLong Competitor Country ID. Example: 76 = United States
return​.competitor[]​.addrstateprov string (up to 2 characters) Competitor search result hit for State/Province
return​.competitor[]​.companyId long Company ID - Most likely this will be a DUNS number. However, there are Hoover's editorial ID's as another unique company ID (Example: 10483000000000). These company ID's may or may not have a corresponding DUNS number.
return​.competitor[]​.duns string 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]*)".
return​.competitor[]​.parentDuns string
return​.competitor[]​.ultimateParentDuns string The ultimate parent company D-U-N-S Number for a family of companies
return​.competitor[]​.finsales decimal Annual sales based on the fiscal year and expressed in millions of US dollars.
return​.competitor[]​.companyName string Company Name
return​.competitor[]​.topcompetitor boolean Top competitor indicator

Sample Request XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:FindCompetitorsByCompanyIDRequest>
         <ns0:uniqueId>884114609</ns0:uniqueId>
      </ns0:FindCompetitorsByCompanyIDRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>

Sample Response XML

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope>
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <sch:FindCompetitorsByCompanyIDResponse>
         <sch:return>
            <sch:competitor>
               <sch:addrcity>Bois Colombes</sch:addrcity>
               <sch:addrcountry>France</sch:addrcountry>
               <sch:addrcountryid>27</sch:addrcountryid>
               <sch:addrstateprov>Hauts De Seine</sch:addrstateprov>
               <sch:companyId>101016000000000</sch:companyId>
               <sch:duns>275253524</sch:duns>
               <sch:parentDuns>395709947</sch:parentDuns>
               <sch:ultimateParentDuns>291588544</sch:ultimateParentDuns>
               <sch:finsales>935.8944216623998</sch:finsales>
               <sch:companyName>CIE FCAISE ASSURANCES COM...</sch:companyName>
               <sch:topcompetitor>false</sch:topcompetitor>
            </sch:competitor>
            <sch:competitor>
               <sch:addrcity>Dublin</sch:addrcity>
               <sch:addrcountry>Ireland</sch:addrcountry>
               <sch:addrcountryid>39</sch:addrcountryid>
               <sch:addrstateprov>Co Dublin</sch:addrstateprov>
               <sch:companyId>154281000000000</sch:companyId>
               <sch:duns>896612129</sch:duns>
               <sch:parentDuns>365214688</sch:parentDuns>
               <sch:ultimateParentDuns>365214688</sch:ultimateParentDuns>
               <sch:finsales>4840.0</sch:finsales>
               <sch:companyName>EXPERIAN PLC</sch:companyName>
               <sch:topcompetitor>true</sch:topcompetitor>
            </sch:competitor>
            ...
            </sch:return>
      </sch:FindCompetitorsByCompanyIDResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CURL Example

curl -d '<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:ns0="http://applications.dnb.com/webservice/schema/" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sch="http://applications.dnb.com/webservice/schema/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header>
      <sch:API-KEY><!-- your API-KEY --></sch:API-KEY>
      <sch:username><!-- your username --></sch:username>
      <sch:password><!-- your password --></sch:password>
   </SOAP-ENV:Header>
   <ns1:Body>
      <ns0:FindCompetitorsByCompanyIDRequest>
         <ns0:uniqueId>884114609</ns0:uniqueId>
      </ns0:FindCompetitorsByCompanyIDRequest>
   </ns1:Body>
</SOAP-ENV:Envelope>' -H "SOAPAction: sch:FindCompetitorsByCompanyID" -H "Content-Type: text/xml" -i 'http://dnbdirect-api.dnb.com/DnBAPI-17'

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.

Request

Element Type Notes
TransactionDetail RequestTransactionDetail Records information necessary to process this request.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.TransactionTimestamp dateTime The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionDetail​.SubmittingOfficeID string (up to 64 characters) For internal D&B use. A default value is used. A number that identifies the system or the software application from where this request originated. / A number used to uniquely identify the D&B business segment or delivery channel from where this request originated.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.TransactionTimestamp dateTime The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionDetail​.SubmittingOfficeID string (up to 64 characters) For internal D&B use. A default value is used. A number that identifies the system or the software application from where this request originated. / A number used to uniquely identify the D&B business segment or delivery channel from where this request originated.
ServiceVersionNumber string (up to 10 characters) Required A number assigned by D&B which either uniquely identifies or helps to identify the state of this software deliverable. These numbers are generally assigned in increasing order and correspond to new releases in the software such as "2.0".
TransactionDetail RequestTransactionDetail Records information necessary to process this request.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.TransactionTimestamp dateTime The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionDetail​.SubmittingOfficeID string (up to 64 characters) For internal D&B use. A default value is used. A number that identifies the system or the software application from where this request originated. / A number used to uniquely identify the D&B business segment or delivery channel from where this request originated.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.TransactionTimestamp dateTime The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionDetail​.SubmittingOfficeID string (up to 64 characters) For internal D&B use. A default value is used. A number that identifies the system or the software application from where this request originated. / A number used to uniquely identify the D&B business segment or delivery channel from where this request originated.
ServiceVersionNumber string (up to 10 characters) Required A number assigned by D&B which either uniquely identifies or helps to identify the state of this software deliverable. These numbers are generally assigned in increasing order and correspond to new releases in the software such as "2.0".
GetCleanseMatchRequestDetail GetCleanseMatchRequestDetail Required
GetCleanseMatchRequestDetail​.InquiryDetail InquiryDetail Required Records data that allows the customer to specify identifying information about the subject being inquired such as the DUNS Number, the address, the telephone number.
GetCleanseMatchRequestDetail​.InquiryDetail​.DUNSNumber string (up to 15 characters) 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]*)".
GetCleanseMatchRequestDetail​.InquiryDetail​.CountryISOAlpha2Code 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail OrganizationIdentificationNumberTypeCodeType Records the identifier issued by organizations to uniquely identify subjects. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise such as Chamber of Commerce numbers or Value Added Tax (VAT) numbers.
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumber string (1-40 characters) Required input only if this section exists. A number issued by an external official registry body, a government entity, or a commercial enterprise to uniquely identify an organization such as Chamber of Commerce numbers or Value Added Tax numbers.
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumberTypeCode integer (up to 7 characters) Required input only if this section exists. A D&amp;B code value which denotes the type of Organization Identification Number, such as Chamber of Commerce Number, Value Added Tax Number, Federal Taxpayer Identification Number, Companies Registry Office Number.
GetCleanseMatchRequestDetail​.InquiryDetail​.DUNSNumber string (up to 15 characters) 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]*)".
GetCleanseMatchRequestDetail​.InquiryDetail​.SubjectName string (up to 240 characters)
GetCleanseMatchRequestDetail​.InquiryDetail​.Address RequestAddress (1-64 characters) Physical street address of the business
GetCleanseMatchRequestDetail​.InquiryDetail​.Address​.StreetAddressLine Array of StreetAddressLine
GetCleanseMatchRequestDetail​.InquiryDetail​.Address​.StreetAddressLine[]​.LineText string (up to 240 characters)
GetCleanseMatchRequestDetail​.InquiryDetail​.Address​.PrimaryTownName string (up to 64 characters)
GetCleanseMatchRequestDetail​.InquiryDetail​.Address​.CountryISOAlpha2Code string (2 characters) 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
GetCleanseMatchRequestDetail​.InquiryDetail​.Address​.TerritoryName string (up to 64 characters)
GetCleanseMatchRequestDetail​.InquiryDetail​.Address​.FullPostalCode string (up to 32 characters)
GetCleanseMatchRequestDetail​.InquiryDetail​.TelephoneNumber TelecommunicationNumberSimpleType
GetCleanseMatchRequestDetail​.InquiryDetail​.TelephoneNumber​.TelecommunicationNumber string (1-50 characters)
GetCleanseMatchRequestDetail​.InquiryDetail​.TelephoneNumber​.InternationalDialingCode integer (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.
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail OrganizationIdentificationNumberSimpleType Records the identifier issued by organizations to uniquely identify subjects. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise such as Chamber of Commerce numbers or Value Added Tax (VAT) numbers.
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumber string (1-40 characters) Required input only if this section exists. A number issued by an external official registry body, a government entity, or a commercial enterprise to uniquely identify an organization such as Chamber of Commerce numbers or Value Added Tax numbers.
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.TypeText string (up to 256 characters)
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.DNBCodeValue integer A unique number assigned by D&B to identify the fact recorded in this data element.
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.DNBCodeTableNumber integer
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumber string (1-40 characters) Required input only if this section exists. A number issued by an external official registry body, a government entity, or a commercial enterprise to uniquely identify an organization such as Chamber of Commerce numbers or Value Added Tax numbers.
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.DNBCodeTableNumber integer
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.DNBCodeValue integer
GetCleanseMatchRequestDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.TypeText string (up to 256 characters)
GetCleanseMatchRequestDetail​.MatchSpecification CleanseMatchSpecification (3 characters) The match specification can be based on the CandidateMaximumQuanity which is an integer 3 digits long.
GetCleanseMatchRequestDetail​.MatchSpecification​.CandidateMaximumQuantity integer 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.
GetCleanseMatchRequestDetail​.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
GetCleanseMatchRequestDetail​.MatchSpecification​.OrderReasonCode integer 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.
GetCleanseMatchRequestDetail​.MatchSpecification​.CandidateMaximumQuantity integer 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.
GetCleanseMatchRequestDetail​.MatchSpecification​.ConfidenceLowerLevelThresholdValue integer
GetCleanseMatchRequestDetail​.MatchSpecification​.ExclusionCriteria Array of ExclusionCriteria 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"
GetCleanseMatchRequestDetail​.MatchSpecification​.ExclusionCriteria[]​.ExclusionDataDescription string Available Values:
Exclude Non HeadQuarters
Exclude Non Marketable
Exact Match
Exclude Out of Business
Exclude Unreachable
Exclude Undeliverable
GetCleanseMatchRequestDetail​.MatchSpecification​.OrderReasonCode integer 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.
GetCleanseMatchRequestDetail​.MatchSpecification​.IncludeCleansedAndStandardizedInformationIndicator boolean
GetCleanseMatchRequestDetail​.InquiryReferenceDetail InquiryReferenceDetail Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.
GetCleanseMatchRequestDetail​.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
GetCleanseMatchRequestDetail​.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
GetCleanseMatchRequestDetail​.InquiryReferenceDetail​.CustomerBillingEndorsementText string (1-240 characters)
GetCleanseMatchRequestDetail​.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
GetCleanseMatchRequestDetail​.InquiryReferenceDetail​.CustomerBillingEndorsementText string (1-240 characters)

Response

Element Type Notes
TransactionResult TransactionResult Required
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultID string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultID string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultCode string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
ServiceVersionNumber string (up to 10 characters) Required A number assigned by D&B which either uniquely identifies or helps to identify the state of this software deliverable. These numbers are generally assigned in increasing order and correspond to new releases in the software such as "2.0".
TransactionDetail ResponseTransactionDetail Required Records information necessary to process this request.
TransactionDetail​.ApplicationTransactionID string (up to 64 characters) A number assigned by the calling application to uniquely identify this request.
TransactionDetail​.ServiceTransactionID string (up to 64 characters) Required
TransactionDetail​.TransactionTimestamp dateTime Required The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&amp;B function such as the date and time when the xml document was created by the requesting intermediary. Any of the following formats may be used: YYYY-MM-DDThh:mmTZD (Example 1997-07-16T19:20+01:00), Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (Example 1997-07-16T19:20:30+01:00), Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (Example 1997-07-16T19:20:30.45+01:00)
TransactionResult TransactionResult Required
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultID string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultID string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.SeverityText string Required Available Values:
Error
Fatal
Information
Warning
Error
Fatal
Information
Warning
Information
Warning
Error
TransactionResult​.ResultCode string (up to 32 characters) Required
TransactionResult​.ResultText string (up to 512 characters)
TransactionResult​.ResultMessage Array of ResultMessage
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
TransactionResult​.ResultMessage[]​.ResultDescription string (up to 512 characters)
ServiceVersionNumber string (up to 10 characters) Required A number assigned by D&B which either uniquely identifies or helps to identify the state of this software deliverable. These numbers are generally assigned in increasing order and correspond to new releases in the software such as "2.0".
GetCleanseMatchResponseDetail GetCleanseMatchResponseDetail
GetCleanseMatchResponseDetail​.InquiryDetail InquiryDetail Records data that allows the customer to specify identifying information about the subject being inquired such as the DUNS Number, the address, the telephone number.
GetCleanseMatchResponseDetail​.InquiryDetail​.DUNSNumber string (up to 15 characters) 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]*)".
GetCleanseMatchResponseDetail​.InquiryDetail​.CountryISOAlpha2Code string (2 characters) 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail OrganizationIdentificationNumberTypeCodeType Records the identifier issued by organizations to uniquely identify subjects. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise such as Chamber of Commerce numbers or Value Added Tax (VAT) numbers.
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumber string (1-40 characters) Required input only if this section exists. A number issued by an external official registry body, a government entity, or a commercial enterprise to uniquely identify an organization such as Chamber of Commerce numbers or Value Added Tax numbers.
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumberTypeCode integer (up to 7 characters) Required input only if this section exists. A D&amp;B code value which denotes the type of Organization Identification Number, such as Chamber of Commerce Number, Value Added Tax Number, Federal Taxpayer Identification Number, Companies Registry Office Number.
GetCleanseMatchResponseDetail​.InquiryDetail​.DUNSNumber string (up to 15 characters) 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]*)".
GetCleanseMatchResponseDetail​.InquiryDetail​.SubjectName string (up to 240 characters)
GetCleanseMatchResponseDetail​.InquiryDetail​.Address RequestAddress (1-64 characters) Physical street address of the business
GetCleanseMatchResponseDetail​.InquiryDetail​.Address​.StreetAddressLine Array of StreetAddressLine
GetCleanseMatchResponseDetail​.InquiryDetail​.Address​.StreetAddressLine[]​.LineText string (up to 240 characters)
GetCleanseMatchResponseDetail​.InquiryDetail​.Address​.PrimaryTownName string (up to 64 characters)
GetCleanseMatchResponseDetail​.InquiryDetail​.Address​.CountryISOAlpha2Code string (2 characters) 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
GetCleanseMatchResponseDetail​.InquiryDetail​.Address​.TerritoryName string (up to 64 characters)
GetCleanseMatchResponseDetail​.InquiryDetail​.Address​.FullPostalCode string (up to 32 characters)
GetCleanseMatchResponseDetail​.InquiryDetail​.TelephoneNumber TelecommunicationNumberSimpleType
GetCleanseMatchResponseDetail​.InquiryDetail​.TelephoneNumber​.TelecommunicationNumber string (1-50 characters)
GetCleanseMatchResponseDetail​.InquiryDetail​.TelephoneNumber​.InternationalDialingCode integer (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.
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail OrganizationIdentificationNumberSimpleType Records the identifier issued by organizations to uniquely identify subjects. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise such as Chamber of Commerce numbers or Value Added Tax (VAT) numbers.
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumber string (1-40 characters) Required input only if this section exists. A number issued by an external official registry body, a government entity, or a commercial enterprise to uniquely identify an organization such as Chamber of Commerce numbers or Value Added Tax numbers.
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.TypeText string (up to 256 characters)
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.DNBCodeValue integer A unique number assigned by D&B to identify the fact recorded in this data element.
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumber string (1-40 characters) Required input only if this section exists. A number issued by an external official registry body, a government entity, or a commercial enterprise to uniquely identify an organization such as Chamber of Commerce numbers or Value Added Tax numbers.
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.InquiryDetail​.OrganizationIdentificationNumberDetail​.TypeText string (up to 256 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail MatchResultDetail
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchDataCriteriaText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchDataCriteriaText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchDataCriteriaText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchDataCriteriaText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchDataCriteriaText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchDataCriteriaText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchDataCriteriaText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.CandidateMatchedQuantity integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate Array of MatchResult
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.DUNSNumber string (up to 15 characters) 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]*)".
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SubjectID string (up to 15 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName OrganizationPrimaryNameType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName DNBStringType256
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName DNBStringType256
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName DNBStringType256
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName DNBStringType256
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationPrimaryName​.RegisteredNameIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName OrganizationNameBaseType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName DNBStringType256
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName DNBStringType256
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TradeStyleName​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName IndividualNameType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.NamePrefix Array of NamePrefix
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.NamePrefix[]​.NamePrefixText string (up to 16 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.NamePrefix[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.FirstName string (up to 64 characters) Person First Name
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.MiddleName string (up to 64 characters) Person Middle Name
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.LastName string (up to 64 characters) Person Last Name
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.FullName string (up to 240 characters) Person Full Name
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.NameSuffix Array of NameSuffix
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.NameSuffix[]​.NameSuffixText string (up to 16 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.SeniorPrincipalName​.NameSuffix[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress PrimaryAddressType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress​.StreetAddressLine Array of StreetAddressLine
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress​.PrimaryTownName string (up to 64 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress​.CountryISOAlpha2Code string (2 characters) 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress​.PostalCode string (up to 16 characters) Postal Code
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress​.PostalCodeExtensionCode string (up to 16 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress​.TerritoryOfficialName string (up to 64 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress​.TerritoryAbbreviatedName string (up to 64 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.PrimaryAddress​.UndeliverableIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress MailAddressType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress​.StreetAddressLine Array of StreetAddressLine
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress​.PrimaryTownName string (up to 64 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress​.CountryISOAlpha2Code string (2 characters) 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress​.PostalCode string (up to 16 characters) Postal Code
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress​.PostalCodeExtensionCode string (up to 16 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress​.TerritoryOfficialName string (up to 64 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress​.TerritoryAbbreviatedName string (up to 64 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MailingAddress​.UndeliverableIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TelephoneNumber TelecommunicationNumberType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TelephoneNumber​.TelecommunicationNumber string (1-50 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TelephoneNumber​.InternationalDialingCode integer (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.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.TelephoneNumber​.UnreachableIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.WebPageAddress WebPageAddressType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.WebPageAddress​.TelecommunicationAddress string (up to 240 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.WebPageAddress​.UnreachableIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OperatingStatusText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OperatingStatusText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OperatingStatusText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OperatingStatusText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OperatingStatusText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OperatingStatusText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OperatingStatusText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.FamilyTreeMemberRole Array of FamilyTreeMemberRole
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.FamilyTreeMemberRole[]​.FamilyTreeMemberRoleText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.FamilyTreeMemberRole[]​.FamilyTreeMemberRoleText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.FamilyTreeMemberRole[]​.FamilyTreeMemberRoleText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.FamilyTreeMemberRole[]​.FamilyTreeMemberRoleText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.FamilyTreeMemberRole[]​.FamilyTreeMemberRoleText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.FamilyTreeMemberRole[]​.FamilyTreeMemberRoleText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.FamilyTreeMemberRole[]​.FamilyTreeMemberRoleText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MarketabilityIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.StandaloneOrganizationIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail OrganizationIdentificationNumberType Records the identifier issued by organizations to uniquely identify subjects. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise such as Chamber of Commerce numbers or Value Added Tax (VAT) numbers.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumber string (1-40 characters) Required input only if this section exists. A number issued by an external official registry body, a government entity, or a commercial enterprise to uniquely identify an organization such as Chamber of Commerce numbers or Value Added Tax numbers.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail​.TypeText string (up to 256 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail​.DNBCodeValue integer A unique number assigned by D&B to identify the fact recorded in this data element.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail​.OrganizationIdentificationNumber string (1-40 characters) Required input only if this section exists. A number issued by an external official registry body, a government entity, or a commercial enterprise to uniquely identify an organization such as Chamber of Commerce numbers or Value Added Tax numbers.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.OrganizationIdentificationNumberDetail​.TypeText string (up to 256 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation MatchQualityInformation
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.ConfidenceCodeValue integer 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.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis Array of MatchBasis
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.EndIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.SubjectTypeText string Available Values:
Affiliate
Branch
Business
Division
DomesticUltimate
GlobalUltimate
Headquarters
Parent
Single
Subsidiary
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.SeniorPrincipalIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.EndIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.SubjectTypeText string Available Values:
Affiliate
Branch
Business
Division
DomesticUltimate
GlobalUltimate
Headquarters
Parent
Single
Subsidiary
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.SeniorPrincipalIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeText string (up to 11 characters) Code indicating the MatchGrade. A textual string that identifies the compound rating that is comprised of one rating per type of data scored by a match engine, e.g., AABZBAAAFBZ where "A" in the 1st position means that the Name scored between 80-100; "A" in the 2nd position means that the Street Number had to score exactly 100.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponentCount integer Number that indicates how many components are in the MatchGrade
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent Array of MatchGradeComponent
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Rating string (up to 1 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Score decimal
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentRating string (up to 1 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentScore decimal
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileText string (up to 28 characters) A textual string that describes the information that the matching process used to arrive at a match in addition to the application's business rules and parameters specified by the requestor. This is a 28 byte string consisting of 14 components of two bytes each. The 14 components are Name, Street Number, Street Name, Town Name, Territory Name, P.O. Box, Telephone, Post Code, DUNS Number, Industry Code, Geographical Density, Location Uniqueness, Registration Number and URL respectively. Example: 0299990000999800000000009898
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponentCount integer (up to 2 characters) Indicates the number of components in the Match Data Profile.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent Array of MatchDataProfileComponent
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Value string (2 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentValue string (2 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.ConfidenceCodeValue integer 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.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis Array of MatchBasis
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.EndIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.SubjectTypeText string Available Values:
Affiliate
Branch
Business
Division
DomesticUltimate
GlobalUltimate
Headquarters
Parent
Single
Subsidiary
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.SeniorPrincipalIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.EndIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.SubjectTypeText string Available Values:
Affiliate
Branch
Business
Division
DomesticUltimate
GlobalUltimate
Headquarters
Parent
Single
Subsidiary
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.SeniorPrincipalIndicator boolean
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchBasis[]​.MatchBasisText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeText string (up to 11 characters) Code indicating the MatchGrade. A textual string that identifies the compound rating that is comprised of one rating per type of data scored by a match engine, e.g., AABZBAAAFBZ where "A" in the 1st position means that the Name scored between 80-100; "A" in the 2nd position means that the Street Number had to score exactly 100.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponentCount integer Number that indicates how many components are in the MatchGrade
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent Array of MatchGradeComponent
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Rating string (up to 1 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.Score decimal
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentRating string (up to 1 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.MatchGradeComponentScore decimal
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchGradeComponent[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileText string (up to 28 characters) A textual string that describes the information that the matching process used to arrive at a match in addition to the application's business rules and parameters specified by the requestor. This is a 28 byte string consisting of 14 components of two bytes each. The 14 components are Name, Street Number, Street Name, Town Name, Territory Name, P.O. Box, Telephone, Post Code, DUNS Number, Industry Code, Geographical Density, Location Uniqueness, Registration Number and URL respectively. Example: 0299990000999800000000009898
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponentCount integer (up to 2 characters) Indicates the number of components in the Match Data Profile.
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent Array of MatchDataProfileComponent
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Text​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.Value string (2 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText DNBDecodedStringType
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeValue integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentTypeText​.DNBCodeTableNumber integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.MatchDataProfileComponentValue string (2 characters)
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.MatchQualityInformation​.MatchDataProfileComponent[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.MatchResponseDetail​.MatchCandidate[]​.DisplaySequence integer
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail CleanseAndStandardizeResult
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedName StandardizedNameType
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName DNBStringType256
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName​.LanguageCode integer
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedName​.OrganizationName​.WritingScriptISOAlpha4Code string (up to 4 characters)
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress StandardizedAddress
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.StreetAddressLine Array of StreetAddressLine
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.StreetAddressLine[]​.LineText string (up to 240 characters)
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.PrimaryTownName string (up to 64 characters)
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.CountyName string (up to 64 characters)
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.TerritoryAbbreviatedName string (up to 64 characters)
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.TerritoryName string (up to 64 characters)
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.PostalCode string (up to 16 characters) Postal Code
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.PostalCodeExtensionCode string (up to 16 characters)
GetCleanseMatchResponseDetail​.CleanseAndStandardizeResponseDetail​.StandardizedAddress​.CountryISOAlpha2Code string (2 characters) 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. Available Values:
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PR
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SK
SL
SM
SN
SO
SR
ST
SV
SY
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
YE
YT
ZA
ZM
ZW
AD
AE
AF
AG
AI
AL
AM
AN
AO
AR
AS
AT
AU
AW
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BM
BN
BO
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IN
IQ
IR
IS
IT
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
<