The Direct+ Multi-Process API allows customers to request batch processing of records. The following processes are supported:
Match (match)
For each input record, identifies the single most likely match for the given criteria. The response content for
each record, if a match is found, is same as for transactional Company Entity Resolution API. This feature is design to handle
up to 25,000 records per request.
Match & Append (extmatch)
For each input record, identifies the single most likely match for the given criteria and then appends a data
product to the response. This feature is design to handle up to 25,000 records per request.
High Volume Match (hvmatch)
For each input record, identifies the single most likely match. The response content for each record, if a match
is found, is same as for transactional Company Entity Resolution API. This feature is designed to handle up to 1 million records
per request.
IMPORTANT: High Volume Match requires additional capacity; please contact your Dun & Bradstreet
representative for more information.
To utilize the Multi-Process API, you will need to do the following:
NOTE: Use of the D&B APIs requires an access token. Refer to the Authentication page for more details on the steps involved in
authenticating.
The file:
File contents:
Name | Characteristics |
---|---|
recordID | Element, string, maximum 16 chars A unique identifier assigned by calling application to identify a specific request provided in the input file. |
parameters | Element, string The request parameters acceptable by the specific process invoked by the customer application. This should be in the same format as accepted by the Company Entity Resolution API URL. For permissible parameters, see the Query Parameters section on the Company Entity Resolution API page. |
For a complete sample file, see the Multi-Process Sample Files page.
For detailed explanations of the parameters, see the Query Parameters section on the Company Entity Resolution API page.
RQ001, name=AVNET%20EUROPE%20COMM%20VA&streetAddressLine1=KOUTERVELDSTRAAT%2020&streetAddressLine2=&countryISOAlpha2Code=BE&addressLocality=MACHELEN&addressRegion=&postalCode=1831&inLanguage=en-US&confidenceLowerLevelThresholdValue=8&candidateMaximumQuantity=1
RQ001, name=AVNET%20EUROPE%20COMM%20VA&streetAddressLine1=KOUTERVELDSTRAAT%2020&streetAddressLine2=&countryISOAlpha2Code=BE&addressLocality=MACHELEN&addressRegion=&postalCode=1831&inLanguage=en-US&confidenceLowerLevelThresholdValue=8&candidateMaximumQuantity=1
RQ001, name=AVNET%20EUROPE%20COMM%20VA&streetAddressLine1=KOUTERVELDSTRAAT%2020&streetAddressLine2=&countryISOAlpha2Code=BE&addressLocality=MACHELEN&addressRegion=&postalCode=1831&inLanguage=en-US
The Multi-Process API makes use of Amazon S3 as a temporary storage for the input and output files. For security purposes, a "customer key" is used to encrypt the contents.
For more information about Amazon Server-Side Encryption and Customer-Provided Encryption Keys visit Amazon's documentation site: http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html#RESTObjectPUT-requests
To create a customer key, you can use the below provided generator or follow the steps below:
Paste your D&B Direct+ Consumer Key provided to you when you registered for access to the Direct+ API into the text box field and click on 'Generate' button.
NOTE: If Consumer Key has more than 32 characters, use first 32 characters for encoding.
Use this request to upload a file for a Multi-Process job already submitted.
Name | Characteristics |
---|---|
x-amz-server-side-encryption-customer-key | Required Customer Key generated by base64-encoding your D&B Direct+ Consumer Key. |
x-amz-server-side-encryption-customer-algorithm | Required Algorithm name which is always "AES256". |
x-amz-server-side-encryption-customer-key-MD5 | Required Customer key generated from Base64 encoding of your D&B Direct+ Consumer Key MD5 value. |
For the request, copy the jobSubmissionDetail.url from the Job Submission response.
Sample Request (Input File Upload PUT) |
---|
PUT https//prd-multi-request.s3.amazonaws.com/multi-request-uploads/1000305/request/XXXXXXXXXX/file.csv?X-Amz-Security-Token=...&X-Amz-Algorithm=xxxxxxx&X-Amz-Date=20160901T093114Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption-customer-algorithm%3Bx-amz-server-side-encryption-customer-key%3Bx-amz-server-side-encryption-customer-key-md5&X-Amz-Expires=86399&X-Amz-Credential=...&X-Amz-Signature=... |
Use this feature to download the file when processing is complete.
Name | Characteristics |
---|---|
x-amz-server-side-encryption-customer-key | Required Must use same key as used on the initial job submission request. Field value <Customer key generated by SDK> |
x-amz-server-side-encryption-customer-algorithm | Required Must use algorithm name. Field value "AES256" |
x-amz-server-side-encryption-customer-key-MD5 | Required Can be generated either using SDK, Java standard library or any MD5 hashing web service. Field value <Customer key MD5 hash> |
For the request, copy the outputDetail.contentURL from the Job Status response.
Sample Request (Output File Download) |
---|
GET https//prd-multi-request.s3.amazonaws.com/multi-request-uploads/1000305/request/xxxxxxx/file.csv?X-Amz-Security-Token=...&X-Amz-Algorithm=xxxxx&X-Amz-Date=20160901T093114Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption-customer-algorithm%3Bx-amz-server-side-encryption-customer-key%3Bx-amz-server-side-encryption-customer-key-md5&X-Amz-Expires=86399&X-Amz-Credential=...&X-Amz-Signature=... |
Name | Characteristics |
---|---|
recordID | Element, string, maximum 16 chars A unique identifier assigned by calling application to identify a specific request provided in the input file. |
{comma} | |
HTTPStatus | Element, string The HTTP Status returned by the requested service for this request. |
{comma} | |
processResponse | Element, string The response generated by the processing application for this request. For response parameters, see the Company Entity Resolution API page. |
{end of line} |