This feature allows multiple cleanse and match requests to be issued from a single API call, using the Batch Service. 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.
For cleansing, a primary address (building number and street name, post office box or rural route number) is required in combination with an organization name, city, state, country and postal code to meet one of the following 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 or prefecture name and postal code, (b) city name and postal code, or (c) city name with name of the state, province or prefecture.
NOTE: Please refer to the On-Demand Single Entity Resolution documentation for minimum requirements for matching.
The product request details is submitted as a list of comma-delimited entries.
,1,,,,,,,,NATIONAL INSTITUTE OF TECHNOLOGY,,"HEAD, COMPUTER CENTRE",,ROURKELA,,769008,,333,,,Registration type,Registration Number ,2,,,,,,,,GEA PROCESS ENGINEERING(INDIA) LIMITED,,VADODARA,,GUJARATH,,391350,,333,,,, ,3,,,,,,,,KASPERSKY LAB AUSTRALIA AND NEW ZEALAND PTY LTD,,7/75 LORIMER STREET,,DOCKLANDS,VI,3008,,37,,,, ,4,,,,,,,,PATRICK AUBRY,,36 RUE DES ORMEAUX,,CESSON SEVIGN,,35510,,241,,,, ,5,,,,,,,,METALLGLAVSNAB LLC,,55 NOVOROSSIYSKAYA STR.,,KRASNODAR,,350080,,622,,,,
This operation 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.
|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
<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>
The search behavior and minimum requirements for matching outlined in the Company GetCleanseMatch() documentation also apply to this operation.
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.
The current implementation of this service accepts embedded base64 Content Objects for SOAP, and multipart attachments (MTOM) for REST. Both implementations support XML only.
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 of the input requests which failed, with an error code appended.
For details on how to obtain this data layer, please refer to the Batch Service documentation.