D&B Direct. API Documentation for Custom Product Service. Version 2.0 (API) / 2.0 (Service)

Transcription

1 D&B Direct API Documentation for Custom Product Service Version 2.0 (API) / 2.0 (Service)

2 D&B Direct is a trademark or registered trademark of Dun and Bradstreet, Incorporated. Other trademarks used herein are the trademarks or registered trademarks of their respective owners. This document is a work of authorship that belongs to Dun and Bradstreet, Incorporated and is protected by United States and foreign copyright laws and international copyright treaties. The use of the software and this Documentation is governed by the Dun and Bradstreet Incorporated software license agreement. D&B DOES NOT GUARANTEE OR WARRANT SYSTEMS AVAILABILITY OR PERFORMANCE IN ACCORDANCE WITH THE FIGURES WITHIN THIS DOCUMENT, NOR DOES D&B ACCEPT ANY LIABILITY FOR DAMAGES WHICH MAY BE SUFFERED AS A RESULT OF PLACING ANY RELIANCE ON THESE FIGURES. D&B RESERVES THE RIGHT TO AMEND THIS DOCUMENT AT ANY TIME AND WILL ADVISE THE CUSTOMER ACCORDINGLY OF ANY SUCH AMENDMENTS OR CHANGES. Dun & Bradstreet, Inc All rights reserved

3 Service History Contents These pages provide business overviews; explaining requirements and the business elements that will be delivered. For suggested uses of the API components, please refer to the Solutions menu option on the developer.dnb.com home page. Title / Overview Link Custom Product Selection These pages provide the technical specifications that a developer will need to obtain information using D&B Direct. Service Operation / SOAP Resource / REST n/a [Authentication Process] POST Authentication Custom Product Service OrderProduct GET organizations/{duns}/products/{productid} RetrieveProduct GET assets/{assetid}/{productid} Service History Version Date 2.0 August 22, 2014 Interface (s) Change(s) SOAP/REST Custom data layers are now accepted by the monitoring service. Use GetProductCatalog for list of elements which will be monitored. Dun & Bradstreet, Inc

4 About this Documentation About this Documentation The D&B Direct 2.0 API Reference materials are organized into product, feature, service and operation pages. Throughout the documentation, certain items are marked as eligible for custom products and/or for inclusion in the monitoring process. Key Concepts Business Elements vs. Data Fields The D&B Direct API has been designed to efficiently deliver information, and as a result, multiple business elements are often delivered in the same data field (with separate attributes signaling the specific contents of a data field). The documentation highlights the business elements (i.e. business-oriented labels) on product pages; and the data fields (i.e. technical, variable-like names used within the delivery packages) on operation pages -- with the business elements linked to the corresponding data field for each available implementation. Data Layers The D&B Direct API delivers information in data layers, some of which have multiple levels. For the purpose of this documentation, the term Product is used to represent a given level for a data layer. For example, "Detailed Company Profile" is the Data Layer, while "Detailed Company Profile - Enhanced" will be referred to as a Product. Custom Products D&B Direct offers a customization service that allows for up to eight pre-configured products to be delivered through the API web service. Throughout the documentation, business elements and data fields which are eligible for inclusion in a custom product are designated with a [C] marker. Service Versions It is important to note that D&B Direct 2.x implements version control at the service level, in addition to the API level. For example, the current version of the Assessment Product Service is Version 2.0 (API) / 3.0 (Service). D&B Direct services will be updated (major and minor version changes) without a API version change. Following the example given, it will be possible for the Assessment Product Service to change to Version 2.0 Dun & Bradstreet, Inc

5 Product Pages (API) / 3.1 (Service) or Version 2.0 (API) / 4.0 (Service) based on the significance of the changes made to the service. Product Pages These are non-technical pages that describe the information (i.e. business elements) returned by the dataoriented operations. In addition, the requirements and options for requesting data are mentioned. Feature Pages These are also non-technical pages, but explain the use of operations that provide a function (e.g. search) and often return the items (i.e. D-U-N-S Number) required to request data products. Service Pages These are technical pages that explain what operations a given API web service provides, the correct version and endpoints, WSDL location (for SOAP), and how to download samples and data dictionaries specific to the service. While services are not applicable for REST implementations, the documentation is organized around them for consistency. Operation Pages These are also technical pages, but describe (for each available implementation method) the individual functions provided by a service, listing the input field names and requirements, and the output with data fields (including data type, size, description and possible values). Release Histories Whenever an operation is enhanced (or a minor correction is made), a notation will be added to a section on the bottom of the affected SOAP/REST operation page. If the change is significant and results in a version change, the release history will maintain a link to the documentation for the previous version(s). Getting Started While the API Reference documentation provides extensive details on each operation and data layer, for more summarized explanations of common tasks/uses refer to the collection of How To Guides. Dun & Bradstreet, Inc

6 Custom Product Selection Custom Product Selection D&B Direct allows the creation of custom collections of data elements per customer account. Custom collections are configured by D&B Sales Associates, and then made available through API calls. Product Configuration Throughout the D&B Direct documentation, Business Element and Response Data Field items will be designated with a [C] if they may be included in a Custom Product. D&B Sales Associates may be provided lists of either Business Element or Response Data Field items (the latter is preferred) for pricing and configuration of up to six Custom Products. Customers may also designate fields in a given Custom Product to be "required." When any of these required fields (for a given D-U-N-S Number) are not available, the request will return an error code. For data items where previous calculations are available (e.g. Financial Stress Score and Commercial Credit Score), be sure to mention the version number to the D&B Sales Associate if an alternate calculation is required. Once configured, the D&B Sales Associate will provide a Product Code designated for the new Custom Product. Each custom product configuration is only available to the customer account to which it is assigned. Requirements & Options When requesting a Custom Product (that excludes small businesses or company principals), a valid D-U-N-S Number for a company, its country code, and the appropriate product code will be required. If this information is not available, refer to obtaining a company D-U-N-S Number for assistance. A trade up option exists to request data for the headquarters when the requested organization is a branch. When ordering information for organizations located in Germany, customers are required to provide a valid order reason code. A list of possible values is included on the respective SOAP or REST operation page. When requesting a Custom Product for a small business, you will be required to supply either valid D-U-N-S Number or subject identification number (Subject ID) for a small business, a country code of "US", and the appropriate product code. Subject IDs for organizations may be obtained by using the small business option in the On-Demand Entity Identification feature. When requesting a Custom Product for a company principal, you will be required to supply the valid D-U-N-S Number for a company, principal identification number (Principal ID), and the appropriate product code. Principal IDs for individual company officers may be obtained by using the Search & Build-a-List - Contacts (Plus Lookup) feature. Dun & Bradstreet, Inc

7 Business Elements Note: The product code for D&B Direct Custom Product will be CST_PRD_1 to CST_PRD_6. This product may be included in the Monitoring process. Business Elements The business elements returned in a custom product vary based on customer selection. Exception: Custom Product requests will not return a set of standard elements for the company requested. These elements may be included, by request, during the configuration process. When any of the business elements that were designated as "required" when the Custom Product was configured do not contain a value for a particular company, an error code will be returned, and your organization will not incur a usage credit for the request. The Product Availability Lookup feature may be utilized to determine if a particular D&B Direct custom product is available for a D-U-N-S Number. Additional Details The availability of certain scores delivered by this product may be limited due to a lack of sufficient company or industry specific data to perform the calculations. Access to this information is provided on a metered basis; and will require data layer entitlement prior to use in the production environment. A built-in feature exists to prevent duplicate billing when multiple 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]). 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. Monitoring Custom Products To determine which data fields within a custom product will trigger a Monitoring Change Notice, issue a request to the GetProductCatalog function in the Product Catalog Serviceand inspect the MonitorableElementDetail list that is returned. Technical Specification For details on how to obtain this data layer, please refer to the Custom.OrderProduct (SOAP) or Custom.OrderProduct (REST) page. Dun & Bradstreet, Inc

8 Custom Product Service Custom Product Service Version 2.0 (API) / 2.0 (Service) Functions This D&B Direct service includes the following functionality. The respective SOAP and/or REST pages provide technical details including input parameters, responses and sample requests. Function Operation / SOAP Deliver a data layer. (see "Product (Data Layer) Details") OrderProduct() Resource / REST GET organizations/{duns}/products/ {productid} Deliver copies of previously ordered products. RetrieveProduct() GET assets/{assetid}/{productid} The Order Product function provides pre-configured custom data layers for a specific company, and requires a D-U-N-S Number, country code and one of the custom product codes {productid}. The Retrieve Product function can be used to fetch previously obtained copies of data layers from the Product Request Archive. The default archival period is 120 days, unless extended (up to 365 days) when the data layer was originally requested. Product (Data Layer) Details The following D&B products may be obtained by using this service. All D&B Direct product codes are case sensitive. The Product pages provide an overview, including the business elements (and definitions) delivered. Title / Overview Link D&B Direct Custom Product Product Code {productid} CST_PRD_1 to CST_PRD_6 Interfaces & Endpoints D&B Direct implements version control at the web service level, in addition to the API level. This D&B Direct 2.0 {version} of the Custom Product Service is 2.0. When contacting D&B customer support, please provide both the API and Service version numbers. The following table(s) identify version-specific access points for the available API interfaces. SOAP Endpoint WSDL * Dun & Bradstreet, Inc

9 Interfaces & Endpoints *There may be operations defined in the WSDL that are not available to D&B Direct customers at this time. REST OrderProduct OrderProduct (by Subject ID) RetrieveProduct GET {productid} GET /products/{productid} GET Note: While "organizations" is part of the REST OrderProduct URL, there is no service by this name. D&B Direct product-related calls have a similar structure; however, the {version} component is based on the service to which a given product is associated. D&B Direct API calls must be made using Secured Socket Layers (SSL) as reflected in the preceding table(s). Dun & Bradstreet, Inc

10 Custom:OrderProduct (REST) Custom:OrderProduct (REST) This operation -- part of the Custom Product Service -- provides access to (up to six) D&B Direct Custom Product using product codes CST_PRD_1 to CST_PRD_6. Authentication & Endpoint D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) is determined by the credentials submitted with each API request. Refer to the service page for the correct version of the operation. Endpoint GET Request Parameters The following parameters are accepted by this operation; however, the requirements for a specific request may differ based the product being requested. Please refer to the downloadable data dictionary (filterable by product code) to determine which fields are applicable. The default value for ArchiveProductOptOutIndicator is 'true', indicating that the request will NOT be automatically archived. Name {version} ApplicationTransactionID Characteristics Element string, up to 64 chars, Optional A number assigned by the calling application to uniquely identify this request. TransactionTimestamp SubmittingOfficeID 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. 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. Dun & Bradstreet, Inc

11 Request Parameters Name {DUNS} {subjectid} CountryISOAlpha2Code Characteristics 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). string, up to 15 chars, Optional A number uniquely identifying the inquired subject within the D&B Worldwide Network. string, at least 2 chars up to 2 chars, Optional The two-letter country code, defined in the ISO scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. PrincipalIdentificationNumberTypeCode Element PrincipalIdentificationNumber string, Optional {productid} A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual. string, Required An alphanumeric string that uniquely identifies the product being requested. LanguagePreferenceCode CharacterSetPreferenceCode ProductFormatPreferenceCode 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. 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. integer, up to 7 digits, Optional Dun & Bradstreet, Inc

12 Request Parameters Name TradeUpIndicator OrderReasonCode Characteristics boolean, Optional When 'true' indicates that the customer has requested that D&B return the data for the Headquarters when the requested organization is a Branch. When 'false' indicates 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. integer, up to 7 digits, Optional ArchiveProductOptOutIndicator ExtendArchivePeriodIndicator PortfolioAssetContainerID 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] 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. 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. long, Optional A number used to uniquely identify the location where this product is to be stored. Dun & Bradstreet, Inc

13 Testing / Sandbox Name CustomerReferenceText CustomerBillingEndorsementText Characteristics string, up to 240 chars, Optional A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation. 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. Testing / Sandbox This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-S Number is provided in the request parameters. Response Data Fields The following is a list of the possible data fields returned by this operation in the JSON response. The specific data fields pre-configured for each custom data product will located in the response package as noted. Name OrderProductResponse TransactionDetail TransactionDetail { ApplicationTransactionID TransactionDetail { ServiceTransactionID Characteristics Aggregate Attribute Aggregate, Required Records information necessary to process a particular request. Examples of a request is the ordering of a product. string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. string up to 64 chars., Required A number assigned by the D&B service to uniquely identify this transaction. Dun & Bradstreet, Inc

14 Response Data Fields Name TransactionDetail { TransactionTimestamp End: OrderProductResponse } TransactionDetail TransactionResult TransactionResult { SeverityText TransactionResult { ResultID TransactionResult { ResultText TransactionResult { ResultMessage TransactionResult { ResultMessage { ResultDescription End: OrderProductResponse } TransactionResult } ResultMessage End: OrderProductResponse } TransactionResult OrderProductResponseDetail Characteristics DateTimestamp, 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. Aggregate, Required An aggregate that can repeat multiple times to record the different outcomes of the transaction. string up to 16 chars., Required Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. string up to 32 chars., Required An alphanumeric string that uniquely identifies the outcome of the transaction. string up to 512 chars., Optional Text that explains the outcome of the transaction. 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. string up to 512 chars., Required Text that describes the additional information regarding the outcome of the transaction. Aggregate, Optional Records the data being returned to the customer as a result of a product request. Dun & Bradstreet, Inc

15 Response Data Fields Name OrderProductResponseDetail { InquiryDetail OrderProductResponseDetail { InquiryDetail { DUNSNumber OrderProductResponseDetail { InquiryDetail { SubjectID OrderProductResponseDetail { InquiryDetail { CountryISOAlpha2Code OrderProductResponseDetail { InquiryDetail { PrincipalIdentificationNumberDetail OrderProductResponseDetail { InquiryDetail { OrderProductResponseDetail { InquiryDetail { OrderProductResponseDetail { InquiryDetail { Characteristics 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. string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional The D&B's identification number, which provides unique identification of the inquired organization, in accordance with the Data Universal Numbering System (D-U-N-S). string up to 15 chars., Optional A number uniquely identifying the inquired subject within the D&B Worldwide Network. string at least 2 chars. up to 2 chars., Optional The two-letter country code, defined in the ISO scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of several different identifiers issued by organizations to uniquely identify the principal. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise, e.g., the Social Security Administration department. Attribute Attribute Attribute Dun & Bradstreet, Inc

16 Response Data Fields Name OrderProductResponseDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber End: OrderProductResponse } OrderProductResponseDetail } InquiryDetail } PrincipalIdentificationNumberDetail End: OrderProductResponse } OrderProductResponseDetail } InquiryDetail OrderProductResponseDetail { Product OrderProductResponseDetail { Product { DNBProductID OrderProductResponseDetail { Product { LanguageCode OrderProductResponseDetail { Product { Organization Contents of "Organization PCM Aggregate END: OrderProductResponse } OrderProductResponseDetail } Product } Organization OrderProductResponseDetail { Product { ArchiveDetail OrderProductResponseDetail { Product { ArchiveDetail { PortfolioAssetID Characteristics string, Optional A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual. Aggregate, Required Records data about the product ordered by the customer and data about the organization on which the customer has placed this order. string up to 64 chars., Optional An alphanumeric string that uniquely identifies this product. integer up to 7 digits., Optional A D&B code value that defines the language in which the requested product is fulfilled. 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. Contents of "Organization PCM Aggregate Possible values: Contents of "Organization PCM Aggregate Aggregate, Optional Records data about the archival details of the product requested. PortfolioAssetIDType, Optional A number used to uniquely identify this product in the location where it is stored. Dun & Bradstreet, Inc

17 Abbreviated Territory Names Name OrderProductResponseDetail { Product { ArchiveDetail { PortfolioAssetContainerID End: OrderProductResponse } OrderProductResponseDetail } Product } ArchiveDetail OrderProductResponseDetail { Product { CopyrightNoticeText End: OrderProductResponse } OrderProductResponseDetail } Product OrderProductResponseDetail { InquiryReferenceDetail OrderProductResponseDetail { InquiryReferenceDetail { CustomerReferenceText OrderProductResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText End: OrderProductResponse } OrderProductResponseDetail } InquiryReferenceDetail End: OrderProductResponse } OrderProductResponseDetail End: OrderProductResponse Characteristics long, Optional A number used to uniquely identify the location where this product is stored. string up to 128 chars., Optional Text that specifies the underlying claim to copyright ownership of this product. Aggregate, Optional Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation. 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. 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. Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered in the response and should be anticipated in any implementation. Abbreviated Territory Names When present, the Territory Abbreviated Name field will contain local abbreviations, which may be based on standard designations. For companies domiciled in the United States or Canada, this field will contain the Dun & Bradstreet, Inc

18 Language/Character Sets second component of ISO codes. For example, the ISO :US code for New Jersey is "US-NJ" and the value "NJ" will be delivered in this field. Similarly, the ISO :CA code for Ontario is "CA-ON" and the value "ON" will be delivered in this field. Language/Character Sets The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including the D&B Business Information Report (BIR), provide additional language options. Data layers are encoded using the ISO character set standard (sometimes referred to as Latin-1), EXCEPT when the organization is domiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets is currently encoded using the ISO character set standard. Response Codes Successful service requests will return a CM000 response code. 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, and SC001-SC012. Product (Data Layer) Details Title / Overview Link Product Code Countries D&B Direct Custom Product CST_PRD_1 to CST_PRD_6 varies Samples (Download) Request and response samples are available for this D&B Direct web services. The samples may cover a variety of scenarios (when applicable) and are designed for use in the test environment. Custom Product Service Samples Related Topics {productservice}:retrieveproduct (REST) Dun & Bradstreet, Inc

19 Custom:OrderProduct (SOAP) Custom:OrderProduct (SOAP) This operation -- part of the Custom Product Service -- provides access to (up to six) D&B Direct Custom Product using product codes CST_PRD_1 to CST_PRD_6. Authentication, Endpoint & WSDL D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) is determined by the credentials submitted with each API request. Refer to the service page for the correct version of the operation. Endpoint Request Parameters The following parameters are accepted by this operation; however, the requirements for a specific request may differ based the product being requested. Please refer to the downloadable data dictionary (filterable by product code) to determine which fields are applicable. The default value for ArchiveProductOptOutIndicator is 'true', indicating that the request will NOT be automatically archived. Name OrderProductRequest TransactionDetail TransactionDetail. ApplicationTransactionID TransactionDetail. TransactionTimestamp Characteristics Aggregate Attribute Aggregate, Optional Records information necessary to process this request. string, up to 64 chars, Optional A number assigned by the calling application to uniquely identify this request. 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. Dun & Bradstreet, Inc

20 Request Parameters Name TransactionDetail. SubmittingOfficeID End: TransactionDetail OrderProductRequestDetail InquiryDetail InquiryDetail. DUNSNumber InquiryDetail. SubjectID InquiryDetail. CountryISOAlpha2Code InquiryDetail. PrincipalIdentificationNumberDetail Characteristics 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. Aggregate, Optional Records data relating to requests for a product. This may include such details as the product required, the subject about which the product should be produced, the content of the product. 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. 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). string, up to 15 chars, Optional A number uniquely identifying the inquired subject within the D&B Worldwide Network. string, at least 2 chars up to 2 chars, Optional The two-letter country code, defined in the ISO scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of several different identifiers issued by organizations to uniquely identify the principal. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise, e.g., the Social Security Administration department. Dun & Bradstreet, Inc

21 Request Parameters Name InquiryDetail. InquiryDetail. InquiryDetail. InquiryDetail. PrincipalIdentificationNumberDetail. PrincipalIdentificationNumber End: InquiryDetail. PrincipalIdentificationNumberDetail End: InquiryDetail ProductSpecification ProductSpecification. DNBProductID ProductSpecification. LanguagePreferenceCode Characteristics Attribute Attribute Attribute string, Optional A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual. Aggregate, Required Records data that allows the customer to specify the details of the requested product. This may include details such as the identifier of the product, the language in which the product needs to be rendered, the format in which the product needs to be rendered. string, Optional An alphanumeric string that uniquely identifies the product being requested. 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. Dun & Bradstreet, Inc

22 Request Parameters Name ProductSpecification. CharacterSetPreferenceCode ProductSpecification. ProductFormatPreferenceCode ProductSpecification. TradeUpIndicator ProductSpecification. OrderReasonCode End: ProductSpecification ArchiveDetail ArchiveDetail. ArchiveProductOptOutIndicator Characteristics 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. integer, up to 7 digits, Optional boolean, Optional When 'true' indicates that the customer has requested that D&B return the data for the Headquarters when the requested organization is a Branch. When 'false' indicates 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. 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] Aggregate, Optional 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. Dun & Bradstreet, Inc

23 Testing / Sandbox Name ArchiveDetail. ExtendArchivePeriodIndicator ArchiveDetail. PortfolioAssetContainerID End: ArchiveDetail InquiryReferenceDetail InquiryReferenceDetail. CustomerReferenceText InquiryReferenceDetail. CustomerBillingEndorsementText End: InquiryReferenceDetail End: OrderProductRequestDetail End: OrderProductRequest Characteristics 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. long, Optional A number used to uniquely identify the location where this product is to be stored. Aggregate, Optional Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation. 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. 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. Testing / Sandbox This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-S Number is provided in the request parameters. Dun & Bradstreet, Inc

24 Data Field Response Data Field Response The following is a list of the possible data fields returned by this operation in the XML response. The specific data fields pre-configured for each custom data product will located in the response package as noted. Name OrderProductResponse TransactionDetail TransactionDetail. ApplicationTransactionID TransactionDetail. ServiceTransactionID TransactionDetail. TransactionTimestamp End: TransactionDetail TransactionResult TransactionResult. SeverityText TransactionResult. ResultID TransactionResult. ResultText Characteristics Aggregate Attribute Aggregate, Required Records information necessary to process a particular request. Examples of a request is the ordering of a product. string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. string up to 64 chars., Required A number assigned by the D&B service to uniquely identify this transaction. DateTimestamp, 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. Aggregate, Required An aggregate that can repeat multiple times to record the different outcomes of the transaction. string up to 16 chars., Required Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. string up to 32 chars., Required An alphanumeric string that uniquely identifies the outcome of the transaction. string up to 512 chars., Optional Text that explains the outcome of the transaction. Dun & Bradstreet, Inc

25 Data Field Response Name TransactionResult. ResultMessage TransactionResult. ResultMessage. ResultDescription End: TransactionResult. ResultMessage End: TransactionResult OrderProductResponseDetail InquiryDetail InquiryDetail. DUNSNumber InquiryDetail. SubjectID InquiryDetail. CountryISOAlpha2Code Characteristics 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. string up to 512 chars., Required Text that describes the additional information regarding the outcome of the transaction. Aggregate, Optional Records the data being returned to the customer as a result of a product request. 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. string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional The D&B's identification number, which provides unique identification of the inquired organization, in accordance with the Data Universal Numbering System (D-U-N-S). string up to 15 chars., Optional A number uniquely identifying the inquired subject within the D&B Worldwide Network. string at least 2 chars. up to 2 chars., Optional The two-letter country code, defined in the ISO scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. Dun & Bradstreet, Inc

26 Data Field Response Name InquiryDetail. PrincipalIdentificationNumberDetail InquiryDetail. InquiryDetail. InquiryDetail. InquiryDetail. PrincipalIdentificationNumberDetail. PrincipalIdentificationNumber End: InquiryDetail. PrincipalIdentificationNumberDetail End: InquiryDetail Product Product. DNBProductID Characteristics Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of several different identifiers issued by organizations to uniquely identify the principal. The issuing organization may be a Registration Authority, Government Department or Commercial Enterprise, e.g., the Social Security Administration department. Attribute Attribute Attribute string, Optional A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual. Aggregate, Required Records data about the product ordered by the customer and data about the organization on which the customer has placed this order. string up to 64 chars., Optional An alphanumeric string that uniquely identifies this product. Dun & Bradstreet, Inc

27 Data Field Response Name Product. LanguageCode Product. Organization Contents of "Organization PCM Aggregate END: Product. Organization Product. ArchiveDetail Product. ArchiveDetail. PortfolioAssetID Product. ArchiveDetail. PortfolioAssetContainerID End: Product. ArchiveDetail Product. CopyrightNoticeText End: Product InquiryReferenceDetail InquiryReferenceDetail. CustomerReferenceText Characteristics integer up to 7 digits., Optional A D&B code value that defines the language in which the requested product is fulfilled. 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. Contents of "Organization PCM Aggregate Possible values: Contents of "Organization PCM Aggregate Aggregate, Optional Records data about the archival details of the product requested. PortfolioAssetIDType, Optional A number used to uniquely identify this product in the location where it is stored. long, Optional A number used to uniquely identify the location where this product is stored. string up to 128 chars., Optional Text that specifies the underlying claim to copyright ownership of this product. Aggregate, Optional Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation. 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. Dun & Bradstreet, Inc

28 Abbreviated Territory Names Name InquiryReferenceDetail. CustomerBillingEndorsementText End: InquiryReferenceDetail End: OrderProductResponseDetail End: OrderProductResponse Characteristics 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. Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered in the response and should be anticipated in any implementation. Abbreviated Territory Names When present, the Territory Abbreviated Name field will contain local abbreviations, which may be based on standard designations. For companies domiciled in the United States or Canada, this field will contain the second component of ISO codes. For example, the ISO :US code for New Jersey is "US-NJ" and the value "NJ" will be delivered in this field. Similarly, the ISO :CA code for Ontario is "CA-ON" and the value "ON" will be delivered in this field. Language/Character Sets The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including the D&B Business Information Report (BIR), provide additional language options. Data layers are encoded using the ISO character set standard (sometimes referred to as Latin-1), EXCEPT when the organization is domiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets is currently encoded using the ISO character set standard. Response Codes Successful service requests will return a CM000 response code. 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, and SC001-SC012. Dun & Bradstreet, Inc

29 Product (Data Layer) Details Product (Data Layer) Details Title / Overview Link Product Code Countries D&B Direct Custom Product CST_PRD_1 to CST_PRD_6 varies Samples (Download) Request and response samples are available for this D&B Direct web services. The samples may cover a variety of scenarios (when applicable) and are designed for use in the test environment. Custom Product Service Samples Related Topics {productservice}:retrieveproduct (SOAP) Dun & Bradstreet, Inc

30 Authentication Process Authentication Process Before D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link for activating username/password combinations will be included in an sent upon completion of the registration process. If you do not receive an , or unable to locate it, please contact the D&B support team for assistance (and specify if this a production, trial or sandbox related issue). The system will generate a unique username for accounts created after December 6, Prior to that date, the customer-supplied address was used as the username. No change is required for existing credentials. Most of the D&B Direct products and features require contractual entitlement prior to production (and trial) environment access. Please refer to the data layer entitlement page for more details. SOAP Authentication All D&B Direct API services require that a valid username and password be provided in the SOAP header with each call to an operation. The 2.0 services do not require that an API key be supplied. If the credentials are valid and the associated account is entitled to access the product or feature, the request will be processed. If the authentication process fails, an error response code will be returned. The security related response codes are prefixed with "SC." Sample Request <soapenv:envelope xmlns:soapenv=" lope/" xmlns:com=" <soapenv:header> <wsse:security soapenv:mustunderstand="0" xmlns:wsse=" cs.oasis-open.org/wss/2004/01/oasis wss-wssecurity-secext-1.0. xsd" xmlns:wsu=" ss-wssecurity-utility-1.0.xsd"> <wsse:usernametoken wsu:id="usernametoken-11"> <wsse:username>myusername</wsse:username> <wsse:password Type=" 01/oasis wss-username-token-profile-1.0#PasswordText">MyPasswo rd</wsse:password> </wsse:usernametoken> </wsse:security> </soapenv:header> <soapenv:body> <!--Request Body as per the service schema--> Dun & Bradstreet, Inc

31 REST Authentication </soapenv:body> </soapenv:envelope> Response - Invalid Credentials <soapenv:envelope xmlns:soapenv=" lope/"> <soapenv:body> <com:matchresponse ServiceVersionNumber="4.0" xmlns:com=" /services.dnb.com/companyservicev2.0"> <TransactionDetail> <ApplicationTransactionID>Id-b118ae275255a7cf0cfb742e</Ap plicationtransactionid> <ServiceTransactionID>Id-b118ae275255a7cf0cfb742e</Servic etransactionid> <TransactionTimestamp> T15:00:31</TransactionTim estamp> </TransactionDetail> <TransactionResult> <SeverityText>Error</SeverityText> <ResultID>SC001</ResultID> <ResultText>Your user credentials are invalid. Please con tact your D&B Representative or your local Customer Service Cente r.</resulttext> </TransactionResult> </com:matchresponse> </soapenv:body> </soapenv:envelope> REST Authentication Implementation of D&B Direct API services using REST methodology involves obtaining an Authentication Token, that is then submitted with subsequent requests during a particular session (up to eight hours). Secure access to D&B Direct services is managed through the use of an Authentication Token, which can be obtained by sending an HTTP POST request to Authentication Service URL, passing a valid username and password in the HTTP header. The 2.0 services do not require that an API key be supplied. If the user credentials are valid, an Authentication Token (valid for eight hours) will be returned back in the Authorization tag in the HTTP header of the response. Dun & Bradstreet, Inc

32 REST Authentication Once an Authentication Token is obtained, it should be embedded in the HTTP header of all subsequent requests. If the Authentication Token is valid and the user is entitled to access the product or feature being requested, the service will be processed and requested information returned as a JSON object. If the Authentication Token is invalid, an error code will be returned in the JSON response. Note: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations. Sample Request - Get New Token POST x-dnb-user: MyUsername x-dnb-pwd: MyPassword A {version} parameter is not required when initiating a request to the Authentication service. Response - Success HTTP/ OK Date: Wed, 09 Oct :47:22 GMT Authorization: <MyToken> x-dnb-user: MyUsername x-dnb-pwd: MyPassword Response - Failed HTTP/ ERROR Date: Wed, 09 Oct :51:11 GMT Authorization: INVALID CREDENTIALS x-dnb-user: MyUsername x-dnb-pwd: MyPassword Sample Request - Invoke Operation with Token GET Code=US&SubjectName=GORMAN%20MANUFACTURING&match=true&MatchTypeText=A dvanced&territoryname=ca Authorization: <MyToken> Response - Expired Authentication Token HTTP/ UNAUTHORIZED Date: Thu, 10 Oct :55:19 GMT Dun & Bradstreet, Inc

33 REST Authentication Authorization: <MyToken> Content-Type: application/json Content-Encoding: gzip {"MatchResponse": { "TransactionDetail": { "ApplicationTransactionID": "REST", "ServiceTransactionID": "Id-c04bbdff5256bfd70a7b742e", "TransactionTimestamp": " T10:55:19" }, "TransactionResult": { "SeverityText": "Error", "ResultID": "SC001", "ResultText": "Your user credentials are invalid. Please contact your D&B Representative or your local Customer Service Center." } }} Dun & Bradstreet, Inc

34 Obtaining Credentials Obtaining Credentials Access to the D&B Direct web services are secured by a username and password combination. D&B will issue your organization a production username upon completion of the contract establishment process. This username will be sent to the address designated on the contract, along with instructions for setting up the password. This process will also be followed for production trial requests. D&B offers a non-billable environment (commonly referred to as the sandbox) for testing the D&B Direct web services. Developers may establish, via a self-service interface, sandbox user id and password combinations. The production credentials assigned to your organization may NOT be used in the sandbox environment to authenticate web services, and vice-versa. Before D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link for activating username/password combinations will be included in an sent upon completion of the registration process. If you do not receive an , or unable to locate it, please contact the D&B support team for assistance (and specify if this a production, trial or sandbox related issue). The system will generate a unique username for accounts created after December 6, Prior to that date, the customer-supplied address was used as the username. No change is required for existing credentials. Most of the D&B Direct products and features require contractual entitlement prior to production (and trial) environment access. Please refer to the data layer entitlement page for more details. Dun & Bradstreet, Inc

35 Data Layer Entitlement Data Layer Entitlement D&B Direct 2.0 services are provisioned to customers at the data layer, which, for some of the features, might not be intuitive. This page is intended to help developers clearly understand what services and operations they are entitled to use. Components Requiring Entitlement Data Layer: D&B Direct Custom Product 1 to 6 Service: Custom Product Service Operation: OrderProduct() + CST_PRD_1 to CST_PRD_6 Product: Custom Product Selection Components Not Requiring Entitlement These items are available to customers who have one or more entitled data layers. Dun & Bradstreet, Inc

36 Country Codes Country Codes Many of the D&B Direct web services expect to receive a country code for the company specified by the D-U- N-S Number being requested. This input parameter is case-sensitive and must be supplied in upper case. On some requests, this parameter is optional; however, D&B recommends that it be provided to reduce the response time of the service(s) -- including products limited to results for US companies. D&B Direct services utilize the two-letter country code as defined by the International Organization for Standardization (ISO) in their ISO specification. For a list of actual country codes supported for a specific data layer, please refer to the Country Availability tab contained in the downloadable "Extras" file for the respective Service. Code Substitutions Data for the following countries is stored under the alternate country code specified. Country Name ABU DHABI ADMIRALTY ISLANDS AJMAN AL AIN ASCENSION ISLAND Cocos (Keeling) Islands DUBAI FUJAIRAH MIDWAY ISLANDS RAS AL KHAIMAH SHARJAH Alternate Instructions Use the code of United Arab Emirates (AE) Use the code of Papua New Guinea (PG) Use the code of United Arab Emirates (AE) Use the code of United Arab Emirates (AE) Use the code SH (Saint Helena, Ascension and Tristan da Cunha) Use the code AU (Australia) Use the code of United Arab Emirates (AE) Use the code of United Arab Emirates (AE) Use the code of US Use the code of United Arab Emirates (AE) Use the code of United Arab Emirates (AE) SOUTH SANDWICH ISLANDS Use the code GS (South Georgia and the South Sandwich Islands) South Sudan TURKISH CYPRUS UMM-AL-QUWAIN Use the code of Sudan (SD) Use the code of Cyprus (Match is not supported) Use the code of United Arab Emirates (AE) While some territories of the United States (e.g. Puerto Rico) have been assigned ISO country codes, the information on organizations from those areas will be located under the US country code. Data Not Available Data for the following countries is not currently available through the D&B Direct 2.0 API. Dun & Bradstreet, Inc

37 Country Codes Country Name Antarctica Åland Islands Saint Barthélemy Bonaire, Saint Eustatius and Saba Bouvet Island CAROLINE ISLANDS?? Cuba Curaçao Western Sahara Micronesia, Federated States of Guernsey Heard Island and McDonald Islands Isle of Man British Indian Ocean Territory Jersey ISO Code AQ AX BL BQ BV CU CW EH FM GG HM IM IO Korea, Democratic People's Republic of KP Saint Martin (French part) Mongolia Niue Pitcairn Palestinian Territory, Occupied Palau Svalbard and Jan Mayen Sint Maarten (Dutch part) French Southern Territories Wallis and Futuna Wake Island?? Mayotte JE MF MN NU PN PS PW SJ SX TF WF YT Please contact your local D&B Customer Service department/representative for more details; or to place an inquiry for a specific organization. Dun & Bradstreet, Inc

38 Response Codes Response Codes Whenever a D&B Direct web service request is unsuccessful, one of the following response codes will be returned. Code Description HTTP Status * CM000 Success 200 CM001 The given request is invalid. 400 CM002 The format of this request is invalid. 400 CM003 Missing information in the request. 400 CM004 Internal D&B system error. 500 CM005 D&B System temporarily unavailable. 503 CM006 D&B System busy. 503 CM007 Your request cannot be fulfilled for the given criteria. 404 CM008 No match found for the requested Duns number. 404 CM009 Reason Code required for Germany. 400 CM010 Partial Success. 200 CM011 Invalid Country Code provided in the request. 400 CM012 Invalid Duns number provided in the request. 400 CM013 Invalid Subject ID provided in the request. 400 CM014 Invalid Product Code provided in the request. 400 CM016 Invalid Territory provided in the request. 400 CM017 Duns number is missing in the request. 400 CM018 No candidates resulted for the given input criteria. 404 CM022 Only a Subset of request parameters were used for processing the request. 200 CM023 Duplicate record cannot be created. 400 CM026 Request accepted. Processing pending. 200 CP001 No Match for the given input criteria. 404 CP002 No candidates resulted in the Extended Search. 404 CP003 No Match for given Telephone Number. 404 CP004 No Match for given Organization Identifier. 404 CP005 Insufficient Information to determine Fraud Score. 400 PD001 Requested product not available due to insufficient data. 404 PD002 Requested subject is promised later. Preliminary report returned. 200 PD003 Requested product not available - subject is on Stop Distribution. 404 Dun & Bradstreet, Inc

39 Response Codes Code Description HTTP Status * PD004 Requested product not available due to subject information is too old. 404 PD005 Requested Product not available. 404 PD006 Subject is foreign branch, therefore trade-up to HQ is not available. 404 PD007 Family Tree does not exist for requested subject. 404 PD008 PD009 Success. Returned truncated family tree, as family tree member count exceeds maximum limit for requested subject. Required scoring elements missing - a Commercial or Blended Small Business report is not available. You may proceed with a Principal only request. PD010 Requested Product not available as address is undeliverable. 200 PD011 Requested Product not available as address is undeliverable. 404 PD012 Requested Product not available on Self request. 404 PD013 PD014 PD015 PD016 Requested Product is not available currently. Product will be delivered to the customer at a later point of time via offline delivery channels ( /FAX/FTP etc). Requested data is not available or partially available due to data integrity errors. Trade-up to HQ is not available. Therefore delivering the data for branch organization. Requested Product is not available since the requested DUNS is transferred to a new DUNS SC001 Your user credentials are invalid. 401 SC002 Your user credentials are not eligible for this request. 401 SC003 Your user credentials have expired. 401 SC004 Your Subscriber number has expired. 401 SC005 You have reached maximum limit permitted as per the contract. 401 SC006 Transaction not processed as the permitted concurrency limit was exceeded. 401 SC007 Subscriber validation failed. 401 SC008 Your account has been locked out due to repeated attempts to login with an incorrect User ID/Password. SC009 Invalid Sign On Token in the request. 401 SC010 The User ID you provided doesn t exist in the system. n/a SC011 The User ID you provided already exist in the system n/a SC012 Request not processed as user activation key is invalid or expired. n/a SC014 Your user credentials are not eligible for this request since you are in trial period BC001 Partial Success. One or more records in the input file were not processed. 200 Dun & Bradstreet, Inc

40 Response Codes Code Description HTTP Status * BC002 BC003 BC004 Batch request is not processed since input file is not available in the specified location. Batch request is not processed since the content of the input file is not in the expected format. Batch request is not processed since the count of the records specified in the request do not match the exact count of records in the input file. BC005 Intermediate Success 200 BC006 Batch request is not processed 400 BC007 Batch Execution in progress n/a BC008 Batch Execution not yet started n/a BC009 Batch not processed as the input file contains more records than the permitted limit. BC010 Batch files no longer available after retention period. 200 BC011 Invalid Batch Process Id provided in the request MN001 Invalid Monitoring Profile ID provided in the request. 400 MN002 Invalid Notification Profile ID provided in the request. 400 MN003 Product not registered for Level 2 Monitoring 400 MN004 Cannot delete Monitoring Profile - registrations exist 400 MN005 Cannot delete Notification Profile - registrations exist. 400 *This column displays the corresponding HTTP status code that will be returned for REST API calls. Dun & Bradstreet, Inc

41 Sandbox Access Sandbox Access D&B Direct provides a test environment (referred to as the sandbox) that requires a separate set of credentials. Service requests made with sandbox credentials should be issued using the same endpoints (and in the case of SOAP, using the same WSDL file). When conducting testing in the production environment during a trial period, product requests will be limited to the local market of the customer. Some D&B Direct products and features may behave differently in the sandbox environment. Any limitations or restrictions will be specified on the operation page for each interface. Test Parameter Values The following suggested parameters may be used for test environment (sandbox) requests to retrieve successful responses. Company Reports Country Reports Static Responses Some operations currently return a static set of results, regardless of the request parameters, in the test environment. Company Service Match, GetCleanseMatch, SearchByFilingName, SearchByFilingNumber, and CleanseAndStandardize will return a static response in the Sandbox environment. Entity List Service FindCompany, FindContact, FindCompetitor, and FindIndustry will return a static response in the Sandbox environment. Dun & Bradstreet, Inc

42 {data products}:retrieveproduct (REST) {data products}:retrieveproduct (REST) This operation -- included in all data and report product services (listed below)-- provides access to the product request archive. Assets may also be retrieved by using the Portfolio:RetrievePortfolioAsset (REST) operation. Service Request Response * Custom Product Service RetrieveProduct() same as OrderProduct() *The response data field names will be prefixed with "RetrieveProductResponse.RetrieveProductResponseDetail" instead of "OrderProductResponseDetail". Request Parameters The following parameters are accepted by this operation; however, the requirements for a specific request may differ based the product being requested. Name Characteristics ApplicationTransactionID string up to 64 chars., Optional TransactionTimestamp A number assigned by the calling application to uniquely identify this request. 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. Dun & Bradstreet, Inc

43 Response Data Fields Name SubmittingOfficeID {assetid} Characteristics 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. long, Required Response Data Fields Refer to the respective OrderProduct operation for each service. For example, a request from Assessment:RetrieveProduct() will return the same response as Assessment:OrderProduct(). The response items, however, will be prefixed with "RetrieveProductResponse.RetrieveProductResponseDetail" instead of "OrderProductResponseDetail". Language/Character Sets The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including the D&B Business Information Report (BIR), provide additional language options. Data layers are encoded using the ISO character set standard (sometimes referred to as Latin-1), EXCEPT when the organization is domiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets is currently encoded using the ISO character set standard. Response Codes Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standard response codes will be returned. This operation may return the following response codes: CM001, CM002, CM003, CM004, CM005, CM006, PT001, and SC001-SC009. Operation-specific supplemental response code explanations: PT001 No Portfolio asset not found for given portfolio asset identifier or investigation tracking ID or asset removed from archive. Dun & Bradstreet, Inc

44 SOAP Interface SOAP Interface This operation is also available using the SOAP architecture. Refer to {data products}:retrieveproduct (SOAP) for details. Dun & Bradstreet, Inc

45 {data products}:retrieveproduct (SOAP) {data products}:retrieveproduct (SOAP) This operation -- included in all data and report product services (listed below)-- provides access to the product request archive. Assets may also be retrieved by using the Portfolio:RetrievePortfolioAsset (REST) operation. Service Request Response * Custom Product Service RetrieveProduct() same as OrderProduct() *The response data field names will be prefixed with "RetrieveProductResponse.RetrieveProductResponseDetail" instead of "OrderProductResponseDetail". Request Parameters The following parameters are accepted by this operation; however, the requirements for a specific request may differ based the product being requested. Name Characteristics RetrieveProductRequest Aggregate RetrieveProductRequest@ServiceVersionNumber Attribute RetrieveProductRequest. TransactionDetail Aggregate, Optional Records information necessary to process this request. RetrieveProductRequest. TransactionDetail. ApplicationTransactionID RetrieveProductRequest. TransactionDetail. TransactionTimestamp RetrieveProductRequest. TransactionDetail. SubmittingOfficeID END: RetrieveProductRequest. TransactionDetail string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. 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. 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. Dun & Bradstreet, Inc

46 Response Data Fields Name RetrieveProductRequest. RetrieveProductRequestDetail RetrieveProductRequest. RetrieveProductRequestDetail. ArchiveDetail RetrieveProductRequest. RetrieveProductRequestDetail. ArchiveDetail. PortfolioAssetID END: RetrieveProductRequest. RetrieveProductRequestDetail. ArchiveDetail END: RetrieveProductRequest. RetrieveProductRequestDetail END: RetrieveProductRequest Characteristics Aggregate, Required Aggregate, Required long, Required Response Data Fields Refer to the respective OrderProduct operation for each service. For example, a request from Assessment:RetrieveProduct() will return the same response as Assessment:OrderProduct(). The response items, however, will be prefixed with "RetrieveProductResponse.RetrieveProductResponseDetail" instead of "OrderProductResponseDetail". Language/Character Sets The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including the D&B Business Information Report (BIR), provide additional language options. Data layers are encoded using the ISO character set standard (sometimes referred to as Latin-1), EXCEPT when the organization is domiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets is currently encoded using the ISO character set standard. Response Codes Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standard response codes will be returned. This operation may return the following response codes: CM001, CM002, CM003, CM004, CM005, CM006, PT001, and SC001-SC009. Operation-specific supplemental response code explanations: PT001 No Portfolio asset not found for given portfolio asset identifier or investigation tracking ID or asset removed from archive. Dun & Bradstreet, Inc

47 REST Interface REST Interface This operation is also available using the REST architecture. Refer to {data products}:retrieveproduct (REST) for details. Dun & Bradstreet, Inc

48 BadgerFish (REST) BadgerFish (REST) BadgerFish is a convention for translating an XML document into a JSON object. D&B Direct JSON responses follow this convention with a few minor variations. Exception: The responses supplied by the Data Exchange Service follow the convention used by the respective business partner. Attributes will always be represented by prefixing (see Example 2) If an element is repeatable, that element will be always returned as an Array of objects in the JSON response. (see Example 7) o If a repeatable element is not repeating in a specific JSON response, even then that element will be returned as an Array having a single object. (see Example 9) Element content will be represented with $ if it has attributes (see Example 2) o Consider a scenario where an element has an attribute as per the definition, however the attribute is not returned in a specific JSON response. Even then, the element content will be represented as $ in the JSON. (see Example 4) String values will be returned within double quotes. (see Example 14) Numeric and Boolean values will not be returned within double quotes. (see Example 12 and Example 13) Examples # Scenario XML Instance JSON Instance 1 Element having no attribute 2 Element having Attribute 3 Aggregate having attribute 4 Element having Attribute as per definition, however attribute is not returned for a specific JSON instance <DUNSNumber> </DUNSNumber> "DUNSNumber": " " <FamilyTreeMemberRoleText DNBCodeValue="12773">Parent </FamilyTreeMemberRoleText> <OrganizationIdentificationNumberDetail TypeText="Federal Taxpayer Identification Number (US)" DNBCodeValue="6863"> <OrganizationIdentificationNumber>12345 </OrganizationIdentificationNumber> </OrganizationIdentificationNumberDetail> <OrganizationName>Gorman Manufacturing Company, Inc. </OrganizationName> "FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" } "OrganizationIdentificationNumberDetail": { "@TypeText": "Federal Taxpayer Identification Number (US)", "@DNBCodeValue": 6863, "OrganizationIdentificationNumber": "12345" } "OrganizationName": { "$": "Gorman Manufacturing Company, Inc." } Dun & Bradstreet, Inc

49 Examples # Scenario XML Instance JSON Instance 5 Aggregate having Attribute as per definition, however attribute is not returned for a specific JSON instance 6 Non-Repeating Element <OrganizationIdentificationNumberDetail > <OrganizationIdentificationNumber>12345 </OrganizationIdentificationNumber> </OrganizationIdentificationNumberDetail> "OrganizationIdentificationNumberDetail": { "OrganizationIdentificationNumber": "12345" } <DUNSNumber> </DUNSNumber> "DUNSNumber": " " 7 Repeating Element <SalesRevenueAmount CurrencyISOAlpha3Code="USD > </SalesRevenueAmount> <SalesRevenueAmount CurrencyISOAlpha3Code="CAD > </SalesRevenueAmount> 8 Repeating Aggregate <FamilyTreeMemberRole> <FamilyTreeMemberRoleText DNBCodeValue="12773">Parent </FamilyTreeMemberRoleText> </FamilyTreeMemberRole> <FamilyTreeMemberRole> <FamilyTreeMemberRoleText DNBCodeValue="12775">Global Ultimate </FamilyTreeMemberRoleText> </FamilyTreeMemberRole> <FamilyTreeMemberRole> <FamilyTreeMemberRoleText DNBCodeValue="12774">Domestic Ultimate </FamilyTreeMemberRoleText> </FamilyTreeMemberRole> 9 Element is repeatable as per the definition. However it is not repeating in a specific JSON instance. 10 Aggregate is repeatable as per the definition. However it is not repeating in a specific JSON instance. <SalesRevenueAmount CurrencyISOAlpha3Code="USD > </SalesRevenueAmount> <FamilyTreeMemberRole> <FamilyTreeMemberRoleText DNBCodeValue="12773">Parent </FamilyTreeMemberRoleText> </FamilyTreeMemberRole> 11 Date Field <TransactionTimestamp> T11:08: :00 </TransactionTimestamp> 12 Boolean Field <StandaloneOrganizationIndicator>false </StandaloneOrganizationIndicator> "SalesRevenueAmount": [ { "@CurrencyISOAlpha3Code": "USD", "$": }, { "@CurrencyISOAlpha3Code": "CAD", "$": } ] "FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }}, {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12775, "$": "Global Ultimate" }}, {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12774, "$": "Domestic Ultimate" }} ] "SalesRevenueAmount": [ { "@CurrencyISOAlpha3Code": "USD", "$": }] "FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }} ] "TransactionTimestamp": " T11:10: :00" "StandaloneOrganizationIndicator": false Dun & Bradstreet, Inc

50 Examples # Scenario XML Instance JSON Instance 13 Numeric Field <RawScore>352</RawScore> "RawScore": String Field <LineText>492 Koller Street</LineText> "LineText": "492 Koller Street" Dun & Bradstreet, Inc

51 Dun & Bradstreet (D&B) 103 JFK Parkway Short Hills, NJ Dun & Bradstreet, Inc All rights reserved.