Business Background Report
Products | D&B Direct 2.0 |
Product Code(s) | BBR |
Level(s) | Standard |
Monitoring Available | No |
Interface | REST |
Method | GET |
Format(s) | JSON, XML |
Service | ReportProduct |
{version} | 3.1 |
3.1 Released On | December 11, 2015 |
D&B's Business Background Report provides details about the operations of a company, its history, and business background of its management.
Update History
No modifications have been made to this data layer since the initial release.
Report Request
IMPORTANT: Due to a known issue, please do not include request values for SubmittingOfficeID.
Overview
When requesting this feature, a valid D-U-N-S Number for a company, a product (format) preference and the appropriate product code will be required. For improved performance, include a country code of "US".
A trade up option exists to request data for a headquarters location when the requested organization is a branch.
Options exist to specify a report format and/or language, where available. Unless otherwise specified, reports are delivered in English, in a simple text format.
Report sample(s):
NOTE: This report is only available in TEXT format.
Global Availability
This data layer is only available for businesses domiciled in the United States.
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 "D&B Business Information Report (BIR) & Other D&B Reports" 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 NOT included in the D&B Direct Onboard suite.
Specification
Correction: The IncludeAttachmentIndicator option is currently not available in this REST implementation for PDF report formats.
GET https://direct.dnb.com/V3.1/organizations/804735132/products/BBR?ProductFormatPreferenceCode=15106&IncludeAttachmentIndicator=false Authorization: <My Token>
GET https://direct.dnb.com/V3.1/organizations/804735132/products/BBR?ProductFormatPreferenceCode=15106&IncludeAttachmentIndicator=true Authorization: <My Token>
Embedded | MTOM | 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 | dateTime, Optional The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
Y | Y | SubmittingOfficeID | string up to 64 chars., Optional A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. |
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 up to 64 chars., Required An alphanumeric string that uniquely identifies the product being requested. |
Y | Y | ProductFormatPreferenceCode | integer up to 7 digits., Required A D&B code value that describes the defined structure in which the product is to be rendered, e.g., txt, xml, pdf. Possible values: HTML - 5183; TEXT - 15106 (default); PDF - 13204 |
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: English - 39 (default); US English - 331; French - 40; Spanish - 44; German - 41; Portuguese - 43; Italian - 42; Dutch - 38; Belgian Dutch - 36; Belgian French - 37 |
Y | Y | OrderReasonCode | integer up to 7 digits., Optional A D&B code value that defines the grounds for the customer requesting the product, e.g., required to support a credit decision. 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 Agreemen |
Y | Y | TradeUpIndicator | boolean, Optional When true (set to 1) this denotes that the customer has requested that D&B return the data for the Headquarters when the requested organization is a Branch. When false (set to 0) this denotes that the customer has not requested that D&B return the data for the Headquarters when the requested organization is a Branch; however as this is the assumed condition there is no requirement to create this tag to represent this fact. Note: There are D&B WorldWide Network operations where the Headquarters information will be returned automatically, regardless of the customer request. |
N | Y | IncludeAttachmentIndicator | boolean, Optional When true (set to 1), the Content Object will be returned as an MTOM Attachment. When false (set to 0), the content object will be returned embedded within the XML / JSON Response. Possible values: true/false |
Y | Y | 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. |
Y | Y | 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. |
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 report. The {version} is dependent on the underlying service delivering the report.
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.
Endpoint (ReportProduct) |
---|
GET https://direct.dnb.com/V{version}/organizations/{DUNS}/products/{productID} |
Testing
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.
Report | D-U-N-S Number (Country Code) |
---|---|
Business Background Report | 804735132 (US) |
Business Information Report | 804735132 (US) |
+ BIR Banking (US) | 804735132 (US) |
+ BIR Finance (US) | 804735132 (US) |
+ BIR History & Operations (US) | 804735132 (US) |
+ BIR Special Events/Changes/Updates (US) | 804800217 (US) |
+ BIR ID and Summary | 804735132 (US) |
+ BIR Payments | 804735132 (US) |
+ BIR Public Filings | 804735132 (US) |
+ PAR Payment Habits by Industry (US) | 804735132 (US) |
Compact Report | 214567885 (GB) |
Comprehensive Report | 804735132 (US) |
Electronic Credit File | 214567885 (GB) |
KYC | 804735132 (US) 214567885 (GB) |
Market Analysis Report | n/a |
Report Response
Specification
Text reports are returned in a Base64 encoded format within the Report Content/Data tags. All other formats are returned using the Message Transmission Optimization Mechanism (MTOM) method. An option is available to return all report formats as MTOM attachments.
NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.
{"OrderCompanyReportResponse": { "@ServiceVersionNumber": "3.0", "TransactionDetail": { "ServiceTransactionID": "Id-6c7525705199cbef102b742e-2", "TransactionTimestamp": "2015-07-06T00:29:28.708-04:00" }, "TransactionResult": { "SeverityText": "Information", "ResultID": "CM000", "ResultText": "Success" }, "OrderCompanyReportResponseDetail": { "InquiryDetail": { "DUNSNumber": "804735132", "CountryISOAlpha2Code": "US" }, "Product": { "DNBProductID": "BBR", "Organization": { "SubjectHeader": { "DUNSNumber": "804735132", "CountryISOAlpha2Code": "US" }, "OrganizationName": {"OrganizationPrimaryName": {"OrganizationName": {"$":"GORMAN MANUFACTURING CO INC" }}} }, "ObjectAttachment": [{ "ContentObject": "ICAgICAgIENPUFlSSUdIVCAyMDE1IERVTiAmIEJSQURTVFJFRVQgSU5DLiAtIFBST1ZJREVEIFVOREVSIENPTlRSQUNUDQogICAgICAgICAgICAgICAgRk9SIFRIRSBFWENMVVNJVkUgVVNFIE9GIFNVQlNDUklCRVIgMjYzLTE2MDM0MS4NCg0KICAgICAgICAgICAgICAgICAgICAgQVRUTjogQXJ1bg0KDQogICAgICAgICAgICAgICAgICAgICAgICAgIEJVU0lORVNTIEJBQ0tHUk9VTkQgUkVQT1JUDQoNCkdPUk1BTiBNQU5VRkFDVFVSSU5HIENPTVBBTlksIElOQy4NCg0KRFVOUzogODAtNDczLTUxMzIgICAgICAgICAgICAgICAgICAgICAgICAgREFURSBQUklOVEVEOiBKdWx5IDYsIDIwMTUNCg0KPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PQ0KDQo0OTIgS09MTEVSIFNUICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBZZWFyIFN0YXJ0ZWQ6IDE5ODUNClNBTiBGUkFOQ0lTQ08sIENBIDk0MTEwICAgICAgICAgICAgICAgICAgICAgICAgIENvbnRyb2wgWWVhcjogMTk4NQ0KVGVsZXBob25lOiA2NTAgNTU1LTAwMDAgICAgICAgICAgICAgICAgICAgICAgICAgVGhpcyBpcyBhIEhlYWRxdWFydGVyIGxvY2F0aW9uLg0KDQpTYWxlcyAgICAgJDIwLDgzOSwzNzIgKEZpc2NhbCkgICAgICAgICAgICAgICAgICBFbXBsb3llZXMgVG90YWw6IDEyNQ0KTmV0IFdvcnRoICQxLDQ5MCwwNzcgKEZpc2NhbCkgICAgICAgICAgICAgICAgICAgRW1wbG95ZWVzIEhlcmU6ICAxMTANCg0KVG9wIEV4ZWN1dGl2ZTogTEVTTElFIFNNSVRILCBQUkVTDQoNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KSU5EVVNUUlkNCg0KTGluZSBvZiBCdXNpbmVzczogIExJVEhPR1JBUEhJQyBDT01NRVJDSUFMIFBSSU5USU5HDQoNClByaW1hcnkgU0lDOg0KDQogICAgIDI3NTIgICAoTElUSE9HUkFQSElDIENPTU1FUkNJQUwgUFJURykNCg0KPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PQ0KDQpCVVNJTkVTUyBISVNUT1JZDQoNCiAgICAgICAgIC0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0NCg0KICAgICAgICAgVGhlIENvcnBvcmF0ZSBEZXRhaWxzIHByb3ZpZGVkIGJlbG93IG1heSBoYXZlIGJlZW4gc3VibWl0dGVkIGJ5IHRoZQ0KICAgICAgICAgbWFuYWdlbWVudCBvZiB0aGUgc3ViamVjdCBidXNpbmVzcyBhbmQgbWF5IG5vdCBoYXZlIGJlZW4gdmVyaWZpZWQgd2l0aA0KICAgICAgICAgdGhlIGdvdmVybm1lbnQgYWdlbmN5IHdoaWNoIHJlY29yZHMgc3VjaCBkYXRhLg0KDQogICAgICAgICBCVVNJTkVTUyBUWVBFOiBDT1JQT1JBVElPTiAgICAgICAgIFNUQVRFIE9GIElOQ09SUDogICBDQUxJRk9STklBDQogICAgICAgICAtLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tDQowMi8wMy8xNQ0KICAgICAgICAgTEVTTElFIFNNSVRILCBQUkVTICAgICAgICAgICAgICAgICBLRVZJTiBKIEhVTlQsIFNFQy1UUkVBUw0KICAgICAgICAgRElSRUNUT1IoUyk6ICBUSEUgT0ZGSUNFUihTKQ0KDQogICAgICAgICAgICAgIFRoZSBDYWxpZm9ybmlhICBTZWNyZXRhcnkgb2YgU3RhdGUncyBidXNpbmVzcyByZWdpc3RyYXRpb25zIGZpbGUNCiAgICAgICAgIHNob3dlZCB0aGF0IEdvcm1hbiBNYW51ZmFjdHVyaW5nIENvbXBhbnksIEluYy4gd2FzIHJlZ2lzdGVyZWQgYXMgYQ0KICAgICAgICAgQ29ycG9yYXRpb24gb24gTWF5IDIxLCAxOTg1Lg0KICAgICAgICAgICAgICBCdXNpbmVzcyBzdGFydGVkIDE5ODUgYnkgTGVzbGllIFNtaXRoIGFuZCBLZXZpbiBKIEh1bnQuICA2MCUgb2YNCiAgICAgICAgIGNhcGl0YWwgc3RvY2sgaXMgb3duZWQgYnkgTGVzbGllIFNtaXRoLiAgNDAlIG9mIGNhcGl0YWwgc3RvY2sgaXMgb3duZWQNCiAgICAgICAgIGJ5IEtldmluIEogSHVudC4NCiAgICAgICAgICAgICAgTEVTTElFIFNNSVRIIGJvcm4gMTk0Ni4gIEdyYWR1YXRlZCBmcm9tIHRoZSBVbml2ZXJzaXR5IG9mDQogICAgICAgICBDYWxpZm9ybmlhLCBMb3MgQW5nZWxlcywgQ0EsIGluIEp1bmUgMTk2NyB3aXRoIGEgQlMgZGVncmVlIGluIEJ1c2luZXNzDQogICAgICAgICBNYW5hZ2VtZW50LiAgMTk2Ny04NSBHZW5lcmFsIE1hbmFnZXIgZm9yIFJheW1vciBQcmludGluZyBDbywgU2FuDQogICAgICAgICBGcmFuY2lzY28sIENBLiAgMTk4NSBmb3JtZWQgc3ViamVjdCB3aXRoIEtldmluIEogSHVudC4gIDE5ODUgdG8NCiAgICAgICAgIHByZXNlbnQgYWN0aXZlIGFzIFByaW5jaXBhbCBpbiBHb3JtYW4gQWZmaWxpYXRlIEx0ZCwgU2FuIEZyYW5jaXNjbywNCiAgICAgICAgIENBLg0KICAgICAgICAgICAgICBLRVZJTiBKIEhVTlQgYm9ybiAxOTQ1LiAgR3JhZHVhdGVkIGZyb20gTm9ydGh3ZXN0ZXJuIFVuaXZlcnNpdHksDQogICAgICAgICBFdmFuc3RvbiwgSUwgaW4gSnVuZSAxOTY2LiAgMTk2Ni0xOTg1IHdhcyBHZW5lcmFsIE1hbmFnZXIgZm9yIFJheW1vcg0KICAgICAgICAgUHJpbnRpbmcgQ28sIFNhbiBGcmFuY2lzY28sIENBLiAgMTk4NSBmb3JtZWQgc3ViamVjdCB3aXRoIExlc2xpZQ0KICAgICAgICAgU21pdGguICAxOTg1IHRvIHByZXNlbnQgYWN0aXZlIGFzIFByaW5jaXBhbCBpbiBHb3JtYW4gQWZmaWxpYXRlIEx0ZCwNCiAgICAgICAgIFNhbiBGcmFuY2lzY28sIENBLg0KICAgICAgICAgICAgICBBRkZJTElBVEU6IFRoZSBmb2xsb3dpbmcgaXMgcmVsYXRlZCB0aHJvdWdoIGNvbW1vbiBwcmluY2lwYWxzLA0KICAgICAgICAgbWFuYWdlbWVudCBhbmQvb3Igb3duZXJzaGlwLiAgR29ybWFuIEFmZmlsaWF0ZSBMdGQsIFNhbiBGcmFuY2lzY28sIENBLA0KICAgICAgICAgc3RhcnRlZCAxOTg1LiAgT3BlcmF0ZXMgYXMgY29tbWVyY2lhbCBwcmludGVyLiAgSW50ZXJjb21wYW55DQogICAgICAgICByZWxhdGlvbnM6IE5vbmUgcmVwb3J0ZWQgYnkgbWFuYWdlbWVudC4NCg0KPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PQ0KDQpPUEVSQVRJT05TDQoNCjAyLzAzLzE1ICAgICAgRW5nYWdlZCBpbiBjb21tZXJjaWFsIGxpdGhvZ3JhcGhpYyBwcmludGluZyAoMTAwJSkuDQogICAgICAgICBUZXJtcyBhcmUgTmV0IDMwIGRheXMuIEhhcyAyNDAgYWNjb3VudChzKS4gIFNlbGxzIHRvIGNvbW1lcmNpYWwNCiAgICAgICAgIGNvbmNlcm5zLiAgVGVycml0b3J5IDogVW5pdGVkIFN0YXRlcy4NCiAgICAgICAgIE5vbnNlYXNvbmFsLg0KICAgICAgICAgICAgICBFTVBMT1lFRVM6ICAxMjUgd2hpY2ggaW5jbHVkZXMgb2ZmaWNlcihzKS4gIDExMCBlbXBsb3llZCBoZXJlLg0KICAgICAgICAgICAgICBGQUNJTElUSUVTOiAgT2NjdXBpZXMgcHJlbWlzZXMgaW4gYSBvbmUgc3RvcnkgY2luZGVyIGJsb2NrDQogICAgICAgICBidWlsZGluZy4NCiAgICAgICAgICAgICAgTE9DQVRJT046ICBDZW50cmFsIGJ1c2luZXNzIHNlY3Rpb24gb24gd2VsbCB0cmF2ZWxlZCBzdHJlZXQuDQogICAgICAgICAgICAgIEJSQU5DSEVTOiAgVGhpcyBidXNpbmVzcyBoYXMgbXVsdGlwbGUgYnJhbmNoZXMsIGRldGFpbGVkDQogICAgICAgICBicmFuY2gvZGl2aXNpb24gaW5mb3JtYXRpb24gaXMgYXZhaWxhYmxlIGluIEQmQidzIGxpbmthZ2Ugb2YgZmFtaWx5DQogICAgICAgICB0cmVlIHByb2R1Y3RzLg0KICAgICAgICAgICAgICBTVUJTSURJQVJJRVM6ICBUaGlzIGJ1c2luZXNzIGhhcyBtdWx0aXBsZSBzdWJzaWRpYXJpZXMsIGRldGFpbGVkDQogICAgICAgICBzdWJzaWRpYXJ5IGluZm9ybWF0aW9uIGlzIGF2YWlsYWJsZSBpbiBEJkJzIGxpbmthZ2Ugb3IgZmFtaWx5IHRyZWUNCiAgICAgICAgIHByb2R1Y3RzLg0KDQo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCkNVU1RPTUVSIFNFUlZJQ0UNCg0KSWYgeW91IG5lZWQgYW55IGFkZGl0aW9uYWwgaW5mb3JtYXRpb24gb3IgaGF2ZSBhbnkgcXVlc3Rpb25zIHJlZ2FyZGluZyB0aGlzDQpyZXBvcnQsIHBsZWFzZSBjYWxsIG91ciBDdXN0b21lciBTZXJ2aWNlIENlbnRlciBhdCAxLTgwMC0yMzQtRFVOUygzODY3KS4NCg0KPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PQ0KICAgICAgICAgICAgIEVORCBPRiBEVU4gJiBCUkFEU1RSRUVUIEJVU0lORVNTIEJBQ0tHUk9VTkQgUkVQT1JUDQo=", "ObjectFormatTypeText": {"$": "TEXT"}, "DNBProductModuleID": [null] }], "ArchiveDetail": {"PortfolioAssetID": 1269801} } } }}
"OrderCompanyReportResponse": { "@ServiceVersionNumber": "3.0", "TransactionDetail": { "ServiceTransactionID": "Id-6c7525705199cbef102b742e-2", "TransactionTimestamp": "2015-07-06T00:34:11.043-04:00" }, "TransactionResult": { "SeverityText": "Information", "ResultID": "CM000", "ResultText": "Success" }, "OrderCompanyReportResponseDetail": { "InquiryDetail": { "DUNSNumber": "804735132", "CountryISOAlpha2Code": "US" }, "Product": { "DNBProductID": "BBR", "Organization": { "SubjectHeader": { "DUNSNumber": "804735132", "CountryISOAlpha2Code": "US" }, "OrganizationName": { "OrganizationPrimaryName": { "OrganizationName": { "$": "GORMAN MANUFACTURING CO INC" } } } }, "ObjectAttachment": [ { "ContentObject": { "Include": { "@href": "cid:29c99d18:14e5d313a4a:-27f6" } }, "ObjectFormatTypeText": { "$": "TEXT" }, "DNBProductModuleID": [ null ] } ] } } } }
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, CM008, CM011, CM012, PD001-PD006, and SC001-SC008.
Report Notes
The Product Availability Lookup feature may be utilized to determine if a particular report is available for a given D-U-N-S Number.