Loading

Direct 2.0
Collapse

Market Analysis Report

Product Code(s)MKT_ANL_RP
Level(s)Standard
Monitoring AvailableNo
InterfaceREST
MethodGET
Format(s)JSON, XML
ServiceReportProduct
{version}3.2
3.2 Released OnApril 22, 2016

This call returns a Morningstar market analysis for the specified company. Please note not all companies have reports.

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.

NOTE: The trade up option is currently not available for this data layer.

Report sample(s):

  • Market Analysis Report (PDF)

This report is delivered in Adobe Acrobat (PDF) format.

Global Availability

The MKT_ANL_RP data layer is available for businesses domiciled in the following countries:

CountryISO Code
United States of AmericaUS
BelgiumBE
FranceFR
GermanyDE
ItalyIT
NetherlandsNL
PortugalPT
SpainES
United KingdomGB
AustraliaAU
New ZealandNZ
AndorraAD
AnguillaAI
Antigua & BarbudaAG
ArubaAW
BahamasBS
BarbadosBB
BelizeBZ
BermudaBM
BoliviaBO
British Virgin IslandsVG
CanadaCA
Cayman IslandsKY
ChileCL
ColombiaCO
Costa RicaCR
DenmarkDK
DominicaDM
Dominican RepublicDO
EcuadorEC
El SalvadorSV
Faero IslandsFO
FinlandFI
GreenlandGL
GrenadaGD
GuatemalaGT
GuyanaGY
HaitiHT
HondurasHN
IrelandIE
JamaicaJM
JapanJP
LuxembourgLU
MexicoMX
MonacoMC
MontserratMS
Netherlands AntillesAN
Bonaire, Sint Eustatius And SabaBQ
CuraçaoCW
Sint Maarten (dutch)SX
NicaraguaNI
NorwayNO
PanamaPA
Saint Kitts & NevisKN
Saint LuciaLC
Saint VincentVC
San MarinoSM
SurinameSR
SwedenSE
Taiwan (republic of China)TW
Trinidad And TobagoTT
Turks And CaicosTC
VenezuelaVE
AfghanistanAF
AlbaniaAL
AlgeriaDZ
American SamoaAS
AngolaAO
ArgentinaAR
ArmeniaAM
AustriaAT
AzerbaijanAZ
BahrainBH
BangladeshBD
Benin, Peoples Republic ofBJ
BhutanBT
Bosnia And HerzegovinaBA
BotswanaBW
BrazilBR
BruneiBN
BulgariaBG
Burkina FasoBF
Burma (myanmar)MM
BurundiBI
BelarusBY
Kampuchea (prev. Cambodia)KH
CameroonCM
Cape Verde, Republic ofCV
Central Africa RepublicCF
Chad, Republic ofTD
China, Peoples Republic ofCN
Christmas IslandCX
Comoros RepublicKM
Congo Democratic RepublicCD
Cook IslandsCK
CroatiaHR
CyprusCY
Turkish Republic of Northern CyprusXT
Czech RepublicCZ
DjiboutiDJ
EgyptEG
Equatorial GuineaGQ
EritreaER
EstoniaEE
EthiopiaET
Falkland IslandsFK
FijiFJ
French GuianaGF
French Polynesia/tahitiPF
Gabon RepublicGA
GambiaGM
GeorgiaGE
GhanaGH
GibraltarGI
GreeceGR
GuadeloupeGP
GuamGU
Guinea BissauGW
Guinea, Republic ofGN
Hong KongHK
HungaryHU
IcelandIS
IndiaIN
IndonesiaID
IranIR
IraqIQ
IsraelIL
Ivory Coast/cote D'ivoireCI
JordanJO
KazakhstanKZ
KenyaKE
KiribatiKI
Korea, Republic ofKR
KuwaitKW
KyrgyzstanKG
LaosLA
LatviaLV
LebanonLB
LesothoLS
LiberiaLR
LibyaLY
LiechtensteinLI
LithuaniaLT
MacauMO
MacedoniaMK
MadagasgarMG
MalawiMW
MaldivesMV
MaliML
MaltaMT
Marianas IslandsMP
Marshall IslandsMH
MartiniqueMQ
MauritaniaMR
MauritiusMU
MoldovaMD
MontenegroME
MoroccoMA
MozambiqueMZ
NamibiaNA
NauruNR
NepalNP
New CaledoniaNC
NigerNE
NigeriaNG
Norfolk IslandNF
OmanOM
PakistanPK
Papua New GuineaPG
ParaguayPY
PeruPE
PhilippinesPH
PolandPL
QatarQA
Reunion IslandRE
RomaniaRO
Russian FederationRU
RwandaRW
Saint HelenaSH
Saint Pierre Et MiquelonPM
Sao Tome & PrincipeST
Saudi ArabiaSA
SenegalSN
SerbiaRS
SeychellesSC
Sierra LeoneSL
SingaporeSG
SlovakiaSK
SloveniaSI
Solomon IslandsSB
SomaliaSO
South AfricaZA
Sri LankaLK
SudanSD
South SudanSS
SwazilandSZ
SwitzerlandCH
SyriaSY
TajhikstanTJ
TanzaniaTZ
ThailandTH
TogoTG
Tokelau IslandsTK
TongaTO
TunisiaTN
TurkeyTR
TurkmenistanTM
TuvaluTV
UgandaUG
UkraineUA
United Arab EmiratesAE
UruguayUY
UzbekistanUZ
VanuatuVU
VietnamVN
Western SamoaWS
YemenYE
ZambiaZM
ZimbabweZW
CongoCG
Puerto RicoPR
Holy See (vatican City State)VA
Serbia & MontenegroCS
KosovoXK
Micronesia, Federated States ofFM

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.

Sample Request (MKT_ANL_RP)
GET https://direct.dnb.com/V3.2/organizations/799901301/products/MKT_ANL_RP?ProductFormatPreferenceCode=13204

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/{DNBproductID}?

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.

ReportD-U-N-S Number (Country Code)
Business Background Report804735132 (US)
Business Information Report804735132 (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 Summary804735132 (US)
+ BIR Payments804735132 (US)
+ BIR Public Filings804735132 (US)
+ PAR Payment Habits by Industry (US)804735132 (US)
Compact Report214567885 (GB)
Comprehensive Report804735132 (US)
Electronic Credit File214567885 (GB)
KYC804735132 (US)
214567885 (GB)
Market Analysis Reportn/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.

Sample Response (MKT_ANL_RP)
Embedded MTOM Name Characteristics
Y Y OrderCompanyReportResponse Aggregate
Y Y OrderCompanyReportResponse @ServiceVersionNumber Attribute
Y Y OrderCompanyReportResponse { TransactionDetail Aggregate, Required

Records information necessary to process a particular request. Examples of a request is the ordering of a product.

Y Y OrderCompanyReportResponse { TransactionDetail { ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application to uniquely identify this request.

Y Y OrderCompanyReportResponse { TransactionDetail { ServiceTransactionID string up to 64 chars., Required

A number assigned by the D&B service to uniquely identify this transaction.

Y Y OrderCompanyReportResponse { TransactionDetail { TransactionTimestamp dateTime, Required

The date and time when this request was submitted or the date and time when the requesting intermediary, such as a workflow manager or service bus, sent the message to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

Y Y END: OrderCompanyReportResponse } TransactionDetail /Aggregate
Y Y OrderCompanyReportResponse { TransactionResult Aggregate, Required

An aggregate that can repeat multiple times to record the different outcomes of the transaction.

Y Y OrderCompanyReportResponse { TransactionResult { SeverityText string, Required

Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.

Y Y OrderCompanyReportResponse { TransactionResult { ResultID string up to 32 chars., Required

An alphanumeric string that uniquely identifies the outcome of the transaction.

Y Y OrderCompanyReportResponse { TransactionResult { ResultText string up to 512 chars., Optional

Text that explains the outcome of the transaction.

Y Y OrderCompanyReportResponse { TransactionResult { ResultMessage Aggregate, Optional (Array)

An aggregate that can repeat multiple times to record textual data that expands on the ResultID and ResultText to provide additional information to the user regarding the status of the transaction. If the status implies that there is a problem this may also provide guidance to the user on how to address it.

Y Y OrderCompanyReportResponse { TransactionResult { ResultMessage { ResultDescription string up to 512 chars., Required

Text that describes the additional information regarding the outcome of the transaction.

Y Y END: OrderCompanyReportResponse } TransactionResult } ResultMessage /Aggregate
Y Y END: OrderCompanyReportResponse } TransactionResult /Aggregate
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail Aggregate, Optional

Records the data being returned to the customer as a result of a product request.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { 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 OrderCompanyReportResponse { OrderCompanyReportResponseDetail { InquiryDetail { DUNSNumber string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { InquiryDetail { CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Required

The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject.

Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } InquiryDetail /Aggregate
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { 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 OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { DNBProductID string up to 64 chars., Required

An alphanumeric string that uniquely identifies this product.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { LanguageCode integer up to 7 digits., Optional

A D&B code value that defines the language in which the requested product is fulfilled.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { 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 OrderCompanyReportResponse { OrderCompanyReportResponseDetail { 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 OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { SubjectHeader { DUNSNumber string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { SubjectHeader { CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Required

The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO), identifying the country where the subject is located

Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } Product } Organization } SubjectHeader /Aggregate
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { 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 OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName Aggregate, Optional

Records the single name by which the organization is primarily known / identified in different languages and/or writing scripts.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName string up to 256 chars., Required

Text recording a name of this organization in the specified language and/or writing script.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName @LanguageCode Attribute
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName @WritingScriptISOAlpha4Code Attribute
Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } Product } Organization } OrganizationName } OrganizationPrimaryName /Aggregate
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { RegisteredDetail Aggregate, Optional

Records data registered by an organization with an external official registry body, a government entity or a commercial enterprise. This includes but is not limited to the following data: Legal Form, Stock Details, Organization Identification Numbers, Fiscal Period, Document Filings.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { RegisteredDetail { OrganizationIdentificationNumberDetail Aggregate, Optional (Array)

An entry loop which can repeat multiple times to allow recording of the identifiers issued by an external official registry body, a government entity or a commercial enterprise to uniquely identify an organization. Examples of an organization identification number are Chamber of Commerce numbers, Value Added Tax numbers and Tax Identification Numbers.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { RegisteredDetail { OrganizationIdentificationNumberDetail @TypeText Attribute
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { RegisteredDetail { OrganizationIdentificationNumberDetail @DNBCodeValue Attribute
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { RegisteredDetail { OrganizationIdentificationNumberDetail @DNBCodeTableNumber Attribute
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { Organization { RegisteredDetail { OrganizationIdentificationNumberDetail { OrganizationIdentificationNumber string at least 1 chars. up to 40 chars., Required

A number issued by an external official registry body, a government entity or a commercial enterprise to uniquely identify an organization.

Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } Product } Organization } RegisteredDetail } OrganizationIdentificationNumberDetail /Aggregate
Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } Product } Organization } RegisteredDetail /Aggregate
Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } Product } Organization /Aggregate
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { ObjectAttachment Aggregate, Required (Array)

Records or holds the file attached to the XML document and information pertaining to the file.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { ObjectAttachment { ContentObject base64Binary, Required

Records or holds the actual file (e.g. data, picture, blob) stored within the attachment.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { ObjectAttachment { ObjectFormatTypeText string up to 256 chars., Required

Text that describes the format of the attached file, e.g., txt, pdf, html.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { ObjectAttachment { ObjectFormatTypeText @DNBCodeValue Attribute
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { ObjectAttachment { ObjectFormatTypeText @DNBCodeTableNumber Attribute
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { ObjectAttachment { DNBProductModuleID string up to 64 chars., Optional (Array)

An alphanumeric string that uniquely identifies a section (i.e., module) of data within the requested product as defined by DNBProductID.

Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } Product } ObjectAttachment /Aggregate
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { ArchiveDetail Aggregate, Optional

Records data about the archival details of the product requested.

Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { Product { ArchiveDetail { PortfolioAssetID PortfolioAssetIDType, Required

A number used to uniquely identify this product in the location where it is stored.

Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } Product } ArchiveDetail /Aggregate
Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } Product /Aggregate
Y Y OrderCompanyReportResponse { OrderCompanyReportResponseDetail { 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 OrderCompanyReportResponse { OrderCompanyReportResponseDetail { InquiryReferenceDetail { CustomerReferenceText 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 OrderCompanyReportResponse { OrderCompanyReportResponseDetail { InquiryReferenceDetail { 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.

Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail } InquiryReferenceDetail /Aggregate
Y Y END: OrderCompanyReportResponse } OrderCompanyReportResponseDetail /Aggregate

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.