Corporate Linkage
Products | D&B Direct 2.0, D&B Direct Onboard (LNK_FF only) |
Product Code(s) | LNK_UPF, LNK_FF |
Level(s) | Standard, Enhanced |
Monitoring Available | Yes (LNK_FF only) |
Interface | REST |
Method | GET |
Format(s) | JSON |
Service | Linkage |
{version} | 3.1 |
Initial Release | October 3, 2013 |
The Enhanced version of this D&B Direct product returns the ultimate parent of the requested company and all related entities (i.e., full family tree). The Standard version returns only the direct line entities between the requested company and the global ultimate (i.e., upward family tree).
NOTE: The Corporate Linkage Service cannot be relied upon to deliver family trees exceeding 7,500 or more members at this time. Family tree requests of this size will likely result in a time-out condition. It is possible to monitor large family trees with the Level 1 service; however the Level 2 monitoring service cannot be used.
NOTE: If you have a need to download family trees with 7,500 or more members, please contact your D&B representative.
Update History
- April 30, 2021 (v4.0 SOAP & REST):Sole proprietorship( 8631) as 100% owner and rest of the share holders (137) together with additional information of names in the family tree data topic for Markets - Denmark, Greenland & Faroe Islands.
- August 09, 2019 (v4.0 SOAP & REST):TerritoryOfficialName element has fixed to give the full name instead of abbreviated name for linkage full family tree product(LNK_FF).
- August 18, 2017 (v4.0 SOAP & REST): Updated request elements specification for Linkage Standard (LNK_UPF) and Linkage Enhanced (LNK_FF).
- January 27, 2017 (vALL SOAP & REST): Territory Official Name element has been added to the response returning abbreviated values.
- August 26, 2016 (vALL SOAP & REST): Updated Response Specification details around applicable fields for Linkage Standard (LNK_UPF) vs. Linkage Enhanced (LNK_FF).
- January 29, 2016 (v4.0 SOAP & REST): The country availability chart has been corrected to reflect that Linkage Standard (LNK-UPF) is available for U.S. companies.
- January 8, 2016 (v4.0 SOAP & REST): The request element AttachCompressedProductIndicator and response elements ObjectAttachment, ContentObject, ObjectFormatTypeText are added to support compressed product for Linkage full family tree.
Product Request
IMPORTANT: Due to a known issue, please do not include request values for SubmittingOfficeID.
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
Overview
When requesting this D&B Direct product, a valid D-U-N-S Number for a company, and the appropriate product code will be required. If a country code is included in the request, it will filter the results.
There are several options available when requesting this product.
1. Depth Limit: By default, this product will return all available levels of the corporate tree. An option exists to limit the number of levels returned.
2. Location Type: This option filters the corporate tree by specifying the type of entities to include. Subsidiary, Branch, Division, Headquarters, Parent, Domestic Ultimate, Global Ultimate and/or Affiliate are the possible options. Refer to the FamilyTreeMemberRoleCode field for a list of the acceptable coded values.
3. Geographic: This option allows the corporate tree to be filtered by country, state/territory, or city name.
4. Marketable Inclusions: By default, this product will exclude non marketable entities. Options exist to include entities with undeliverable mailing addresses, incomplete data, or that have specified they do not wish to be marketed to.
Global Availability
The LNK_UPF, LNK_FF data layers are available for businesses domiciled in the following countries:
LNK_UPF | LNK_FF | Country | ISO Code |
---|---|---|---|
Y | Y | United States of America | US |
Y | Y | Belgium | BE |
Y | Y | France | FR |
Y | Y | Germany | DE |
Y | Y | Italy | IT |
Y | Y | Netherlands | NL |
Y | Y | Portugal | PT |
Y | Y | Spain | ES |
Y | Y | United Kingdom | GB |
Y | Y | Australia | AU |
Y | Y | New Zealand | NZ |
Y | Y | Andorra | AD |
Y | Y | Anguilla | AI |
Y | Y | Antigua & Barbuda | AG |
Y | Y | Aruba | AW |
Y | Y | Bahamas | BS |
Y | Y | Barbados | BB |
Y | Y | Belize | BZ |
Y | Y | Bermuda | BM |
Y | Y | Bolivia | BO |
Y | Y | British Virgin Islands | VG |
Y | Y | Canada | CA |
Y | Y | Cayman Islands | KY |
Y | Y | Colombia | CO |
Y | Y | Costa Rica | CR |
Y | Y | Denmark | DK |
Y | Y | Dominica | DM |
Y | Y | Dominican Republic | DO |
Y | Y | Ecuador | EC |
Y | Y | El Salvador | SV |
Y | Y | Faero Islands | FO |
Y | Y | Finland | FI |
Y | Y | Greenland | GL |
Y | Y | Grenada | GD |
Y | Y | Guatemala | GT |
Y | Y | Guyana | GY |
Y | Y | Haiti | HT |
Y | Y | Honduras | HN |
Y | Y | Ireland | IE |
Y | Y | Jamaica | JM |
Y | Y | Japan | JP |
Y | Y | Luxembourg | LU |
Y | Y | Mexico | MX |
Y | Y | Monaco | MC |
Y | Y | Montserrat | MS |
Y | Y | Netherlands Antilles | AN |
Y | Y | Bonaire, Sint Eustatius And Saba | BQ |
Y | Y | Curaçao | CW |
Y | Y | Sint Maarten (dutch) | SX |
Y | Y | Nicaragua | NI |
Y | Y | Norway | NO |
Y | Y | Panama | PA |
Y | Y | Saint Kitts & Nevis | KN |
Y | Y | Saint Lucia | LC |
Y | Y | Saint Vincent | VC |
Y | Y | San Marino | SM |
Y | Y | Suriname | SR |
Y | Y | Sweden | SE |
Y | Y | Taiwan | TW |
Y | Y | Trinidad And Tobago | TT |
Y | Y | Turks And Caicos | TC |
Y | Y | Venezuela | VE |
Y | Y | Albania | AL |
Y | Y | Algeria | DZ |
Y | Y | American Samoa | AS |
Y | Y | Angola | AO |
Y | Y | Argentina | AR |
Y | Y | Armenia | AM |
Y | Y | Austria | AT |
Y | Y | Azerbaijan | AZ |
Y | Y | Bahrain | BH |
Y | Y | Bangladesh | BD |
Y | Y | Benin, Peoples Republic of | BJ |
Y | Y | Bhutan | BT |
Y | Y | Bosnia And Herzegovina | BA |
Y | Y | Botswana | BW |
Y | Y | Brazil | BR |
Y | Y | Brunei | BN |
Y | Y | Bulgaria | BG |
Y | Y | Burkina Faso | BF |
Y | Y | Burma (myanmar) | MM |
Y | Y | Burundi | BI |
Y | Y | Belarus | BY |
Y | Y | Cameroon | CM |
Y | Y | Cape Verde, Republic of | CV |
Y | Y | Central Africa Republic | CF |
Y | Y | Chad, Republic of | TD |
Y | Y | China, Peoples Republic of | CN |
Y | Y | Christmas Island | CX |
Y | Y | Comoros Republic | KM |
Y | Y | Congo Democratic Republic | CD |
Y | Y | Cook Islands | CK |
Y | Y | Croatia | HR |
Y | Y | Cyprus | CY |
Y | Y | Turkish Republic of Northern Cyprus | XT |
Y | Y | Czech Republic | CZ |
Y | Y | Djibouti | DJ |
Y | Y | Egypt | EG |
Y | Y | Equatorial Guinea | GQ |
Y | Y | Eritrea | ER |
Y | Y | Estonia | EE |
Y | Y | Ethiopia | ET |
Y | Y | Falkland Islands | FK |
Y | Y | Fiji | FJ |
Y | Y | French Guiana | GF |
Y | Y | French Polynesia/tahiti | PF |
Y | Y | Gabon Republic | GA |
Y | Y | Gambia | GM |
Y | Y | Georgia | GE |
Y | Y | Ghana | GH |
Y | Y | Gibraltar | GI |
Y | Y | Greece | GR |
Y | Y | Guadeloupe | GP |
Y | Y | Guam | GU |
Y | Y | Guinea Bissau | GW |
Y | Y | Guinea, Republic of | GN |
Y | Y | Hong Kong SAR | HK |
Y | Y | Hungary | HU |
Y | Y | Iceland | IS |
Y | Y | India | IN |
Y | Y | Indonesia | ID |
Y | Y | Iran | IR |
Y | Y | Iraq | IQ |
Y | Y | Israel | IL |
Y | Y | Ivory Coast/cote D'ivoire | CI |
Y | Y | Jordan | JO |
Y | Y | Kazakhstan | KZ |
Y | Y | Kenya | KE |
Y | Y | Kiribati | KI |
Y | Y | Korea, Republic of | KR |
Y | Y | Kuwait | KW |
Y | Y | Kyrgyzstan | KG |
Y | Y | Latvia | LV |
Y | Y | Lebanon | LB |
Y | Y | Lesotho | LS |
Y | Y | Liberia | LR |
Y | Y | Libya | LY |
Y | Y | Lithuania | LT |
Y | Y | Macao SAR | MO |
Y | Y | North Macedonia | MK |
Y | Y | Madagasgar | MG |
Y | Y | Malawi | MW |
Y | Y | Malaysia | MY |
Y | Y | Maldives | MV |
Y | Y | Mali | ML |
Y | Y | Malta | MT |
Y | Y | Marianas Islands | MP |
Y | Y | Marshall Islands | MH |
Y | Y | Martinique | MQ |
Y | Y | Mauritania | MR |
Y | Y | Mauritius | MU |
Y | Y | Moldova | MD |
Y | Y | Montenegro | ME |
Y | Y | Morocco | MA |
Y | Y | Mozambique | MZ |
Y | Y | Namibia | NA |
Y | Y | Nauru | NR |
Y | Y | Nepal | NP |
Y | Y | New Caledonia | NC |
Y | Y | Niger | NE |
Y | Y | Nigeria | NG |
Y | Y | Norfolk Island | NF |
Y | Y | Oman | OM |
Y | Y | Pakistan | PK |
Y | Y | Papua New Guinea | PG |
Y | Y | Paraguay | PY |
Y | Y | Peru | PE |
Y | Y | Philippines | PH |
Y | Y | Poland | PL |
Y | Y | Qatar | QA |
Y | Y | Reunion Island | RE |
Y | Y | Romania | RO |
Y | Y | Russian Federation | RU |
Y | Y | Rwanda | RW |
Y | Y | Saint Helena | SH |
Y | Y | Saint Pierre Et Miquelon | PM |
Y | Y | Sao Tome & Principe | ST |
Y | Y | Saudi Arabia | SA |
Y | Y | Senegal | SN |
Y | Y | Serbia | RS |
Y | Y | Seychelles | SC |
Y | Y | Sierra Leone | SL |
Y | Y | Singapore | SG |
Y | Y | Slovakia | SK |
Y | Y | Slovenia | SI |
Y | Y | Solomon Islands | SB |
Y | Y | Somalia | SO |
Y | Y | South Africa | ZA |
Y | Y | Sri Lanka | LK |
Y | Y | Sudan | SD |
Y | Y | South Sudan | SS |
Y | Y | Eswatini | SZ |
Y | Y | Switzerland | CH |
Y | Y | Syria | SY |
Y | Y | Tajhikstan | TJ |
Y | Y | Tanzania | TZ |
Y | Y | Thailand | TH |
Y | Y | Togo | TG |
Y | Y | Tokelau Islands | TK |
Y | Y | Tonga | TO |
Y | Y | Tunisia | TN |
Y | Y | Turkiye | TR |
Y | Y | Turkmenistan | TM |
Y | Y | Tuvalu | TV |
Y | Y | Uganda | UG |
Y | Y | Ukraine | UA |
Y | Y | United Arab Emirates | AE |
Y | Y | Uruguay | UY |
Y | Y | Uzbekistan | UZ |
Y | Y | Vanuatu | VU |
Y | Y | Vietnam | VN |
Y | Y | Western Samoa | WS |
Y | Y | Yemen | YE |
Y | Y | Zambia | ZM |
Y | Y | Zimbabwe | ZW |
Y | Y | Kosovo | XK |
Y | Y | Micronesia, Federated States of | FM |
Y | Timor-Leste | TL |
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 product is entitled as "Corporate Linkage" 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 includes only LNK_FF 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/V3.0/organizations/804735132/products/LNK_UPF?CountryISOAlpha2Code=US Authorization: <My Token>
GET https://direct.dnb.com/V3.0/organizations/804735132/products/LNK_FF?CountryISOAlpha2Code=US 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.
There are no differences in the request for these products.
Name | Characteristics |
---|---|
{version} | Element |
ApplicationTransactionID | string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. |
TransactionTimestamp | DateTimestamp, 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. |
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. |
{DUNS} | string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). |
CountryISOAlpha2Code | string at least 2 chars. up to 2 chars., Optional The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. |
{productID} | string, Required An alphanumeric string that uniquely identifies the product being requested. |
LanguagePreferenceCode | integer up to 7 digits., Optional A D&B code value that defines the language in which the customer wants this product to be rendered. Possible values: 39 (English) |
RequestedOrganizationChildLevelMaximumQuantity | int up to 5 digits., Optional |
FamilyTreeMemberRoleCode-n | integer up to 7 digits., Optional Possible values: 9159 (Subsidiary); 12769 (Branch); 12770 (Division); 12771 (Headquarters); 12773 (Parent); 12774 (Domestic Ultimate); 12775 (Global Ultimate); 15388 (Affiliate) |
LinkedOrganizationLocationCountryISOAlpha2Code-n | string at least 2 chars. up to 2 chars., Optional The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO), identifying the country for this address. |
LinkedOrganizationLocationTerritoryName-n | string up to 64 chars., Optional The name of a locally governed area which forms part of a centrally governed nation. As a guiding principle this is a geographic area which could theoretically exist as a separate nation. In the U.S. this would be a State in the UK this would be one of the Home Nations. |
LinkedOrganizationLocationPrimaryTownName-n | string up to 64 chars., Optional The name of the town or city recognized by the Postal Authority for delivering mail. |
InclusionDataDescription-n | InclusionDataEnum, Optional Text that denotes a data inclusion requirement that the service should apply to the subjects returned as candidates. For example if the value is specified as: IncludeUndeliverableAddressSubject, then the service should also include the companies which D&B has not determined deliverable mailing address. IncludeIncompleteData, then the service should also include the companies with incomplete data like telephone unreachable, undeliverable mailing address, unavailable Standard Industry Classification Code,.. IncludeNonMarketableSubject, then the service should also include the companies that are non- marketable, also refers to companies that are marked in the Do Not call list. Possible values: IncludeUndeliverableAddressSubject; IncludeIncompleteData; IncludeNonMarketableSubject NOTE: 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. |
ArchiveProductOptOutIndicator | boolean, Optional When true (set to 1), it indicates that the product being ordered is not to be stored. When false (set to 0), it indicates that the product being ordered is to be stored; however as this is the assumed condition there is no requirement to create this tag to represent this fact. |
ExtendArchivePeriodIndicator | boolean, Optional When true (set to 1), the duration to archive the data is to be extended. Note: There is an additional cost for extending the archival period of the data purchased. When false (set to 0), the duration to archive the data is not to be extended. |
CustomerReferenceText-n | string, up to 240 chars, Optional (up to 5x) A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation. |
CustomerBillingEndorsementText | string at least 1 chars. up to 240 chars., Optional Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.This text is a reference used during the billing process. |
Endpoint
Use the following endpoint for requesting this product. The {version} is dependent on the underlying service delivering the product.
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 (Linkage) |
---|
GET https://direct.dnb.com/V{version}/organizations/{DUNS}/products/{productID} |
Testing
Sandbox
The following parameters may be used for D&B Direct 2.0 developer sandbox requests to retrieve successful responses. The data returned from sandbox requests may not represent actual values that this feature will deliver.
D-U-N-S Number (Country Code) |
---|
754683795 (AU); 970814638 (AR); 302150912 (AT); 811761659 (MX); 804735132 (US) |
Trials
When conducting testing in the production environment during a trial period, product requests will be limited to the local market of the customer.
Production
A set of D-U-N-S Numbers is available to D&B Direct 2.0 customers for performing non-billable transactions in the production environment.
Product Response
While data for a particular company may not contain values for each of the business elements, there may be items that are considered by D&B to be "essential" to yield the maximum benefit of a data layer. If any of these essential elements do not contain a value for a particular company, a PD005 response code will be returned, and your organization will not incur a usage credit for the request.
For all codified data delivered by D&B Direct, the response package will include the decoded text value as a data element with the code value attached as an attribute. Refer to the Reference Data Service for access to the D&B standard code tables.
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.
{"OrderProductResponse": { "@ServiceVersionNumber": "3.0", "TransactionDetail": { "ApplicationTransactionID": "Id-0102525584661700b9620e000aa88c77-2", "ServiceTransactionID": "Id-0102525584661700b9620e000aa88c77-2", "TransactionTimestamp": "2015-05-12T09:37:06.261-04:00" }, "TransactionResult": { "SeverityText": "Information", "ResultID": "CM000", "ResultText": "Success" }, "OrderProductResponseDetail": { "InquiryDetail": { "DUNSNumber": "804735132", "CountryISOAlpha2Code": "US" }, "Product": { "DNBProductID": "LNK_UPF", "LinkageResponseOrganizationCount": 1, "Organization": { "SubjectHeader": {"DUNSNumber": "804735132"}, "Location": {"PrimaryAddress": { "StreetAddressLine": [ { "LineText": "492 KOLLER ST", "DisplaySequence": "1" }], "PrimaryTownName": "SAN FRANCISCO", "CountryISOAlpha2Code": "US", "CountyOfficialName": "SAN FRANCISCO", "TerritoryOfficialName": "CA", "PostalCode": "94110" }}, "OrganizationName": {"OrganizationPrimaryName": {"OrganizationName": {"$": "GORMAN MANUFACTURING COMPANY, INC."}}}, "OrganizationDetail": { "FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": {"$": "Parent"}}, {"FamilyTreeMemberRoleText": {"$": "Headquarters"}} ], "StandaloneOrganizationIndicator": false }, "Linkage": { "FamilyTreeHierarchyLevel": 1, "LinkageSummary": {"ChildrenSummary": [ { "ChildrenQuantity": 9, "DirectChildrenIndicator": false }, { "ChildrenTypeText": {"$": "Subsidiary"}, "ChildrenQuantity": 3, "DirectChildrenIndicator": true }, { "ChildrenTypeText": {"$": "Branch"}, "ChildrenQuantity": 1, "DirectChildrenIndicator": true } ]}, "GlobalUltimateOrganization": {"DUNSNumber": "804735132"}, "DomesticUltimateOrganization": {"DUNSNumber": "804735132"} } } } } }}
{"lin$OrderProductResponse": { "@xmlns$lin": "http://services.dnb.com/LinkageServiceV2.0", "@xmlns$soap-env": "http://schemas.xmlsoap.org/soap/envelope/", "@xmlns$soapenv": "http://schemas.xmlsoap.org/soap/envelope/", "@ServiceVersionNumber": "2.0", "TransactionDetail": { "ApplicationTransactionID": "Id-46fd515582d71600bf460e007e3f8928-2", "ServiceTransactionID": "Id-46fd515582d71600bf460e007e3f8928-2", "TransactionTimestamp": "2015-05-12T09:16:54.811-04:00" }, "TransactionResult": { "SeverityText": "Information", "ResultID": "CM000", "ResultText": "Success" }, "OrderProductResponseDetail": { "InquiryDetail": { "DUNSNumber": "186281820", "CountryISOAlpha2Code": "US" }, "Product": { "DNBProductID": "LNK_FF", "LinkageResponseOrganizationCount": "2", "Organization": { "SubjectHeader": {"DUNSNumber": "179190251"}, "Location": {"PrimaryAddress": { "StreetAddressLine": [ { "LineText": "3775 S 500 W", "DisplaySequence": "1" }], "PrimaryTownName": "SALT LAKE CITY", "CountryISOAlpha2Code": "US", "CountyOfficialName": "SALT LAKE", "TerritoryOfficialName": "UT", "PostalCode": "84115-4209" }}, "OrganizationName": { "OrganizationPrimaryName": {"OrganizationName": {"$t": "AUDIO VENTURES CORPORATION"}}, "TradeStyleName": [{"OrganizationName": {"$t": "ABCD"}}] }, "OrganizationDetail": { "FamilyTreeMemberRole": [{"FamilyTreeMemberRoleText": {"$t": "Parent"}}], "StandaloneOrganizationIndicator": "false" }, "Linkage": { "FamilyTreeHierarchyLevel": "1", "LinkageSummary": {"ChildrenSummary": [ { "ChildrenQuantity": "1", "DirectChildrenIndicator": "false" }, { "ChildrenTypeText": {"$t": "Subsidiary"}, "ChildrenQuantity": "1", "DirectChildrenIndicator": "true" } ]}, "GlobalUltimateOrganization": {"DUNSNumber": "179190251"}, "DomesticUltimateOrganization": {"DUNSNumber": "179190251"}, "FamilyTreeMemberOrganization": [ { "AssociationTypeText": {"$t": "ParentSubsidiary"}, "SubjectHeader": {"DUNSNumber": "186281820"}, "Location": {"PrimaryAddress": { "StreetAddressLine": [ { "LineText": "3775 S 500 W", "DisplaySequence": "1" }], "PrimaryTownName": "SALT LAKE CITY", "CountryISOAlpha2Code": "US", "CountyOfficialName": "SALT LAKE", "TerritoryOfficialName": "UT", "PostalCode": "84115-4209" }}, "OrganizationName": { "OrganizationPrimaryName": {"OrganizationName": {"$t": "AUDIO BOOKS ON CASSETTE DISTRIBUTORS, INC"}}, "TradeStyleName": [{"OrganizationName": {"$t": "ABCD"}}] }, "OrganizationDetail": { "FamilyTreeMemberRole": [{"FamilyTreeMemberRoleText": {"$t": "Subsidiary"}}], "StandaloneOrganizationIndicator": "false" }, "Linkage": { "FamilyTreeHierarchyLevel": "2", "LinkageSummary": null, "GlobalUltimateOrganization": {"DUNSNumber": "179190251"}, "DomesticUltimateOrganization": {"DUNSNumber": "179190251"}, "ParentOrganization": {"DUNSNumber": "179190251"} } }] } } } } }}
There are no differences in the response for these products.
Name | Characteristics |
---|---|
OrderProductResponse | Aggregate |
OrderProductResponse { OrderProductResponseDetail | Aggregate, Optional Records the data being returned to the customer as a result of a product request. |
OrderProductResponse { OrderProductResponseDetail { Product | Aggregate, Required Records data about the product ordered by the customer and data about the organization on which the customer has placed this order. |
OrderProductResponse { OrderProductResponseDetail { Product { LinkageResponseOrganizationCount | integer, upto 5 digits, Optional This is the number of Legal linkages to the subject in the downward direction of the family tree with the subject as starting point. Same when subject is Global Ultimate. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization | Aggregate, Required Records data about an organization, a legal or commercial entity established to provide products and/or services in the marketplace or to the community. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader | Aggregate, Required Records high level information about the subject such as the primary language of the subject and the primary currency in which this subject trades. When the subject is an organizantion, this may also include details such as DUNS Number. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader { DUNSNumber | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). NOTE: DUNS returned in the response will be 9 digit zero-padded numeric value. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader { SubjectHandling | Aggregate, Optional (Infinite) An entry loop records the type of special handling a subject is to receive from D&B (or a D&B partner, e.g., IBM, Bonnier) e.g., the subject is not to be contacted by us, by calling or any other means, at the organization's request. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader { SubjectHandling { SubjectHandlingText | string, up to 256 chars, Required Text specifying the manner in which the Subject is to receive special care from D&B when it is being contacted; e.g., do not call, do not send information requests. In many cases this process was specifically requested by the Subject. Possible values: SCoTS decode of (11028) |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader { SubjectHandling { SubjectHandlingText @DNBCodeValue | integer, up to 7 digits, Attribute (1x) Possible values: 11028 |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader { SubjectHandling { SubjectHandlingText @DNBCodeTableNumber | integer, up to 7 digits, Attribute (1x) |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } SubjectHeader } SubjectHandling | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader { 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. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } SubjectHeader | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location | Aggregate, Optional Records the address details for a subject. An address is the designation of a place where a subject can be located or may be communicated with, e.g., primary address, registered address, mailing address. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress | Aggregate, Optional (Infinite) An entry loop to allow the recording of a single primary or physical address of the subject in multiple languages and/or writing scripts. For an organization this is the principal address at which the organization is located. For an individual, this is the home address. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { StreetAddressLine | Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of several lines where each address line contains one or more named address elements. Examples of named address elements are Street Name, Street Number, Building Name, Estate Name. They are called “lines” because an addres can be divided into multiple lines. When there are multiple lines the sequence of the lines must be preserved. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { StreetAddressLine { LineText | string, up to 240 chars, Required Text that records the street address components as it would be presented on an address label. This includes, but is not limited to, details such as street name, street number, building name, estate name. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Location } PrimaryAddress } StreetAddressLine | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { PrimaryTownName | string, up to 64 chars, Optional The name of the town or city recognized by the Postal Authority for delivering mail. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { CountryISOAlpha2Code | string, at least 2 chars, up to 2 chars, Optional The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO), identifying the country for this address. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { TerritoryAbbreviatedName | string, up to 64 chars, Optional The shortened name of the locally governed area which forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States of America. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { PostalCode | string, up to 16 chars, Optional An 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. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { CountyOfficialName | string, up to 64 chars, Optional The legal name of the primary administrative division within a Territory or Country. Clarification Note: As a guiding principle this is a geographic area which would be classified as a Province (except Canada) or a County. In the U.S. this would be a county within a State. In the UK this would be a county in one of the Home Nations. In Republic Of Ireland, this would be a county and there would be no Territory. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { TerritoryOfficialName | string, up to 64 chars, Optional The legal name of the locally governed area which forms part of a centrally governed nation. Clarification Note: As a guiding principle this is a geographic area which could theoretically exist as a separate nation. In the U.S. this would be a State. In the UK this would be one of the Home Nations. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { UndeliverableIndicator | boolean, Optional When 'true' indicates that it is difficult or impossible to deliver to this address. When 'false' indicates that mails to this address can be delivered successfully; however as this is the assumed condition there is no requirement to create this tag to represent this fact. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Location } PrimaryAddress | /Aggregate |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Location | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Financial | Aggregate, Optional Records a standardized view the financial results of a subject usually extracted from a set of accounts. This includes the financial period to which those results apply, the terms of its audited status, whether is fiscal or estimated, whether it is a group/consolidated or individual statement etc. The identifying data for the financial statement (e.g. The financial period to which it refers) and the 70 D&B global standard financial items are recorded in the 'Statement' aggregate. Additionally the full granular view of the financial statement may be recorded in the 'Financial Statement Schedule' sub-aggregation. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Financial { KeyFinancialFiguresOverview | Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to record highlights of the financial statements (Balance sheet, Income statement, cash flow statement etc.) across years and gives a snapshot view of how the company has been performing on items in these financial statements. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Financial } KeyFinancialFiguresOverview | /Aggregate |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Financial | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName | Aggregate, Optional Records the different names of the organization by which it is known as well as names of other organizations that have a similar name to this organization. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName | Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of a single name by which the organization is primarily known / identified in different languages and/or writing scripts. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName | string, up to 256 chars, Required Text recording a name of this organization in the specified language and/or writing script. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } OrganizationName } OrganizationPrimaryName | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { TradeStyleName | Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of a name which an organization trades under for commercial purposes, although its registered, legal name, used for contracts and other formal situations, may be another. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { TradeStyleName { OrganizationName | string, up to 256 chars, Required Text recording a name of this organization in the specified language and/or writing script. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { TradeStyleName { DisplaySequence | integer, up to 3 digits, Optional A numeric value used to identify the relative importance of this Organization Name compared to the other Organization Names for this organization that are of the same type (e.g., Trading Style). The lower the importance level number, the more important (preferred) is an Organization Name. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } OrganizationName } TradeStyleName | /Aggregate |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } OrganizationName | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail | Aggregate, Optional Records fundamental information about a Subject which may vary over time. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail { FamilyTreeMemberRole | Aggregate, Optional (Infinite) An entry loop that can repeat multiple times to allow the recording of various parts that the Subject plays as a member of an ownership structured family tree. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail { FamilyTreeMemberRole { FamilyTreeMemberRoleText | string, up to 256 chars, Optional Text describing the part that the Subject plays as a member of an ownership structured family tree, e.g., a branch, division, a parent, headquarters, subsidiary, global ultimate, domestic ultimate. Possible values: 9159 (Subsidiary); 12769 (Branch); 12770 (Division); 12771 (Headquarters); 12773 (Parent); 12774 (Domestic Ultimate); 12775 (Global Ultimate); 15388 (Affiliate) |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail { FamilyTreeMemberRole { FamilyTreeMemberRoleText @DNBCodeValue | integer, up to 7 digits, Attribute (1x) |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } OrganizationDetail } FamilyTreeMemberRole | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail { StandaloneOrganizationIndicator | boolean, Optional When 'true' indicates that this organization is not a member of a legal family tree. This means it cannot play the role of a subsidiary, parent, headquarters or branch; i.e., FamilyTreeMemberRoleText cannot be present. When 'false' indicates that this organization is a member of a legal family tree. In this condition the FamilyTreeMemberRoleText must be present. Possible values: true / false |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } OrganizationDetail | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage | Aggregate, Optional Records the relationship between the subject and the next subject UP in the family tree. E.g. Its Parent, HQ, Joint Parent or shareholder. Also records names, addresses and registration numbers for the related subject. This data topic may also be used to record the details of the relationship between the subject and the business founder; however if a simple textual reference to the business founder is all that is required then the 'Started By' element in 'Subject Details' should be used |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { LinkageSummary | Aggregate, Optional Records the indicative or derived information about the subject UP and DOWN in the family tree. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { LinkageSummary { ChildrenSummary | Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of the number of children of various types for the Subject. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { LinkageSummary { ChildrenSummary { ChildrenTypeText | string, up to 256 chars, Optional Text describing the relationship of the children to the linked Family Tree Subject, e.g., Subsidiary. Possible values: ; Division; Subsidiary; Branch; Affiliate; |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { LinkageSummary { ChildrenSummary { ChildrenQuantity | integer, up to 8 digits, Optional The total number of children of the linked Family Tree Subject of the type specified by Children Type Text. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { LinkageSummary { ChildrenSummary { DirectChildrenIndicator | boolean, Optional When TRUE (set to 1)it indicates immediate children only. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } LinkageSummary } ChildrenSummary | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { LinkageSummary { SiblingCount | integer, Optional This is the number of linkages to the subject in the family tree with the same hierarchy level as of the subject. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } LinkageSummary | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization | Aggregate, Optional Records information about the top most business in the family tree, tracing each parent up to its own parent. For example, Company A is a business based in the US and has company B as its parent also in the US. In turn company B is owned by company C, also in the US, which is owned by company D which is in the UK. Thus the Global Ultimate" of this family tree (and therefore of each member of the family tree) is Company D." |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization { DUNSNumber | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). NOTE: DUNS returned in the response will be 9 digit zero-padded numeric value. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } GlobalUltimateOrganization | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization | Aggregate, Optional Records information about the last business in the tree, when reviewing upwards, which is in the same country as the other subject. For example, Company A is a business based in the US and has company B as its parent also in the US. In turn company B is owned by company C, also in the US, which is owned by company D which is in the UK. Thus the Domestic Ultimate" of Company A is actually Company C as this is the last business in the parent chain which is in the US" |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization { DUNSNumber | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). NOTE: DUNS returned in the response will be 9 digit zero-padded numeric value. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } DomesticUltimateOrganization | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { HeadquartersOrganization | Aggregate, Optional Records information about the office that serves as the administrative center of an enterprise. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { HeadquartersOrganization { DUNSNumber | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). NOTE: DUNS returned in the response will be 9 digit zero-padded numeric value. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } HeadquartersOrganization | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization | Aggregate, Optional Records information about the organization which owns more than 50% of the subject and the organization at the very top of the legal family. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization { DUNSNumber | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). NOTE: DUNS returned in the response will be 9 digit zero-padded numeric value. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } ParentOrganization | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization | Aggregate, Optional (Infinite) An entry loop that can repeat multiple times to allow the recording of the details of an organization owning less than 50% of the shares of the subject. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { AssociationTypeText | string, up to 256 chars, Optional Text that defines the nature of the relationship of the linked organization to the business subject, e.g., Parent, HQ, Joint Parent Possible values: 142 [Headquarters / Branch]; 1300 [Headquarters / Division]; 1012 [Parent / Subsidiary] |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { AssociationTypeText @DNBCodeValue | integer, up to 7 digits, Attribute (1x) |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationName | Aggregate, Optional Records the different names of the organization by which it is known as well as names of other organizations that have a similar name to this organization |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationName { OrganizationPrimaryName | Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of a single name by which the organization is primarily known / identified in different languages and/or writing scripts. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationName { OrganizationPrimaryName { OrganizationName | string, up to 256 chars, Required Text recording a name of this organization in the specified language and/or writing script. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } OrganizationName } OrganizationPrimaryName | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationName { TradeStyleName | Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of a name which an organization trades under for commercial purposes, although its registered, legal name, used for contracts and other formal situations, may be another. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationName { TradeStyleName { OrganizationName | string, up to 256 chars, Required Text recording a name of this organization in the specified language and/or writing script. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationName { TradeStyleName { DisplaySequence | integer, up to 3 digits, Optional A numeric value used to identify the relative importance of this Organization Name compared to the other Organization Names for this organization that are of the same type (e.g., Trading Style). The lower the importance level number, the more important (preferred) is an Organization Name. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } OrganizationName } TradeStyleName | /Aggregate |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } OrganizationName | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader | Aggregate, Optional |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader { DUNSNumber | string, up to 15 chars Pattern: {([0-9a-zA-Z]*)}, Optional The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). NOTE: DUNS returned in the response will be 9 digit zero-padded numeric value. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader { SubjectHandling | Aggregate, Optional (Infinite) An entry loop records the type of special handling a subject is to receive from D&B (or a D&B partner, e.g., IBM, Bonnier) e.g., the subject is not to be contacted by us, by calling or any other means, at the organization's request. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader { SubjectHandling { SubjectHandlingText | string, up to 256 chars, Required Text specifying the manner in which the Subject is to receive special care from D&B when it is being contacted; e.g., do not call, do not send information requests. In many cases this process was specifically requested by the Subject. Possible values: De-listed |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader { SubjectHandling { SubjectHandlingText @DNBCodeValue | integer, up to 7 digits, Attribute (1x) Possible values: 11028 |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } SubjectHeader } SubjectHandling | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader { 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. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } SubjectHeader | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location | Aggregate, Optional |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress | Aggregate, Optional (Infinite) An entry loop to allow the recording of a single primary or physical address of the subject in multiple languages and/or writing scripts. For an organization this is the principal address at which the organization is located. For an individual, this is the home address. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { StreetAddressLine | Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of several lines where each address line contains one or more named address elements. Examples of named address elements are Street Name, Street Number, Building Name, Estate Name. They are called “lines” because an addres can be divided into multiple lines. When there are multiple lines the sequence of the lines must be preserved. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { StreetAddressLine { LineText | string, up to 240 chars, Required Text that records the street address components as it would be presented on an address label. This includes, but is not limited to, details such as street name, street number, building name, estate name. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } Location } PrimaryAddress } StreetAddressLine | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { PrimaryTownName | string, up to 64 chars, Optional The name of the town or city recognized by the Postal Authority for delivering mail. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { CountryISOAlpha2Code | string, at least 2 chars, up to 2 chars, Optional The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO), identifying the country for this address. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { TerritoryAbbreviatedName | string, up to 64 chars, Optional The shortened name of the locally governed area which forms part of a centrally governed nation. For example 'NJ' for the US State New Jersey within Country United States of America. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { TerritoryOfficialName | string, up to 64 chars, Optional The legal name of the locally governed area which forms part of a centrally governed nation. Clarification Note: As a guiding principle this is a geographic area which could theoretically exist as a separate nation. In the U.S. this would be a State. In the UK this would be one of the Home Nations. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { UndeliverableIndicator | boolean, Optional |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } Location } PrimaryAddress | /Aggregate |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } Location | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationDetail | Aggregate, Optional |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationDetail { FamilyTreeMemberRole | Aggregate, Optional (Infinite) An entry loop that can repeat multiple times to allow the recording of various parts that the Subject plays as a member of an ownership structured family tree. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationDetail { FamilyTreeMemberRole { FamilyTreeMemberRoleText | string, up to 256 chars, Optional Text describing the part that the Subject plays as a member of an ownership structured family tree, e.g., a branch, division, a parent, headquarters, subsidiary, global ultimate, domestic ultimate. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationDetail { FamilyTreeMemberRole { FamilyTreeMemberRoleText @DNBCodeValue | integer, up to 7 digits, Attribute (1x) |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } OrganizationDetail } FamilyTreeMemberRole | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationDetail { StandaloneOrganizationIndicator | boolean, Optional When 'true' indicates that this organization is not a member of a legal family tree. This means it cannot play the role of a subsidiary, parent, headquarters or branch; i.e., FamilyTreeMemberRoleText cannot be present. When 'false' indicates that this organization is a member of a legal family tree. In this condition the FamilyTreeMemberRoleText must be present. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage } FamilyTreeMemberOrganization } OrganizationDetail | /Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Linkage | Linkage, Optional |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeHierarchyLevel | integer, up to 2 digits, Optional A two-position code, in conjunction with the status and subsidiary indicators that pinpoints the location of an establishment within a corporate hierarchy. |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization } Linkage | /Aggregate |
END: OrderProductResponse } OrderProductResponseDetail } Product } Organization | /Aggregate |
END: OrderProductResponse } OrderProductResponseDetail } Product | /Aggregate |
END: OrderProductResponse } OrderProductResponseDetail | /Aggregate |
END: OrderProductResponse | /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: CM001-CM006, CM011, CM012, CM014, CM017, CM018, PD007, PD008 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 D-U-N-S Number and product code are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).
Retrieving Archived Copies
An option exists to retain the results from all successful requests for this product in a Product Request Archive, which may be retrieved without incurring additional usage charges.
NOTE: The default value for ArchiveProductOptOutIndicator is 'true', indicating that the request will NOT be automatically archived.
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.
This product will also return a set of standard elements (e.g. D-U-N-S Number, Organization Name, Trade Styles, Family Tree Role, Primary Address, Mailing Address, Telephone Number, Fax Number, etc.) in addition to the business elements listed.
Name | Description |
---|---|
Direct Children Indicator | When 'true' indicates that only the count of immediate children is provided. PCM XPath: //Organization/ Linkage/ LinkageSummary/ ChildrenSummary/ DirectChildrenIndicator |
Domestic Ultimate D-U-N-S Number | The D-U-N-S Number of the highest level parent within a corporate family tree that is domiciled in the same country as the requested company. A parent is a corporation that owns more than 50% of another corporation's capital stock. A subject may be its own domestic ultimate. PCM XPath: //Organization/ Linkage/ DomesticUltimateOrganization/ DUNSNumber |
Family Tree Hierarchy Level Code | A two-position counter that indicates the number of family tree levels below the global ultimate. The hierarchy level value of the global ultimate will always be 1. Each subsidiary level below the global ultimate is incremented by one. Branch locations in a family tree will have the same hierarchy code as its associated headquarter. PCM XPath: //Organization/ Linkage/ FamilyTreeHierarchyLevel |
Family Tree Member Association Type | Text that defines the nature of the relationship of the linked organization to the business subject , e.g., parent, headquarter. PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ AssociationTypeText |
Family Tree Member Business Name | Text recording a name of this organization in the specified language and/or writing script. PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ OrganizationName/ OrganizationPrimaryName/ OrganizationName |
Family Tree Member Country Code | The ISO Alpha 2 Country Code of the primary address of the family tree member organization. PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ Location/ PrimaryAddress/ CountryISOAlpha2Code |
Family Tree Member Delist Indicator | When 'true' indicates that a business has requested its listing be removed from the D&B marketing file for privacy or other reasons. Delisting of records is performed at a company level, not at the executive name level. Records are removed from the PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ SubjectHeader/ SubjectHandling/ SubjectHandlingText |
Family Tree Member D-U-N-S Number | D-U-N-S Number of the family tree member. PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ SubjectHeader/ DUNSNumber |
Family Tree Member Location Type | Text that describes the part that the Subject plays as a member of an ownership structured family tree (e.g. headquarter, branch, division, parent, subsidiary, global ultimate, domestic ultimate). PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ OrganizationDetail/ FamilyTreeMemberRole/ FamilyTreeMemberRoleText |
Family Tree Member Primary Address (NIXIE) Undeliverable | When 'true' indicates that it is difficult or impossible to deliver to this address. When 'false' indicates that mails to this address can be delivered successfully. PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ Location/ PrimaryAddress/ UndeliverableIndicator |
Family Tree Member Street Address | Text that records the street address components as it would be presented on an address label for a member of an ownership structured family tree. This includes, but is not limited to, details such as street name, street number, building name, estate n PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ Location/ PrimaryAddress/ StreetAddressLine/ LineText |
Family Tree Member Territory Abbreviated Name | Text recording the shortened name of the locally governed area which forms part of a centrally governed nation to identify where the family tree member is located. PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ Location/ PrimaryAddress/ TerritoryAbbreviatedName |
Family Tree Member Town Name | Text recording the name of the family tree member organization's town or city recognized by the Postal Authority for delivering mail. PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ Location/ PrimaryAddress/ PrimaryTownName |
Family Tree Member Trade Style Name | Text recording the name which the family tree member trades under for commercial purposes although its registered legal name used for contracts and other formal situations may be another name. PCM XPath: //Organization/ Linkage/ FamilyTreeMemberOrganization/ OrganizationName/ TradeStyleName/ OrganizationName |
Global Ultimate D-U-N-S Number | The D-U-N-S number of the highest level parent within a corporate family tree. A parent is a corporation that owns more than 50% of another corporation's capital stock. A subject may be its own global ultimate. PCM XPath: //Organization/ Linkage/ GlobalUltimateOrganization/ DUNSNumber |
Headquarter D-U-N-S Number | The D-U-N-S Number of the headquarters company. A headquarters is a business establishment that has branches or divisions reporting to it. PCM XPath: //Organization/ Linkage/ HeadquartersOrganization/ DUNSNumber |
Marketability Indicator | 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. PCM XPath: //Organization/ SubjectHeader/ MarketabilityIndicator |
Parent D-U-N-S Number | The D-U-N-S number of the parent company. A parent is a corporation that owns more than 50% of another corporation's capital stock; these owned companies are subsidiaries to the parent company. PCM XPath: //Organization/ Linkage/ ParentOrganization/ DUNSNumber |
Sibling Count | The total number of affiliated subsidiaries for this parent organization (i.e. having the same hierarchy level). PCM XPath: //Organization/ Linkage/ LinkageSummary/ SiblingCount |
Subject Handling Text | Text specifying the manner in which the Subject is to receive special care from D&B when it is being contacted; e.g. do not call or do not send information requests. In many cases this process was specifically requested by the Subject. PCM XPath: //Organization/ SubjectHeader/ SubjectHandling/ SubjectHandlingText |
Total Affiliate Quantity | The number of affiliated companies linked to this organization. Affiliates are related to other businesses through common ownership by the same parent organization. PCM XPath: //Organization/ Linkage/ LinkageSummary/ ChildrenSummary/ ChildrenQuantity |
Total Branch Quantity | The number of branches linked to this headquarters location. PCM XPath: //Organization/ Linkage/ LinkageSummary/ ChildrenSummary/ ChildrenQuantity |
Total Children Quantity | The number of subsidiaries, divisions, and branches plus the total number of affiliated subsidiaries linked to this company (i.e. subsidiaries with the same parent company). If Direct Children Indicator is set to true, this quantity is the total number of direct children; if Direct Children Indicator is set to false, this quantity is the total number of direct and indirect children. PCM XPath: //Organization/ Linkage/ LinkageSummary/ ChildrenSummary/ ChildrenQuantity |
Total Division Quantity | The number of divisions linked to this company. PCM XPath: //Organization/ Linkage/ LinkageSummary/ ChildrenSummary/ ChildrenQuantity |
Total Subsidiary Quantity | The number of subsidiaries linked to this parent organization. PCM XPath: //Organization/ Linkage/ LinkageSummary/ ChildrenSummary/ ChildrenQuantity |
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.
Standard Elements
Whenever a D&B Direct data or report product request returns a single D-U-N-S Number, several business elements pertaining to that company will be included with the results.
These elements include D-U-N-S Number*, Organization Name, Primary Address** (including street, city, state, postal code, country), Mailing Address** (including street, city, state, postal code, county), Telephone Number, Fax Number, Trade Styles (up to five), Family Tree Role (HQ, branch), a Standalone Organization Indicator(true/false) and the PortfolioAssetID***.
All standard elements (with the exception of Family Tree Role and PortfolioAssetID) may be referenced by the Monitoring process.
* The D-U-N-S Number of the organization referenced in the results. In the case of a trade up, this will be the headquarters D-U-N-S Number.
** Addresses are returned as they are recieved by D&B and therefore may not conform to local postal formatting specifications.
*** This is an identification number that can be used to retrieve a given results package at a later date from the Product Request Archive (if/when that feature is enabled in a request).
Name | Description |
---|---|
D-U-N-S Number | The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). This DUNS Number represents the business entity. |
Country Code | The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country of the business entity. |
County Name | Text recording the name of the county in which the business is located. |
Family Tree Member Role | Text recording of various parts that the Subject plays as a member of an ownership structured family tree. |
FAX Number | The FAX number of the business. |
FAX Number International Dialing Code | The FAX number international dialing code of the business. |
Mailing Country Code | The two-letter country code, defined by the International Organization for Standardization (ISO) ISO 3166-1 scheme identifying the country which the business uses for mailing purposes. |
Mailing County Name | Text recording the name of the county which the business uses for mailing purposes. |
Mailing Postal Code | An identifier used by the local country Postal Authority which the business uses for mailing purposes. |
Mailing Street | Text recording an address which is mainly utilized for the purpose of mail delivery to the business. This usually includes a Post Office Box number or similar mailing details. |
Mailing Street (2) | Text recording an address which is mainly utilized for the purpose of mail delivery to the business. This usually includes a Post Office Box number or similar mailing details. |
Mailing Territory Abbreviation | Text recording the shortened name of the locally governed area which forms part of a centrally governed nation which the business uses for mailing purposes. |
Mailing Territory Name | Text recording the name of the locally governed area which forms part of a centrally governed nation which the business uses for mailing purposes. |
Mailing Town Name | The address number, or post office box number, and street name which a business uses for mailing purposes. |
Postal Code | An identifier used by the local country Postal Authority to identify where the business is located. |
Primary Business Name | Text recording of a single name by which the organization is primarily known or identified. |
Standalone Organization Indicator | When true indicates that this organization is not a member of a legal family tree. The Subject has no Parent Company, no subsidiaries or no branch/division locations. |
Street Address | Text recording the address number, or post office box number and street name where the business is located. |
Street Address (2) | Text recording the address number, or post office box number and street name where the business is located. |
Telephone Number | The telephone number of the business. |
Telephone Number International Dialing Code | The telephone number international dialing code of the business. |
Territory Abbreviated Name | Text recording the shortened name of the locally governed area which forms part of a centrally governed nation to identify where the business is located. |
Territory Name | Text recording the name of the locally governed area which forms part of a centrally governed nation to identify where the business is located. |
Town Name | Text recording the name of a city, town, township, village, borough, etc. where the business is located. |
Trade Style Name | Text recording the name which an organization trades under for commercial purposes although its registered legal name used for contracts and other formal situations may be another name. |
Product Notes
The business elements will be repeated for each entity returned on the corporate tree.
The Corporate Linkage data layer (LNK_FF) may only be monitored at the product code level (i.e. individual Business Elements may NOT be specified), and the change notice will be generated for any change in the entire linkage of the global ultimate parent.