Loading

dnb-logo
Direct 2.0
Collapse

On-Demand Multiple Entity Resolution (Asynchronous)

Also referred to as Medium (up to 10,000 companies) Batch Cleanse Initiation.

This feature allows multiple cleanse and match requests to be issued from a single API call, using the Batch Service to support medium-sized batches (fewer than 10,000 companies). The process involves creating two request files: one containing the companies (and available details) that should be cleansed and matched, and the match specification parameters.

NOTE: Effective Sept 1, 2015, the On Demand Multiple Entity Resolution product will be available on a limited basis. Existing contract commitments will continue to be fully supported. Please contact a D&B sales representative for additional details.

Update History

  • June 20, 2014 (v3.0 SOAP & REST): The REST implementation now supports transfer/receipt of embedded base64 encoded ContentObjects. The SOAP implementation now supports transfer/receipt using the MTOM protocol (multi-part attachments).
  • May 16, 2014 (v2.0 SOAP & REST): Error codes refined to improve usability/implementation.
  • October 3, 2013 (v1.0 SOAP & REST): The current implementation of this service accepts embedded base64 Content Objects for SOAP, and multipart attachments (MTOM) for REST. Both implementations support XML only.

Quick Start for Medium Batches

The process for medium batches requires the following steps:

  1. List Preparation - there is a specific layout/format, naming and size limit of the files that you will submit for cleanse/match processing.
  2. List Uploads - when you're ready to initiate a batch, submit the list (i.e. ProcessBatch) and control file for processing.
  3. Get Ready for the Results - like the initial list, the results will be in a specific layout/format.
  4. Downloading Results - use the list batch operation to poll for a completed status and then download the results (i.e., GetBatchResults).

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.

Overview

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

This operation also requires that a second text file be prepared and attached to the request. The second file must have a file extension of "XML" and include the following match specification parameters in XML format.

Sample Specification
<com:GetCleanseMatchRequest xmlns:com="http://services.dnb.com/CompanyServiceV2.0" ServiceVersionNumber="1">
         <GetCleanseMatchRequestDetail>
            <InquiryDetail>               
            </InquiryDetail>
            <MatchSpecification>
               <ConfidenceLowerLevelThresholdValue>7</ConfidenceLowerLevelThresholdValue>
               <ExclusionCriteria>
                  <ExclusionDataDescription>Exclude Undeliverable</ExclusionDataDescription>
               </ExclusionCriteria>
               <IncludeCleansedAndStandardizedInformationIndicator>true</IncludeCleansedAndStandardizedInformationIndicator>
            </MatchSpecification>        
         </GetCleanseMatchRequestDetail>
</com:GetCleanseMatchRequest>
XML ElementDescription
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.

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

NOTE: Please refer to the On-Demand Single Entity Resolution documentation for minimum requirements for and search behavior of matching.

Data Layer Entitlement

For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.

  • This report is entitled as "On-Demand Multiple Entity Resolution" for D&B Direct 2.0 customers, and also requires that "On-Demand Single Entity Resolution" be entitled.

For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.

  • This particular data layer is NOT included in the D&B Direct Onboard suite.

Specification

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

The following parameters are accepted by this operation.

Sample Request (Embedded)
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Header>
      <wsse:Security xmlns:wsse="http://docs.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-1">
            <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>
   </SOAP-ENV:Header>
    <SOAP-ENV:Body>
      <bat:ProcessBatchRequest ServiceVersionNumber="3.0" xmlns:bat="http://services.dnb.com/BatchServiceV1.0">
         <BatchDetail>
            <ApplicationBatchID>plss</ApplicationBatchID>
            <MessageTimeStamp>2014-03-08T12:48:47.0Z</MessageTimeStamp>
         </BatchDetail>
         <BatchSpecification>
            <BatchProcessID>CPCM_CM</BatchProcessID>
            <BatchPriorityValue>5</BatchPriorityValue>
            <BatchSpecificationObject>
               <ContentObject>PGNvbTpHZXRDbGVhbnNlTWF0Y2hSZXF1ZXN0IHhtbG5zOmNvbT0iaHR0cDovL3NlcnZpY2VzLmRuYi5jb20vQ29tcGFueVNlcnZpY2VWMi4wIiBTZXJ2aWNlVmVyc2lvbk51bWJlcj0iMSI+DQoJPEdldENsZWFuc2VNYXRjaFJlcXVlc3REZXRhaWw+DQoJCTxJbnF1aXJ5RGV0YWlsPg0KICAgICAgICAgICAgPC9JbnF1aXJ5RGV0YWlsPg0KCQk8TWF0Y2hTcGVjaWZpY2F0aW9uPg0KCQkJPENvbmZpZGVuY2VMb3dlckxldmVsVGhyZXNob2xkVmFsdWU+ODwvQ29uZmlkZW5jZUxvd2VyTGV2ZWxUaHJlc2hvbGRWYWx1ZT4NCgkJCTxFeGNsdXNpb25Dcml0ZXJpYT4NCgkJCQk8RXhjbHVzaW9uRGF0YURlc2NyaXB0aW9uPkV4Y2x1ZGUgTm9uIE1hcmtldGFibGU8L0V4Y2x1c2lvbkRhdGFEZXNjcmlwdGlvbj4NCgkJCTwvRXhjbHVzaW9uQ3JpdGVyaWE+DQoJCQk8RXhjbHVzaW9uQ3JpdGVyaWE+DQoJCQkJPEV4Y2x1c2lvbkRhdGFEZXNjcmlwdGlvbj5FeGNsdWRlIE91dCBvZiBCdXNpbmVzczwvRXhjbHVzaW9uRGF0YURlc2NyaXB0aW9uPg0KCQkJPC9FeGNsdXNpb25Dcml0ZXJpYT4NCgkJCTxJbmNsdWRlQ2xlYW5zZWRBbmRTdGFuZGFyZGl6ZWRJbmZvcm1hdGlvbkluZGljYXRvcj5mYWxzZTwvSW5jbHVkZUNsZWFuc2VkQW5kU3RhbmRhcmRpemVkSW5mb3JtYXRpb25JbmRpY2F0b3I+DQoJCTwvTWF0Y2hTcGVjaWZpY2F0aW9uPg0KCTwvR2V0Q2xlYW5zZU1hdGNoUmVxdWVzdERldGFpbD4NCjwvY29tOkdldENsZWFuc2VNYXRjaFJlcXVlc3Q+</ContentObject>
               <ObjectFormatTypeText>XML</ObjectFormatTypeText>
               <LayoutName>Company Service</LayoutName>
            </BatchSpecificationObject>
         </BatchSpecification>
         <InputDetail>
            <InputObjectDetail>
               <ContentObject>LDEsLCwsLCwsODA0NzM1MTMyLCJHT1JNQU4gTUFOVUZBQ1RVUklORyBDT01QQU5ZLCBJTkMuIiwsNDkyIEtPTExFUiBTVCwsU0FOIEZSQU5DSVNDTywsOTQxMTAsLFVTLCwwNjUwNTU1MDAwMCwsDQosMiwsLCwsLCwyMTQ1Njc4ODUsIkQgJmFtcDsgQiBTQU1QTEUgQ08gTFREIiwsTUFSTE9XIElOVEVSTkFUSU9OQUwgUEFSS1dBWSwsTUFSTE9XLCxTTDcgMUFKLCxHQiwsOTg4NDEyMTIxMjAsLA0KLDMsLCxibG9vbWJlcmcubmV0LCwsLCwsLCwsLCwsLCwsLCwNCiw0LCwsLHRlc3RAYmxvb21iZXJnLm5ldCwsLCwsLCwsLCwsLCwsLCwNCiw1LCwsLCwsLCxibG9vbWJlcmcubmV0LCwsLCwsLCxVUywsLCwNCg==</ContentObject>
               <ObjectFormatTypeText>CSV</ObjectFormatTypeText>
               <LayoutName>PCMGBIMatch</LayoutName>
               <LayoutVersion>1.0</LayoutVersion>
               <CharacterSetCode>23423</CharacterSetCode>
               <LanguageCode>36</LanguageCode>
               <CompressTypeValue>None</CompressTypeValue>
               <RecordsCount>5</RecordsCount>
            </InputObjectDetail>
         </InputDetail>
         <OutputSpecification>
            <ObjectFormatTypeText>CSV</ObjectFormatTypeText>
            <CompressTypeValue>ZIP</CompressTypeValue>
         </OutputSpecification>
         <BatchReferenceDetail>
            <BatchReferenceText>ISE</BatchReferenceText>
            <BatchReferenceText>Verification</BatchReferenceText>
            <BatchReferenceText>DCSN_ENGN=1</BatchReferenceText>
            <BatchReferenceText>NextGen-US</BatchReferenceText>
         </BatchReferenceDetail>
      </bat:ProcessBatchRequest>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Request (MTOM)
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.

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 (Array)

Possible values: Should give one specification Object for CPCM_CM

ProcessBatchRequest. BatchSpecification. BatchSpecificationObject. ContentObject For Multipart: Include statement1, Required

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

For Embedded: base64Binary, Required

ProcessBatchRequest. BatchSpecification. BatchSpecificationObject. ObjectFormatTypeText string up to 5 chars., Required

XML,CSV,JSON

Possible values: XML

ProcessBatchRequest. BatchSpecification. BatchSpecificationObject. 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: 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 (Array)
ProcessBatchRequest. InputDetail. InputObjectDetail. ContentObject For Multipart: Include statement2, Required

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

For Embedded: base64Binary, Required

ProcessBatchRequest. InputDetail. InputObjectDetail. ObjectFormatTypeText string up to 5 chars., Required

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

Possible values: CSV

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 Include statement 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 Include statement 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"

Endpoint

Use the following endpoint with the downloadable WSDL to request this feature.

Endpoint (Batch)
https://direct.dnb.com:8443/V{version}/BatchService

NOTE: Calls to the Batch service use an alternate port (8443).

Testing

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

NOTE: All sandbox requests for this service require the following fixed authentication token:
jAu4dMpeUcgrDE0J66k3x5AUm+3ej7Dq2+Pl2TTwtbOC06c+szLpjs8yzMYFKvjPXOBrGRCr61LkVedVC9w0NChRFMUlWopw/KQRv9GHWDOV5yvK43Tt4fTYA6cgVef9wb572rHNHlisRFm4789nw8re+K9jgoO9LvlIhs9IgZUbGRaIAttKDYFmtLSKDmjjZWoo7RPiwqaZR4dFLQ86v10038clavB/lqJtu6zo6qmep7Na2xU7Ot+UcWA0bMA18gnFikzptbbqu/DP6Fa89s6itBrEbFn5iD88KCRPQfImtD6li7g+Rt7CdracVkQv7vkxO9LvrVc4YqTVJX51xqzuP1HuCYE3/Kdnn1B3pSZjw4xy5nq03LFu8HJ9VF89

Feature Response

Specification

The following is a list of the possible data fields returned by this operation in the XML response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.

NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.

Sample Response (Embedded)
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">
   <env:Header/>
   <env:Body>
      <ns1:ProcessBatchResponse ServiceVersionNumber="3.0" xmlns:oracle-xsl-mapper="http://www.oracle.com/xsl/mapper/schemas" xmlns:ns1="http://services.dnb.com/BatchServiceV1.0">
         <BatchDetail>
            <ApplicationBatchID>plss</ApplicationBatchID>
            <ServiceBatchID>125873E1</ServiceBatchID>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Request Message has been placed in the Queue Successfully</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchProcessSummary>
            <ExecutionTimeSummary>
               <BatchRequestCreatedTimeStamp>2014-03-08T12:48:47.0Z</BatchRequestCreatedTimeStamp>
               <BatchReceivedTimeStamp>2017-12-22T06:42:17.132-05:00</BatchReceivedTimeStamp>
            </ExecutionTimeSummary>
            <RecordSummary>
               <TotalInputRecordCount>5</TotalInputRecordCount>
            </RecordSummary>
            <BatchPriorityValue>5</BatchPriorityValue>
         </BatchProcessSummary>
      </ns1:ProcessBatchResponse>
   </env:Body>
</env:Envelope>

Sample Response (MTOM)
Name Characteristics
ProcessBatchResponse Aggregate
ProcessBatchResponse@ServiceVersionNumber Attribute
ProcessBatchResponse. BatchDetail Aggregate, Required

Records information necessary to return a particular response.

ProcessBatchResponse. BatchDetail Aggregate, Required

Records information necessary to return a particular response.

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

ProcessBatchResponse. BatchDetail. ApplicationBatchID string up to 64 chars., Optional

A number assigned by consuming application (e.g., GIH) which is used to uniquely identify a batch request.

ProcessBatchResponse. BatchDetail. ServiceBatchID string up to 64 chars., Required

A number assigned by the composite service (e.g., MatchCleanseService, GHM) which is used to uniquely identify a batch request.

ProcessBatchResponse. BatchDetail. ServiceBatchID string up to 64 chars., Required

A number assigned by the composite service (e.g., MatchCleanseService, GHM) which is used to uniquely identify a batch request.

END: ProcessBatchResponse. BatchDetail /Aggregate
ProcessBatchResponse. BatchResult Aggregate, Optional

Records information about the result of the process.

ProcessBatchResponse. BatchResult Aggregate, Optional

Records information about the result of the process.

ProcessBatchResponse. BatchResult. SeverityText string, Required

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

Possible values: Error; Fatal; Information; Warning

ProcessBatchResponse. BatchResult. SeverityText string up to 16 chars., Required

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

Possible values: Error; Fatal; Information; Warning

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

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

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

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

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

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

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

Text that explains the outcome of the 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;

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

Text that explains the outcome of the 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;

ProcessBatchResponse. BatchResult. ResultMessage Aggregate, Optional (Array)

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

ProcessBatchResponse. BatchResult. ResultMessage Aggregate, Optional (Array)

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

ProcessBatchResponse. BatchResult. ResultMessage. ResultDescription string up to 512 chars., Required

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

ProcessBatchResponse. BatchResult. ResultMessage. ResultDescription string up to 512 chars., Required

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

END: ProcessBatchResponse. BatchResult. ResultMessage /Aggregate
END: ProcessBatchResponse. BatchResult /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.

ProcessBatchResponse. BatchProcessSummary. ExecutionTimeSummary Aggregate, Optional

Records information about the process time and completion time.

ProcessBatchResponse. BatchProcessSummary. ExecutionTimeSummary Aggregate, Optional

Records information about the process time and completion time.

ProcessBatchResponse. BatchProcessSummary. ExecutionTimeSummary. BatchRequestCreatedTimeStamp dateTime, Required

The date and time when the batch request was created by the submitting application.

ProcessBatchResponse. BatchProcessSummary. ExecutionTimeSummary. BatchRequestCreatedTimeStamp dateTime, Required

The date and time when the batch request was created by the submitting application.

ProcessBatchResponse. BatchProcessSummary. ExecutionTimeSummary. BatchReceivedTimeStamp dateTime, Optional

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

ProcessBatchResponse. BatchProcessSummary. ExecutionTimeSummary. BatchReceivedTimeStamp dateTime, Optional

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

END: ProcessBatchResponse. BatchProcessSummary. ExecutionTimeSummary /Aggregate
ProcessBatchResponse. 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.

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

ProcessBatchResponse. BatchProcessSummary. RecordSummary. TotalInputRecordCount integer, Optional

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

ProcessBatchResponse. BatchProcessSummary. RecordSummary. TotalInputRecordCount integer, Optional

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

END: ProcessBatchResponse. BatchProcessSummary. RecordSummary /Aggregate
ProcessBatchResponse. BatchProcessSummary. BatchPriorityValue 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.

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

ProcessBatchResponse. BatchProcessSummary. BatchPriorityValue 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.

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

END: ProcessBatchResponse. BatchProcessSummary /Aggregate
END: ProcessBatchResponse /Aggregate

Response Codes & Error Handling

Successful service requests will return a CM000 response code in the BatchResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.

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

NOTE: For this operation, the CM000 success response code indicates the batch was accepted for processing, NOT that the batch completed. To obtain the status for a batch, use the GetBatchResults operation.

D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.

Qualified usage (e.g., a successful response) is tracked and billed according to the terms & conditions of the customer's contract. The response codes CM000, CM010, PD002 and PD015 are considered successful. A built-in feature exists to prevent duplicate billing when multiple successful requests with the same criteria are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).

The usage details for a Medium batch request are summarized by country, and then recorded. Therefore, customer online usage (OLUS) reports will display multiple entries for each batch submitted.

Operation-specific supplemental response code explanations:

Return CodeError ScenarioResult TextResult Message
BC009User exceeded Max records/request limitBatch not processed as the input file contains more records than the permitted limit.Batch not processed as the input file contains more records than the permitted limit.
BC011When BatchProcessID under the aggregate BatchSpecification is wrongInvalid Batch Process Id provided in the request.BatchProcessID of BatchSpecification contains Invalid Value in the request
CM000SuccessSuccessRequest Message has been placed in the Queue Successfully
CM001Multiple "BatchSpecificationObject" present in the requestThe given request is invalid.More than one BatchSpecificationObject attachments provided in the request.
CM001Multiple "InputObjectDetail" present in the requestThe given request is invalid.More than one InputObject attachments provided in the request.
CM001ApplicationBatchID is not presentThe given request is invalid.ApplicationBatchID is not present
CM001When LayoutName under the aggregate InputObjectDetail is incorrectThe given request is invalid.Input LayoutName should have value of "PCMGBIMatch".
CM001When ObjectFormatTypeText under the aggregate BatchSpecificationObject is wrongThe given request is invalid.ObjectFormatTypeText of BatchSpecificationObject contains invalid value in the request.
CM001When ObjectFormatTypeText under the aggregate InputObjectDetail is wrongThe given request is invalid.ObjectFormatTypeText of InputObjectDetails contains invalid value in the request.
CM001When BatchProcessID under the aggregate BatchSpecification is wrongThe given request is invalid.BatchProcessID of BatchSpecification contains Invalid Value in the request
CM001When CompressTypeValue under the aggregate InputObjectDetail is incorrectThe given request is invalid.CompressTypeValue of InputObjectDetail contains Invalid Value in the request
CM001When LayoutName under the aggregate BatchSpecificationObject is wrongThe given request is invalid.BatchSpecification LayoutName should have value of "Company Service"
CM001More than one BatchSpecificationObject attachments provided in the request.The given request is invalid.More than one BatchSpecificationObject attachments provided in the request.
CM001Input LayoutName should have value of "PCMGBIMatch"The given request is invalid.Input LayoutName should have value of "PCMGBIMatch"
CM001Input LayoutVersion should have value of 1.0The given request is invalid.Input LayoutVersion should have value of 1.0
CM001BatchSpecification LayoutName should have value of "Company Service"The given request is invalid.BatchSpecification LayoutName should have value of "Company Service"
CM003Missing BatchProcessID under the aggregate BatchSpecificationMissing Information in the request.BatchProcessID is missing in the request
CM003Missing ObjectFormatTypeText under the aggregate BatchSpecificationObjectMissing Information in the request.ObjectFormatTypeText of BatchSpecificationObject is missing in the request
CM003BatchSpecificationObject Attachment not provided in the request (Input.csv)Missing Information in the request.BatchSpecificationObject Attachment not provided in the request
CM003InputObject Attachment not provided in the request (Control.xml)Missing Information in the request.InputObject Attachment not provided in the request
CM003Missing ContentObject under the aggregate InputObjectDetailMissing Information in the request.ContentObject of InputObjectDetail is missing in the request
CM003Missing LayoutName under the aggregate BatchSpecificationObjectMissing Information in the request.LayoutName of BatchSpecificationObject is missing in the request
CM003Missing LayoutName under the aggregate InputObjectDetailMissing Information in the request.LayoutName of InputObjectDetail is missing in the request.
CM003Missing ContentObject under the aggregate BatchSpecificationObjectMissing Information in the request.ContentObject of BatchSpecificationObject is missing in the request
CM003ObjectFormatTypeText under the aggregate InputObjectDetail is missingMissing Information in the request.ObjectFormatTypeText of InputObjectDetail is missing in the request
CM004Failed to write to storage device.Internal D&B system error. Please try again or contact your local Customer Service CenterFailed to write to storage device.
CM004Service Batch ID not generatedInternal D&B system error. Please try again or contact your local Customer Service CenterInternal D&B system error. Please try again or contact your local Customer Service Center
SC005User exceeded max records per hourYou have reached maximum limit permitted as per the contract. Please contact your D&B representative or your local Customer Service Center.Hourly limit of batch records exceeded the permitted limit

Feature Notes

On average, submissions with the maximum of 10,000 entries require approximately 5 to 7 minutes for processing. Actual completion of a batch is dependent on the number of pending (queued) requests from all API customers.

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

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

What to do Next