Search & Build-a-List - Contacts
Also known as Locating Contacts
| 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 search results of people based on keyword.
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): A contact keyword is required in addition to setting the search mode to 'Basic'. The contact keyword (KeywordContactText) will be compared against the contact name, title and biography fields. 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 organization keyword and/or D&B D-U-N-S Number range may be provided as options. The organization keyword (KeywordText) will be compared against any company names (past, present, synonyms and tradestyles) and stock ticker symbols.
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, only non-marketable* businesses, only contacts with direct email details, only contacts with direct telephone details or only contacts with either direct email or telephone details.
*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 descending by order of relevancy (i.e. best matched results). Optionally, both the sort direction and a primary sort field can be designated on 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.
11. People (Advanced only): Filter for people by job function, salary, bonus, total compensation and age.
A separate email only version (search mode set to 'EmailLookup') of this function is available to search for people using an email address. No other criteria may be used in conjunction with the email address. The sorting and pagination options, however, do apply.
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, Advanced or EmailLookup 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.
- This BASIC feature is entitled as "Search/Lookup for People" for D&B Direct 2.0 customers.
- This ADVANCED feature is entitled as "Detailed Build-a-List - Contacts" 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
Sample Request (Basic)
GET https://direct.dnb.com/V6.4/organizations?findcontact=true&KeywordText=Gorman%20Manufacturing&KeywordContactText=Kevin&SearchModeDescription=Basic&InclusionDataDescription=IncludeNonMarketable
Authorization: <My Token>
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.
Filter:
| Availability | 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 | Element NOTE: Deprecated | |
| N | Y | PostalCodeHighRangeValue | Element NOTE: Deprecated | |
| 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 6 times) | string, up to 16 chars, Optional Possible values: North America : 1; South America : 2; Europe : 3; Asia : 4; Australia : 5; Africa : 6 NOTE: Deprecated | |
| N | Y | RadiusSearchPostalCode | string, up to 32 chars, Optional NOTE: Deprecated | |
| N | Y | RadiusSearchCountryISOAlpha2Code | Element, Optional NOTE: Deprecated | |
| N | Y | RadiusMeasurement | decimal, up to 5 digits, maximum of 2 decimal places, Optional NOTE: Deprecated | |
| N | Y | RadiusMeasurementUnitCode | integer, up to 7 digits, Optional Possible values: 3353 [miles]; 3349 [kilometre] NOTE: Deprecated | |
| N | Y | RadiusSearchLatitudeMeasurement | LatitudeMeasurementType up to 9 digits, maximum of 6 decimal places, Optional NOTE: Deprecated | |
| N | Y | RadiusSearchLongitudeMeasurement | LongitudeMeasurementType up to 10 digits, maximum of 6 decimal places, Optional NOTE: Deprecated | |
| N | Y | TelephoneNumberAreaCode-n (Can repeat up to 10 times) | string, at least 1 char, up to 16 chars, Optional NOTE: Deprecated | |
| 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] NOTE: Deprecated | |
| N | Y | StandaloneOrganizationIndicator | StandaloneOrganizationIndicatorType, Optional NOTE: Deprecated | |
| N | Y | IndustryCodeTypeCode | Element 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 | 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) NOTE: Deprecated | |
| N | Y | ControlOwnershipTypeCode-n (Can repeat up to 3 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 3 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 NOTE: Deprecated | |
| N | Y | SalesLowRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | SalesHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | SalesHighRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | TotalAssetLowRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | TotalAssetLowRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | TotalAssetHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | TotalAssetHighRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | MarketCapitalizationLowRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | MarketCapitalizationLowRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | MarketCapitalizationHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | MarketCapitalizationHighRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | NetIncomeLowRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | NetIncomeLowRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | NetIncomeHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | NetIncomeHighRangeAmountCurrencyISOAlpha3Code | Element 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 NOTE: Deprecated | |
| N | Y | IndividualEntityEmployeeHighRangeQuantity | integer, Optional NOTE: Deprecated | |
| N | Y | ConsolidatedEmployeeLowRangeQuantity | integer, Optional NOTE: Deprecated | |
| N | Y | ConsolidatedEmployeeHighRangeQuantity | integer, Optional NOTE: Deprecated | |
| 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. NOTE: Deprecated | |
| 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 | Element Possible values: USD NOTE: Deprecated | |
| N | Y | InitialPublicOfferingHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | InitialPublicOfferingHighRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | InitialPublicOfferingShareValueLowRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | InitialPublicOfferingShareValueLowRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | InitialPublicOfferingShareValueHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | InitialPublicOfferingShareValueHighRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | MinorityOwnedIndicator | boolean, Optional NOTE: Deprecated | |
| N | Y | FemaleOwnedIndicator | boolean, Optional NOTE: Deprecated | |
| 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 | Element Possible values: 2541: COMPANIES REGISTRY OFFICE Number (GB) | |
| 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. NOTE: Deprecated | |
| N | Y | ExportIndicator | boolean, Optional When 'true' indicates that the subject company exports a quantity of goods to other countries. NOTE: Deprecated | |
| N | Y | IndividualAgeLowRangeValue | integer, Optional NOTE: Deprecated | |
| N | Y | IndividualAgeHighRangeValue | integer, Optional NOTE: Deprecated | |
| N | Y | ManagementResponsibilityCode | string, up to 16 chars, Optional | |
| N | Y | BaseSalaryLowRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | BaseSalaryLowRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | BaseSalaryHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | BaseSalaryHighRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | BonusCompensationLowRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | BonusCompensationLowRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | BonusCompensationHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | BonusCompensationHighRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | TotalCompensationLowRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | TotalCompensationLowRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| N | Y | TotalCompensationHighRangeAmount | decimal, Optional NOTE: Deprecated | |
| N | Y | TotalCompensationHighRangeAmountCurrencyISOAlpha3Code | Element Possible values: USD NOTE: Deprecated | |
| Y | Y | KeywordContactText | string, up to 30 chars, Optional NOTE: Deprecated | |
| N | Y | KeywordContactScopeText | ContactSearchScopeTextEnum, Optional Possible values: Bio; Title (search in Jobtitle text and Management Responsibility Text); Both (Bio and Title) NOTE: Deprecated | |
| N | Y | ContactName | string, up to 256 chars, Optional | |
| N | Y | ContactEmailAddress | string, Optional Text recording the electronic mail address used by a subject by which the subject can transmit and or receive text messages, links, and files electronically, typically via a network, like the Internet. | |
| N | Y | JobFunction | string, Optional Title assigned by D&B based on the routine set of tasks or activities undertaken by a person in that position. | |
| 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. NOTE: Deprecated | |
| Y | Y | ExactLocationFindIndicator | boolean, Optional 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; EmailLookup | |
| Y | Y | InclusionDataDescription-n | InclusionContactDataEnum, 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; IncludeContactsOnlyWithDirectEmail; IncludeContactsOnlyWithDirectPhone; IncludeContactsOnlyWithDirectEmailOrDirectPhone; IncludeNonMarketableOnly; IncludeNonMarketable; IncludeDelisted NOTE: Deprecated | |
| Y | Y | SortBasisText | SortBasisTextContactEnum, Optional Possible values: DUNSNumber; FirstName; FullName; LastName; ManagementResponsibilityCodeText; OrganizationPrimaryName; ConsolidatedEmployeeQuantity; SalesRevenueAmount; Relevancy; JobRanking | |
| N | Y | ReturnJobTitleNavigatorIndicator | boolean, Optional When 'true' the job title navigator will be returned. When 'false' the job title navigator will not be returned. If not specified, the default is FALSE. NOTE: Deprecated | |
| N | Y | ReturnManagementResponsibilityCodeNavigatorIndicator | boolean, Optional When 'true' the management responsibility code navigator will be returned. When 'false' the management responsibility code navigator will not be returned. If not specified, the default is FALSE. | |
| 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 | ReturnContactDataNavigatorIndicator | boolean, Optional When 'true' the contact data navigator will be returned. When 'false' the contact data navigator will not be returned. If not specified, the default is FALSE. NOTE: Deprecated | |
| 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?findcontact |
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.
The results from this search will return principal identification numbers (Principal ID) that may be passed to the People feature to obtain additional information about individuals.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.
Sample Response (Basic)
{
"FindContactResponse": {
"@ServiceVersionNumber": "6.4",
"TransactionDetail": {
"ApplicationTransactionID": "ServiceGovernance EntityList 6.4 Sample",
"ServiceTransactionID": "Id-d04cac56df95010074020100aece7395-1",
"TransactionTimestamp": "2016-01-30T00:40:32"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"FindContactResponseDetail": {
"CandidateMatchedQuantity": 2,
"CandidateReturnedQuantity": 2,
"FindCandidate": [
{
"DUNSNumber": "804735132",
"ContactID": {
"$": "804735132-5412658"
},
"OrganizationPrimaryName": {
"OrganizationName": {
"$": "Gorman Manufacturing Company, Inc."
}
},
"ConsolidatedEmployeeDetails": {
"TotalEmployeeQuantity": 125
},
"NonMarketableReasonText": [],
"ContactName": {
"FirstName": "Kevin",
"MiddleName": "J",
"LastName": "Hunt",
"FullName": "Kevin J Hunt"
},
"PrincipalIdentificationNumberDetail": [
{
"@DNBCodeValue": 24215,
"@TypeText": "Professional Contact Identifier",
"PrincipalIdentificationNumber": "5412658"
}
],
"JobTitle": [
{
"JobTitleText": {
"$": "Sec-treas"
}
}
],
"ManagementResponsibilityCodeText": [
{
"$": "Secretary"
}
],
"JobRanking": "2",
"ContactDataSourceDetail": {
"NameInformationSourceName": {
"$": "DNB"
}
},
"DirectTelephoneInformationAvailableIndicator": false,
"DirectEmailInformationAvailableIndicator": false,
"ManufacturingIndicator": true,
"DisplaySequence": 1
},
{
"DUNSNumber": "804735132",
"ContactID": {
"$": "804735132-5412657"
},
"OrganizationPrimaryName": {
"OrganizationName": {
"$": "Gorman Manufacturing Company, Inc."
}
},
"ConsolidatedEmployeeDetails": {
"TotalEmployeeQuantity": 125
},
"NonMarketableReasonText": [
{
"@DNBCodeValue": 11028,
"$": "De-listed"
}
],
"ContactName": {
"FirstName": "Leslie",
"LastName": "Smith",
"FullName": "Leslie Smith"
},
"PrincipalIdentificationNumberDetail": [
{
"@DNBCodeValue": 24215,
"@TypeText": "Professional Contact Identifier",
"PrincipalIdentificationNumber": "5412657"
}
],
"JobTitle": [
{
"JobTitleText": {
"$": "Pres"
}
}
],
"ManagementResponsibilityCodeText": [
{
"$": "President"
}
],
"JobRanking": "5",
"ContactDataSourceDetail": {
"NameInformationSourceName": {
"$": "DNB"
}
},
"DirectTelephoneInformationAvailableIndicator": false,
"DirectEmailInformationAvailableIndicator": false,
"ManufacturingIndicator": true,
"DisplaySequence": 2
}
]
}
}
}
Filter:
| Availability | Name | Characteristics | ||
|---|---|---|---|---|
| Y | Y | FindContactResponse | Aggregate | |
| Y | Y | FindContactResponse { TransactionDetail | Aggregate, Required Records information necessary to process a particular request. Examples of a request is the ordering of a product. | |
| Y | Y | FindContactResponse { TransactionDetail { ApplicationTransactionID | string, up to 64 chars, Optional A number assigned by the calling application to uniquely identify this request. | |
| Y | Y | FindContactResponse { TransactionDetail { ServiceTransactionID | string, up to 64 chars, Required A number assigned by the D&B service to uniquely identify this transaction. | |
| Y | Y | FindContactResponse { TransactionDetail { TransactionTimestamp | dateTime, Required The date and time when this request was submitted or the date and time when the requesting intermediary, such as a workflow manager or service bus, sent the message to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. | |
| Y | Y | END: FindContactResponse } TransactionDetail | /Aggregate | |
| Y | Y | FindContactResponse { TransactionResult | Aggregate, Required Records the different outcomes of the transaction. | |
| Y | Y | FindContactResponse { TransactionResult { SeverityText | string, Required | |
| Y | Y | FindContactResponse { TransactionResult { ResultID | string, up to 32 chars, Required | |
| Y | Y | FindContactResponse { TransactionResult { ResultText | string, up to 512 chars, Optional | |
| Y | Y | FindContactResponse { TransactionResult { ResultMessage | Aggregate, Optional (Array) | |
| Y | Y | FindContactResponse { TransactionResult { ResultMessage { ResultDescription | string, up to 512 chars, Required Text that describes the additional information regarding the outcome of the transaction. | |
| Y | Y | END: FindContactResponse } TransactionResult } ResultMessage | /Aggregate | |
| Y | Y | END: FindContactResponse } TransactionResult | /Aggregate | |
| Y | Y | FindContactResponse { FindContactResponseDetail | Aggregate, Optional Records data relating to responses for search based on contact information. This may include details such as the total Number of contacts that matched the search criteria, name and address details of the contact etc. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { CandidateMatchedQuantity | integer, Required Total Number of Contacts that matched the Search Criteria. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { CandidateReturnedQuantity | integer, Optional | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate | Aggregate, Optional (Array) Records the details of the candidates that matched the search criteria. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { DUNSNumber | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ContactID | Element, Optional | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { OrganizationPrimaryName | Aggregate, Optional | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { OrganizationPrimaryName { OrganizationName | string, up to 256 chars, Required | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate } OrganizationPrimaryName | /Aggregate | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { TradeStyleName | Aggregate, Optional (Array) | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { TradeStyleName { OrganizationName | string, up to 256 chars, Required NOTE: Deprecated | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate } TradeStyleName | /Aggregate | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ConsolidatedEmployeeDetails | Aggregate, Optional Records current employee data which includes all employees who are engaged in the operations of the legal entity (including employees located at branch locations) as well as all employees who are engaged in the operations of every direct descendant in its family tree (based on controlling interest), i.e., subsidiaries. Note: An organization which is classified by D&B as a branch" location cannot have a "Consolidated" employee figure." | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ConsolidatedEmployeeDetails { TotalEmployeeQuantity | long, Optional A number that defines how many people are directly engaged and paid by the organization to perform or support its business operations. | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate } ConsolidatedEmployeeDetails | /Aggregate | |
| N | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { MarketabilityIndicator | boolean, Optional When 'true' indicates that the record satisfies D&B marketability rules. When 'false' indicates that the record does not satisfy D&B marketability rules; however, there is no requirement to create this tag to represent this fact. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { NonMarketableReasonText | string, up to 256 chars, Optional (Array) Text specifying the reason why the subject's data is not considered marketable by D&B. Possible values: 11027 [NIXIE]; 11024 [Out of business]; 11028 [De-listed]; 25837 [Insufficient Data] | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ContactName | Aggregate, Optional | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ContactName { FirstName | string, up to 64 chars, Optional First name of the principal. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ContactName { MiddleName | string, up to 64 chars, Optional Middle name of the principal. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ContactName { LastName | string, up to 64 chars, Optional Last name of the principal. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ContactName { FullName | string, up to 240 chars, Optional Full Name of the principal. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ContactName { NameSuffix | Aggregate, Optional (Array) | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { ContactName { NameSuffix { NameSuffixText | string, up to 16 chars, Optional A text identifying either a familial suffix to the principals name (E.g. Senior, Junior, III. ) or a professional/qualification suffix to the principals name (E.g. MD, FRICS, PhD etc.) or some other suffix to the principals name (E.g. Baronet, Retired.). | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate } ContactName } NameSuffix | /Aggregate | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate } ContactName | /Aggregate | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { PrincipalIdentificationNumberDetail | Aggregate, Optional (Array) An entry loop which can repeat multiple times to allow the recording of the identifiers assigned to the principal by D&B. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { PrincipalIdentificationNumberDetail @DNBCodeValue | integer, up to 7 digits, Attribute (1x) Possible values: 24215 NOTE: Deprecated | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber | string, Optional A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual. | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate } PrincipalIdentificationNumberDetail | /Aggregate | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { JobTitle | Aggregate, Optional (Array) An entry loop which can repeat multiple times to allow the recording of the name used by the organization to describe this person's job, e.g., Leader Global Communication, Manager National Technical Support Center. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { JobTitle { JobTitleText | string, up to 3000 chars, Optional Text that denotes a position held by the principal or manager. | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate } JobTitle | /Aggregate | |
| Y | Y | FindContactResponse } FindContactResponseDetail } FindCandidate } ManagementResponsibilityCodeText | string, up to 3000 chars, Optional | |
| Y | Y | FindContactResponse } FindContactResponseDetail } FindCandidate } JobFunction | string, up to 3000 chars, Optional, multiple occurring Title assigned by D&B based on the routine set of tasks or activities undertaken by a person in that position. NOTE: Deprecated | |
| Y | Y | FindContactResponse } FindContactResponseDetail } FindCandidate } JobRanking | integer, single occurring NOTE: Deprecated A ranking number assigned by D&B based on the job hierarchy of a person in that position. | |
| Y | Y | FindContactResponse } FindContactResponseDetail } FindCandidate } ContactDataSourceDetail | /Aggregate | |
| Y | Y | FindContactResponse } FindContactResponseDetail } FindCandidate } ContactDataSourceDetail } NameInformationSourceName | string, up to 256 chars, Optional NOTE: Deprecated | |
| Y | Y | FindContactResponse } FindContactResponseDetail } FindCandidate } ContactDataSourceDetail } EmailInformationSourceName | string, up to 256 chars, Optional NOTE: Deprecated | |
| Y | Y | FindContactResponse } FindContactResponseDetail } FindCandidate } ContactDataSourceDetail } TelephoneInformationSourceName | string, up to 256 chars, Optional NOTE: Deprecated | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate } ContactDataSourceDetail | /Aggregate | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { DirectTelephoneInformationAvailableIndicator | boolean, Optional When 'true' indicates that the telephone information required to connect to the contact without the assistance of an operator is available. When turend OFF (set to 0), it indicates that the telephone information required to connect to the contact without the assistance of an operator is not available. When NULL or absent, it indicates that it is not known if the telephone information required to connect to the contact without the assistance of an operator is available. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { DirectEmailInformationAvailableIndicator | boolean, Optional When 'true' indicates that the email information used to communicate solely with the contact is available. When turend OFF (set to 0), it indicates that the email information used to communicate solely with the contact is not available. When NULL or absent, it indicates that it is not known if the email information used to communicate solely with the contact is available. | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { 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. NOTE: Deprecated | |
| Y | Y | FindContactResponse { FindContactResponseDetail { FindCandidate { DisplaySequence | integer, up to 5 digits, Optional | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail } FindCandidate | /Aggregate | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail | Aggregate, Optional | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ManagementResponsibilityCodeNavigatorDetail | Aggregate, Optional | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ManagementResponsibilityCodeNavigatorDetail { ManagementResponsibilityCode | Aggregate, Optional (Array) | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ManagementResponsibilityCodeNavigatorDetail { ManagementResponsibilityCode { ManagementResponsibilityCodeText | _ up to 3000 chars, Required | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ManagementResponsibilityCodeNavigatorDetail { ManagementResponsibilityCode { ManagementResponsibilityCodeText @LanguageCode | integer, up to 3 digits, Attribute (1x) NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ManagementResponsibilityCodeNavigatorDetail { ManagementResponsibilityCode { ManagementResponsibilityCodeText @WritingScriptISOAlpha4Code | string, Attribute (1x) NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ManagementResponsibilityCodeNavigatorDetail { ManagementResponsibilityCode { CandidateMatchedQuantity | integer, Required Total Number of Contacts that matched the Search Criteria. | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } ManagementResponsibilityCodeNavigatorDetail } ManagementResponsibilityCode | /Aggregate | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } ManagementResponsibilityCodeNavigatorDetail | /Aggregate | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { JobTitleNavigatorDetail | Aggregate, Optional Restrict results to and display specified job titles. NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { JobTitleNavigatorDetail { JobTitle | Aggregate, Optional (Array) An entry loop which can repeat multiple times to allow the recording of the name used by the organization to describe this person's job, e.g., Leader Global Communication, Manager National Technical Support Center. | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { JobTitleNavigatorDetail { JobTitle { JobTitleText | string, up to 3000 chars, Optional Text that denotes a position held by the principal or manager. NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { JobTitleNavigatorDetail { JobTitle { JobTitleText @LanguageCode | integer, up to 3 digits, Attribute (1x) NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { JobTitleNavigatorDetail { JobTitle { JobTitleText @WritingScriptISOAlpha4Code | string, Attribute (1x) NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { JobTitleNavigatorDetail { JobTitle { CandidateMatchedQuantity | integer, Required Total Number of Contacts that matched the Search Criteria. NOTE: Deprecated | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } JobTitleNavigatorDetail } JobTitle | /Aggregate | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } JobTitleNavigatorDetail | /Aggregate | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { LocationNavigatorDetail | Aggregate, Optional | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { LocationNavigatorDetail { LocationNavigator | Aggregate, Required (Array) | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { LocationNavigatorDetail { LocationNavigator { LocationType | LocationNavigatorTypeEnum, Required Possible values: Country; Territory | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { LocationNavigatorDetail { LocationNavigator { LocationCode | string, Optional | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { LocationNavigatorDetail { LocationNavigator { LocationName | string, Required | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { LocationNavigatorDetail { LocationNavigator { CandidateMatchedQuantity | integer, Required The number of subjects identified as possible prospects in the D&B repository. | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } LocationNavigatorDetail } LocationNavigator | /Aggregate | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } LocationNavigatorDetail | /Aggregate | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail | Aggregate, Optional | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode | Aggregate, Optional (Array) Only results matching the specified industry code(s) will be returned. | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode | IndustryCodeType, Required NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode @TypeText | string, up to 256 chars, Attribute (1x) | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode @DNBCodeValue | integer, up to 7 digits, Attribute (1x) | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode @DNBCodeTableNumber | integer, up to 7 digits, Attribute (1x) NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode { IndustryCode | string, up to 16 chars, Optional An alphanumeric value identifying a business activity based on the scheme specified by the typeText. For instance, 1611 represents the highway and street construction industry in the U.S. SIC (Standard Industrial Classification) system. Clarification Note: These are generally external codes created by an external authoritative body, like the U.S. Office of Management and Budget (OMB), but D&B may have created extensions to more precisely define an activity, as in the case of the SIC 2+2 (the last 4 digits of an 8-digit SIC). | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode { IndustryCodeDescription | string, up to 256 chars, Optional (Array) Text that describes the business activity based on the scheme specified by the attribute typeText. E.g., 'highway and street construction' is the description of industry code 1611 in the U.S. SIC (Standard Industrial Classification) system. | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode { IndustryCodeDescription @IndustryCodeDescriptionLengthCode | Attribute NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode { IndustryExplanationText | string, up to 3000 chars, Optional Free form text describing the business activity. NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { IndustryCode { DisplaySequence | integer, Optional A number which may be used to define the order in which this industry code should be presented relative to other industry codes of the same type where the lower the number the earlier the data is presented. | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } IndustryNavigatorDetail } IndustryCode } IndustryCode | /Aggregate | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { IndustryNavigatorDetail { IndustryCode { CandidateMatchedQuantity | integer, Required The number of subjects identified as possible prospects in the D&B repository. | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } IndustryNavigatorDetail } IndustryCode | /Aggregate | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } IndustryNavigatorDetail | /Aggregate | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ContactDataNavigatorDetail | Aggregate, Optional NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ContactDataNavigatorDetail { ContactData | Aggregate, Optional (Array) | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ContactDataNavigatorDetail { ContactData { ContactDataType | ContactDataTypeEnum, Required Possible values: HasDirectPhone; HasDirectEmail; HasDirectPhoneOrDirectEmail; HasDirectPhoneAndDirectEmail; HasDirectPhoneAndDirectEmail; HasNeitherDirectPhoneNorDirectEmai NOTE: Deprecated | |
| N | Y | FindContactResponse { FindContactResponseDetail { NavigatorDetail { ContactDataNavigatorDetail { ContactData { CandidateMatchedQuantity | integer, Required Total Number of Contacts that matched the Search Criteria. NOTE: Deprecated | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } ContactDataNavigatorDetail } ContactData | /Aggregate | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail } ContactDataNavigatorDetail | /Aggregate | |
| N | Y | End: FindContactResponse } FindContactResponseDetail } NavigatorDetail | /Aggregate | |
| Y | Y | END: FindContactResponse } FindContactResponseDetail | /Aggregate | |
| Y | Y | END: FindContactResponse | /Aggregate |
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').
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.
Filter:
| Availability | Business Element Name | Description | ||
|---|---|---|---|---|
| Y | Y | Company Principal First Name | First name of the principal PCM XPath: //FindCandidate/ ContactName/ FirstName | |
| Y | Y | Company Principal Full Name | Full Name of the principal PCM XPath: //FindCandidate/ ContactName/ FullName | |
| Y | Y | Company Principal Job Title | PCM XPath: //FindCandidate/ JobTitle/ JobTitleText | |
| Y | Y | Company Principal Last Name | Last name of the principal PCM XPath: //FindCandidate/ ContactName/ LastName | |
| Y | Y | Company Principal Name Prefix | A text defining the correct form of address for this principal. E.g. Dr, Professor, Lord, etc. PCM XPath: //FindCandidate/ ContactName/ NamePrefix/ NamePrefixText | |
| Y | Y | Company Principal Name Suffix | A text identifying either a familial suffix to the principals name (E.g. Senior, Junior, III. ) or a professional/qualification suffix to the principals name (E.g. MD, FRICS, PhD etc.) or some other suffix to the principals name (E.g. Baronet, Retired.). PCM XPath: //FindCandidate/ ContactName/ NameSuffix/ NameSuffixText | |
| Y | Y | Direct E-Mail Indicator | Indicates if the contact's direct email information is available or not PCM XPath: //FindCandidate/ DirectEmailInformationAvailableIndicator | |
| Y | Y | Direct Phone Indicator | Indicates if the contact's direct telephone number information is available or not PCM XPath: //FindCandidate/ DirectTelephoneInformationAvailableIndicator | |
| Y | Y | D-U-N-S Number | The subject identifier under the Data Universal Numbering System. PCM XPath: //FindCandidate/ DUNSNumber | |
| Y | Y | Manufacturing Indicator | ManufacturingIndicator denotes that the subject has a manufacturing facility. PCM XPath: //FindCandidate/ ManufacturingIndicator | |
| Y | Y | Non Marketable Reason Text | PCM XPath: //FindCandidate/ NonMarketableReasonText | |
| Y | Y | Primary Business Name | Text recording a name of this organization. PCM XPath: //FindCandidate/ OrganizationPrimaryName/ OrganizationName | |
| Y | Y | Principal Identification Number | A number assigned by an external body or by D&B which either uniquely identifies or helps to identify the principal. PCM XPath: //FindCandidate/ PrincipalIdentificationNumberDetail/ PrincipalIdentificationNumber | |
| Y | Y | Total Employee Quantity | PCM XPath: //FindCandidate/ ConsolidatedEmployeeDetails/ TotalEmployeeQuantity | |
| Y | Y | Trade Style Name | Text recording tradestyle name (doing business as) of this organization. PCM XPath: //FindCandidate/ TradeStyleName/ OrganizationName |
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 match rate in the name, company name, title and biographical text fields.
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.
What to do Next
- Retrieve additional Contact details (using Principal ID)
- © Dun & Bradstreet, Inc. 2019 – 2025. All rights reserved.