D&B Direct 2.0 Batch Service · String 64 Y 3 CustomerReferenceText Fillerforanyfuture purposes 100...

D&B DirectAPI Documentation for

Batch Service

Version 2.0 (API) / 1.0 (Service)

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. 2014. All rights reserved

ContentsThese pages provide business overviews; explaining requirements and the business elements that will bedelivered. For suggested uses of the API components, please refer to the Solutions menu option on thedeveloper.dnb.com home page.

Title / Overview Link

Fraud Risk Score

On-Demand Multiple Entity Resolution (Asynchronous)

These pages provide the technical specifications that a developer will need to obtain information usingD&B Direct.

Service Operation / SOAP Resource / REST

n/a [Authentication Process] POST Authentication

Batch Service ProcessBatch POST Batches

ListBatch GET Batches

GetBatchResults GET Batches/{batchID}

GetFraudScore GET organizations? fraudscore=true

Service History

Version Date Interface(s) Change(s)

D&B Direct API Documentation Service History

©Dun & Bradstreet, Inc. 2014 3

http://developer.dnb.com/

About this DocumentationThe 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 inclusionin 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 businesselements are often delivered in the same data field (with separate attributes signaling the specific contents ofa data field).

The documentation highlights the business elements (i.e. business-oriented labels) on product pages; and thedata fields (i.e. technical, variable-like names used within the delivery packages) on operation pages -- withthe 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 ofthis 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" willbe 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 deliveredthrough the API web service. Throughout the documentation, business elements and data fields which areeligible 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 theAPI 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

D&B Direct API Documentation About this Documentation


(API) / 3.1 (Service) or Version 2.0 (API) / 4.0 (Service) based on the significance of the changes made to theservice.

Product Pages

These are non-technical pages that describe the information (i.e. business elements) returned by the data-oriented 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) andoften 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 versionand endpoints, WSDL location (for SOAP), and how to download samples and data dictionaries specific to theservice. While services are not applicable for REST implementations, the documentation is organized aroundthem for consistency.

Operation Pages

These are also technical pages, but describe (for each available implementation method) the individualfunctions provided by a service, listing the input field names and requirements, and the output with datafields (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 onthe bottom of the affected SOAP/REST operation page. If the change is significant and results in a versionchange, 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 moresummarized explanations of common tasks/uses refer to the collection of How To Guides.

D&B Direct API Documentation Product Pages


On-Demand Multiple Entity Resolution(Asynchronous)This feature allows multiple product requests to be issued from a single API call, using the Batch Service.

Requirements & Options

For cleansing, a primary address (building number and street name, post office box or rural route number) isrequired in combination with an organization name, city, state, country and postal code to meet one of thefollowing conditions:

1. For locations within the United States: primary address plus either (a) state abbreviation and ZIP code, (b) city name and ZIP code, or (c) city name with state abbreviation.

2. For locations outside of the United States: country code, primary address plus either (a) state, province orprefecture name and postal code, (b) city name and postal code, or (c) city name with name of the state,province or prefecture.

The product request details is submitted as a list of comma-delimited entries.

Additional Details

The results from this feature will be a list of separate comma-delimited responses.

In addition to the successful responses, an error file may be returned. The error file will contain exact copies ofthe input requests which failed, with an error code appended.

This feature may make multiple attempts to locate the D-U-N-S Number, initially using the cleansed inputcriteria. If a high confidence match is not located, a subsequent search will be performed using the originalinput criteria, and the results of both attempts will be merged and sorted to provide the highest confidencematches available.

When a multi-line address is provided (e.g. building number, street name and post office box in a singlerequest), this feature will return the proper address for mailing purposes.

D&B Direct API Documentation On-Demand Multiple Entity Resolution (Asynchronous)


Cleanse and Match CDL InputThe following fields (fully-quoted and comma-separated) should be provided for each product request,followed by a carriage return/line-feed combination. If a specific data element is empty in the input file, still acomma delimiter should be present.

(!) Important Note: a carriage return/line-feed is required for the last record.

Sequence Name Description DataType

Length Mandatory(Y/N)

1 Reserved1 100

2 ApplicationTransactionID Unique Transaction ID ofthe request

String 64 Y

3 Customer Reference Text Filler for any futurepurposes

100

4 Customer Reference Text Filler for any futurepurposes

100

5 Reserved2

6 Reserved3

7 Reserved4 100

8 Reserved5 100

9 DUNSNumber The D-U-N-S Number isDandBs identificationnumber, which providesunique identification ofthis organization, inaccordance with the DataUniversal NumberingSystem (D-U-N-S).

String 15 N

10 SubjectName Company name String 256 N

11 Reserved6 1

12 StreetAddressLine1 First line of thisOrganization's address

String 240 N

13 StreetAddressLine2 Second line of thisOrganization's address

String 240 N

14 PrimaryTownName The name of the town orcity recognized by thePostal Authority fordelivering mail.

String 64 N

15 TerritoryName TerritoryName String 64 N

16 FullPostalCode The country code for thisentity's location

String 32 N

D&B Direct API Documentation Cleanse and Match CDL Input



Length Mandatory(Y/N)

17 Reserved7 50

18 CountryISOAlpha2Code The two-letter countrycode, defined in the ISO3166-1 scheme publishedby InternationalOrganization forStandardization (ISO),identifying the country forthis address.

String 2 N

19 Reserved8 1

20 TelephoneNumber The telephone number forthis Subject

String 50 N

21 OrganizationIdentificationNumber.DNBCodeValue Integer 7

22 OrganizationIdentificationNumber Organization IdentificationNumber

String 40 N

D&B Direct API Documentation Cleanse and Match CDL Input


Cleanse and Match CDL OutputThe following fields (fully-quoted and comma-separated) will be provided for each resulting matched item,followed by a carriage return/line-feed combination.


Length

1 Reserved1

2 ApplicationTransactionID Unique Transaction ID of the request String 64

3 Customer Reference Text Filler for any future purposes 100

4 Customer Reference Text Filler for any future purposes 100

5 Reserved2

6 Reserved3

7 Reserved4 100

8 Reserved5 100

9 DUNSNumber The D-U-N-S Number is DandBs identificationnumber, which provides unique identificationof this organization, in accordance with theData Universal Numbering System (D-U-N-S).

String 15

10 SubjectName Company name String 240

11 Reserved6 1

12 StreetAddressLine1 First line of this Organization's address String 240

13 StreetAddressLine2 Second line of this Organization's address String 240

14 PrimaryTownName The name of the town or city recognized bythe Postal Authority for delivering mail.

String 64

15 TerritoryName TerritoryName String 64

16 FullPostalCode The country code for this entity's location String 32

17 Reserved7 50

18 CountryISOAlpha2Code The two-letter country code, defined in theISO 3166-1 scheme published by InternationalOrganization for Standardization (ISO),identifying the country for this address.

String 2

19 Reserved8 1

20 TelephoneNumber The telephone number for this Subject String 50

21 OrganizationIdentificationNumber Organization Identification Number String 40

22 OrganizationIdentificationNumber.DNBCodeValue

Integer 7

23 InquiryDetail. TelephoneNumber.OrganizationIdentificationNumberDetail.OrganizationIdentificationNumber.TypeText

*** Currently not supported *** String 256

D&B Direct API Documentation Cleanse and Match CDL Output



Length

24 MatchDataCriteriaText *** Currently not supported *** String 256

25 MatchDataCriteriaText. DNBCodeValue *** Currently not supported *** Integer 7

26 DUNSNumber The D-U-N-S Number is DandBs identificationnumber, which provides unique identificationof this organization, in accordance with theData Universal Numbering System (D-U-N-S).

Integer 15

27 OrganizationPrimaryName.OrganizationName

String 256

28 TradeStyleName .OrganizationName String 256

29 SeniorPrinicipalName. FullName *** Currently not supported *** String 240

30 PrimaryAddress. StreetAddressLine1 First Line of this Organization Address String 240

31 PrimaryAddress. StreetAddressLine2 Second Line of this Organization Address String 240

32 PrimaryAddress. PrimaryTownName The name of the town or city recognized bythe Postal Authority for delivering mail.

String 64

33 PrimaryAddress. CountryISOAlpha2Code The two-letter country code, defined in theISO 3166-1 scheme published by InternationalOrganization for Standardization (ISO),identifying the country for this address.

String 2

34 PrimaryAddress. PostalCode Postal Code with Extension String 16

35 PrimaryAddress. PostalCodeExtensionCode *** Currently not supported *** String 16

36 PrimaryAddress. TerritoryOfficialName *** Currently not supported *** String 64

37 PrimaryAddress. TerritoryAbbreviatedName Territory Abbreviated Name Available only forUS and Canada

String 64

38 PrimaryAddress. UndeliverableIndicator(a.k.a. Nixie)

Both 0/1 OR Y/N can be returned in this field.0=Deliverable 1=Undeliverable N=DeliverableY=Undeliverable

Boolean 1

39 TelephoneNumber.TelecommunicationNumber

The telephone number for this Subject String 50

40 TelephoneNumber. UnreachableIndicator(a.k.a. Tixie)

*** Currently not supported *** Boolean 1

41 Out of Business Indicator Both 0/1 OR Y/N can be returned in this field.0 = In business; 1- Out of Business; N = Inbusiness; Y- Out of Business

String 256

42 OperatingStatusText. DNBCodeValue *** Currently not supported *** Integer 7

43 StandAloneOrganizationIndicator *** Currently not supported *** String 256

44 FamilyMemberRole.FamilyMemberRoleText. DNBCodeValue

*** Currently not supported *** Integer 7

45 StandaloneOrganizationIndicator Boolean 1

46 OrganizationIdentificationNumberDetail.OrganizationIdentificationNumber

String 40




Length

47 OrganizationIdentificationNumberDetail.DNBCodeValue

Integer 7

48 OrganizationIdentificationNumberDetail.DNBTypeText


49 MatchQualityInformation.ConfidenceCodeValue

Integer 2

50 MatchQualityInformation.MatchGradeText String 11

51 MatchQualityInformation.MatchGradeComponent_1.MatchGradeComponentScore

Float 11


Float 11


Float 11


Float 11


Float 11


Float 11


Float 11


Float 11


Float 11


Float 11


Float 11

62 MatchQualityInformation.MatchDataProfileComponent_1.MatchDataProfileComponentValue

String 2




Length


String 2


String 2


String 2


String 2


String 2


String 2


String 2


String 2


String 2


String 2


String 2


String 2


String 2

76 CleanseAndStandardizeResponseDetail.StandardizedName. OrganizationName

String 256




Length

77 CleanseAndStandardizeResponseDetail.StandardizedName. OrganizationName.LanguageCode

*** Currently not supported *** Integer 7

78 CleanseAndStandardizeResponseDetail.StandardizedName. OrganizationName.WritingScriptISOAlpha4Code


79 CleanseAndStandardizeResponseDetail.StandardizedAddress. StreetAddressLine1

First line of this Organization's address String 240

80 CleanseAndStandardizeResponseDetail.StandardizedAddress. StreetAddressLine2

Second line of this Organization's address String 240

81 CleanseAndStandardizeResponseDetail.StandardizedAddress. PrimaryTownName

The name of the town or city recognized bythe Postal Authority for delivering mail.

String 64

82 CleanseAndStandardizeResponseDetail.StandardizedAddress. CountyName

String 64

83 CleanseAndStandardizeResponseDetail.StandardizedAddress.TerritoryAbbreviatedName

String 64

84 CleanseAndStandardizeResponseDetail.StandardizedAddress. TerritoryName

String 64

85 CleanseAndStandardizeResponseDetail.StandardizedAddress. PostalCode

String 16

86 CleanseAndStandardizeResponseDetail.StandardizedAddress.PostalCodeExtensionCode


87 CleanseAndStandardizeResponseDetail.StandardizedAddress.CountryISOAlpha2Code

The two-letter country code, defined in theISO 3166-1 scheme published by InternationalOrganization for Standardization (ISO),identifying the country for this address.

String 2

88 CleanseAndStandardizeResponseDetail.StandardizedAddress. CountryName

String 64




Length

89 CleanseAndStandardizeResponseDetail.StandardizedAddress.DeliveryPointValidationDetail. StatusValue

BR: Y - Submitted address is valid, including, if

required for delivery, the secondary address:

suite, room, floor or apartment #. This is

equal to DSF Deliverability Indicator #1.

N - Submitted address is invalid and possibly

to definitely undeliverable. It might however,

qualify for a ZIP+4. This is equal to DSF

Deliverability Indicator #4 or higher or X.

S - Secondary address invalid: submitted

street address is valid, but the submitted

secondary address - the suite, room, floor or

apartment # -- required for delivery at this

location, is incorrect. This address is possibly

deliverable, at the letter carrier's

option. This is equal to DSF Deliverability

Indicator #2.

D - Secondary address missing: submitted

street address is valid, but the secondary

address - the suite, room, floor or apartment

# -- required for delivery at this location, is

missing. This address is possibly deliverable,

at the letter carrier's option.

L - Submitted address is invalid, undeliverable

and could not be identified by DPV. This is a

fictitious address on the DPV file designed to

identify mis-use of USPS data. Contact your

DB rep.

Blank - DPV cannot categorize the input

address.

String 64




Length

90 CleanseAndStandardizeResponseDetail.StandardizedAddress.DeliveryPointValidationDetail. CMRAValue

BR: Y - The address is a valid Commercial Mail

Receiving Agency (CMRA). A CMRA is a private

business that accepts mail delivery from the

Postal Service for others (addressee), holds it

for pickup (in most cases a private mailbox

("PMB") or re-mails it to another

address with payment of new postage.

(Example: “Mailboxes, Etc.”)

N - The address is not a valid Commercial Mail

Receiving Agency (CMRA).

L - Submitted address is invalid, undeliverable

and could not be identified by DPV. These are

“decoy,” fantasy addresses.

Blank - DPV cannot categorize the input

address

String 64

91 CleanseAndStandardizeResponseDetail.StandardizedAddress. AddressTypeValue

String 64



Batch ServiceVersion 2.0 (API) / 1.0 (Service)

This service is designed to allow multiple product or feature requests to be submitted as an asynchronousAPI call. When the batch is completed, the results may be retrieved using a separate function.

Functions

This D&B Direct service includes the following functionality. The respective SOAP and/or REST pages providetechnical details including input parameters, responses and sample requests.

Function Operation / SOAP Resource / REST

Submit a new batch of requests. ProcessBatch() POST Batches

List previously submitted batches. ListBatch() GET Batches

Retrieve details for a specific batch. GetBatchResults() GET Batches/{batchID}

The Process Batch function will process up to the pre-configured amount designated on the contract (to amaximum of 10,000). Batches are queued and processed on a first-come, first-served basis.

The List Batch function will return details on all submitted batches (queued, in process and completed), andreturns a {batchID}.

The Get Batch Results function returns the results for an individual batch request if/when it is completed.

Batch Process Details

The following item(s) may be requested by using this service.

Feature / Overview Link Batch Process ID

On-Demand Multiple Entity Resolution (Asynchronous) BTCH_CleanseMatch

Maintenance Window

There is a pre-scheduled weekly maintenance window for the Batch Service between Saturday 11:00 PM andSunday 9:00 AM (EST); however, the service will only be unavailable if/when updates are being applied.

D&B Direct API Documentation Batch Service


Interfaces & Endpoints

D&B Direct implements version control at the web service level, in addition to the API level. This D&B Direct2.0 {version} of the Batch Service is 1.0. When contacting D&B customer support, please provide both the APIand Service version numbers. The following table(s) identify version-specific access points for the availableAPI interfaces.

SOAP

Endpoint https://maxcvservices.dnb.com:8443/V{version}/BatchService

WSDL* http://developer.dnb.com/docs/2.0/assessment/1.0/BatchService.zip

*There may be operations defined in the WSDL that are not available to D&B Direct customers at this time.

REST

ProcessBatch POST https://maxcvservices.dnb.com:8443/V{version}/Batches

ListBatch GET https://maxcvservices.dnb.com:8443/V{version}/Batches

GetBatchResults GET https://maxcvservices.dnb.com:8443/V{version}/Batches/{batchID}

D&B Direct API calls must be made using Secured Socket Layers (SSL) as noted in the preceding table(s).

Sandbox (REST)

ProcessBatch POST https://maxcvservices.dnb.com:8443/V{version}/sandbox

ListBatch GET https://maxcvservices.dnb.com:8443/V{version}/sandbox

GetBatchResults GET https://maxcvservices.dnb.com:8443/V{version}/sandbox/{batchID}

Authentication N/A; All sandbox requests uses a Fixed Token*

*Sandbox Token:jAu4dMpeUcgrDE0J66k3x5AUm+3ej7Dq2+Pl2TTwtbOC06c+szLpjs8yzMYFKvjPXOBrGRCr61LkVedVC9w0NChRFMUlWopw/KQRv9GHWDOV5yvK43Tt4fTYA6cgVef9wb572rHNHlisRFm4789nw8re+K9jgoO9LvlIhs9IgZUbGRaIAttKDYFmtLSKDmjjZWoo7RPiwqaZR4dFLQ86v10038clavB/lqJtu6zo6qmep7Na2xU7Ot+UcWA0bMA18gnFikzptbbqu/DP6Fa89s6itBrEbFn5iD88KCRPQfImtD6li7g+Rt7CdracVkQv7vkxO9LvrVc4YqTVJX51xqzuP1HuCYE3/Kdnn1B3pSZjw4xy5nq03LFu8HJ9VF89

D&B Direct API Documentation Interfaces & Endpoints


ProcessBatch (REST)This operation -- part of the Batch Service -- provides access to multiple products and/or features, controlledby unique batch process IDs (listed in the following table).

Feature / Overview Link Batch Process ID Countries

On-Demand Multiple Entity Resolution (Asynchronous) BTCH_CleanseMatch All

Authentication & Endpoint

D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.

Exception: The expiration of Authentication Tokens for this service is 30 minutes.

Endpoint

POST https://maxcvservices.dnb.com:8443/V{version}/Batches

Batch Request Files

This operation requires two text files be prepared and attached to the request. The first file must have a fileextension of "CSV" and include fully quote-enclosed, comma-delimited formatted requests. The second filemust have a file extension of "XML" and include the following match specification parameters in XML format.

XML Element Description

GetCleanseMatchRequest.GetCleanseMatchRequestDetail. MatchSpecification.ConfidenceLowerLevelThresholdValue

A numeric value from 1 (low) up to 10 (high) indicating the

required level of certainty at which a possible Candidate should

be included in the result set.

Possible Values: 1 – 10

GetCleanseMatchRequest.GetCleanseMatchRequestDetail. MatchSpecification.ExclusionCriteria. ExclusionDataDescription

Can repeat multiple times to allow the recording of filtering

requirements that a service should apply to prevent subjects

from being returned in a match response. For example exclude

subjects from the candidate list that are out of business.

Possible Values: Exclude Non Marketable, Exclude Out of

Business, Exclude Undeliverable.

D&B Direct API Documentation ProcessBatch (REST)



GetCleanseMatchRequest.GetCleanseMatchRequestDetail. MatchSpecification.IncludeCleansedAndStandardizedInformationIndicator

When TRUE this denotes that the cleansed and standardized

information should be included in the response.

When FALSE this denotes that the cleansed and standardized

information should not be included in the response.

Possible Values: true / false

Request Parameters

Exception: This operation currently does not support JSON. Requests must be submitted in XML format.

The following parameters are accepted by this operation; however, this operation can only be invoked using aPOST request.

The number of product requests allowed per operation batch is designated on the customer contract (up to amaximum of 10,000).

Exception: Calls to this operation must be submitted as a multi-part POST request, with the batch requestfiles appended as separate parts.

Content-Type: multipart/form-data

Content-Transfer-Encoding: 8bit

Name Characteristics

ProcessBatchRequest Aggregate

ProcessBatchRequest. BatchDetail Aggregate, Required

Records information necessary to process a

particular request.

ProcessBatchRequest. BatchDetail. ApplicationBatchID string up to 64 chars., Required

A number assigned by consuming application

(e.g., GIH) which is used to uniquely identify a

batch request.

D&B Direct API Documentation Request Parameters



ProcessBatchRequest. BatchDetail. MessageTimeStamp dateTime, Required

The date and time when this message was

created. When the message is from an

intermediary, such as a workflow manager or

service bus, this is the date and time when

the message was sent to or from the D&B

function,

END: ProcessBatchRequest. BatchDetail /Aggregate

ProcessBatchRequest. BatchSpecification Aggregate, Required

Records specific information that are required

for processing a Batch Request.

ProcessBatchRequest. BatchSpecification. BatchProcessID string up to 32 chars., Required

A number assigned by the composite service

which is used to uniquely identify the

business function to be performed (e.g.,

Match, Cleanse, Match and Cleanse).

Possible values: CPCM_CM

ProcessBatchRequest. BatchSpecification. BatchSpecificationObject Aggregate, Optional (Infinite)

Possible values: Should give one specification

Object for CPCM_CM

ProcessBatchRequest. BatchSpecification. BatchSpecificationObject.ContentObject

Include statement1, Required

Example: <Include href="cid:Control.xml"/>

ProcessBatchRequest. BatchSpecification. BatchSpecificationObject.ObjectFormatTypeText

string up to 5 chars., Required

XML,CSV,JSON

Possible values: XML

ProcessBatchRequest. BatchSpecification. BatchSpecificationObject.LayoutName


The name of the layout for this collection of

the data records. For example the layout

names 'GBI' denotes the Global Batch Input

layout.

Possible values: Company Service




END: ProcessBatchRequest. BatchSpecification.BatchSpecificationObject

/Aggregate

END: ProcessBatchRequest. BatchSpecification /Aggregate

ProcessBatchRequest. InputDetail Aggregate, Required

Records information about the input into the

Batch process.

ProcessBatchRequest. InputDetail. InputObjectDetail Aggregate, Optional (Infinite)

ProcessBatchRequest. InputDetail. InputObjectDetail. ContentObject Include statement2, Required

Example: <Include href="cid:Request.csv"/>

ProcessBatchRequest. InputDetail. InputObjectDetail.ObjectFormatTypeText


XML,CSV,JSON

Possible values: CSV

ProcessBatchRequest. InputDetail. InputObjectDetail. LayoutName string up to 32 chars., Required

The name of the layout for this collection of

the data records. For example the layout

names 'GBI' denotes the Global Batch Input

layout.

Possible values: PCMGBIMatch

ProcessBatchRequest. InputDetail. InputObjectDetail. LayoutVersion string up to 10 chars., Required

The version of the Layout

Possible values: 1.0

ProcessBatchRequest. InputDetail. InputObjectDetail.CompressTypeValue

string up to 64 chars., Optional

Text that describes the compresssion

software that has been used to reduce the

size of this collection of data records.

Possible values: None




ProcessBatchRequest. InputDetail. InputObjectDetail. RecordsCount unsignedLong, Optional

A numeric value denoting the number of

records contained in the input file.

Possible values: vary based on performance

and customer

END: ProcessBatchRequest. InputDetail. InputObjectDetail /Aggregate

END: ProcessBatchRequest. InputDetail /Aggregate

ProcessBatchRequest. OutputSpecification Aggregate, Required

Records information about the output

specification.

ProcessBatchRequest. OutputSpecification. ObjectFormatTypeText string up to 5 chars., Required

XML,CSV,JSON


ProcessBatchRequest. OutputSpecification. CompressTypeValue string up to 64 chars., Optional

Text that describes the compresssion

software that has been used to reduce the

size of this collection of data records.

Possible values: None

END: ProcessBatchRequest. OutputSpecification /Aggregate

END: ProcessBatchRequest /Aggregate

1 The file contents should be appended to the request as a separate part. The file name specified in the Includestatement must match the part header:

Content-Type: text/xml; charset=Cp1252; name=Control.xml

Content-Transfer-Encoding: binary

Content-Disposition: form-data; name="Control.xml"; filename="Control.xml"

2 The file contents should be appended to the request as a separate part. The file name specified in the Includestatement must match the part header:

Content-Type: application/octet-stream; name=Request.csv

Content-Transfer-Encoding: binary

Content-Disposition: form-data; name="Request.csv"; filename="Request.csv"



Testing / Sandbox

This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless ofthe request parameters.

Data Field Response

Exception: This operation currently does not support JSON. The following is a list of the possible data fieldsreturned by this operation in the XML response.


ProcessBatchResponse Aggregate

ProcessBatchResponse@ServiceVersionNumber Attribute

ProcessBatchResponse. BatchDetail Aggregate

ProcessBatchResponse. BatchDetail.ApplicationBatchID

Element

ProcessBatchResponse. BatchDetail.ServiceBatchID

Element

END: ProcessBatchResponse. BatchDetail /Aggregate

ProcessBatchResponse. BatchResult Aggregate

ProcessBatchResponse. BatchResult.SeverityText

Element

Possible values: Error; Fatal; Information; Warning

ProcessBatchResponse. BatchResult. ResultID Element

Possible values: BC005; CM001; CM004; BC001; BC002; BC003;

BC004; CM003

ProcessBatchResponse. BatchResult. ResultText Element

Possible values: CM000 Success; BC005 Intermediate Notification;

CM001 The given request is invalid; CM004 Internal D&B system

error. Please try again or contact your local Customer Service Center;

BC001 Partial Success; BC002 Batch request is not processed since

input file is not available in the specified location; BC003 Batch

request is not processed since the content of the input file is not in

the expected format or has invalid data; BC004 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;

ProcessBatchResponse. BatchResult.ResultMessage

Aggregate

ProcessBatchResponse. BatchResult.ResultMessage. ResultDescription

Element

D&B Direct API Documentation Testing / Sandbox



END: ProcessBatchResponse. BatchResult.ResultMessage

/Aggregate

END: ProcessBatchResponse. BatchResult /Aggregate

ProcessBatchResponse. BatchProcessSummary Aggregate

ProcessBatchResponse. BatchProcessSummary.ExecutionTimeSummary

Aggregate

ProcessBatchResponse. BatchProcessSummary.ExecutionTimeSummary.BatchRequestCreatedTimeStamp

Element

ProcessBatchResponse. BatchProcessSummary.ExecutionTimeSummary.BatchReceivedTimeStamp

Element

END: ProcessBatchResponse.BatchProcessSummary.ExecutionTimeSummary

/Aggregate

ProcessBatchResponse. BatchProcessSummary.RecordSummary

Aggregate

ProcessBatchResponse. BatchProcessSummary.RecordSummary. TotalInputRecordCount

Element

END: ProcessBatchResponse.BatchProcessSummary. RecordSummary

/Aggregate

ProcessBatchResponse. BatchProcessSummary.BatchPriorityValue

Element

Possible values: 1 to 10; 10 - High; 1 - Low

END: ProcessBatchResponse.BatchProcessSummary

/Aggregate

END: ProcessBatchResponse /Aggregate

Language/Character Sets

The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (sometimes referred to as Latin-1), EXCEPT when the organization isdomiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets iscurrently encoded using the ISO 8859-2 character set standard.

Response Codes

Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.

This operation may return the following response codes: CM002, CM003, CM004, and SC001-SC005.

D&B Direct API Documentation Language/Character Sets


Operation-specific supplemental response code explanations:

Code Result Text Extended Message

CM000 Success Success

CM002 Compression type not mentioned Missing CompressTypeValue under the aggregateInputObjectDetail, plese send this tag

CM002 Input Format Type not mentioned Input Missing ObjectFormatTypeText under theaggregate InputObjectDetail, plese send this tag

CM002 Invalid Control message format Please check the value of ObjectFormatTypeTextunder the aggregate BatchSpecificationObject Referdocumentation

CM002 Invalid Control message layout name Please check the value of LayoutName under theaggregate BatchSpecificationObject Referdocumentation

CM002 Invalid Input Compression mentioned Please check the value of CompressTypeValue underthe aggregate InputObjectDetail Referdocumentation

CM002 Invalid input format Please check the value of ObjectFormatTypeTextunder the aggregate InputObjectDetail Referdocumentation

CM002 Invalid Input layout name Please check the value of LayoutName under theaggregate InputObjectDetail Refer documentation

CM002 Invlid Batch Process ID Please check the value of BatchProcessID under theaggregate BatchSpecification Refer documentation

CM002 The format of this request is invalid or invalidparameter sent. Please correct it and try again.

The format of this request is invalid or invalidparameter sent. Please correct it and try again.

CM003 Control message format not mentioned Missing ObjectFormatTypeText under the aggregateBatchSpecificationObject, plese send this tag

CM003 Control message layout name not mentioned Missing LayoutName under the aggregateBatchSpecificationObject, plese send this tag

CM003 Input layout name not mentioned Missing LayoutName under the aggregateInputObjectDetail, plese send this tag

CM003 Missing Batch Process ID Missing BatchProcessID under the aggregateBatchSpecification, plese send this tag

CM003 Missing information (or) empty attachment (or)multiple attachments in the request. Please correct andtry again.

Missing information (or) empty attachment (or)multiple attachments in the request. Please correctand try again.

CM004 Internal D&B error. Please try again or contactyour local Customer Service Center.

Internal D&B error. Please try again or contactyour local Customer Service Center.

SC001 User Credentials Missing. Please fill in the usercredentials and try again.

Token or Application Id Missing. Please fill in the usercredentials and try again.

SC002 You are not entitled for this enquired product. Pleasecontact your D&B Representative or your localCustomer Service Center.

Your are not entitled for this enquired product. Pleasecontact your D&B Representative or your localCustomer Service Center.

D&B Direct API Documentation Response Codes



SC002 Your user credentials are not eligible for this request.Please contact your D&B Representative or yourlocal Customer Service Center.

Invalid user credentails. Please contact yourD&B Representative or your local CustomerService Center.

SC004 Your contract has expired. Please contact yourD&B Representative or your local CustomerService Center.

Your contract has expired. Please contact yourD&B Representative or your local CustomerService Center.

SC005 You have exceeded maximum records limit. Pleasereduce inputs records count and try again.

You have crossed maximum records limit per batch.Please reduce inputs records count and try again.

Samples (Download)

Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.

Batch Service

Samples http://developer.dnb.com/docs/2.0/batch/1.0/DnB-Batch.zip

Related Topics

ListBatch (REST), GetBatchResults (REST).

D&B Direct API Documentation Samples (Download)


ProcessBatch (SOAP)This operation -- part of the Batch Service -- provides access to multiple products and/or features, controlledby unique batch process IDs (listed in the following table).

Feature / Overview Link Batch Process ID Countries

On-Demand Multiple Entity Resolution (Asynchronous) BTCH_CleanseMatch All



Endpoint

https://maxcvservices.dnb.com:8443/V{version}/BatchService

Batch Request Files

This operation requires two text files be prepared and embedded in the request as Base64 encodedobjects. The first file must include fully quote-enclosed, comma-delimited formatted requests. The second filemust include the following match specification parameters in XML format.


GetCleanseMatchRequest.GetCleanseMatchRequestDetail. MatchSpecification.ConfidenceLowerLevelThresholdValue

A numeric value from 1 (low) up to 10 (high) indicating the

required level of certainty at which a possible Candidate should

be included in the result set.

Possible Values: 1 – 10

GetCleanseMatchRequest.GetCleanseMatchRequestDetail. MatchSpecification.ExclusionCriteria. ExclusionDataDescription

Can repeat multiple times to allow the recording of filtering

requirements that a service should apply to prevent subjects

from being returned in a match response. For example exclude

subjects from the candidate list that are out of business.

Possible Values: Exclude Non Marketable, Exclude Out of

Business, Exclude Undeliverable.

D&B Direct API Documentation ProcessBatch (SOAP)



GetCleanseMatchRequest.GetCleanseMatchRequestDetail. MatchSpecification.IncludeCleansedAndStandardizedInformationIndicator

When TRUE this denotes that the cleansed and standardized

information should be included in the response.

When FALSE this denotes that the cleansed and standardized

information should not be included in the response.

Possible Values: true / false

Request Parameters

The following parameters are accepted by this operation; however, this operation can only be invoked using aPOST request.

The number of product requests allowed per operation batch is designated on the customer contract (up to amaximum of 10,000).




ProcessBatchResponse. BatchDetail Aggregate


Element


Element


ProcessBatchResponse. BatchResult Aggregate


Element


ProcessBatchResponse. BatchResult. ResultID Element


BC004; CM003




ProcessBatchResponse. BatchResult. ResultText Element











Aggregate


Element


/Aggregate


ProcessBatchResponse. BatchProcessSummary Aggregate


Aggregate


Element


Element


/Aggregate


Aggregate


Element


/Aggregate


Element



/Aggregate




Testing / Sandbox

This operation is currently unavailable in the D&B Direct sandbox (test) environment.

Data Field Response

The following is a list of the possible data fields returned by this operation in the XML response.




ProcessBatchResponse. BatchDetail Aggregate, Required

Records information necessary to return a particular response.

ProcessBatchResponse. BatchDetail Aggregate, Required




A number assigned by consuming application (e.g., GIH) which is used

to uniquely identify a batch request.



A number assigned by consuming application (e.g., GIH) which is used

to uniquely identify a batch request.



A number assigned by the composite service (e.g.,

MatchCleanseService, GHM) which is used to uniquely identify a

batch request.



A number assigned by the composite service (e.g.,

MatchCleanseService, GHM) which is used to uniquely identify a

batch request.


ProcessBatchResponse. BatchResult Aggregate, Optional

Records information about the result of the process.




ProcessBatchResponse. BatchResult Aggregate, Optional



string, Required

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

Warning, Error, Fatal.




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

Warning, Error, Fatal.


ProcessBatchResponse. BatchResult. ResultID string up to 32 chars., Required

An alphanumeric string that uniquely identifies the outcome of the

batch.


BC004; CM003

ProcessBatchResponse. BatchResult. ResultID string up to 32 chars., Required

An alphanumeric string that uniquely identifies the outcome of the

batch.


BC004; CM003

D&B Direct API Documentation Data Field Response



ProcessBatchResponse. BatchResult. ResultText string up to 512 chars., Optional

Text that explains the outcome of the batch.










ProcessBatchResponse. BatchResult. ResultText string up to 512 chars., Optional












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 batch. If the

status implies that there is a problem this may also provide guidance

to the user on how to address it.



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 batch. If the

status implies that there is a problem this may also provide guidance

to the user on how to address it.






Text that describes the additional information regarding the outcome

of the batch.



Text that describes the additional information regarding the outcome

of the transaction.


/Aggregate


ProcessBatchResponse. BatchProcessSummary Aggregate, Optional

Records information about the process time and the number of

records processed.

ProcessBatchResponse. BatchProcessSummary Aggregate, Optional

Records information about the process time and the number of

records processed.


Aggregate, Optional

Records information about the process time and completion time.


Aggregate, Optional



dateTime, Required

The date and time when the batch request was created by the

submitting application.


dateTime, Required

The date and time when the batch request was created by the

submitting application.


dateTime, Optional

The date and time when the batch request was received by the

service.





dateTime, Optional

The date and time when the batch request was received by the

service.


/Aggregate


Aggregate, Optional

Records information about the number of input and output records,

and the count of the number of records which have passed and failed

the requested process.


Aggregate, Optional

Records information about the number of input and output records,

and the count of the number of records which have passed and failed

the requested process.


integer, Optional

A numeric value denoting the total number of records contained in

the input file.


integer, Optional

A numeric value denoting the total number of records contained in

the input file.


/Aggregate


int, Optional

A number between 1 and 10 denoting the level of urgency for this

Batch Job. A batch job with the priority value 10 has the highest level

of urgency.






int, Optional

A number between 1 and 10 denoting the level of urgency for this

Batch Job. A batch job with the priority value 10 has the highest level

of urgency.



/Aggregate




Response Codes



Operation-specific supplemental response code explanations:


CM000 Success Success

CM002 Compression type not mentioned Missing CompressTypeValue under the aggregateInputObjectDetail, plese send this tag

CM002 Input Format Type not mentioned Input Missing ObjectFormatTypeText under theaggregate InputObjectDetail, plese send this tag

CM002 Invalid Control message format Please check the value of ObjectFormatTypeTextunder the aggregate BatchSpecificationObject Referdocumentation

CM002 Invalid Control message layout name Please check the value of LayoutName under theaggregate BatchSpecificationObject Referdocumentation




CM002 Invalid Input Compression mentioned Please check the value of CompressTypeValue underthe aggregate InputObjectDetail Referdocumentation

CM002 Invalid input format Please check the value of ObjectFormatTypeTextunder the aggregate InputObjectDetail Referdocumentation

CM002 Invalid Input layout name Please check the value of LayoutName under theaggregate InputObjectDetail Refer documentation

CM002 Invlid Batch Process ID Please check the value of BatchProcessID under theaggregate BatchSpecification Refer documentation

CM002 The format of this request is invalid or invalidparameter sent. Please correct it and try again.

The format of this request is invalid or invalidparameter sent. Please correct it and try again.

CM003 Control message format not mentioned Missing ObjectFormatTypeText under the aggregateBatchSpecificationObject, plese send this tag

CM003 Control message layout name not mentioned Missing LayoutName under the aggregateBatchSpecificationObject, plese send this tag

CM003 Input layout name not mentioned Missing LayoutName under the aggregateInputObjectDetail, plese send this tag

CM003 Missing Batch Process ID Missing BatchProcessID under the aggregateBatchSpecification, plese send this tag

CM003 Missing information (or) empty attachment (or)multiple attachments in the request. Please correct andtry again.

Missing information (or) empty attachment (or)multiple attachments in the request. Please correctand try again.

CM004 Internal D&B error. Please try again or contactyour local Customer Service Center.

Internal D&B error. Please try again or contactyour local Customer Service Center.

SC001 User Credentials Missing. Please fill in the usercredentials and try again.

Token or Application Id Missing. Please fill in the usercredentials and try again.

SC002 You are not entitled for this enquired product. Pleasecontact your D&B Representative or your localCustomer Service Center.

Your are not entitled for this enquired product. Pleasecontact your D&B Representative or your localCustomer Service Center.

SC002 Your user credentials are not eligible for this request.Please contact your D&B Representative or yourlocal Customer Service Center.

Invalid user credentails. Please contact yourD&B Representative or your local CustomerService Center.

SC004 Your contract has expired. Please contact yourD&B Representative or your local CustomerService Center.

Your contract has expired. Please contact yourD&B Representative or your local CustomerService Center.

SC005 You have exceeded maximum records limit. Pleasereduce inputs records count and try again.

You have crossed maximum records limit per batch.Please reduce inputs records count and try again.



Samples (Download)


Batch Service


Related Topics

ListBatch (SOAP), GetBatchResults (SOAP).



ListBatch (REST)This operation -- part of the Batch Service -- provides access to the list of submitted batch requests (queued, inprocess and completed).




Endpoint

GET https://maxcvservices.dnb.com:8443/V{version}/Batches

Request Parameters

The following parameters are accepted by this operation.

Exception: The Application TransactionID, TransactionTimestamp and SubmittingOfficeID fields arerequired for this operation. Please contact a D&B sales associate to obtain the correct SubmittingOfficeIDvalue.


ServiceVersionNumber Element

ApplicationTransactionID string up to 64 chars., Required

A number assigned by the

calling application to uniquely

identify this request.

D&B Direct API Documentation ListBatch (REST)



TransactionTimestamp DateTimestamp, Required

The date and time when this

request was created. When the

request is from an

intermediary, such as a

workflow manager or service

bus, this is the date and time

when the message was sent to

the D&B function, i.e., the date

and time when the xml

document was created by the

requesting intermediary.

SubmittingOfficeID string up to 64 chars., Required

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.

ServiceBatchID string up to 64 chars., Optional


composite service (e.g.,

MatchCleanseService, GHM)

which is used to uniquely

identify a batch request.

BatchSubmittedFromTimestamp dateTime, Optional

BatchSubmittedToTimestamp dateTime, Optional

Up to a maximum of 50 Batches will be returned by this operation. Batches will be returned in the descendingorder of the submission date (Latest Batch on the top)

Customers can optionally filter the results by providing one of the following filter conditions

1. Up to a maximum of 50 ServiceBatchIds can be provided in the request (separated by a dot [“.”]). In thiscase, only the details for the given ServiceBatchIds will be returned in the response.



2. The “from” and “to” dates of the batch submission can be provided in the request. In this case, only thebatches submitted between the specified dates will be retuned in the response.*

* If both ServiceBatchIds AND “from” / “to” dates are provided in the request, only the ServiceBatchId list willbe considered. “From” / “to” dates will be ignored by the service.

Testing / Sandbox


Data Field Response



ListBatchResponse Aggregate

ListBatchResponse. TransactionDetail Aggregate, Optional

Records information necessary to process

this request.

ListBatchResponse. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application

to uniquely identify this request.

ListBatchResponse. TransactionDetail. ServiceTransactionID string up to 64 chars., Required

A number assigned by the D&B service to

uniquely identify this transaction.

ListBatchResponse. TransactionDetail. TransactionTimestamp 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.

END: ListBatchResponse. TransactionDetail /Aggregate




ListBatchResponse. TransactionResult Aggregate, Required

An aggregate that can repeat multiple times

to record the different outcomes of the

transaction.

ListBatchResponse. TransactionResult. SeverityText string, Required

Text that records the criticality of the

outcome, e.g., Information, Warning, Error,

Fatal.

ListBatchResponse. TransactionResult. ResultID string up to 32 chars., Required

An alphanumeric string that uniquely

identifies the outcome of the transaction.

ListBatchResponse. TransactionResult. ResultText string up to 512 chars., Optional

Text that explains the outcome of the

transaction.

ListBatchResponse. TransactionResult. ResultMessage Aggregate, Optional (Infinite)


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.

ListBatchResponse. TransactionResult. ResultMessage. ResultDescription string up to 512 chars., Required

Text that describes the additional

information regarding the outcome of the

batch.

END: ListBatchResponse. TransactionResult. ResultMessage /Aggregate

END: ListBatchResponse. TransactionResult /Aggregate




ListBatchResponse. ListBatchResponseDetail Aggregate, Optional

An entry loop which can repeat multiple

times to allow the recording of the details

on the status of the supplier records in a

registration batch file uploaded by the user.

ListBatchResponse. ListBatchResponseDetail.CandidateReturnedQuantity

int up to 6 digits., Required

The number of candidates returned for the

search criteria.

Possible values: maximum 50

ListBatchResponse. ListBatchResponseDetail.CandidateMatchedQuantity


The number of candidates matched for the

search criteria.


ListBatchResponse. ListBatchResponseDetail. Batch Aggregate, Optional (Infinite)

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail Aggregate, Required

Records information necessary to return a

particular response.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail.ApplicationBatchID


A number assigned by consuming

application (e.g., GIH) which is used to

uniquely identify a batch request.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail.ServiceBatchID



(e.g., MatchCleanseService, GHM) which is

used to uniquely identify a batch request.




ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail.MessageTimeStamp

dateTime, Required



intermediary, such as a workflow manager

or service bus, this is the date and time

when the message was sent to or from the

D&B function.

END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail /Aggregate

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult Aggregate, Optional

Records information about the result of the

process.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.SeverityText

string, Required



Fatal.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultID



identifies the outcome of the batch.

Possible values: BC005; CM001; CM004;

BC001; BC002; BC003; BC004




ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultText



batch.

Possible values: CM000 Success; BC005

Intermediate Notification; CM001 The given

request is invalid; CM004 Internal D&B

system error. Please try again or contact

your local Customer Service Center; BC001

Partial Success; BC002 Batch request is not

processed since input file is not available in

the specified location; BC003 Batch request

is not processed since the content of the

input file is not in the expected format or

has invalid data; BC004 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;

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultMessage






status of the batch. If the status implies

that there is a problem this may also provide

guidance to the user on how to address it.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultMessage. ResultDescription




batch.

END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultMessage

/Aggregate

END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult /Aggregate

END: ListBatchResponse. ListBatchResponseDetail. Batch /Aggregate

END: ListBatchResponse. ListBatchResponseDetail /Aggregate

END: ListBatchResponse /Aggregate



Batch Result Codes

These codes indicates the status of a specific Batch.

CM001 Error The given request is invalid. The given input request(not inputfile) is incorrect

CM004 Fatal Internal D&B system error. Please try again or contact yourlocal Customer Service Center.

Could not process the job due tosome internal system error

BC001 Warning Partial Success. Job processed successfully.However there are some errorrecords.

BC003 Error Batch request is not processed since the content of the inputfile is not in the expected format or has invalid data.

The input file is not in therequired format

BC004 Error Batch request is not processed since the count of the recordsspecified in the request do not match the exact count ofrecords in the input file.

Mismatch is the records countfield to the number of records inthe input file.

BC005 Information Job In Progress Job is still under execution



Response Codes



Samples (Download)


Batch Service


D&B Direct API Documentation Batch Result Codes


Related Topics

ProcessBatch (REST), GetBatchResults (REST).

D&B Direct API Documentation Related Topics


ListBatch (SOAP)This operation -- part of the Batch Service -- provides access to the list of submitted batch requests (queued, inprocess and completed).



Endpoint


Request Parameters


Exception: The fields comprising the TransactionDetail aggregate are required for this operation. Pleasecontact a D&B sales associate to obtain the correct SubmittingOfficeID value.


ListBatchRequest Aggregate

ListBatchRequest@ServiceVersionNumber

Attribute

Possible values: 1

ListBatchRequest.TransactionDetail

Aggregate, Optional

Records information necessary to process this request.

ListBatchRequest.TransactionDetail.ApplicationTransactionID


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

ListBatchRequest.TransactionDetail.TransactionTimestamp

DateTimestamp, Optional

The date and time when this request was created. When the request is from an

intermediary, such as a workflow manager or service bus, this is the date and time

when the message was sent to the D&B function, i.e., the date and time when the

xml document was created by the requesting intermediary.

Possible values: e.g.: 2013-08-01T23:43:09.000-06:00

D&B Direct API Documentation ListBatch (SOAP)



ListBatchRequest.TransactionDetail.SubmittingOfficeID


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.

END: ListBatchRequest.TransactionDetail

/Aggregate

ListBatchRequest.ListBatchRequestDetail

Aggregate, Optional

Records data to view the status of the supplier records in a registration batch file

uploaded by the user.

ListBatchRequest.ListBatchRequestDetail.InquiryDetail

Aggregate, Optional

Records data that allows the customer to specify identifying information about the

subject being inquired.

ListBatchRequest.ListBatchRequestDetail.InquiryDetail. ServiceBatchID

string up to 64 chars., Optional (Infinite)

A number assigned by the composite service (e.g., MatchCleanseService, GHM)

which is used to uniquely identify a batch request.

ListBatchRequest.ListBatchRequestDetail.InquiryDetail.BatchSubmittedFromTimestamp

dateTime, Optional


Up to a maximum of 50 Batches will be returned by this operation. Batches will be returned in the descendingorder of the submission date (Latest Batch on the top)

Customers can optionally filter the results by providing one of the following filter conditions

1. Up to a maximum of 50 ServiceBatchIds can be provided in the request (separated by a dot [“.”]). In thiscase, only the details for the given ServiceBatchIds will be returned in the response.

2. The “from” and “to” dates of the batch submission can be provided in the request. In this case, only thebatches submitted between the specified dates will be retuned in the response.*

* If both ServiceBatchIds AND “from” / “to” dates are provided in the request, only the ServiceBatchId list willbe considered. “From” / “to” dates will be ignored by the service.

Testing / Sandbox




Data Field Response



ListBatchResponse Aggregate

ListBatchResponse. TransactionDetail Aggregate, Optional

Records information necessary to process

this request.

ListBatchResponse. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application

to uniquely identify this request.

ListBatchResponse. TransactionDetail. ServiceTransactionID string up to 64 chars., Required

A number assigned by the D&B service to

uniquely identify this transaction.

ListBatchResponse. TransactionDetail. TransactionTimestamp 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.

END: ListBatchResponse. TransactionDetail /Aggregate

ListBatchResponse. TransactionResult Aggregate, Required


to record the different outcomes of the

transaction.

ListBatchResponse. TransactionResult. SeverityText string, Required



Fatal.




ListBatchResponse. TransactionResult. ResultID string up to 32 chars., Required


identifies the outcome of the transaction.

ListBatchResponse. TransactionResult. ResultText string up to 512 chars., Optional


transaction.

ListBatchResponse. TransactionResult. ResultMessage Aggregate, Optional (Infinite)





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.

ListBatchResponse. TransactionResult. ResultMessage. ResultDescription string up to 512 chars., Required



batch.

END: ListBatchResponse. TransactionResult. ResultMessage /Aggregate

END: ListBatchResponse. TransactionResult /Aggregate

ListBatchResponse. ListBatchResponseDetail Aggregate, Optional

An entry loop which can repeat multiple

times to allow the recording of the details

on the status of the supplier records in a

registration batch file uploaded by the user.

ListBatchResponse. ListBatchResponseDetail.CandidateReturnedQuantity


The number of candidates returned for the

search criteria.





ListBatchResponse. ListBatchResponseDetail.CandidateMatchedQuantity


The number of candidates matched for the

search criteria.


ListBatchResponse. ListBatchResponseDetail. Batch Aggregate, Optional (Infinite)

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail Aggregate, Required

Records information necessary to return a

particular response.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail.ApplicationBatchID


A number assigned by consuming

application (e.g., GIH) which is used to


ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail.ServiceBatchID



(e.g., MatchCleanseService, GHM) which is

used to uniquely identify a batch request.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail.MessageTimeStamp

dateTime, Required



intermediary, such as a workflow manager

or service bus, this is the date and time

when the message was sent to or from the

D&B function.

END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail /Aggregate

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult Aggregate, Optional

Records information about the result of the

process.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.SeverityText

string, Required



Fatal.




ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultID



identifies the outcome of the batch.

Possible values: BC005; CM001; CM004;

BC001; BC002; BC003; BC004

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultText



batch.

Possible values: CM000 Success; BC005

Intermediate Notification; CM001 The given

request is invalid; CM004 Internal D&B

system error. Please try again or contact

your local Customer Service Center; BC001

Partial Success; BC002 Batch request is not

processed since input file is not available in

the specified location; BC003 Batch request

is not processed since the content of the

input file is not in the expected format or

has invalid data; BC004 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;

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultMessage






status of the batch. If the status implies

that there is a problem this may also provide

guidance to the user on how to address it.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultMessage. ResultDescription




batch.




END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult.ResultMessage

/Aggregate

END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult /Aggregate

END: ListBatchResponse. ListBatchResponseDetail. Batch /Aggregate

END: ListBatchResponse. ListBatchResponseDetail /Aggregate

END: ListBatchResponse /Aggregate

Batch Result Codes













Response Codes





Samples (Download)


Batch Service


Related Topics

ProcessBatch (SOAP), GetBatchResults (SOAP).



GetBatchResults (REST)This operation -- part of the Batch Service -- provides access to the results of an individual batch requestif/when it is completed.




Endpoint

GET https://maxcvservices.dnb.com:8443/V{version}/Batches/{batchID}

Request Parameters


Exception: The Application TransactionID, TransactionTimestamp and SubmittingOfficeID fields arerequired for this operation. Please contact a D&B sales associate to obtain the correct SubmittingOfficeIDvalue.


ServiceVersionNumber Element

ApplicationTransactionID string up to 64 chars., Required


calling application to uniquely

identify this request.

D&B Direct API Documentation GetBatchResults (REST)



TransactionTimestamp DateTimestamp, Required

The date and time when this

request was created. When the

request is from an

intermediary, such as a

workflow manager or service

bus, this is the date and time

when the message was sent to

the D&B function, i.e., the date

and time when the xml

document was created by the

requesting intermediary.

SubmittingOfficeID string up to 64 chars., Required

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.

{batchID} string up to 64 chars., Required


composite service (e.g.,

MatchCleanseService, GHM)

which is used to uniquely

identify a batch request.

Testing / Sandbox




Batch Result Files

This operation delivers two text files that will be delivered as plain text MTOM attachments. One of the filesreturned will be a failed transaction (ERR) list; copies of the lines from the request file that were not able to beprocessed. The other file will be a list of comma-delimited formatted responses.

Data Field Response



GetBatchResultsResponse Aggregate

GetBatchResultsResponse.TransactionDetail

Aggregate, Optional


GetBatchResultsResponse.TransactionDetail.TransactionTimestamp

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.

END: GetBatchResultsResponse.TransactionDetail

/Aggregate

GetBatchResultsResponse.TransactionResult

Aggregate, Required

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

the transaction.

GetBatchResultsResponse.TransactionResult. SeverityText

string, Required

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

Fatal.

GetBatchResultsResponse.TransactionResult. ResultID


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

GetBatchResultsResponse.TransactionResult. ResultText


Text that explains the outcome of the transaction.

END: GetBatchResultsResponse.TransactionResult

/Aggregate

D&B Direct API Documentation Batch Result Files



GetBatchResultsResponse.GetBatchResultsResponseDetail

Aggregate, Optional

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchDetailResponse

Aggregate, Required


GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchDetailResponse.ApplicationBatchID


A number assigned by consuming application (e.g., GIH) which is used to


GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchDetailResponse.ServiceBatchID




END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchDetailResponse

/Aggregate

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult

Aggregate, Optional


GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. SeverityText

string, Required


Fatal.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultID


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

Possible values: BC005; CM001; CM004; BC001; BC002; BC003; BC004

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultText



Possible values: CM000 Success; BC005 Intermediate Notification; CM001 The

given request is invalid; CM004 Internal D&B system error. Please try again or

contact your local Customer Service Center; BC001 Partial Success; BC002 Batch

request is not processed since input file is not available in the specified location;

BC003 Batch request is not processed since the content of the input file is not in

the expected format or has invalid data; BC004 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;




GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultMessage


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 batch. If the status implies that there is a problem

this may also provide guidance to the user on how to address it.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultMessage.ResultDescription


Text that describes the additional information regarding the outcome of the

batch.

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultMessage

/Aggregate

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult

/Aggregate

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary

Aggregate, Optional

Records information about the process time and the number of records

processed.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.ExecutionTimeSummary

Aggregate, Optional


GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.ExecutionTimeSummary.BatchReceivedTimeStamp

dateTime, Optional

The date and time when the batch request was received by the service.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.ExecutionTimeSummary.ActualProcessCompletionTimestamp

dateTime, Optional

The date and time when the requested process (i.e., match, cleanse,

cleansematch) was actually completed by the service.

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.ExecutionTimeSummary

/Aggregate

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary

Aggregate, Optional

Records information about the number of input and output records, and the

count of the number of records which have passed and failed the requested

process.




GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary.TotalInputRecordCount

integer, Optional

A numeric value denoting the total number of records contained in the input file.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary.TotalOutputRecordCount

integer, Optional

A numeric value denoting the total number of records contained in the output

file.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary.TotalPassedRecordCount

string, Optional

A numeric value denoting the total number of records which have passed the

requested process.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary.TotalFailedRecordCount

string, Optional

A numeric value denoting the total number of records which have failed the

requested process.

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary

/Aggregate

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary

/Aggregate

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail

Aggregate, Optional

Records information about the output of the Batch process.

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail


Possible values: Can repeat up to 2 times; one for Output file and second for

Error file

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail.ContentObject

base64Binary, Required

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail.ObjectFormatTypeText


XML,CSV,JSON





GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail.LayoutName


The name of the layout for this collection of the data records. For example the

layout names 'GBI' denotes the Global Batch Input layout.

Possible values: PCMGBOMatch (For the output file); ERR (For the Error file)

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail.RecordsCount

unsignedLong, Optional

A numeric value denoting the number of records contained in the input file.

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail

/Aggregate

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail

/Aggregate

END: GetBatchResultsResponse.GetBatchResultsResponseDetail

/Aggregate

END: GetBatchResultsResponse /Aggregate

Batch Result Codes











Possible Codes in Error File

Appended to each line in the error file (which is a cloned copy of the input request file) are one of thefollowing:



Error Scenario Code Description

Invalid Input Record Format CM002 Invalid Input Record

Missing Country Code CM003 Missing Country Code

Invalid / Unsupported Country Code CM011 Invalid / Unsupported Country Code

Missing Chunks Records CM004 Internal D&B system error

Invalid Territory Provided CM016 Invalid Territory Provided



Response Codes



Samples (Download)


Batch Service


Related Topics

ProcessBatch (REST), ListBatch (REST).



GetBatchResults (SOAP)This operation -- part of the Batch Service -- provides access to the results of an individual batch requestif/when it is completed.



Endpoint


Request Parameters


Exception: The fields comprising the TransactionDetail aggregate are required for this operation. Pleasecontact a D&B sales associate to obtain the correct SubmittingOfficeID value.


GetBatchResultsRequest Aggregate

GetBatchResultsRequest@ServiceVersionNumber

Attribute

Possible values: 1

GetBatchResultsRequest.TransactionDetail

Aggregate, Optional


GetBatchResultsRequest.TransactionDetail.ApplicationTransactionID


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

GetBatchResultsRequest.TransactionDetail.TransactionTimestamp

DateTimestamp, Optional

The date and time when this request was created. When the request is from an

intermediary, such as a workflow manager or service bus, this is the date and time

when the message was sent to the D&B function, i.e., the date and time when the

xml document was created by the requesting intermediary.


D&B Direct API Documentation GetBatchResults (SOAP)



GetBatchResultsRequest.TransactionDetail.SubmittingOfficeID


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.

END: GetBatchResultsRequest.TransactionDetail

/Aggregate

GetBatchResultsRequest.GetBatchResultsRequestDetail

Aggregate, Required

GetBatchResultsRequest.GetBatchResultsRequestDetail.InquiryDetail

Aggregate, Required

Records data that allows the customer to specify identifying information about the

Batch

GetBatchResultsRequest.GetBatchResultsRequestDetail.InquiryDetail. ServiceBatchID


A number assigned by the composite service (e.g., MatchCleanseService, GHM) which

is used to uniquely identify a batch request.

Testing / Sandbox


Batch Result Files

This operation delivers two text files that will be delivered as embedded Base64 encoded objects. One of thefiles returned will be a failed transaction (ERR) list; copies of the lines from the request file that were not ableto be processed. The other file will be a list of comma-delimited formatted responses.

Data Field Response



GetBatchResultsResponse Aggregate

GetBatchResultsResponse.TransactionDetail

Aggregate, Optional





GetBatchResultsResponse.TransactionDetail.TransactionTimestamp

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.

END: GetBatchResultsResponse.TransactionDetail

/Aggregate

GetBatchResultsResponse.TransactionResult

Aggregate, Required

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

the transaction.

GetBatchResultsResponse.TransactionResult. SeverityText

string, Required


Fatal.

GetBatchResultsResponse.TransactionResult. ResultID


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

GetBatchResultsResponse.TransactionResult. ResultText


Text that explains the outcome of the transaction.

END: GetBatchResultsResponse.TransactionResult

/Aggregate

GetBatchResultsResponse.GetBatchResultsResponseDetail

Aggregate, Optional

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchDetailResponse

Aggregate, Required


GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchDetailResponse.ApplicationBatchID


A number assigned by consuming application (e.g., GIH) which is used to


GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchDetailResponse.ServiceBatchID




END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchDetailResponse

/Aggregate




GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult

Aggregate, Optional


GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. SeverityText

string, Required


Fatal.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultID


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

Possible values: BC005; CM001; CM004; BC001; BC002; BC003; BC004

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultText



Possible values: CM000 Success; BC005 Intermediate Notification; CM001 The

given request is invalid; CM004 Internal D&B system error. Please try again or

contact your local Customer Service Center; BC001 Partial Success; BC002 Batch

request is not processed since input file is not available in the specified location;

BC003 Batch request is not processed since the content of the input file is not in

the expected format or has invalid data; BC004 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;

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultMessage


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 batch. If the status implies that there is a problem

this may also provide guidance to the user on how to address it.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultMessage.ResultDescription


Text that describes the additional information regarding the outcome of the

batch.

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult. ResultMessage

/Aggregate

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchResult

/Aggregate




GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary

Aggregate, Optional

Records information about the process time and the number of records

processed.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.ExecutionTimeSummary

Aggregate, Optional


GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.ExecutionTimeSummary.BatchReceivedTimeStamp

dateTime, Optional

The date and time when the batch request was received by the service.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.ExecutionTimeSummary.ActualProcessCompletionTimestamp

dateTime, Optional

The date and time when the requested process (i.e., match, cleanse,

cleansematch) was actually completed by the service.

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.ExecutionTimeSummary

/Aggregate

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary

Aggregate, Optional

Records information about the number of input and output records, and the

count of the number of records which have passed and failed the requested

process.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary.TotalInputRecordCount

integer, Optional

A numeric value denoting the total number of records contained in the input file.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary.TotalOutputRecordCount

integer, Optional

A numeric value denoting the total number of records contained in the output

file.

GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary.TotalPassedRecordCount

string, Optional

A numeric value denoting the total number of records which have passed the

requested process.




GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary.TotalFailedRecordCount

string, Optional

A numeric value denoting the total number of records which have failed the

requested process.

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary.RecordSummary

/Aggregate

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.BatchProcessSummary

/Aggregate

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail

Aggregate, Optional

Records information about the output of the Batch process.

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail


Possible values: Can repeat up to 2 times; one for Output file and second for

Error file

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail.ContentObject

base64Binary, Required

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail.ObjectFormatTypeText


XML,CSV,JSON


GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail.LayoutName


The name of the layout for this collection of the data records. For example the

layout names 'GBI' denotes the Global Batch Input layout.

Possible values: PCMGBOMatch (For the output file); ERR (For the Error file)

GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail.RecordsCount

unsignedLong, Optional

A numeric value denoting the number of records contained in the input file.

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail. OutputObjectDetail

/Aggregate

END: GetBatchResultsResponse.GetBatchResultsResponseDetail.OutputDetail

/Aggregate




END: GetBatchResultsResponse.GetBatchResultsResponseDetail

/Aggregate

END: GetBatchResultsResponse /Aggregate


Batch Result Codes











Possible Codes in Error File

Appended to each line in the error file (which is a cloned copy of the input request file) are one of thefollowing:

Error Scenario Code Description

Invalid Input Record Format CM002 Invalid Input Record

Missing Country Code CM003 Missing Country Code

Invalid / Unsupported Country Code CM011 Invalid / Unsupported Country Code

Missing Chunks Records CM004 Internal D&B system error

Invalid Territory Provided CM016 Invalid Territory Provided


The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 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 iscurrently encoded using the ISO 8859-2 character set standard.

Response Codes



Samples (Download)


Batch Service


Related Topics

ProcessBatch (SOAP), ListBatch (SOAP).



Authentication ProcessBefore D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link foractivating username/password combinations will be included in an email sent upon completion of theregistration process. If you do not receive an email, or unable to locate it, please contact the D&B supportteam 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, 2013. Prior to that date,the customer-supplied email 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 witheach 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 requestwill be processed. If the authentication process fails, an error response code will be returned. The securityrelated response codes are prefixed with "SC."

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://services.dnb.com/CompanyServiceV2.0">

<soapenv:Header><wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://do

cs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

<wsse:UsernameToken wsu:Id="UsernameToken-11"><wsse:Username>MyUsername</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/

01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>

</wsse:UsernameToken></wsse:Security>

</soapenv:Header><soapenv:Body>



D&B Direct API Documentation Authentication Process


http://dnbus.force.com/support?prod=DNBDirect

</soapenv:Body></soapenv:Envelope>

Response - Invalid Credentials

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body><com:MatchResponse ServiceVersionNumber="4.0" xmlns:com="http:/

/services.dnb.com/CompanyServiceV2.0"><TransactionDetail>

<ApplicationTransactionID>Id-b118ae275255a7cf0cfb742e</ApplicationTransactionID>

<ServiceTransactionID>Id-b118ae275255a7cf0cfb742e</ServiceTransactionID>

<TransactionTimestamp>2013-10-09T15:00:31</TransactionTimestamp>

</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 Center.</ResultText>

</TransactionResult></com:MatchResponse>

</soapenv:Body></soapenv:Envelope>

REST Authentication

Implementation of D&B Direct API services using REST methodology involves obtaining anAuthentication Token, that is then submitted with subsequent requests during a particular session (up to eighthours).

Secure access to D&B Direct services is managed through the use of an Authentication Token, which can beobtained by sending an HTTP POST request to Authentication Service URL, passing a valid username andpassword in the HTTP header. The 2.0 services do not require that an API key be supplied. If the usercredentials are valid, an Authentication Token (valid for eight hours) will be returned back in theAuthorization tag in the HTTP header of the response.

D&B Direct API Documentation REST Authentication


Once an Authentication Token is obtained, it should be embedded in the HTTP header of all subsequentrequests. If the Authentication Token is valid and the user is entitled to access the product or feature beingrequested, the service will be processed and requested information returned as a JSON object. If theAuthentication 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 minorvariations.

Sample Request - Get New Token

POST https://maxcvservices.dnb.com/rest/Authenticationx-dnb-user: MyUsernamex-dnb-pwd: MyPassword

A {version} parameter is not required when initiating a request to the Authentication service.

Response - Success

HTTP/1.1 200 OKDate: Wed, 09 Oct 2013 18:47:22 GMTAuthorization: <MyToken>x-dnb-user: MyUsernamex-dnb-pwd: MyPassword

Response - Failed

HTTP/1.1 401 ERRORDate: Wed, 09 Oct 2013 18:51:11 GMTAuthorization: INVALID CREDENTIALSx-dnb-user: MyUsernamex-dnb-pwd: MyPassword

Sample Request - Invoke Operation with Token

GET https://maxcvservices.dnb.com/V4.0/organizations?CountryISOAlpha2Code=US&SubjectName=GORMAN%20MANUFACTURING&match=true&MatchTypeText=Advanced&TerritoryName=CAAuthorization: <MyToken>

Response - Expired Authentication Token

HTTP/1.1 401 UNAUTHORIZEDDate: Thu, 10 Oct 2013 14:55:19 GMT



Authorization: <MyToken>Content-Type: application/jsonContent-Encoding: gzip

{"MatchResponse": {"TransactionDetail": {

"ApplicationTransactionID": "REST","ServiceTransactionID": "Id-c04bbdff5256bfd70a7b742e","TransactionTimestamp": "2013-10-10T10: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."}

}}



Obtaining CredentialsAccess to the D&B Direct web services are secured by a username and password combination. D&B will issueyour organization a production username upon completion of the contract establishment process. Thisusername will be sent to the email address designated on the contract, along with instructions for setting upthe 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 webservices. 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 toauthenticate web services, and vice-versa.

Before D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link foractivating username/password combinations will be included in an email sent upon completion of theregistration process. If you do not receive an email, or unable to locate it, please contact the D&B supportteam 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, 2013. Prior to that date,the customer-supplied email 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.

D&B Direct API Documentation Obtaining Credentials


http://developer.dnb.com/register-v2

http://dnbus.force.com/support?prod=DNBDirect

Data Layer EntitlementD&B Direct 2.0 services are provisioned to customers at the data layer, which, for some of the features, mightnot be intuitive. This page is intended to help developers clearly understand what services and operations theyare entitled to use.

Components Requiring Entitlement

Data Layer: On-Demand Multiple Entity Resolution*Service: Batch Service; Transactional Mini-Batch ServiceOperation: ProcessBatch() - BTCH_CleanseMatch; ProcessBatch() + CPCM_CMFeature: On-Demand Multiple Entity Resolution (Asynchronous); On-Demand Multiple Entity Resolution(Synchronous).

*This item requires that On-Demand Single Entity Resolution also be entitled.

Components Not Requiring Entitlement

These items are available to customers who have one or more entitled data layers.

D&B Direct API Documentation Data Layer Entitlement


Response CodesWhenever a D&B Direct web service request is unsuccessful, one of the following response codes will bereturned.

Code Description HTTPStatus*

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

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

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 Success. Returned truncated family tree, as family tree member countexceeds maximum limit for requested subject.

200

PD009 Required scoring elements missing - a Commercial or Blended Small Businessreport is not available. You may proceed with a Principal only request.

200

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 Requested Product is not available currently. Product will be delivered to thecustomer at a later point of time via offline delivery channels (Email/FAX/FTPetc).

404

PD014 Requested data is not available or partially available due to data integrityerrors.

404

PD015 Trade-up to HQ is not available. Therefore delivering the data for branchorganization.

200

PD016 Requested Product is not available since the requested DUNS is transferred toa new DUNS.

200

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 anincorrect User ID/Password.

401

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 trialperiod.

401

BC001 Partial Success. One or more records in the input file were not processed. 200




BC002 Batch request is not processed since input file is not available in the specifiedlocation.

400

BC003 Batch request is not processed since the content of the input file is not in theexpected format.

400

BC004 Batch request is not processed since the count of the records specified in therequest do not match the exact count of records in the input file.

400

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

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.



Sandbox AccessD&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 ofSOAP, using the same WSDL file).

When conducting testing in the production environment during a trial period, product requests will be limitedto the local market of the customer.

Some D&B Direct products and features may behave differently in the sandbox environment. Any limitationsor restrictions will be specified on the operation page for each interface.

Static Responses

Some operations currently return a static set of results, regardless of the request parameters, in the testenvironment.

Test Parameter Values

The following suggested parameters may be used for test environment (sandbox) requests to retrievesuccessful responses.

Company Reports

Country Reports

D&B Direct API Documentation Sandbox Access


BadgerFish (REST)BadgerFish is a convention for translating an XML document into a JSON object. D&B Direct JSON responsesfollow this convention with a few minor variations. Exception: The responses supplied by the DataExchange Service follow the convention used by the respective business partner.

l Attributes will always be represented by prefixing with “@”. (see Example 2)l 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)l 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 theattribute is not returned in a specific JSON response. Even then, the element content will berepresented as “$” in the JSON. (see Example 4)

l String values will be returned within double quotes. (see Example 14)l 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 noattribute

<DUNSNumber>804735132 </DUNSNumber> "DUNSNumber": "804735132"

2 Element havingAttribute

<FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText>

"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }

3 Aggregate havingattribute

<OrganizationIdentificationNumberDetailTypeText="Federal Taxpayer IdentificationNumber (US)" DNBCodeValue="6863"><OrganizationIdentificationNumber>12345</OrganizationIdentificationNumber></OrganizationIdentificationNumberDetail>

"OrganizationIdentificationNumberDetail":{ "@TypeText": "Federal TaxpayerIdentification Number (US)","@DNBCodeValue": 6863,"OrganizationIdentificationNumber":"12345" }

4 Element havingAttribute as perdefinition, howeverattribute is notreturned for aspecific JSONinstance

<OrganizationName>Gorman ManufacturingCompany, Inc. </OrganizationName>

"OrganizationName": { "$": "GormanManufacturing Company, Inc." }

D&B Direct API Documentation BadgerFish (REST)



5 Aggregate havingAttribute as perdefinition, howeverattribute is notreturned for aspecific JSONinstance

<OrganizationIdentificationNumberDetail ><OrganizationIdentificationNumber>12345</OrganizationIdentificationNumber></OrganizationIdentificationNumberDetail>

"OrganizationIdentificationNumberDetail":{ "OrganizationIdentificationNumber":"12345" }

6 Non-RepeatingElement

<DUNSNumber>804735132 </DUNSNumber> "DUNSNumber": "804735132"

7 Repeating Element <SalesRevenueAmountCurrencyISOAlpha3Code="USD”>1000000</SalesRevenueAmount><SalesRevenueAmountCurrencyISOAlpha3Code="CAD”>1040000</SalesRevenueAmount>

"SalesRevenueAmount": [ { "@CurrencyISOAlpha3Code": "USD", "$":1000000 }, { "@CurrencyISOAlpha3Code":"CAD", "$": 1040000 } ]

8 Repeating Aggregate <FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText></FamilyTreeMemberRole><FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12775">Global Ultimate</FamilyTreeMemberRoleText></FamilyTreeMemberRole><FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12774">Domestic Ultimate</FamilyTreeMemberRoleText></FamilyTreeMemberRole>

"FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }},{"FamilyTreeMemberRoleText": {

"@DNBCodeValue": 12775, "$": "GlobalUltimate" }},{"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12774, "$": "DomesticUltimate" }} ]

9 Element isrepeatable as per thedefinition. Howeverit is not repeating ina specific JSONinstance.

<SalesRevenueAmountCurrencyISOAlpha3Code="USD”>1000000</SalesRevenueAmount>

"SalesRevenueAmount": [ { "@CurrencyISOAlpha3Code": "USD", "$":1000000 }]

10 Aggregate isrepeatable as per thedefinition. Howeverit is not repeating ina specific JSONinstance.

<FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText></FamilyTreeMemberRole>

"FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }}]

11 Date Field <TransactionTimestamp>2013-07-11T11:08:48.067-04:00</TransactionTimestamp>

"TransactionTimestamp": "2013-07-11T11:10:39.110-04:00"

12 Boolean Field <StandaloneOrganizationIndicator>false</StandaloneOrganizationIndicator>

"StandaloneOrganizationIndicator": false

D&B Direct API Documentation Examples



13 Numeric Field <RawScore>352</RawScore> "RawScore": 352

14 String Field <LineText>492 Koller Street</LineText> "LineText": "492 Koller Street"

D&B Direct API Documentation Examples


D&B Direct 2.0 Batch Service · String 64 Y 3 CustomerReferenceText Fillerforanyfuture purposes 100...

Documents

Transcript of D&B Direct 2.0 Batch Service · String 64 Y 3 CustomerReferenceText Fillerforanyfuture purposes 100...