Minority Linkage
Product(s) | Direct Onboard |
Product Code(s) | LNK_FF_MNRT |
Level(s) | Standard |
Monitoring Available | No |
Interface | REST |
Method | GET |
Format(s) | JSON |
Service | Linkage |
{version} | 4.0 |
Initial Release | January 8, 2016 |
The Minority Linkage family tree returns the ultimate parent of the requested company and all related entities (i.e., full family tree) but including any minority shareholdings (i.e shareholdings of 50% or less).
Update History
- September 20, 2019 (ALL SOAP & REST): PrimaryTownName element will handle "&" char properly in the Linkage Service response.
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 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.
Global Availability
The LNK_FF_MNRT data layers is available for businesses domiciled in the following countries:
Country | ISO Code |
---|---|
United States of America | US |
Belgium | BE |
France | FR |
Germany | DE |
Italy | IT |
Netherlands | NL |
Portugal | PT |
Spain | ES |
United Kingdom | GB |
Australia | AU |
New Zealand | NZ |
Andorra | AD |
Anguilla | AI |
Antigua & Barbuda | AG |
Aruba | AW |
Bahamas | BS |
Barbados | BB |
Belize | BZ |
Bermuda | BM |
Bolivia | BO |
British Virgin Islands | VG |
Canada | CA |
Cayman Islands | KY |
Chile | CL |
Colombia | CO |
Costa Rica | CR |
Denmark | DK |
Dominica | DM |
Dominican Republic | DO |
Ecuador | EC |
El Salvador | SV |
Faero Islands | FO |
Finland | FI |
Greenland | GL |
Grenada | GD |
Guatemala | GT |
Guyana | GY |
Haiti | HT |
Honduras | HN |
Ireland | IE |
Jamaica | JM |
Japan | JP |
Luxembourg | LU |
Mexico | MX |
Monaco | MC |
Montserrat | MS |
Netherlands Antilles | AN |
Bonaire, Sint Eustatius And Saba | BQ |
Curaçao | CW |
Sint Maarten (dutch) | SX |
Nicaragua | NI |
Norway | NO |
Panama | PA |
Saint Kitts & Nevis | KN |
Saint Lucia | LC |
Saint Vincent | VC |
San Marino | SM |
Suriname | SR |
Sweden | SE |
Taiwan | TW |
Trinidad And Tobago | TT |
Turks And Caicos | TC |
Venezuela | VE |
Afghanistan | AF |
Albania | AL |
Algeria | DZ |
American Samoa | AS |
Angola | AO |
Argentina | AR |
Armenia | AM |
Austria | AT |
Azerbaijan | AZ |
Bahrain | BH |
Bangladesh | BD |
Benin, Peoples Republic of | BJ |
Bhutan | BT |
Bosnia And Herzegovina | BA |
Botswana | BW |
Brazil | BR |
Brunei | BN |
Bulgaria | BG |
Burkina Faso | BF |
Burma (myanmar) | MM |
Burundi | BI |
Belarus | BY |
Kampuchea (prev. Cambodia) | KH |
Cameroon | CM |
Cape Verde, Republic of | CV |
Central Africa Republic | CF |
Chad, Republic of | TD |
China, Peoples Republic of | CN |
Christmas Island | CX |
Comoros Republic | KM |
Congo Democratic Republic | CD |
Cook Islands | CK |
Croatia | HR |
Cyprus | CY |
Turkish Republic of Northern Cyprus | XT |
Czech Republic | CZ |
Djibouti | DJ |
Egypt | EG |
Equatorial Guinea | GQ |
Eritrea | ER |
Estonia | EE |
Ethiopia | ET |
Falkland Islands | FK |
Fiji | FJ |
French Guiana | GF |
French Polynesia/tahiti | PF |
Gabon Republic | GA |
Gambia | GM |
Georgia | GE |
Ghana | GH |
Gibraltar | GI |
Greece | GR |
Guadeloupe | GP |
Guam | GU |
Guinea Bissau | GW |
Guinea, Republic of | GN |
Hong Kong SAR | HK |
Hungary | HU |
Iceland | IS |
India | IN |
Indonesia | ID |
Iran | IR |
Iraq | IQ |
Israel | IL |
Ivory Coast/cote D'ivoire | CI |
Jordan | JO |
Kazakhstan | KZ |
Kenya | KE |
Kiribati | KI |
Korea, Republic of | KR |
Kuwait | KW |
Kyrgyzstan | KG |
Laos | LA |
Latvia | LV |
Lebanon | LB |
Lesotho | LS |
Liberia | LR |
Libya | LY |
Liechtenstein | LI |
Lithuania | LT |
Macao SAR | MO |
North Macedonia | MK |
Madagasgar | MG |
Malawi | MW |
Malaysia | MY |
Maldives | MV |
Mali | ML |
Malta | MT |
Marianas Islands | MP |
Marshall Islands | MH |
Martinique | MQ |
Mauritania | MR |
Mauritius | MU |
Moldova | MD |
Montenegro | ME |
Morocco | MA |
Mozambique | MZ |
Namibia | NA |
Nauru | NR |
Nepal | NP |
New Caledonia | NC |
Niger | NE |
Nigeria | NG |
Norfolk Island | NF |
Oman | OM |
Pakistan | PK |
Papua New Guinea | PG |
Paraguay | PY |
Peru | PE |
Philippines | PH |
Poland | PL |
Qatar | QA |
Reunion Island | RE |
Romania | RO |
Russian Federation | RU |
Rwanda | RW |
Saint Helena | SH |
Saint Pierre Et Miquelon | PM |
Sao Tome & Principe | ST |
Saudi Arabia | SA |
Senegal | SN |
Serbia | RS |
Seychelles | SC |
Sierra Leone | SL |
Singapore | SG |
Slovakia | SK |
Slovenia | SI |
Solomon Islands | SB |
Somalia | SO |
South Africa | ZA |
Sri Lanka | LK |
Sudan | SD |
South Sudan | SS |
Eswatini | SZ |
Switzerland | CH |
Syria | SY |
Tajhikstan | TJ |
Tanzania | TZ |
Thailand | TH |
Togo | TG |
Tokelau Islands | TK |
Tonga | TO |
Tunisia | TN |
Turkiye | TR |
Turkmenistan | TM |
Tuvalu | TV |
Uganda | UG |
Ukraine | UA |
United Arab Emirates | AE |
Uruguay | UY |
Uzbekistan | UZ |
Vanuatu | VU |
Vietnam | VN |
Western Samoa | WS |
Yemen | YE |
Zambia | ZM |
Zimbabwe | ZW |
Congo | CG |
Puerto Rico | PR |
Holy See (vatican City State) | VA |
Serbia & Montenegro | CS |
Kosovo | XK |
Timor-Leste | TL |
Data Layer Entitlement
- This product is not entitled for D&B Direct 2.0 customers.
For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.
- This particular data layer is included in the D&B Direct Onboard 2.0 suite.
Specification
The D&B Direct 2.0 API supports HTTP compression. To utilize this option, add the following line to the header of your request: Accept-Encoding: gzip,deflate
GET https://direct.dnb.com/V4.0/organizations/804735132/products/LNK_FF_MNRT?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.
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) |
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": "4.0", "TransactionDetail": { "ApplicationTransactionID": "Id-b788f859858fadad8c904f6f-2", "ServiceTransactionID": "Id-b788f859858fadad8c904f6f-2", "TransactionTimestamp": "2017-10-31T10:29:11.941-04:00" }, "TransactionResult": { "SeverityText": "Information", "ResultID": "CM000", "ResultText": "Success" }, "OrderProductResponseDetail": { "InquiryDetail": { "DUNSNumber": "804735132", "CountryISOAlpha2Code": "US" }, "Product": { "DNBProductID": "LNK_FF_MNRT", "LinkageResponseOrganizationCount": 6, "Organization": { "SubjectHeader": { "DUNSNumber": "804735132" }, "Location": { "PrimaryAddress": { "PrimaryTownName": "San Francisco", "CountryISOAlpha2Code": "US" } }, "OrganizationName": { "OrganizationPrimaryName": { "OrganizationName": { "$": "Gorman Manufacturing Company, Inc." } } }, "OrganizationDetail": { "FamilyTreeMemberRole": [ { "FamilyTreeMemberRoleText": { "$": "Global Ultimate" } } ] }, "Linkage": { "FamilyTreeHierarchyLevel": 1, "FamilyTreeMemberOrganization": [ { "SubjectHeader": { "DUNSNumber": "362281243" }, "Location": { "PrimaryAddress": { "PrimaryTownName": "Bethlehem", "CountryISOAlpha2Code": "US" } }, "OrganizationName": { "OrganizationPrimaryName": { "OrganizationName": { "$": "US Test Company 700" } } }, "OrganizationDetail": { "FamilyTreeMemberRole": [ { "FamilyTreeMemberRoleText": { "$": "Branch" } } ] }, "Linkage": { "FamilyTreeHierarchyLevel": 2 } }, { "SubjectHeader": { "DUNSNumber": "754683795" }, "Location": { "PrimaryAddress": { "PrimaryTownName": "COLLINGWOOD", "CountryISOAlpha2Code": "AU" } }, "OrganizationName": { "OrganizationPrimaryName": { "OrganizationName": { "$": "KENTMORE CLOTHING (MANUFACTURING) PTY LTD" } } }, "OrganizationDetail": { "FamilyTreeMemberRole": [ { "FamilyTreeMemberRoleText": { "$": "Parent" } } ] }, "Linkage": { "FamilyTreeHierarchyLevel": 2, "FamilyTreeMemberOrganization": [ { "SubjectHeader": { "DUNSNumber": "592493196" }, "Location": { "PrimaryAddress": { "PrimaryTownName": "AUCKLAND", "CountryISOAlpha2Code": "NZ" } }, "OrganizationName": { "OrganizationPrimaryName": { "OrganizationName": { "$": "KENTMORE TRENDS LTD" } } }, "OrganizationDetail": { "FamilyTreeMemberRole": [ { "FamilyTreeMemberRoleText": { "$": "Subsidiary" } } ] }, "Linkage": { "MinorityInterestOrganization": [ { "ShareHoldingPercentage": 10.65, "FamilyTreeMemberRoleText": [ { "$": "Subsidiary" } ] } ], "FamilyTreeHierarchyLevel": 3 } }, { "SubjectHeader": { "DUNSNumber": "740260021" }, "Location": { "PrimaryAddress": { "PrimaryTownName": "WEST RYDE", "CountryISOAlpha2Code": "AU" } }, "OrganizationName": { "OrganizationPrimaryName": { "OrganizationName": { "$": "KENTMORE CLOTHING (MANUFACTURING) PTY LTD" } } }, "OrganizationDetail": { "FamilyTreeMemberRole": [ { "FamilyTreeMemberRoleText": { "$": "Branch" } } ] }, "Linkage": { "FamilyTreeHierarchyLevel": 3 } }, { "SubjectHeader": { "DUNSNumber": "759006828" }, "Location": { "PrimaryAddress": { "PrimaryTownName": "PERTH", "CountryISOAlpha2Code": "AU" } }, "OrganizationName": { "OrganizationPrimaryName": { "OrganizationName": { "$": "KENTMORE CLOTHING (MANUFACTURING) PTY LTD" } } }, "OrganizationDetail": { "FamilyTreeMemberRole": [ { "FamilyTreeMemberRoleText": { "$": "Branch" } } ] }, "Linkage": { "FamilyTreeHierarchyLevel": 3 } } ] } } ] } }, "ArchiveDetail": { "PortfolioAssetID": 78640615 } } } } }
Name | Characteristics |
---|---|
OrderProductResponse | Aggregate |
OrderProductResponse @ServiceVersionNumber | Attribute |
OrderProductResponse { TransactionDetail | Aggregate, Required Records information necessary to process a particular request. Examples of a request is the ordering of a product. |
OrderProductResponse { TransactionDetail { ApplicationTransactionID | Element, string, up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. |
OrderProductResponse { TransactionDetail { ServiceTransactionID | Element, string, up to 64 chars., Required A number assigned by the D&B service to uniquely identify this transaction. |
OrderProductResponse { TransactionDetail { TransactionTimestamp | Element, date, 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. |
END: OrderProductResponse { TransactionDetail | Aggregate |
OrderProductResponse { TransactionResult | Aggregate, Required An aggregate that can repeat multiple times to record the different outcomes of the transaction. |
OrderProductResponse { TransactionResult { SeverityText | Element, string, Required Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. |
OrderProductResponse { TransactionResult { ResultID | Element, string, up to 32 chars., Required An alphanumeric string that uniquely identifies the outcome of the transaction. |
OrderProductResponse { TransactionResult { ResultText | Element, string, up to 512 chars., Optional Text that explains the outcome of the transaction. |
OrderProductResponse { TransactionResult { ResultMessage | Aggregate, Optional (Array) An aggregate that can repeat multiple times to record textual data that expands on the ResultID and ResultText to provide additional information to the user regarding the status of the transaction. If the status implies that there is a problem this may also provide guidance to the user on how to address it. |
OrderProductResponse { TransactionResult { ResultMessage { ResultDescription | Element, string, up to 512 chars., Required Text that describes the additional information regarding the outcome of the transaction. |
END: OrderProductResponse { TransactionResult { ResultMessage | Aggregate |
END: OrderProductResponse { TransactionResult | Aggregate |
OrderProductResponse { OrderProductResponseDetail | Aggregate, Optional Records the data being returned to the customer as a result of a product request. |
OrderProductResponse { OrderProductResponseDetail { InquiryDetail | Aggregate, Required Records data that allows the customer to specify identifying information about the subject being inquired, e.g., the DUNS Number, the address, the telephone number. |
OrderProductResponse { OrderProductResponseDetail { InquiryDetail { DUNSNumber | Element, string, up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required The subject identifier under the Data Universal Numbering System of the inquired subject. OR D&B's identification number, which provides unique identification of the inquired organization, in accordance with the Data Universal Numbering System (D-U-N-S). |
OrderProductResponse { OrderProductResponseDetail { InquiryDetail { CountryISOAlpha2Code | Element, 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. |
END: OrderProductResponse { OrderProductResponseDetail { InquiryDetail | Aggregate |
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 { DNBProductID | Element, string, Required An alphanumeric string that uniquely identifies this product. |
OrderProductResponse { OrderProductResponseDetail { Product { LinkageResponseOrganizationCount | Element, int up to 5 digits., Required The number of organizations that have an association with the requested organization whose data is returned in response to a request for linkage information. Examples of such organizations are branch organizations, subsidiary organizations, the global ultimate of the requested organization. |
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 | Element, 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). |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location | Aggregate, Required 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, Required 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 { PrimaryTownName | Element, 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 | Element, string, at least 2 chars. up to 2 chars., Required The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO), identifying the country for this address. |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress | Aggregate |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName | Aggregate, Required 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, Required An entry loop which can repeat multiple times to allow the recording of names by which the organization is primarily known / identified. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName | Element, 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 |
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 (Array) 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 | Element, 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. |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail { FamilyTreeMemberRole | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail { StandaloneOrganizationIndicator | Element, boolean, Optional When turned ON (set to TRUE) it 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 turned OFF (set to FALSE) it 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 { 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 { FamilyTreeMemberOrganization | Aggregate, Optional (Array) Records information about the various parts that the Subject plays as a member of an ownership structured family tree. |
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, Required |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationName { OrganizationPrimaryName { OrganizationName | Element, 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 |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationName | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader | Aggregate, Optional 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 { Linkage { FamilyTreeMemberOrganization { SubjectHeader { DUNSNumber | Element, 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). |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { 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 { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress | Aggregate, Required |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { PrimaryTownName | Element, string, up to 64 chars., Optional |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { CountryISOAlpha2Code | Element, string, at least 2 chars. up to 2 chars., Required |
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 Records fundamental information about a Subject which may vary over time. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationDetail { FamilyTreeMemberRole | Aggregate, Optional (Array) |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationDetail { FamilyTreeMemberRole { FamilyTreeMemberRoleText | Element, string, up to 256 chars., Optional |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationDetail | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Linkage | Aggregate (Recursive), 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 { FamilyTreeMemberOrganization { Linkage { MinorityInterestOrganization | Aggregate, Optional (Array) An entry loop which can repeat multiple times to record information on those organizations with whom the subject organization has an owner relationship of less than 50% . |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Linkage { MinorityInterestOrganization { ShareHoldingPercentage | Element, decimal, up to 5 digits. Maximum of 2 decimal places., Optional The total percentage of the shares (or other instrument of ownership) of the subject directly held/owned by the Shareholder. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Linkage { MinorityInterestOrganization { FamilyTreeMemberRoleText | Element, string, up to 256 chars., Optional (Array) 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 { Linkage { MinorityInterestOrganization { FamilyTreeMemberRoleText @DNBCodeValue | Attribute |
End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Linkage { MinorityInterestOrganization | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization { Linkage { FamilyTreeHierarchyLevel | Element, 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 { FamilyTreeMemberOrganization { Linkage | Aggregate |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeMemberOrganization | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization | Aggregate, Optional (Array) An entry loop which can repeat multiple times to record information on those organizations with whom the subject organization has an owner relationship of less than 50% . |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization { DUNSNumber | Element, 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). |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization { OrganizationPrimaryName | Aggregate, Optional Records name by which the organization is primarily known / identified. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization { OrganizationPrimaryName { OrganizationName | Element, 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 { MinorityInterestOrganization { OrganizationPrimaryName | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization { PrimaryAddress | Aggregate, Optional Records the primary or physical address of a subject/Case. 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 { MinorityInterestOrganization { PrimaryAddress { PrimaryTownName | Element, string, up to 64 chars., Optional |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization { PrimaryAddress { CountryISOAlpha2Code | Element, string, at least 2 chars. up to 2 chars., Required |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization { PrimaryAddress | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization { ShareHoldingPercentage | Element, decimal up to 5 digits. Maximum of 2 decimal places., Optional The total percentage of the shares (or other instrument of ownership) of the subject directly held/owned by the Shareholder. |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization { FamilyTreeMemberRoleText | Element, string, up to 256 chars., Optional (Array) 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. |
END: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { MinorityInterestOrganization | Aggregate |
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { FamilyTreeHierarchyLevel | Element, 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.