Ultimate Beneficial Ownership
Also known as Compliance Beneficial Ownership Structure and Compliance Beneficial Ownership List.
Product | D&B Direct 2.0, D&B Direct Onboard |
Product Code(s) | CMP_BOL, CMP_BOS |
Level(s) | Standard |
Monitoring Available | No |
Interface | REST |
Method | GET |
Format(s) | JSON |
Service | ComplianceVerification |
{version} | 1.1 |
1.1 Released On | December 9, 2016 |
The findUBO feature allows customers to be able to, within a single call, resolve who is the Ultimate Beneficial Owners of a target D-U-N-S.
The Get List structure (CMP_BOL) focuses on the entities of both corporate and natural persons, and their relationship back to the target D-U-N-S with a particular focus on identifying Ultimate Beneficial Owners (UBOs) and Corporate Beneficial Owners (CBOs). This output is optimized for presentation in list format and use within internal or customer workflows.
The Get Full Structure (CMP_BOS) allows customers to understand all entities (corporate and natural persons) along with all of their individual relationships. This output is optimized for visualization purposes.
Update History
- December 10, 2021 (ALL SOAP & REST): Mapping update for Incorporation year (UK/Ireland)
- October 08, 2021 (ALL SOAP & REST): Defect fix to suppress principal information of non-English Principal name to avoid incomplete Principal and Management section in the response.
- September 17, 2021 (ALL SOAP & REST): New Legal Form text values are added for Argentina.
- September 17, 2021 (ALL SOAP & REST): Indutsry code values are added for Armenia, Azerbaijan, Belarus, Bulgaria, Cyprus, Greece, Georgia, Kazakhstan, Kyrgyzstan, Moldova, Republic of, Romania, Russian Federation, Tajikistan, Turkmenistan, Ukraine and Uzbekistan.
- August 27, 2021 (ALL SOAP & REST): Defect fix to return the missing NAICS 2012 Industry code.
- July 16, 2021 (ALL SOAP & REST): New Legal Form text, PositionText, IndustryCode and OrganizationIdentificationNumber values are added for Hungary, Czech Republic, Japan, Poland & Slovakia.
- June 25, 2021 (ALL SOAP & REST): Defect Fix to add the language code check to populate only English characters.
- March 12, 2021 (ALL SOAP & REST): New Legal Form text values are added for Switzerland.
- March 12, 2021 (ALL SOAP & REST): New Organization Identification Number values are added for Hungary.
- January 29, 2021 (ALL SOAP & REST): PersonID element string length updated to 32 chars.Xpath (applicable to CMP_BOL & CMP_BOS products only): Product.Organization.Linkage.BeneficialOwnership.BeneficialOwners.PersonID
- January 29, 2021 (ALL SOAP & REST): New Legal Form text values are added for Hungary, Southern Markets, Slovenia, Croatia, Bosnia-Herzegovina & Serbia
- August 28, 2020 (ALL SOAP & REST): Defect fix to retrieve the success response for SG and MA country DUNS.
- August 28, 2020 (ALL SOAP & REST): New Legal Form text and Registration Numbers are added for Algeria (AL), Tunisia (TN) and Morocco (MO).
- April 24, 2020 (ALL SOAP & REST): For European countries, FinancialEmbarrassmentIndicator element will consider additional situations.
- April 03, 2020 (ALL SOAP & REST): Defect fix to return the Legal Form Code values for Italy (IT) and San Marino (SM).
- April 03, 2020 (ALL SOAP & REST): Defect fix to sum up both Cash & Cash and Liquid Assets value as single item amount in current asset Financial Statement.
- February 21, 2020 (ALL SOAP & REST): Defect fix to return the missing Financial currency code value.
- December 13, 2019 (ALL SOAP & REST): Bug fix to make response is compliance with Service Response Schema for IndividualEmployeeEntityDetails element.
- November 22, 2019 (ALL SOAP & REST): Mapping fix to return only “Actual” ReliabilityText of ConsolidatedEmployeeDetails & suppress “Estimated” or other ReliabilityText’s of ConsolidatedEmployeeDetails in order to display the aggregate as single occurrence in the response as per schema.
- September 20, 2019 (ALL SOAP & REST): New Legal Form text are added for UAE (AE), Egypt (EG), Australia (AU), China (CN) and Hong Kong (HK) countries.
- September 20, 2019 (ALL SOAP & REST): New Registration Numbers are added for New Zealand (NZ) country.
- August 30, 2019 (ALL SOAP & REST): For Asia Pacific & European countries, Operating status codes: 404(Ceased Trading) will be considered to set value of OutofBusinessIndicator element.
- August 9, 2019 (ALL SOAP & REST): For Project Apollo, added 4 new registration type code for OrganizationNumber element.
- August 9, 2019 (ALL SOAP & REST): An error message from the Services Local FeedsDB , when there is NO Match DUNS from CA DUnslink & GSRL has been fixed for Canada.
- March 29, 2019 (ALL SOAP & REST): TransferDUNSNumberRegistration aggregate and its elements have been suppressed from the response.
- December 7, 2018 (v1.2 SOAP & REST) version 6.0 is now available for all Compliance Verification products. Added new elements to CMP_BOS, and CMP_BOL products.
- June 23, 2017 (v5.0 SOAP & REST) Added new response elements to CMP_BOL, and CMP_BOS.
- May 12, 2017 (v1.2 SOAP & REST) version 5.0 is now available for all Compliance Verification products. Added new elements to CMP_VRF_ID, CMP_VRF_RPT, CMP_BOS, and CMP_BOL products.
- March 10, 2017 (v1.2 SOAP & REST) version 1.2 is now available for all Compliance Verification products. Added new elements to CMP_BOS, and CMP_BOL products.
- December 9, 2016 (v1.1 SOAP & REST) version 1.1 is now available for all Compliance Verification products. Added new products CMP_BOS, and CMP_BOL.
- October 19, 2016 (v1.0 SOAP & REST) Monitoring paths and indicators are now available for CMP_VRF_ID, and CMP_VRF_RPT products.
- September 16, 2016 (v1.0 SOAP & REST) GBO, SMPL_OWNSHP, CMP_VRF_RPT, CMP_VRF_ID, and KYC products are now available through Compliance Verification Service.
- July 15, 2016 (v1.0 SOAP & REST): Monitoring for GBO product has been enabled for the following countries; Austria, Belgium, Germany, Italy, Ireland, Luxembourg, Netherlands, Portugal, Spain, Switzerland, and United Kingdom.
- July 15, 2016 (v1.0 SOAP & REST): SMPL_OWNSHP, GBO and KYC data layers released as part of D&B Direct 2.0 API.
- July 15, 2016 (v1.0 SOAP & REST): CMP_VRF_ID and CMP_VRF_RPT data layers released as part of D&B Direct Onboard API.
- January 29, 2021 (ALL SOAP & REST): PersonID element string length updated to 32 chars.Xpath (applicable to CMP_BOL & CMP_BOS products only): Product.Organization.Linkage.BeneficialOwnership.BeneficialOwners.PersonID
- March 29, 2019 (ALL SOAP & REST): TransferDUNSNumberRegistration aggregate and its elements have been suppressed from the response.
- December 7, 2018 (v1.2 SOAP & REST) version 6.0 is now available for all Compliance Verification products. Added new elements to CMP_BOS, and CMP_BOL products.
- June 23, 2017 (v5.0 SOAP & REST) Added new response elements to CMP_BOL, and CMP_BOS.
- May 12, 2017 (v1.2 SOAP & REST) version 5.0 is now available for all Compliance Verification products. Added new elements to CMP_VRF_ID, CMP_VRF_RPT, CMP_BOS, and CMP_BOL products.
- March 10, 2017 (v1.2 SOAP & REST) version 1.2 is now available for all Compliance Verification products. Added new elements to CMP_BOS, and CMP_BOL products.
- December 9, 2016 (v1.1 SOAP & REST) version 1.1 is now available for all Compliance Verification products. Added new products CMP_BOS, and CMP_BOL.
- October 19, 2016 (v1.0 SOAP & REST) Monitoring paths and indicators are now available for CMP_VRF_ID, and CMP_VRF_RPT products.
- September 16, 2016 (v1.0 SOAP & REST) GBO, SMPL_OWNSHP, CMP_VRF_RPT, CMP_VRF_ID, and KYC products are now available through Compliance Verification Service.
- July 15, 2016 (v1.0 SOAP & REST): Monitoring for GBO product has been enabled for the following countries; Austria, Belgium, Germany, Italy, Ireland, Luxembourg, Netherlands, Portugal, Spain, Switzerland, and United Kingdom.
- July 15, 2016 (v1.0 SOAP & REST): SMPL_OWNSHP, GBO and KYC data layers released as part of D&B Direct 2.0 API.
- July 15, 2016 (v1.0 SOAP & REST): CMP_VRF_ID and CMP_VRF_RPT data layers released as part of D&B Direct Onboard API.
- January 29, 2021 (ALL SOAP & REST): PersonID element string length updated to 32 chars.Xpath (applicable to CMP_BOL & CMP_BOS products only): Product.Organization.Linkage.BeneficialOwnership.BeneficialOwners.PersonID
- March 10, 2017 (v1.2 SOAP & REST) version 1.2 is now available for all Compliance Verification products. Added new elements to CMP_BOS, and CMP_BOL products.
- January 29, 2021 (ALL SOAP & REST): PersonID element string length updated to 32 chars.Xpath (applicable to CMP_BOL & CMP_BOS products only): Product.Organization.Linkage.BeneficialOwnership.BeneficialOwners.PersonID
- December 9, 2016 (v1.1 SOAP & REST) version 1.1 is now available for all Compliance Verification products. Added new products CMP_BOS, and CMP_BOL.
- October 19, 2016 (v1.0 SOAP & REST) Monitoring paths and indicators are now available for CMP_VRF_ID, and CMP_VRF_RPT products.
- September 16, 2016 (v1.0 SOAP & REST) GBO, SMPL_OWNSHP, CMP_VRF_RPT, CMP_VRF_ID, and KYC products are now available through Compliance Verification Service.
- July 15, 2016 (v1.0 SOAP & REST): Monitoring for GBO product has been enabled for the following countries; Austria, Belgium, Germany, Italy, Ireland, Luxembourg, Netherlands, Portugal, Spain, Switzerland, and United Kingdom.
- July 15, 2016 (v1.0 SOAP & REST): SMPL_OWNSHP, GBO and KYC data layers released as part of D&B Direct 2.0 API.
- July 15, 2016 (v1.0 SOAP & REST): CMP_VRF_ID and CMP_VRF_RPT data layers released as part of D&B Direct Onboard API.
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 feature, a valid D&B D-U-N-S Number for a company and the appropriate product code will be required. For improved performance, include its country code.
A trade up option exists to request data for the headquarters when the requested organization is a branch.
NOTE: When ordering information for organizations located in Germany, customers are required to provide a valid order reason code.
Global Availability
The CMP_BOL, CMP_BOS data layers are available for businesses domiciled in the following countries:
CMP_BOL | CMP_BOS | 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 | Chile | CL |
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 | Afghanistan | AF |
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 | Kampuchea (prev. Cambodia) | KH |
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 | Laos | LA |
Y | Y | Latvia | LV |
Y | Y | Lebanon | LB |
Y | Y | Lesotho | LS |
Y | Y | Liberia | LR |
Y | Y | Libya | LY |
Y | Y | Liechtenstein | LI |
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 | 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 | Turkey | 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 | Congo | CG |
Y | Y | Puerto Rico | PR |
Y | Y | Holy See (vatican City State) | VA |
Y | Y | Kosovo | XK |
Y | Y | Micronesia, Federated States of | FM |
Y | 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 particular report is entitled as "Compliance Patriot Act" 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/V1.1/organizations/214567885/products/CMP_BOL Authorization: <Token>
GET https://direct.dnb.com/V1.1/organizations/214567885/products/CMP_BOS Authorization: <Token>
CMP_BOL | CMP_BOS | Name | Characteristics |
---|---|---|---|
Y | Y | {version} | Element |
Y | Y | ApplicationTransactionID | string, up to 64 chars, Optional A number assigned by the calling application to uniquely identify this request. |
Y | Y | 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. |
Y | Y | SubmittingOfficeID | string, up to 64 chars, Optional A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. |
Y | Y | {DUNS} | 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). |
Y | Y | 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. |
Y | Y | {productID} | string, Required An alphanumeric string that uniquely identifies the product being requested. |
Y | Y | 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] |
Y | Y | CharacterSetPreferenceCode | integer, up to 7 digits, Optional A D&B code value denoting the set of graphic symbols (e.g., alphabet letter, pictograph) in which the product is to be rendered, e.g., Unicode. |
Y | Y | ProductFormatPreferenceCode | integer, up to 7 digits, Optional |
Y | Y | OrderReasonCode | integer, up to 7 digits, Optional Possible values: 6332 [Credit Decision]; 6333 [Assessment of credit solvency for intended business connection]; 6334 [Assessment of credit solvency for ongoing business connection]; 6335 [Debt Collection]; 6336 [Commercial Credit Insurance]; 6337 [Insurance Contract]; 6338 [Leasing Agreement]; 6339 [Rental Agreement] |
Y | N | OwnershipType | string, Optional A code that identifies the level of filter to applied on the requested product for the inquired subject, whether to include direct, indirect, both direct and indirect owners, or just beneficial owners etc. When NULL it indicates that there are no restrictions set on the request. Possible Values: BENF_OWRP, CTLD_OWRP, DIRC_OWRP, IDIR_OWRP |
Y | N | OwnershipPercentage | decimal (5,2), Optional The percentage criteria to be applied on the requested product for the inquired subject. The response would include all results with a shareholding percentage greater than this value inclusive. E.g., 20, 50. When NULL it indicates that there is no restriction or cut off percentage. |
Y | N | ExcludeUndisclosedHoldingsIndicator | boolean, Optional When turned ON (set to true) this denotes the result set should exclude information on shareholders whose percentage is zero or undisclosed. When turned OFF (set to false) or set to NULL this denotes the result set should include information on shareholders whose percentage is zero or undisclosed. |
Y | Y | ArchiveProductOptOutIndicator | boolean, Optional When 'true' indicates that the product being ordered is not to be stored. When 'false' 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. |
Y | Y | ExtendArchivePeriodIndicator | boolean, Optional When 'true' 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' the duration to archive the data is not to be extended. |
Y | Y | PortfolioAssetContainerID | long, Optional A number used to uniquely identify the location where this product is to be stored. |
Y | Y | 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. |
Y | Y | 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.
Endpoints (UBO Product) | |
---|---|
Specified version | GET https://direct.dnb.com/V{version}/organizations/{DUNS}/products/{DNBProductID} |
Latest version | GET https://direct.dnb.com/organizations/{DUNS}/products/{DNBProductID} |
Testing
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
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": { "TransactionDetail": { "ServiceTransactionID": "Id-44d3205ccc093563ab40fd15-2", "TransactionTimestamp": "2018-12-24T07:38:29.206-05:00" }, "TransactionResult": { "SeverityText": "Information", "ResultID": "CM000", "ResultText": "Success" }, "OrderProductResponseDetail": { "InquiryDetail": { "DUNSNumber": "214567885", "CountryISOAlpha2Code": "GB" }, "Product": { "DNBProductID": "CMP_BOL", "Organization": { "SubjectHeader": {"DUNSNumber": "214567885"}, "Location": {"PrimaryAddress": [ { "StreetAddressLine": [{"LineText": "Marlow International Parkway"}], "PrimaryTownName": "MARLOW", "CountryISOAlpha2Code": "GB", "PostalCode": "SL7 1AJ", "CountryOfficialName": "United Kingdom" }]}, "OrganizationName": {"OrganizationPrimaryName": [{"OrganizationName": {"$": "D & B SAMPLE CO LTD"}}]}, "OrganizationDetail": {"OutofBusinessIndicator": false}, "RegisteredDetail": {"LegalFormDetails": {"LegalFormText": { "@DNBCodeValue": 2547, "$": "Private Limited Liability Company" }}}, "IndustryCode": {"PrimaryIndustryCode": [ { "@DNBCodeValue": 399, "@TypeText": "US SIC (1987)", "IndustryCode": "7379", "IndustryCodeDescription": [ { "@LanguageCode": 39, "@IndustryCodeDescriptionLengthCode": 1441, "$": "Computer related services" }] }]}, "Linkage": { "GlobalUltimateOrganization": { "DUNSNumber": "214567885", "OrganizationPrimaryName": [{"OrganizationName": {"$": "D & B SAMPLE CO LTD"}}] }, "DomesticUltimateOrganization": { "DUNSNumber": "214567885", "OrganizationPrimaryName": [{"OrganizationName": {"$": "D & B SAMPLE CO LTD"}}] }, "BeneficialOwnership": {"BeneficialOwners": [ { "BeneficiaryIndicator": true, "MemberID": "471381701", "PrimaryName": "Fore Sample Corporate Share holder", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 4.35, "BeneficialOwnershipPercentage": 4.35 }, { "BeneficiaryIndicator": true, "MemberID": "468255377", "PrimaryName": "HKNJ Surname", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 4.35, "BeneficialOwnershipPercentage": 4.35 }, { "BeneficiaryIndicator": false, "MemberID": "181707063", "PrimaryName": "D & B SAMPLE PARTNERSHIP", "DUNSNumber": "231824520", "SubjectTypeDescription": { "@DNBCodeValue": 118, "$": "Businesses" }, "LegalFormText": { "@DNBCodeValue": 47, "$": "Partnership" }, "PrimaryAddress": { "StreetAddressLine": [ {"LineText": "Marlow International D & B Sample Partnership"}, {"LineText": "Parkway"} ], "PrimaryTownName": "MARLOW", "CountryISOAlpha2Code": "GB", "PostalCode": "SL7 1AJ", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.43, "OutofBusinessIndicator": true }, { "BeneficiaryIndicator": false, "MemberID": "185500720", "PrimaryName": "D & B SAMPLE HOLDING CO LTD", "DUNSNumber": "233083567", "SubjectTypeDescription": { "@DNBCodeValue": 118, "$": "Businesses" }, "LegalFormText": { "@DNBCodeValue": 2547, "$": "Private Limited Liability Company" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "41 High Street"}], "PrimaryTownName": "MARKET HARBOROUGH", "CountryISOAlpha2Code": "GB", "PostalCode": "LE16 7NL", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.87, "OutofBusinessIndicator": false }, { "BeneficiaryIndicator": true, "MemberID": "532652332", "PrimaryName": "Rachel Hardwer", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "458268746", "PrimaryName": "Test Test 2", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "252502820", "PrimaryName": "Test Test 1", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 5.22, "BeneficialOwnershipPercentage": 5.22 }, { "BeneficiaryIndicator": true, "MemberID": "406569461", "PrimaryName": "123 SHOPS testing4Ä", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "42 Oakridge Road"}], "PrimaryTownName": "High Wycombe", "CountryISOAlpha2Code": "GB", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "559024352", "PrimaryName": "Forename Test", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [ {"LineText": "XYZ"}, {"LineText": "Jk Rowlin"} ], "PrimaryTownName": "Birmingham", "CountryISOAlpha2Code": "GB", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "505207842", "PrimaryName": "LIMIRTED PARTNERSHIP WAREHOUSE", "DirectOwnershipPercentage": 4.35, "BeneficialOwnershipPercentage": 4.35 }, { "BeneficiaryIndicator": true, "MemberID": "259921260", "PrimaryName": "Might Ican", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 43.48, "BeneficialOwnershipPercentage": 43.48 }, { "BeneficiaryIndicator": true, "MemberID": "553843389", "PrimaryName": "OthersChanges Others", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "Address Check"}], "PrimaryTownName": "High Wycombe", "CountryISOAlpha2Code": "GB", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "523364285", "PrimaryName": "KMJ HJNM", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 4.35, "BeneficialOwnershipPercentage": 4.35 }, { "BeneficiaryIndicator": true, "MemberID": "471009273", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [ {"LineText": "SHOPS testing4Ä"}, {"LineText": "Paulõ"}, {"LineText": "aaaaaÖü"} ], "PrimaryTownName": "Gateway1ä", "CountryISOAlpha2Code": "GB", "CountryOfficialName": "United Kingdom" } }, { "BeneficiaryIndicator": true, "MemberID": "266707889", "PrimaryName": "Test Test", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "sss"}], "PrimaryTownName": "sss", "CountryISOAlpha2Code": "IE", "CountryOfficialName": "Ireland" }, "IndirectOwnershipPercentage": 0, "BeneficialOwnershipPercentage": 0 } ]} } }, "ArchiveDetail": {"PortfolioAssetID": 89142888} } } }}
{"OrderProductResponse": { "TransactionDetail": { "ServiceTransactionID": "Id-4fd3205cd30948cc0bcc922f-2", "TransactionTimestamp": "2018-12-24T07:38:40.789-05:00" }, "TransactionResult": { "SeverityText": "Information", "ResultID": "CM000", "ResultText": "Success" }, "OrderProductResponseDetail": { "InquiryDetail": { "DUNSNumber": "214567885", "CountryISOAlpha2Code": "GB" }, "Product": { "DNBProductID": "CMP_BOS", "Organization": { "SubjectHeader": {"DUNSNumber": "214567885"}, "Location": {"PrimaryAddress": [ { "StreetAddressLine": [{"LineText": "Marlow International Parkway"}], "PrimaryTownName": "MARLOW", "CountryISOAlpha2Code": "GB", "PostalCode": "SL7 1AJ", "CountryOfficialName": "United Kingdom" }]}, "OrganizationName": {"OrganizationPrimaryName": [{"OrganizationName": {"$": "D & B SAMPLE CO LTD"}}]}, "OrganizationDetail": {"OutofBusinessIndicator": false}, "RegisteredDetail": {"LegalFormDetails": {"LegalFormText": { "@DNBCodeValue": 2547, "$": "Private Limited Liability Company" }}}, "IndustryCode": {"PrimaryIndustryCode": [ { "@DNBCodeValue": 399, "@TypeText": "US SIC (1987)", "IndustryCode": "7379", "IndustryCodeDescription": [ { "@LanguageCode": 39, "@IndustryCodeDescriptionLengthCode": 1441, "$": "Computer related services" }] }]}, "Linkage": { "GlobalUltimateOrganization": { "DUNSNumber": "214567885", "OrganizationPrimaryName": [{"OrganizationName": {"$": "D & B SAMPLE CO LTD"}}] }, "DomesticUltimateOrganization": { "DUNSNumber": "214567885", "OrganizationPrimaryName": [{"OrganizationName": {"$": "D & B SAMPLE CO LTD"}}] }, "BeneficialOwnership": { "BeneficialOwners": [ { "BeneficiaryIndicator": false, "MemberID": "170660440", "PrimaryName": "D & B SAMPLE CO LTD", "DUNSNumber": "214567885", "SubjectTypeDescription": { "@DNBCodeValue": 118, "$": "Businesses" }, "LegalFormText": { "@DNBCodeValue": 2547, "$": "Private Limited Liability Company" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "Marlow International Parkway"}], "PrimaryTownName": "MARLOW", "CountryISOAlpha2Code": "GB", "PostalCode": "SL7 1AJ", "CountryOfficialName": "United Kingdom" }, "OutofBusinessIndicator": false }, { "BeneficiaryIndicator": true, "MemberID": "471381701", "PrimaryName": "Fore Sample Corporate Share holder", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 4.35, "BeneficialOwnershipPercentage": 4.35 }, { "BeneficiaryIndicator": true, "MemberID": "468255377", "PrimaryName": "HKNJ Surname", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 4.35, "BeneficialOwnershipPercentage": 4.35 }, { "BeneficiaryIndicator": false, "MemberID": "181707063", "PrimaryName": "D & B SAMPLE PARTNERSHIP", "DUNSNumber": "231824520", "SubjectTypeDescription": { "@DNBCodeValue": 118, "$": "Businesses" }, "LegalFormText": { "@DNBCodeValue": 47, "$": "Partnership" }, "PrimaryAddress": { "StreetAddressLine": [ {"LineText": "Marlow International D & B Sample Partnership"}, {"LineText": "Parkway"} ], "PrimaryTownName": "MARLOW", "CountryISOAlpha2Code": "GB", "PostalCode": "SL7 1AJ", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.43, "OutofBusinessIndicator": true }, { "BeneficiaryIndicator": false, "MemberID": "185500720", "PrimaryName": "D & B SAMPLE HOLDING CO LTD", "DUNSNumber": "233083567", "SubjectTypeDescription": { "@DNBCodeValue": 118, "$": "Businesses" }, "LegalFormText": { "@DNBCodeValue": 2547, "$": "Private Limited Liability Company" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "41 High Street"}], "PrimaryTownName": "MARKET HARBOROUGH", "CountryISOAlpha2Code": "GB", "PostalCode": "LE16 7NL", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.87, "OutofBusinessIndicator": false }, { "BeneficiaryIndicator": true, "MemberID": "532652332", "PrimaryName": "Rachel Hardwer", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "458268746", "PrimaryName": "Test Test 2", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "252502820", "PrimaryName": "Test Test 1", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 5.22, "BeneficialOwnershipPercentage": 5.22 }, { "BeneficiaryIndicator": true, "MemberID": "406569461", "PrimaryName": "123 SHOPS testing4Ä", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "42 Oakridge Road"}], "PrimaryTownName": "High Wycombe", "CountryISOAlpha2Code": "GB", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "559024352", "PrimaryName": "Forename Test", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [ {"LineText": "XYZ"}, {"LineText": "Jk Rowlin"} ], "PrimaryTownName": "Birmingham", "CountryISOAlpha2Code": "GB", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "505207842", "PrimaryName": "LIMIRTED PARTNERSHIP WAREHOUSE", "DirectOwnershipPercentage": 4.35, "BeneficialOwnershipPercentage": 4.35 }, { "BeneficiaryIndicator": true, "MemberID": "259921260", "PrimaryName": "Might Ican", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 43.48, "BeneficialOwnershipPercentage": 43.48 }, { "BeneficiaryIndicator": true, "MemberID": "553843389", "PrimaryName": "OthersChanges Others", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "Address Check"}], "PrimaryTownName": "High Wycombe", "CountryISOAlpha2Code": "GB", "CountryOfficialName": "United Kingdom" }, "DirectOwnershipPercentage": 0.43, "BeneficialOwnershipPercentage": 0.43 }, { "BeneficiaryIndicator": true, "MemberID": "523364285", "PrimaryName": "KMJ HJNM", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "DirectOwnershipPercentage": 4.35, "BeneficialOwnershipPercentage": 4.35 }, { "BeneficiaryIndicator": true, "MemberID": "471009273", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [ {"LineText": "SHOPS testing4Ä"}, {"LineText": "Paulõ"}, {"LineText": "aaaaaÖü"} ], "PrimaryTownName": "Gateway1ä", "CountryISOAlpha2Code": "GB", "CountryOfficialName": "United Kingdom" } }, { "BeneficiaryIndicator": true, "MemberID": "266707889", "PrimaryName": "Test Test", "SubjectTypeDescription": { "@DNBCodeValue": 119, "$": "Individuals" }, "PrimaryAddress": { "StreetAddressLine": [{"LineText": "sss"}], "PrimaryTownName": "sss", "CountryISOAlpha2Code": "IE", "CountryOfficialName": "Ireland" }, "IndirectOwnershipPercentage": 0, "BeneficialOwnershipPercentage": 0 } ], "Relationships": [ { "RelationshipID": "304752799", "SourceMemberID": "170660440", "TargetMemberID": "471381701", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 4.35 }, { "RelationshipID": "131608421", "SourceMemberID": "170660440", "TargetMemberID": "468255377", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 4.35 }, { "RelationshipID": "307721852", "SourceMemberID": "170660440", "TargetMemberID": "181707063", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 0.43 }, { "RelationshipID": "272391846", "SourceMemberID": "170660440", "TargetMemberID": "185500720", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 0.87 }, { "RelationshipID": "348803789", "SourceMemberID": "170660440", "TargetMemberID": "532652332", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 0.43 }, { "RelationshipID": "271200260", "SourceMemberID": "170660440", "TargetMemberID": "458268746", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 0.43 }, { "RelationshipID": "224837955", "SourceMemberID": "170660440", "TargetMemberID": "252502820", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 5.22 }, { "RelationshipID": "270749272", "SourceMemberID": "170660440", "TargetMemberID": "406569461", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 0.43 }, { "RelationshipID": "302746009", "SourceMemberID": "170660440", "TargetMemberID": "559024352", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 0.43 }, { "RelationshipID": "269736876", "SourceMemberID": "170660440", "TargetMemberID": "505207842", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 4.35 }, { "RelationshipID": "300865245", "SourceMemberID": "170660440", "TargetMemberID": "259921260", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 43.48 }, { "RelationshipID": "267938254", "SourceMemberID": "170660440", "TargetMemberID": "553843389", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 0.43 }, { "RelationshipID": "237716524", "SourceMemberID": "170660440", "TargetMemberID": "523364285", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 4.35 }, { "RelationshipID": "27767544", "SourceMemberID": "181707063", "TargetMemberID": "471009273", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" } }, { "RelationshipID": "36919080", "SourceMemberID": "185500720", "TargetMemberID": "266707889", "RelationshipTypeDescription": { "@DNBCodeValue": 137, "$": "Share Ownership" }, "ShareHoldingPercentage": 0.33 } ] } } }, "ArchiveDetail": {"PortfolioAssetID": 89142923} } } }}
CMP_BOL | CMP_BOS | Name | Characteristics |
---|---|---|---|
Y | Y | OrderProductResponse { TransactionDetail | Aggregate, Required Records information necessary to process a particular request. Examples of a request is the ordering of a product. |
Y | Y | OrderProductResponse { TransactionDetail { ApplicationTransactionID | Element, string up to 64 chars. , Optional A number assigned by the calling application to uniquely identify this request. |
Y | Y | OrderProductResponse { TransactionDetail { ServiceTransactionID | Element, string up to 64 chars. , Required A number assigned by the D&B service to uniquely identify this transaction. |
Y | Y | OrderProductResponse { TransactionDetail { TransactionTimestamp | Element, date & time , Required The date and time when this request was submitted or the date and time when the requesting intermediary, such as a workflow manager or service bus, sent the message to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
Y | Y | End: OrderProductResponse { TransactionDetail | Aggregate, Required |
Y | Y | OrderProductResponse { TransactionResult | Aggregate, Required An aggregate that can repeat multiple times to record the different outcomes of the transaction. |
Y | Y | OrderProductResponse { TransactionResult { SeverityText | Element, string up to 16 chars. , Required Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. |
Y | Y | OrderProductResponse { TransactionResult { ResultID | Element, string up to 32 chars. , Required An alphanumeric string that uniquely identifies the outcome of the transaction. |
Y | Y | OrderProductResponse { TransactionResult { ResultText | Element, string up to 512 chars. , Optional Text that explains the outcome of the transaction. |
Y | Y | OrderProductResponse { TransactionResult { ResultMessage | Aggregate, Optional (Infinite) 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. |
Y | Y | OrderProductResponse { TransactionResult { ResultMessage { ResultDescription | Element, string up to 512 chars. , Required Text that describes the additional information regarding the outcome of the transaction. |
Y | Y | End: OrderProductResponse { TransactionResult { ResultMessage | Aggregate, |
Y | Y | End: OrderProductResponse { TransactionResult | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail | Aggregate, Optional Records the data being returned to the customer as a result of a product request. |
Y | Y | 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { InquiryDetail { DUNSNumber | Element, string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}. , Required DUNS 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). |
Y | Y | OrderProductResponse { OrderProductResponseDetail { InquiryDetail { CountryISOAlpha2Code | Element, 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. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { InquiryDetail | Aggregate, |
Y | Y | 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { DNBProductID | Element, string up to 64 chars. , Optional An alphanumeric string that uniquely identifies this product. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { LanguageCode | Element, integer up to 7 digits. , Optional A D&B code value that defines the language in which the requested product is fulfilled. |
Y | Y | 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. |
Y | Y | 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader { DUNSNumber | Element, string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}. , Optional DUNS 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). |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader { CountryISOAlpha2Code | Element, Optional Country Code, The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO), identifying the country where the subject is located |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { SubjectHeader | Aggregate, |
Y | Y | 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. |
Y | Y | 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress @LanguageCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress @WritingScriptCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { StreetAddressLine | Aggregate, Optional (Infinite) Address Line, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { StreetAddressLine { LineText | Element, 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. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { StreetAddressLine | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { PrimaryTownName | Element, string up to 64 chars. , Optional Primary Town, The name of the town or city recognized by the Postal Authority for delivering mail. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { CountryISOAlpha2Code | Element, Optional Country Code, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { TerritoryName | Element, string up to 128 chars. , Optional Province or State, The name of the locally governed area which forms part of a centrally governed nation as received by D&B. 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { PostalCode | Element, string up to 16 chars. , Optional Postal Code, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress { CountryOfficialName | Element, string up to 64 chars. , Optional Country Name, The legal name of the country for this address. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location { PrimaryAddress | Aggregate, |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Location | Aggregate, |
Y | Y | 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. |
Y | Y | 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName | Element, string up to 256 chars. , Required Organization Name, Text recording a name of this organization in the specified language and/or writing script. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName @LanguageCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName @WritingScriptISOAlpha4Code | Attribute |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName | Aggregate, |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationName | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail | Aggregate, Optional Records fundamental information about a Subject which may vary over time. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail { OutofBusinessIndicator | Element, boolean , Optional Operating Status, When turned ON (set to TRUE) it indicates that this organization is no longer functional / trading. When turned OFF (set to FALSE) it indicates that this organization is functioning / trading. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { OrganizationDetail | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { RegisteredDetail | Aggregate, Optional Records the constitutional status of a subject as defined under the laws of a country E.g.; Limited Company, Partnership, co-operative Society and the Stock Equity or share structure employed by a business according to the legal form and rules of incorporation. The owners of the stock or shares are the owners of the business. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { RegisteredDetail { LegalFormDetails | Aggregate, Optional Records the details on the current legal form of a subject. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { RegisteredDetail { LegalFormDetails { LegalFormText | Element, string up to 256 chars. , Required Legal Form Code, Text that describes the legal form or structure of a business, as registered with government authorities, e.g., partnership, corporation, private limited company, government department, proprietorship. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { RegisteredDetail { LegalFormDetails { LegalFormText @DNBCodeValue | Attribute |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { RegisteredDetail { LegalFormDetails | Aggregate, |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { RegisteredDetail | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { IndustryCode | Aggregate, Optional Records the business activities in which an organization is actively engaged using standardized coding schemes such as European NACE and U.S. Standard Industry Classifications (SIC). Examples of business activities are: commercial printing, legal services, drug store, sheet metalwork fabricator. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { IndustryCode { PrimaryIndustryCode | Element, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of the primary business activity in which an organization is actively engaged using standardized coding schemes such as European NACE and U.S. Standard Industry Classifications (SIC) where each entry loop occurrence records a primary business activity in a different standardized coding scheme. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { IndustryCode { PrimaryIndustryCode @DNBCodeValue | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { IndustryCode { PrimaryIndustryCode @TypeText | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { IndustryCode { PrimaryIndustryCode { IndustryCode | Aggregate, string up to 16 chars. , Required SIC Code, An alphanumeric value identifying a business activity based on the scheme specified by the typeText. For instance, 1611 represents the highway and street construction industry in the U.S. SIC (Standard Industrial Classification) system. Clarification Note: These are generally external codes created by an external authoritative body, like the U.S. Office of Management and Budget (OMB), but D&B may have created extensions to more precisely define an activity, as in the case of the SIC 2+2 (the last 4 digits of an 8-digit SIC). |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { IndustryCode { PrimaryIndustryCode { IndustryCodeDescription | Element, Optional (Infinite) SIC Code Description, Text that describes the business activity based on the scheme specified by the attribute typeText. E.g., 'highway and street construction' is the description of industry code 1611 in the U.S. SIC (Standard Industrial Classification) system. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { IndustryCode { PrimaryIndustryCode | Aggregate |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { IndustryCode | Aggregate, |
Y | Y | 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 |
Y | Y | 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." |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization { DUNSNumber | Element, string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}. , Optional Global Ultimate DUNS, 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). |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization { 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization { OrganizationPrimaryName { OrganizationName | Element, string up to 256 chars. , Required Global Ultimate Name, Text recording a name of this organization in the specified language and/or writing script. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization { OrganizationPrimaryName { OrganizationName @LanguageCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization { OrganizationPrimaryName { OrganizationName @WritingScriptISOAlpha4Code | Attribute |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization { OrganizationPrimaryName | Aggregate, |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { GlobalUltimateOrganization | Aggregate, |
Y | Y | 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" |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization { DUNSNumber | Element, string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}. , Optional Domestic Ultimate DUNS, 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). |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization { 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization { OrganizationPrimaryName { OrganizationName | Element, string up to 256 chars. , Required Domestic Ultimate Name, Text recording a name of this organization in the specified language and/or writing script. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization { OrganizationPrimaryName { OrganizationName @LanguageCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization { OrganizationPrimaryName { OrganizationName @WritingScriptISOAlpha4Code | Attribute |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization { OrganizationPrimaryName | Aggregate, |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { DomesticUltimateOrganization | Aggregate, |
Y | Y | 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization { DUNSNumber | Element, string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}. , Optional Parent DUNS, 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). |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization { 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName | Element, string up to 256 chars. , Required Parent Name, Text recording a name of this organization in the specified language and/or writing script. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName @LanguageCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName @WritingScriptISOAlpha4Code | Attribute |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization { OrganizationPrimaryName | Aggregate, |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ParentOrganization | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership | Aggregate, Optional Records the details of the owners of the subject company that can include direct, indirect and beneficial owners.The details under this section can be used to generate/visualize the ownership structure at this point. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners | Aggregate, Required (Infinite) An entry loop that can repeat multiple times to allow the recording of the details of the Beneficiaries of the subject company |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { BeneficiaryIndicator | Element, boolean , Required Beneficiary Indicator, When turned ON (set to TRUE) it indicates that this owner is identified as a beneficiary. When turned OFF (set to FALSE) it indicates that this owner is not identified as a beneficiary. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { MemberID | Element, string up to 16 chars. , Optional Member ID, A unique identifier assigned by D&B at this point of time for a node, entity associated in this structure. This system generated ID is bound to change at a later point of time. Note: This element is mandatory to create the ownership structure |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryName | Element, string up to 256 chars. , Optional Member Name, Records the single name by which the individual / organization is primarily known / identified. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { DUNSNumber | Element, string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}. , Optional 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). |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PersonID | Element, string up to 32 chars. , Optional Person identifier, The personal identification number or shareholder number assigned by an external body that helps to identify a shareholder. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { SubjectTypeDescription | Element, string up to 256 chars. , Optional Member Type Code, Text identifying whether the owner is an Individual or a Company or that this is Unknown. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { SubjectTypeDescription @DNBCodeValue | Attribute, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { LegalFormText | Element, string up to 256 chars. , Optional Legal Form Code, Text that denotes the legal form or structure of this owner business as registered with government authorities, e.g., partnership, corporation, private limited company, government department, proprietorship. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { LegalFormText @DNBCodeValue | Attribute, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress | Aggregate, Optional (Infinite) Primary Address, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress @LanguageCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress @WritingScriptCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress { StreetAddressLine | Aggregate, Optional (Infinite) Street Address Line Text, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress { StreetAddressLine { LineText | Element, 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. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress { StreetAddressLine | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress { PrimaryTownName | Element, string up to 64 chars. , Optional Primary Town, The name of the town or city recognized by the Postal Authority for delivering mail. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress { CountryISOAlpha2Code | Element, Optional Country Code, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress { TerritoryName | Element, string up to 128 chars. , Optional State, The name of the locally governed area which forms part of a centrally governed nation as received by D&B. 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress { PostalCode | Element, string up to 16 chars. , Optional Postal Code, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress { CountryOfficialName | Element, string up to 128 chars. , Optional Country Name, The country name, defined in the scheme published by International Organization for Standardization (ISO) identifying the country of the inquired subject. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { PrimaryAddress | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { DirectOwnershipPercentage | Element, decimal up to 5 digits. Maximum of 2 decimal places. , Optional Direct Ownership Percentage, This denotes the owner's direct shareholding percentage. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { IndirectOwnershipPercentage | Element, decimal up to 5 digits. Maximum of 2 decimal places. , Optional Indirect Ownership Percentage, This denotes the owner's indirect shareholding percentage. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { BeneficialOwnershipPercentage | Element, decimal up to 5 digits. Maximum of 2 decimal places. , Optional Beneficial Ownership Percentage, This denotes the owner's actual shareholding percentage. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { Nationality | Element, string up to 256 chars. , Optional Nationality, The nationality of the owner if the owner is an individual. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { BirthDate | Element, string up to 16 chars. , Optional Date Of Birth, The date of birth of the owner if the owner is an individual. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { MinorityOwnershipIndicator | Element, boolean , Optional Minority Shareholder Indicator, When turned ON (set to TRUE) it indicates that the named shareholder is a minor or minority shareholderm, i.e. holds less than 50% of the shares and is not considered to own a significant stake in the organization, although the precise amount of the shareholding is not known |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners { OutofBusinessIndicator | Element, boolean , Optional Operating Status Indicator, When turned ON (set to TRUE) it indicates that the owner company is currently Out of Business. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { BeneficialOwners | Aggregate, |
N | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { Relationships | Aggregate, , Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of details of the relationships between members in an ownership structure for a subject company. |
N | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { Relationships { RelationshipID | Element, string up to 16 chars. , Required Relationship ID, A unique identifer assigned by D&B at this point of time for a relationship between two entities associated in this structure.This system generated ID is bound to change at a later point of time. |
N | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { Relationships { SourceMemberID | Element, string up to 16 chars. , Required Source Member, A unique identifer assigned by D&B at this point of time to the source node associated based on RelationshipTypeText to the target node denoted by the TargetMemberID.This system generated ID is bound to change at a later point of time. |
N | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { Relationships { TargetMemberID | Element, string up to 16 chars. , Required Target Member, A unique identifer assigned by D&B at this point of time to the receiving node associated based on RelationshipTypeText to the source node denoted by the SourceMemberID.This system generated ID is bound to change at a later point of time. |
N | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { Relationships { RelationshipTypeDescription | Element, string up to 256 chars. , Required Relationship Type, Text that defines the type of relationship exists between the source and target members |
N | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { Relationships { RelationshipTypeDescription @DNBCodeValue | Attribute, Possible values: 137 [Owned Subject/Shareowner], 101 [Parent/Subsidiary] |
N | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { Relationships { ShareHoldingPercentage | Element, decimal up to 5 digits. Maximum of 2 decimal places. , Optional Share Percentage, The total percentage of the shares (or other instrument of ownership) of the subject directly held/owned by the Shareholder. |
N | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership { Relationships | Aggregate |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { BeneficialOwnership | Aggregate |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ShareOwner { Linkage { ParentOrganization { 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ShareOwner { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName @LanguageCode | Attribute |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage { ShareOwner { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName @WritingScriptISOAlpha4Code | Attribute |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization { Linkage | Aggregate, |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { Organization | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { ArchiveDetail | Aggregate, Optional Records data about the archival details of the product requested. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { ArchiveDetail { PortfolioAssetID | Element, Required A number used to uniquely identify this product in the location where it is stored. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { ArchiveDetail { PortfolioAssetContainerID | Element, long , Optional A number used to uniquely identify the location where this product is stored. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { ArchiveDetail { ExtendedArchiveIndicator | Element, boolean , Optional When turned ON (set to TRUE), the duration to archive the data has been extended. When turned OFF (set to FALSE), the duration to archive the data was not extended; however as this is the assumed condition there is no requirement to create this tag to represent this fact. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product { ArchiveDetail | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { Product { CopyrightNoticeText | Element, string up to 128 chars. , Optional Text that specifies the underlying claim to copyright ownership of this product. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { Product | Aggregate, |
Y | Y | OrderProductResponse { OrderProductResponseDetail { InquiryReferenceDetail | Aggregate, Optional Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { InquiryReferenceDetail { CustomerReferenceText | Element, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText | Element, 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. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { InquiryReferenceDetail { PrincipalReferenceText | Element, string up to 64 chars. , Optional (Infinite) A freeform reference string provided by the customer to be linked to the principal information provided in the request for the product in order to support subsequent order reconciliation. |
Y | Y | OrderProductResponse { OrderProductResponseDetail { InquiryReferenceDetail { PrincipalReferenceText @PrincipalImportanceLevel | 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). |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail { InquiryReferenceDetail | Aggregate, string up to 256 chars. , Required Text recording a name of this organization in the specified language and/or writing script. |
Y | Y | End: OrderProductResponse { OrderProductResponseDetail | Aggregate, 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. |
Y | Y | End: OrderProductResponse | Aggregate, , string up to 64 chars. , , Optional The name of the town or city recognized by the Postal Authority for delivering mail. |
Ownership Percentage
Ownership % | Exclude Undisclosed Holding Indicator | Behavior Included in Response |
---|---|---|
100 | TRUE | The Shareholders with 100% ownership across the full list Excluded from the response: Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) |
100 | FALSE | The Shareholders with 100% ownership across the full list. Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) |
100 | Empty/Not specified in request | The Shareholders with 100% ownership across the full list. Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) NOTE: Null values for the Undisclosed Shareholders filters should be treated as ‘FALSE/ OFF/ Include’ |
Any Percentage between 1 and 99 | TRUE | The Shareholders with ≥ Requested% ownership across the full list. Excluded from the response: Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) |
Any Percentage between 1 and 99 | FALSE | The Shareholders with ≥ Requested% ownership across the full list. Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) |
Any Percentage between 1 and 99 | Empty/Not specified in request | The Shareholders with ≥ Requested% ownership across the full list. Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) NOTE: Null values for the Undisclosed Shareholders filters should be treated as ‘FALSE/ OFF / Include’ |
0 | TRUE | The Shareholders with ≥ 0% ownership across the full list. Excluded from the response: Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) |
0 | FALSE | The Shareholders with ≥ 0% ownership across the full list. Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) |
0 | Empty/Not specified in request | The Shareholders with ≥ 0% ownership across the full list. Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) NOTE: Null values for the Undisclosed Shareholders filters should be treated as ‘FALSE/ OFF / Include’ |
Empty/Not specified in request | TRUE | Full list of Shareholders. Excluded from the response: Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) |
Empty/Not specified in request | FALSE | Full list of Shareholders. Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) |
Empty/Not specified in request | Empty/Not specified in request | Full list of Shareholders. Full list of Undisclosed Shareholders (i.e. Ownership % = Null, 0) NOTE: Null values for the Undisclosed Shareholders filters should be treated as ‘FALSE/ OFF / Include’ |
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-CM005, CM007-CM012, CM014, CM017, CM018, PD001, PD003, PD005, PD006, PD015, PD016,PD019 and SC001-SC012.
IMPORTANT: PD006 code - Applicable only for US/CA cases when TradeUpIndicator="true" for Risk packets.
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]).
Operation-specific supplemental response code explanations:
CM000 | Success | Complete Data (or) Standalone cases where only Members/Beneficiaries aggregate is present without any relationships from UBO Graph API (Customer will be charged for the transaction) |
CM004 | Internal D&B system error. Please try again or contact your local Customer Service Center. | Error from UBO Graph API (Customer will not be charged for the transaction) |
CM005 | D&B System temporarily unavailable. Please try again or contact your local Customer Service Center. | UBO Graph API Service is Unavailable (Customer will not be charged for the transaction) |
CM005 | D&B System temporarily unavailable. Please try again or contact your local Customer Service Center. | UBO Graph API Service is Unavailable (Customer will not be charged for the transaction) |
CM007 | Your request cannot be fulfilled for the given criteria. | Error for invalid combination of Filters for Full Ownership Structure |
CM008 | No match found for the requested Duns number. | Failure Response when Target DUNS is not found E.g. DUNS number does not exist within the UBO Graph DB (Customer will not be charged for the transaction) |
CM018 | No candidates resulted for the given input criteria. | Target DUNS Number is found to have no ownership data in the UBO Graph DB based on filters applied in the request. If the filters are changed, the user might receive difference outcomes. (Customer will be charged for the transaction) |
PD001 | Requested product not available due to insufficient data. | Target DUNS Number is found to have no ownership data available in the UBO Graph DB. Hence, irrespective of the type of request, the user will never receive a different outcome. (Customer will not be charged for the transaction) |
PD008 | Success. Returned truncated list of candidates, as candidates count exceeds maximum limit for the given input criteria. | Partial data is returned from UBO Graph API (Customer will be charged for the transaction) |
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.