Search & Build-a-List - Company
Also known as Locating Companies
| Product | D&B Direct 2.0, D&B Direct Onboard |
| Product Code(s) | Not Applicable |
| Options(s) | Basic, Advanced |
| Monitoring Available | No |
| Interface | REST |
| Method | GET |
| Format(s) | JSON |
| Service | EntityList |
| {version} | 6.4 |
| 6.4 Released On | October 6, 2017 |
Returns a set of companies based on keyword, along with basic identifying data for each company.
Update History
- August 05, 2022 (All SOAP & REST): Defect fix to update order of industry code aggregate population based on the priority.
- September 17, 2021 (All SOAP & REST): Defect fix to Truncate the address line response character to 120 characters.
- June 11, 2021 (All SOAP & REST): Defect Fix to add the language code check to populate only English characters.
- October 6, 2017 (v6.4 SOAP & REST): Version 6.4 is now available for Entity List service.
- January 29, 2016 (v6.2 SOAP & REST): The response elements PrimaryAddress LatitudeMeasurement and PrimaryAddress LongitudeMeasurement are added to Find Company response. The UnitofSize attribute is added to Sales Revenue Amount response for Find Competitor.
- December 12, 2014 (v6.1 SOAP & REST): Changes to the FindContact and Find Company operations include: 1. Added the following enumerations to InclusionDataEnum – IncludeNonMarketable, IncludeDelisted; and 2. Added the following enumerations to SortBasisText - Relevancy.
- October 25, 2013 (v6.0 SOAP & REST): The following changes apply: IndustryTypeCode has been changed from a free-form text field to an enumerated type; Multiple postal code ranges may now be specified on requests; MarketingRiskClassCode may now include a value of 0 indicating "unknown"; InclusionDataDescription may now include a value of "IncludeNonMarketableOnly"; Three new filters provide the ability to screen on publicly traded companies, descendants of publicly traded companies, and organizations having a manufacturing facility; Added a new sort criteria: ConsolidatedEmployeeQuantity. This field is also included on the response; and Two new search facets that correspond to the publicly traded company filters.
Feature Request
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
Overview
There are several options available when implementing this feature.
1. Keyword Search (Basic/Advanced): An organization keyword is required in addition to setting the search mode to 'Basic'. The organization keyword (KeywordText) will be compared against any company names (past, present, synonyms and tradestyles) and stock ticker symbols. An option exists (in Advanced search) to limit the search comparison to specific fields.
Keyword search criteria are NOT case sensitive (i.e. "SAMPLE", "Sample" and "sample" will return the same results). Multiple keywords may be specified in either keyword criteria field, separated by spaces.
This feature supports a wild card pattern in the keyword search criteria, which allows an asterisk to be appended to, embedded in, or placed at the start of the keyword parameter.
The optional D&B D-U-N-S Number range may be provided when compiling lists in excess of 10,000 results.
2. Inclusion Rules (Basic/Advanced): By default, organizations with certain operating conditions will be excluded from the results. An option is available to include the following: undeliverable address records, out of business records, incomplete data records, and only non-marketable* businesses.
*In general, a record that meets the following criteria is considered marketable: it has been updated within the last 24 months; it contains a complete business name, valid physical or mailing address, and valid Standard Industry Classification Code; and it is believed to be in business.
NOTE: This rule does not exclude/include de-listed companies (i.e., a company that has requested to be excluded from direct marketing use cases).
3. Sorting Results (Basic/Advanced): By default, the results from this service will be in descending order by Annual Sales, unless specified differently in the request. Both the sort direction and a primary sort field can be designated in the request.
4. Pagination (Basic/Advanced): Options exist to designate the maximum number of records per request, and the starting row number. The maximum number of records this feature will return on a single request is 10,000. The default page length is 25 records.
The remaining options are available only in the advanced version (search mode set to 'Advanced') of this feature.
5. Geographic Proximity (Advanced only): Any combination of longitude+latitude coordinates or postal code, telephone number (full or partial) or street address may be passed to produce a list of matching organizations. By default the criteria provided will be applied using "AND" logic, however, an option is available to alternatively apply "OR" logic to the request.
When performing a search using longitude+latitude, a radius and scale (miles or kilometers) must be supplied. This option is only available when the country code specified is "US" or "CA".
When a postal code is provided, a country code must also be specified.
When providing a U.S. postal code as a criteria, leading zeros are required in the request. For example, "01234" is correct, while "1234" is not correct.
If a postal code is provided, this service will identify the longitude+latitude coordinates for the central point of the respective geographical area. This option is only applicable when the country code specified is "US".
When providing a telephone number as a criteria, exclude any non-numeric characters and spaces. (e.g. "(800) 555-1212" should be supplied as "8005551212")
6. Company Information (Advanced only): Filter for companies by location type, D&B Prescreen Score, ownership type, stock ticker and exchange, D-U-N-S Number, legal status, year of founding, subsidiary status, diversity status (minority owned, women owned and ethnicity classification), occupancy status (owns/rents), franchise status and foreign trade.
7. Industry (Advanced only): Filter for companies by Hoover's Industries, SIC Codes, and NAIC Codes, either by a specific industry code or range. An option exists to search only on an organization's primary industry code.
8. Company Size (Advanced only): Filter for companies by sales, market cap, employees and facility size.
9. Financial Information (Advanced only): filter for companies by net income, assets, fiscal year end, auditors, and rankings/indices.
10. IPO Data (Advanced only): Filter for companies by IPO date, offer amount, price range and underwriters.
Minimum Requirements
The details in this section override the Optional/Required values listed in the Request Specification table.
- The field SearchModeDescription must be set to a value of Basic or Advanced for this feature to work properly (for this use case).
When performing a search using longitude+latitude, a radius measurement and unit code (3353 for miles or 3349 for kilometers) must be supplied.
Data Layer Entitlement
For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.
- The BASIC feature is entitled as "Search/Lookup for Companies" for D&B Direct 2.0 customers.
- The ADVANCED feature is entitled as "Detailed Search & Build-a-List - Company/Industry" for D&B Direct 2.0 customers.
For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.
- This particular data layer is included in the D&B Direct Onboard 2.0 suite.
Specification
The D&B Direct 2.0 API supports HTTP compression. To utilize this option, add the following line to the header of your request: Accept-Encoding: gzip,deflate
GET https://direct.dnb.com/V6.4/organizations?KeywordText=Gorman%20Manufacturing&SearchModeDescription=Basic&findcompany=true&InclusionDataDescription=IncludeNonMarketable Authorization: <My Token>
GET https://direct.dnb.com/V6.4/organizations?KeywordText=Gorman%20Manufacturing&SearchModeDescription=Advanced&findcompany=true&InclusionDataDescription=IncludeNonMarketable Authorization: <MyToken>
Input parameters that include a "-n" designation may be repeated on the request, using a sequence number. For example, for the parameter "example-n", create a request like https://{endpoint}?{other parameters}&example-1={value}&example-2={value} and so on. If a single instance of the parameter is used, it still requires a "-1" suffix.
| Basic | Advanced | Name | Characteristics |
|---|---|---|---|
| Y | Y | ApplicationTransactionID | string, up to 64 chars, Optional A number assigned by the calling application to uniquely identify this request. |
| Y | Y | TransactionTimestamp | dateTime, Optional 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&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
| Y | Y | SubmittingOfficeID | string, up to 64 chars, Optional A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. |
| N | Y | DUNSNumber-n (Can repeat up to 10 times) | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The numeric value assigned by Dun & Bradstreet to uniquely identify the contact organization .This subject identifier under the Data Universal Numbering System. This is a numeric which is always 9 digits; the leading digit or digits may be zero. |
| N | Y | OrganizationName | OrganizationNameSimpleType up to 240 chars, Optional |
| N | Y | WebPageAddress-n (Can repeat up to 10 times) | string, up to 240 chars, Optional |
| N | Y | StreetAddressLine-n (Can repeat up to 10 times) | string, up to 240 chars, Optional |
| N | Y | PrimaryTownName-n (Can repeat up to 10 times) | PrimaryTownNameType up to 240 chars, Optional |
| N | Y | MetropolitanStatisticalAreaUSCensusCode-n (Can repeat up to 10 times) | string, up to 16 chars, Optional NOTE: Deprecated |
| N | Y | CountyGEOREFID-n (Can repeat up to 10 times) | string, up to 13 chars, Optional NOTE: Deprecated |
| N | Y | TerritoryName-n (Can repeat up to 10 times) | TerritoryNameType up to 64 chars, Optional |
| N | Y | PostalCode-n (Can repeat up to 10 times) | string, up to 16 chars, Optional |
| N | Y | PostalCodeLowRangeValue-n | string, up to 16 chars, Optional The lower limit of a range for the identifier used by the local country Postal Authority to identify a particular geographic location. For example, in Belgium, Postal Code 9000 identifies the town of GHENT. NOTE: Deprecated |
| N | Y | PostalCodeHighRangeValue-n | string, up to 16 chars, Optional The upper limit of a range for the identifier used by the local country Postal Authority to identify a particular geographic location. For example, in Belgium, Postal Code 9000 identifies the town of GHENT. NOTE: Deprecated |
| N | Y | CountryISOAlpha2Code-n (Can repeat up to 10 times) | string, at least 2 chars, up to 2 chars, Optional |
| N | Y | CountryGroupGEOREFID-n (Can repeat up to 10 times) | string, up to 16 chars, Optional NOTE: Deprecated |
| N | Y | RadiusSearchPostalCode | string, up to 32 chars, Optional |
| N | Y | RadiusSearchCountryISOAlpha2Code | string, at least 2 chars, up to 2 chars, Optional |
| N | Y | RadiusMeasurement | decimal, up to 5 digits, maximum of 2 decimal places, Optional |
| N | Y | RadiusMeasurementUnitCode | integer, up to 7 digits, Optional Possible values: 3353 [miles]; 3349 [kilometre] |
| N | Y | RadiusSearchLatitudeMeasurement | LatitudeMeasurementType up to 9 digits, maximum of 6 decimal places, Optional |
| N | Y | RadiusSearchLongitudeMeasurement | LongitudeMeasurementType up to 10 digits, maximum of 6 decimal places, Optional |
| N | Y | TelephoneNumberAreaCode-n | string, at least 1 char, up to 16 chars, Required |
| N | Y | FamilyTreeMemberRoleCode-n (can repeat up to 4 times) | integer, up to 7 digits, Optional Possible values: 9141 [Parent/Headquarters] - for Parent; HQ or Parent & HQ; 12769 [Branch] - for Branch or Division; 9159 [Subsidiary] |
| N | Y | StandaloneOrganizationIndicator | StandaloneOrganizationIndicatorType, Optional |
| N | Y | IndustryCodeTypeCode | Possible values: 3599 -USSIC; 19295 - UKSIC; 700 - NAICS; 35912 - Hoovers Industry Code |
| N | Y | IndustryCode-n | string, up to 16 chars, Optional Full or partial industry code. For full industry codes, exact matches will be returned. For partial industry codes, matching candidates that begin with the partial code will be returned. |
| N | Y | IndustryCodeLowRangeValue | string, up to 16 chars, Optional NOTE: Deprecated |
| N | Y | IndustryCodeHighRangeValue | string, up to 16 chars, Optional NOTE: Deprecated |
| N | Y | PrimaryIndustryCodeOnlyIndicator | boolean, Optional NOTE: Deprecated |
| N | Y | LegalFormCode-n (can repeat up to 10 times) | integer, up to 7 digits, Optional Possible values: 451 (Corporation); 452 (Partnership); 453 (Proprietorship); 454 (NationalGovernmentEntity); 455 (RegionalLocalGovernmentEntity); 456 (JointVenture); 457 (NonProfitOrganization); 461 (CooperativeMutualOrganization); 469 (ForeignCompany) |
| N | Y | ControlOwnershipTypeCode-n (can repeat up to 10 times) | integer, up to 7 digits, Optional Possible values: 9057 [Publicly owned]; 9058 [Privately owned]; 9059 [State owned] NOTE: Deprecated |
| N | Y | ControlOwnershipFromYear | integer, Optional NOTE: Deprecated |
| N | Y | ControlOwnershipToYear | integer, Optional NOTE: Deprecated |
| N | Y | OrganizationStartFromYear | integer, Optional NOTE: Deprecated |
| N | Y | OrganizationStartToYear | integer, Optional NOTE: Deprecated |
| N | Y | MarketingRiskClassCode-n (can repeat up to 4 times) | MarketingRiskClassCodeEnum up to 7 digits, Optional Possible values: 10925 [Low]; 10926 [Moderate]; 10927 [High]; 0 [Unknown] NOTE: Deprecated |
| N | Y | GlobalUltimateDUNSNumber-n(can repeat up to 10 times) | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional NOTE: Deprecated |
| N | Y | FiscalPeriodEndMonth-n (can repeat up to 12 times) | MonthType, Optional NOTE: Deprecated |
| N | Y | AuditorID-n (can repeat up to 10 times) | string, up to 256 chars, Optional NOTE: Deprecated |
| N | Y | UnderwriterID-n (can repeat up to 10 times) | string, up to 256 chars, Optional NOTE: Deprecated |
| Y | Y | DUNSNumberLowRangeValue | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The minimum DUNS Number of the companies to be listed in the search result. This is used for search within range values. NOTE: Deprecated |
| Y | Y | DUNSNumberHighRangeValue | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The maximum DUNS Number of the companies to be listed in the search result. This is used for search within range values. NOTE: Deprecated |
| N | Y | SalesLowRangeAmount | decimal, Optional |
| N | Y | SalesLowRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | SalesHighRangeAmount | decimal, Optional |
| N | Y | SalesHighRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | TotalAssetLowRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | TotalAssetLowRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | TotalAssetHighRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | TotalAssetHighRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | MarketCapitalizationLowRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | MarketCapitalizationLowRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | MarketCapitalizationHighRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | MarketCapitalizationHighRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | NetIncomeLowRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | NetIncomeLowRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | NetIncomeHighRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | NetIncomeHighRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | NetIncomeGrowthLowRangePercentage | decimal, up to 7 digits, maximum of 2 decimal places, Optional NOTE: Deprecated |
| N | Y | NetIncomeGrowthHighRangePercentage | decimal, up to 7 digits, maximum of 2 decimal places, Optional NOTE: Deprecated |
| N | Y | IndividualEntityEmployeeLowRangeQuantity | integer, Optional |
| N | Y | IndividualEntityEmployeeHighRangeQuantity | integer, Optional |
| N | Y | ConsolidatedEmployeeLowRangeQuantity | integer, Optional |
| N | Y | ConsolidatedEmployeeHighRangeQuantity | integer, Optional |
| N | Y | ConsolidatedEmployeesGrowthLowRangePercentage | decimal, up to 7 digits, maximum of 2 decimal places, Optional NOTE: Deprecated |
| N | Y | ConsolidatedEmployeesGrowthHighRangePercentage | decimal, up to 7 digits, maximum of 2 decimal places, Optional NOTE: Deprecated |
| N | Y | SalesGrowthLowRangePercentage | decimal, up to 7 digits, maximum of 2 decimal places, Optional NOTE: Deprecated |
| N | Y | SalesGrowthHighRangePercentage | decimal, up to 7 digits, maximum of 2 decimal places, Optional NOTE: Deprecated |
| N | Y | PremisesAreaLowRangeMeasurement | integer, Optional NOTE: Deprecated |
| N | Y | PremisesAreaHighRangeMeasurement | integer, Optional NOTE: Deprecated |
| N | Y | OccupancyCode-n | integer, up to 7 digits, Optional Possible values: 1129 [Rents]; 1128 [Owns] NOTE: Deprecated |
| N | Y | PubliclyTradedCompanyIndicator | boolean, Optional When 'true' indicates that the organization offers its securities to general public, typically through a stock exchange. When 'false' indicates that the organization does not offer its securities to general public. |
| N | Y | UpwardFamilyMemberPubliclyTradedCompanyIndicator | boolean, Optional When 'true' indicates that an organization higher up in the family tree of the subject offers its securities to general public, typically through a stock exchange. When 'false' indicates that none of the organization(s) higher up in the family tree of the subject offer securities to general public. NOTE: Deprecated |
| N | Y | StockExchangeNameCode-n | integer, up to 7 digits, Optional NOTE: Deprecated |
| N | Y | StockExchangeTickerName | string, up to 100 chars, Optional Text by which this subject is identified at this Stock Exchange for share trading purposes, e.g., DNB. |
| N | Y | InitialPublicOfferingFilingFromDate | date, Optional NOTE: Deprecated |
| N | Y | InitialPublicOfferingFilingToDate | date, Optional NOTE: Deprecated |
| N | Y | InitialPublicOfferingTradingFromDate | date, Optional NOTE: Deprecated |
| N | Y | InitialPublicOfferingTradingToDate | date, Optional NOTE: Deprecated |
| N | Y | InitialPublicOfferingLowRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | InitialPublicOfferingLowRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | InitialPublicOfferingHighRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | InitialPublicOfferingHighRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | InitialPublicOfferingShareValueLowRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | InitialPublicOfferingShareValueLowRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | InitialPublicOfferingShareValueHighRangeAmount | decimal, Optional NOTE: Deprecated |
| N | Y | InitialPublicOfferingShareValueHighRangeAmountCurrencyISOAlpha3Code | Possible values: USD NOTE: Deprecated |
| N | Y | MinorityOwnedIndicator | boolean, Optional |
| N | Y | FemaleOwnedIndicator | boolean, Optional |
| N | Y | EthnicClassificationCode-n | integer, up to 7 digits, Optional Possible values: 10881 (Chinese; Filipino; Japanese; Korean; Vietnamese; or other Asian origin); 10882 (Black or African American); 10884 (Hispanic; Latino; or Spanish origin); 10885 (Indian Subcontinent origin); 10883 (American Indian; Alaska Native; or Native Hawaiian); 0 (Unknown) NOTE: Deprecated |
| Y | Y | KeywordText | string, up to 256 chars, Optional |
| N | Y | OrganizationIdentificationNumberTypeCode-n | Attribute |
| N | Y | OrganizationIdentificationNumber-n | string, at least 1 char, up to 40 chars, Optional A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an organization. NOTE: Deprecated |
| N | Y | FranchisingIndicator | boolean, Optional When 'true' indicates that the organization participates in a franchising relationship. When 'false' indicates that the organization does not participate in a franchising relationship. NOTE: Deprecated |
| N | Y | ImportIndicator | boolean, Optional When 'true' indicates that the subject company imports a quantity of goods from other countries. |
| N | Y | ExportIndicator | boolean, Optional When 'true' indicates that the subject company exports a quantity of goods to other countries. |
| N | Y | ManufacturingIndicator | boolean, Optional When 'true' indicates that the subject has a manufacturing facility. When 'false' indicates that the subject does not have a manufacturing facility; however as this is the assumed condition there is no requirement to create this tag to represent this fact. |
| N | Y | ReturnSalesNavigatorIndicator | boolean, Optional When 'true' the sales navigator will be returned. When 'false' the sales navigator will not be returned. If not specified, the default is FALSE. |
| N | Y | SalesNavigatorLowRangeAmount-n | decimal, Optional If only SalesLowRangeAmount is specified, the range will be SalesLowRangeAmount and higher. NOTE: Deprecated |
| N | Y | SalesNavigatorHighRangeAmount-n | decimal, Optional If only SalesHighRangeAmount is specified, the range will be SalesHighRangeAmount and lower. NOTE: Deprecated |
| N | Y | ReturnConsolidatedEmployeeQuantityNavigatorIndicator | boolean, Optional When 'true' the consolidated employee count navigator will be returned. When 'false' the consolidated employee count navigator will not be returned. If not specified, the default is FALSE. |
| N | Y | ConsolidatedEmployeeNavigatorLowRangeQuantity-n | integer, Optional If only ConsolidatedEmployeeLowRangeCount is specified, the range will be ConsolidatedEmployeeLowRangeCount and higher. NOTE: Deprecated |
| N | Y | ConsolidatedEmployeeNavigatorHighRangeQuantity-n | integer, Optional If only ConsolidatedEmployeeHighRangeCount is specified, the range will be ConsolidatedEmployeeHighRangeCount and lower. NOTE: Deprecated |
| N | Y | ReturnIndividualEmployeeQuantityNavigatorIndicator | boolean, Optional When 'true' the individual employee count navigator will be returned. When 'false' the individual employee count navigator will not be returned. If not specified, the default is FALSE. |
| N | Y | IndividualEmployeeNavigatorLowRangeQuantity-n | integer, Optional If only IndividualEmployeeLowRangeCount is specified, the range will be IndividualEmployeeLowRangeCount and higher. NOTE: Deprecated |
| N | Y | IndividualEmployeeNavigatorHighRangeQuantity-n | integer, Optional If only IndividualEmployeeHighRangeCount is specified, the range will be IndividualEmployeeHighRangeCount and lower. NOTE: Deprecated |
| N | Y | ReturnLocationNavigatorIndicator | boolean, Optional When 'true' the location navigator will be returned. When 'false' the location navigator will not be returned. If not specified, the default is FALSE. |
| N | Y | LocationNavigatorType-n | LocationNavigatorTypeEnum, Optional Possible values: Country; Territory NOTE: Deprecated |
| N | Y | ReturnIndustryNavigatorIndicator | boolean, Optional When 'true' the industry navigator will be returned. When 'false' the industry navigator will not be returned. If not specified, the default is FALSE. |
| N | Y | IndustryNavigatorIndustryTypeCode-n | integer, up to 7 digits, Optional Possible values: 3599 -USSIC; 19295 - UKSIC; 700 - NAICS; 35912 - Hoovers Industry Code NOTE: Deprecated |
| N | Y | ReturnFamilyTreeMemberRoleNavigatorIndicator | boolean, Optional When 'true' the family tree member role navigator will be returned. When 'false' the family tree member role navigator will not be returned. If not specified, the default is FALSE. |
| N | Y | ReturnStandaloneOrganizationNavigatorIndicator | boolean, Optional When 'true' the standalone organization navigator will be returned. When 'false' the standalone organization navigator will not be returned. If not specified, the default is FALSE. NOTE: Deprecated |
| N | Y | ReturnControlOwnershipTypeNavigatorIndicator | boolean, Optional When 'true' the control ownership type navigator will be returned. When 'false' the control ownership type navigator will not be returned. If not specified, the default is FALSE. NOTE: Deprecated |
| N | Y | ReturnUpwardFamilyMemberPubliclyTradedCompanyNavigator | boolean, Optional When ON (set to 1), the upward family member publicly traded company navigator will be returned. When 'false' the upward family member publicly traded company navigator will not be returned. If not specified, the default is FALSE. NOTE: Deprecated |
| N | Y | ReturnPubliclyTradedCompanyNavigator | boolean, Optional When ON (set to 1), the publicly traded company navigator will be returned. When 'false' the publicly traded company navigator will not be returned. If not specified, the default is FALSE. NOTE: Deprecated |
| Y | Y | ExactLocationFindIndicator | boolean, Optional Possible values: default "true" NOTE: Deprecated |
| Y | Y | SortDirectionText | SortDirectionEnum, Optional Possible values: Ascending; Descending |
| Y | Y | CandidateMaximumQuantity | integer, up to 6 digits, Optional |
| Y | Y | CandidatePerPageMaximumQuantity | integer, less than or equal to 10000, Optional |
| Y | Y | CandidateDisplayStartSequenceNumber | integer, less than or equal to 10000, Optional |
| Y | Y | SearchModeDescription | SearchModeEnum, Optional Text describing the nature of search to be applied during the search process. Possible values: Basic; Advanced |
| Y | Y | InclusionDataDescription-n | InclusionDataEnum, Optional Text that denotes an inclusion requirement that the Search process should apply to allow subjects from being returned as candidates. For example if the value is specified as Out of Business, then the Search process should return candidates that have an Operating Status which denotes Out Of Business. Possible values: IncludeUndeliverableAddressSubject; IncludeOutofBusiness; IncludeIncompleteData; IncludeNonMarketableOnly; IncludeNonMarketable; IncludeDelisted |
| Y | Y | KeywordScopeText | InclusionParameterenum, Optional Text denoting the type of parameter value provided in KeywordText to be used by the service to perform the search process. Possible values: OrganizationName; StockExchangeTickerName |
| Y | Y | SortBasisText | SortBasisTextEnum, Optional Parameter value using which search candidates will be sorted in the response. Possible values: ConsolidatedEmployeeQuantity; CountryISOAlpha2Code; DUNS Number; FamilyTreeMemberRole; OrganizationPrimaryName; PostalCode; PostalCodeExtensionCode; PrimaryTownName; SalesRevenueAmount; StandaloneOrganizationIndicator; StreetAddressLine; TelephoneNumber; TerritoryAbbreviatedName; TerritoryOfficialName; TradeStyleName; Relevancy, MarketabilityIndicator |
| Y | Y | CustomerReferenceText-n | string, at least 1 char, up to 240 chars, Optional (up to 5x) |
| Y | Y | CustomerBillingEndorsementText | string, at least 1 char, up to 240 chars, Optional NOTE: Deprecated |
Endpoint
Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.
NOTE: While "organizations" is part of this endpoint, there is no service by this name. Many D&B Direct calls have a similar structure; however, the {version} component is based on the SERVICE to which a given product is associated.
| REST (EntityList) |
|---|
| GET https://direct.dnb.com/V{version}/organizations?findcompany |
Testing
This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.
Feature Response
NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.
Specification
The following is a list of the possible data fields returned by this operation in the JSON response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.
{
"FindCompanyResponse": {
"@ServiceVersionNumber": "6.4",
"TransactionDetail": {
"ApplicationTransactionID": "Service Governance Samples - EntityListV6.4",
"ServiceTransactionID": "Id-cfb9a956eb5c000018ff0000a59059f1-1",
"TransactionTimestamp": "2016-01-28T01:48:48"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"FindCompanyResponseDetail": {
"CandidateMatchedQuantity": 1,
"CandidateReturnedQuantity": 1,
"FindCandidate": [
{
"DUNSNumber": "804735132",
"OrganizationPrimaryName": {
"OrganizationName": {
"$": "Gorman Manufacturing Company, Inc."
}
},
"PrimaryAddress": {
"StreetAddressLine": [
{
"LineText": "492 Koller Street"
}
],
"PrimaryTownName": "San Francisco",
"CountryISOAlpha2Code": "US",
"PostalCode": "94110",
"TerritoryOfficialName": "California",
"TerritoryAbbreviatedName": "CA",
"CountryOfficialName": "United States",
"LatitudeMeasurement": 12.34567,
"LongitudeMeasurement": -12.34567,
"GeographicalPrecisionText": {
"@DNBCodeValue": 0,
"$": "Unknown"
},
"MetropolitanStatisticalAreaUSCensusCode": [
"41860"
]
},
"TelephoneNumber": {
"TelecommunicationNumber": "6505550000"
},
"FamilyTreeMemberRole": [
{
"FamilyTreeMemberRoleText": {
"@DNBCodeValue": 12771,
"$": "Headquarters"
}
}
],
"StandaloneOrganizationIndicator": false,
"SubjectHandling": [
{
"SubjectHandlingText": {
"@DNBCodeValue": 7974,
"$": "Do not call"
}
}
],
"ManufacturingIndicator": true,
"ConsolidatedEmployeeDetails": {
"TotalEmployeeQuantity": 125
},
"SalesRevenueAmount": {
"@CurrencyISOAlpha3Code": "USD",
"@UnitOfSize": "Thousand",
"$": 19465.134
},
"DisplaySequence": 1
}
]
}
}
}
{
"FindCompanyResponse": {
"@ServiceVersionNumber": "6.4",
"TransactionDetail": {
"ApplicationTransactionID": "Id-e9a8c52d527270b101bb170d-1",
"ServiceTransactionID": "Id-e9a8c52d527270b101bb170d-1",
"TransactionTimestamp": "2017-10-04T11:01:06"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"FindCompanyResponseDetail": {
"CandidateMatchedQuantity": 4,
"CandidateReturnedQuantity": 4,
"FindCandidate": [
{
"DUNSNumber": "053499156",
"OrganizationPrimaryName": {
"OrganizationName": {
"$": "J Gorman Paving and Seal Coating"
}
},
"MarketabilityIndicator": true,
"PrimaryAddress": {
"StreetAddressLine": [
{
"LineText": "220 275 State Route 10 E"
}
],
"PrimaryTownName": "Succasunna",
"CountryISOAlpha2Code": "US",
"PostalCode": "07876",
"PostalCodeExtensionCode": "1358",
"TerritoryOfficialName": "New Jersey",
"TerritoryAbbreviatedName": "NJ",
"CountryOfficialName": "United States",
"MetropolitanStatisticalAreaUSCensusCode": [
"35620"
]
},
"TelephoneNumber": {
"TelecommunicationNumber": "9732077750"
},
"StandaloneOrganizationIndicator": true,
"IndustryCode": [
{
"@TypeText": "D&B Standard Industry Code",
"@DNBCodeValue": 3599,
"IndustryCode": {
"$": "16110200"
},
"IndustryCodeDescription": [
{
"@IndustryCodeDescriptionLengthCode": 2121,
"$": "SURFACING AND PAVING"
}
]
}
],
"ConsolidatedEmployeeDetails": {
"TotalEmployeeQuantity": 2
},
"PubliclyTradedCompanyIndicator": false,
"UpwardFamilyMemberPubliclyTradedCompanyIndicator": false,
"SalesRevenueAmount": {
"@CurrencyISOAlpha3Code": "USD",
"@UnitOfSize": "Million",
"$": 0.14
},
"DisplaySequence": 1
},
{
"DUNSNumber": "125163910",
"OrganizationPrimaryName": {
"OrganizationName": {
"$": "Howard Gorman"
}
},
"TradeStyleName": [
{
"OrganizationName": {
"$": "JAS SURGICAL"
}
}
],
"MarketabilityIndicator": true,
"PrimaryAddress": {
"StreetAddressLine": [
{
"LineText": "5 Rickland Dr"
}
],
"PrimaryTownName": "Dover",
"CountryISOAlpha2Code": "US",
"PostalCode": "07869",
"PostalCodeExtensionCode": "4304",
"TerritoryOfficialName": "New Jersey",
"TerritoryAbbreviatedName": "NJ",
"CountryOfficialName": "United States",
"MetropolitanStatisticalAreaUSCensusCode": [
"35620"
]
},
"TelephoneNumber": {
"TelecommunicationNumber": "9734421768"
},
"StandaloneOrganizationIndicator": true,
"IndustryCode": [
{
"@TypeText": "D&B Standard Industry Code",
"@DNBCodeValue": 3599,
"IndustryCode": {
"$": "50470300"
},
"IndustryCodeDescription": [
{
"@IndustryCodeDescriptionLengthCode": 2121,
"$": "MEDICAL EQUIP,SUPPS"
}
]
}
],
"ConsolidatedEmployeeDetails": {
"TotalEmployeeQuantity": 1
},
"PubliclyTradedCompanyIndicator": false,
"UpwardFamilyMemberPubliclyTradedCompanyIndicator": false,
"SalesRevenueAmount": {
"@CurrencyISOAlpha3Code": "USD",
"@UnitOfSize": "Million",
"$": 0.092
},
"DisplaySequence": 2
},
{
"DUNSNumber": "102456949",
"OrganizationPrimaryName": {
"OrganizationName": {
"$": "Brian O'Gorman Flooring Inc"
}
},
"MarketabilityIndicator": true,
"PrimaryAddress": {
"StreetAddressLine": [
{
"LineText": "633 Dorothy Ln"
}
],
"PrimaryTownName": "Landing",
"CountryISOAlpha2Code": "US",
"PostalCode": "07850",
"PostalCodeExtensionCode": "1410",
"TerritoryOfficialName": "New Jersey",
"TerritoryAbbreviatedName": "NJ",
"CountryOfficialName": "United States",
"MetropolitanStatisticalAreaUSCensusCode": [
"35620"
]
},
"TelephoneNumber": {
"TelecommunicationNumber": "9733987470"
},
"StandaloneOrganizationIndicator": true,
"IndustryCode": [
{
"@TypeText": "D&B Standard Industry Code",
"@DNBCodeValue": 3599,
"IndustryCode": {
"$": "17520000"
},
"IndustryCodeDescription": [
{
"@IndustryCodeDescriptionLengthCode": 2121,
"$": "FLOOR WORK NEC"
}
]
}
],
"ConsolidatedEmployeeDetails": {
"TotalEmployeeQuantity": 1
},
"PubliclyTradedCompanyIndicator": false,
"UpwardFamilyMemberPubliclyTradedCompanyIndicator": false,
"SalesRevenueAmount": {
"@CurrencyISOAlpha3Code": "USD",
"@UnitOfSize": "Million",
"$": 0.07
},
"DisplaySequence": 3
},
{
"DUNSNumber": "019951598",
"OrganizationPrimaryName": {
"OrganizationName": {
"$": "Marilyn O'Gorman"
}
},
"MarketabilityIndicator": true,
"PrimaryAddress": {
"StreetAddressLine": [
{
"LineText": "67 Crestview Ln"
}
],
"PrimaryTownName": "Mount Arlington",
"CountryISOAlpha2Code": "US",
"PostalCode": "07856",
"PostalCodeExtensionCode": "1390",
"TerritoryOfficialName": "New Jersey",
"TerritoryAbbreviatedName": "NJ",
"CountryOfficialName": "United States",
"MetropolitanStatisticalAreaUSCensusCode": [
"35620"
]
},
"TelephoneNumber": {
"TelecommunicationNumber": "9733980687"
},
"StandaloneOrganizationIndicator": true,
"IndustryCode": [
{
"@TypeText": "D&B Standard Industry Code",
"@DNBCodeValue": 3599,
"IndustryCode": {
"$": "73899999"
},
"IndustryCodeDescription": [
{
"@IndustryCodeDescriptionLengthCode": 2121,
"$": "ATVTY AT NON COMMRCL"
}
]
}
],
"ConsolidatedEmployeeDetails": {
"TotalEmployeeQuantity": 1
},
"PubliclyTradedCompanyIndicator": false,
"UpwardFamilyMemberPubliclyTradedCompanyIndicator": false,
"SalesRevenueAmount": {
"@CurrencyISOAlpha3Code": "USD",
"@UnitOfSize": "Million",
"$": 0.057
},
"DisplaySequence": 4
}
]
}
}
}
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered in the response and should be anticipated in any implementation.
Empty/NULL Values
A NULL returned for an element indicates that the information was not provided to D&B when the related data items were collected. The absence of a value for a particular item should not be considered indicative of any implied value (e.g., NULL for a boolean indicator is NOT the same as a value of 'false').
Abbreviated Territory Names
When present, the Territory Abbreviated Name field will contain local abbreviations, which may be based on standard designations. For companies domiciled in the United States or Canada, this field will contain the second component of ISO 3166-2 codes. For example, the ISO 3166-2:US code for New Jersey is "US-NJ" and the value "NJ" will be delivered in this field. Similarly, the ISO 3166-2:CA code for Ontario is "CA-ON" and the value "ON" will be delivered in this field.
Response Codes & Error Handling
Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.
This operation may return the following response codes: CM002, CM003, CM004, CM005, CM007, CM012, CM018, CM022, and SC001-SC009.
D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.
Qualified usage (e.g., a successful response) is tracked and billed according to the terms & conditions of the customer's contract. The response codes CM000, CM010, PD002 and PD015 are considered successful. A built-in feature exists to prevent duplicate billing when multiple successful requests with the same criteria are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).
Search operations that involve pagination will only be recorded once -- upon the initial search request. Therefore, customer online usage (OLUS) reports will display a single entry for each unique combination of search criteria requested.
Business Elements
While D&B Direct uses a product canonical naming model in the request/response, many customers may be more familiar with the following business element labels.
| Basic | Advanced | Business Element Name | Description |
|---|---|---|---|
| N | Y | Count of Publicly Traded Companies | PCM XPath: //NavigatorDetail/ PubliclyTradedCompanyNavigatorDetail/ CandidateMatchedQuantity |
| N | Y | Count of Upward Family Member Publicly Traded Companies | PCM XPath: //NavigatorDetail/ UpwardFamilyMemberPubliclyTradedCompanyNavigatorDetail/ CandidateMatchedQuantity |
| Y | Y | Country Code | The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme, where the company is located. PCM XPath: //FindCandidate/ PrimaryAddress/ CountryOfficialName |
| Y | Y | D-U-N-S Number | PCM XPath: //FindCandidate/ DUNSNumber |
| Y | Y | Employee Quantity (All Locations) | PCM XPath: //FindCandidate/ ConsolidatedEmployeeDetails/ TotalEmployeeQuantity |
| Y | Y | Family Tree Member Role (HQ/Branch/Subsidiary) | PCM XPath: //FindCandidate/ FamilyTreeMemberRole/ FamilyTreeMemberRoleText |
| Y | Y | Fax Number | Main facsimile number of the business. PCM XPath: //FindCandidate/ FacsimileNumber/ TelecommunicationNumber |
| N | Y | Industry Code | This code represents the locally used activity code. These are generally regionally based industry identification systems. Examples include 1972 U.S. SIC, SBA, APE, and NACE. PCM XPath: //FindCandidate/ IndustryCode/ IndustryCode |
| Y | Y | Latitude | The angular distance of the organization's primary physical address north or south from the Earth's equator measured through 90 degrees expressed in decimal numbers. PCM XPath: //FindCandidate/ PrimaryAddress/ LatitudeMeasurement |
| Y | Y | Longitude | The angular distance of the organization's primary physical address east or west from an imaginary line (called the prime meridian) that goes from the North Pole to the South Pole measured through 90 degrees expressed in decimal numbers. PCM XPath: //FindCandidate/ PrimaryAddress/ LongitudeMeasurement |
| Y | Y | Mailing Country Code | The three digit code associated with the country name of the mailing address. PCM XPath: //FindCandidate/ MailingAddress/ CountryOfficialName |
| Y | Y | Mailing Postal Code | The postal code where the business has its mail delivered. PCM XPath: //FindCandidate/ MailingAddress/ PostalCode |
| Y | Y | Mailing Street Address | PCM XPath: //FindCandidate/ MailingAddress/ StreetAddressLine/ LineText |
| Y | Y | Mailing Territory Abbreviated Name | PCM XPath: //FindCandidate/ MailingAddress/ TerritoryAbbreviatedName |
| Y | Y | Mailing Territory Name | PCM XPath: //FindCandidate/ MailingAddress/ TerritoryOfficialName |
| Y | Y | Mailing Town Name | The mailing city associated with the mailing address. PCM XPath: //FindCandidate/ MailingAddress/ PrimaryTownName |
| Y | Y | Manufacturing Indicator | Indicates whether or not manufacturing is done at this location. PCM XPath: //FindCandidate/ ManufacturingIndicator |
| N | Y | Marketability Indicator | Indicates whether or not the subject record satisfies D&B's global marketability rules PCM XPath: //FindCandidate/ MarketabilityIndicator |
| Y | Y | Postal Code | Zip code from inquiry request PCM XPath: //FindCandidate/ PrimaryAddress/ PostalCode |
| Y | Y | Primary Business Name | PCM XPath: //FindCandidate/ OrganizationPrimaryName/ OrganizationName |
| N | Y | Publicly Traded Company Indicator | PCM XPath: //FindCandidate/ PubliclyTradedCompanyIndicator |
| Y | Y | Sales Revenue Amount (US Dollars) | PCM XPath: //FindCandidate/ SalesRevenueAmount |
| Y | Y | Standalone Organization Indicator | PCM XPath: //FindCandidate/ StandaloneOrganizationIndicator |
| N | Y | Stock Exchange Name | A code used to identify the Stock Exchange at which the subjects Ticker Name is registered. PCM XPath: //FindCandidate/ StockExchangeDetails/ StockExchangeName |
| N | Y | Stock Ticker Name | PCM XPath: //FindCandidate/ StockExchangeDetails/ StockExchangeTickerName |
| Y | Y | Street Address | PCM XPath: //FindCandidate/ PrimaryAddress/ StreetAddressLine/ LineText |
| Y | Y | Subject Handling Text | PCM XPath: //FindCandidate/ SubjectHandling/ SubjectHandlingText |
| Y | Y | Telephone Number | The subjects Telephone Number within the telephone exchange. e.g., 422000 for D&B, High Wycombe, UKThis will also include the exchange code in those countries where this is applicable.If the telephone number cannot be parsed into its component parts then PCM XPath: //FindCandidate/ TelephoneNumber/ TelecommunicationNumber |
| Y | Y | Telephone Number International Dialing Code | International dialing code for country PCM XPath: //FindCandidate/ TelephoneNumber/ InternationalDialingCode |
| Y | Y | Territory Abbreviated Name | PCM XPath: //FindCandidate/ PrimaryAddress/ TerritoryAbbreviatedName |
| Y | Y | Territory Name | PCM XPath: //FindCandidate/ PrimaryAddress/ TerritoryOfficialName |
| Y | Y | Town Name | The name of the city or town in which the business is physically located. PCM XPath: //FindCandidate/ PrimaryAddress/ PrimaryTownName |
| Y | Y | Trade Style Name | Text recording the trade style name of the company. Trade styles are additional business names used by a company, also referred to as a DBA (doing business as) or AKA (also known as) name. PCM XPath: //FindCandidate/ TradeStyleName/ OrganizationName |
| N | Y | Upward Family Member Publicly Traded Company Indicator | PCM XPath: //FindCandidate/ UpwardFamilyMemberPubliclyTradedCompanyIndicator |
The preceding list is not presented in the order, nor manner, in which the information is packaged and delivered via the D&B Direct API. Legend: [C] = may be included in a Custom Data product; [M] = may be referenced by the Monitoring process; [M+] = Monitored using an aggregate or attribute XPath.
Feature Notes
For the BASIC search option, the relevancy sort utilizes weighted values based on the match rate in the name and revenue fields, along with additional considerations.
For the ADVANCED search option, the relevancy option utilizes a proprietary algorithm for returning the best-matched results, taking into consideration input parameters sent in the request, along with additional weighted factors.
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.