Batch Lookup

Poll DNB Lookup JobWSDL

After you have started a curation job, you will receive a job id in the response: { 'id' : '' } Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can download the results.

SecurityapiKey

Request

path Parameters

required

string

ID of the DNB lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

get/dnb/lookupjobs/{id}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"status": "RUNNING",
"createdAt": "2024-04-25T08:59:32Z",
"createdBy": "76248934691294444",
"progress": "77",
"result": {"statistics": {"numberOfRecords": "10",
"numberOfFailed": "0",
"numberOfInserts": "10",
"numberOfQuotaExceeded": "10",
"numberOfUnknown": "0"
}
},
"modifiedAt": "2024-04-25T08:59:32Z",
"statusMessage": "The job failed because storage is empty."
}

Poll Lookup Job

SecurityapiKey

Request

path Parameters

required

string

ID of the lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

get/lookupjobs/{id}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"status": "RUNNING",
"createdAt": "2024-04-25T08:59:32Z",
"user": "johndoe",
"progress": "77"
}

Read DNB Lookup Job resultsWSDL

Reads the results of a DNB lookup job by job ID.

SecurityapiKey

Request

path Parameters

required

string

ID of the lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957

query Parameters

businessPartnerId	Array of strings (BusinessPartnerId) Business Partner IDs which should be filtered. Example: businessPartnerId=63e635235c06b7396330fe40
limit	integer <int32> [ 1 .. 100 ] Default: 100 Number of results that should be fetched. Maximum 100 results can be returned in one page. Example: limit=50
startAfter	string Default: "0" Only records with an ID greater than this ID will be fetched. Example: startAfter=5712566172571652

Responses

200

404

Not Found

get/dnb/lookupjobs/{id}/results

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"limit": "100",
"total": "67",
"values": [{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"businessPartnerId": "63e635235c06b7396330fe40",
"addressId": "0",
"externalId": "The ID managed in the customer's SAP systems.",
"requestData": {"nameLocal": "CDQ",
"nameInternational": "CDQ AG",
"countryValue": "Switzerland",
"countryShortName": "CH",
"administrativeArea": "Sankt Gallen",
"postCodeValue": "9000",
"localityValue": "Sankt Gallen",
"thoroughfareValue": "Lukasstraße 4",
"thoroughfareNumber": "4",
"premiseValue": "Lukasstraße 4",
"classificationCode": "20.20Z",
"classificationTypeName": "NAF 2003",
"classificationName": "Manufacture of pesticides and other agrochemical products.",
"careOf": "CDQ GmbH c/o Product Department",
"addressTypes": "LEGAL_ADDRESS",
"isInactive": "Inactive",
"stceg": "CHE-218.608.88",
"stcd1": "CHE-218.608.88",
"stcd2": "CHE-218.608.88",
"stcd3": "CHE-218.608.88",
"stcd4": "CHE-218.608.88",
"stcd5": "CHE-218.608.88",
"dataSource": "648824a691d8d2503d65103e",
"duns": "15-048-3782"
},
"matchResults": [{"candidate": {"displaySequence": "1",
"organization": {"duns": "804735132",
"dunsControlStatus": {"operatingStatus": { },
"isMailUndeliverable": null
},
"primaryName": "GORMAN MANUFACTURING COMPANY, INC.",
"tradeStyleNames": [{ }
],
"telephone": [{ }
],
"websiteAddress": [{ }
],
"primaryAddress": {"addressCountry": { },
"addressLocality": { },
"addressRegion": { },
"postalCode": null,
"postalCodeExtension": null,
"streetAddress": { }
},
"mailingAddress": "",
"registrationNumbers": [{ }
],
"mostSeniorPrincipals": [{ }
],
"isStandalone": "false",
"corporateLinkage": {"familytreeRolesPlayed": [ ]
}
},
"matchQualityInformation": {"confidenceCode": "6",
"matchGrade": "AZZZZZZZFZZ",
"matchGradeComponentsCount": "11",
"matchGradeComponents": [{ }
],
"matchDataProfile": "0000000000989800000000009898",
"matchDataProfileComponentsCount": "14",
"matchDataProfileComponents": [{ }
],
"nameMatchScore": "85.5"
}
},
"matchingProfile": {"matchingScores": {"overall": {"classification": null,
"value": null,
"explanation": null
},
"businessPartner": {"classification": null,
"value": null,
"explanation": null
},
"address": {"classification": null,
"value": null,
"explanation": null
}
}
}
}
]
}
]
}

Start DNB Lookup JobWSDL

Initialisation of a DNB lookup job. The job will be executed asynchronously. The response contains the job ID which can be used to poll for the status of the job.

SecurityapiKey

Request

Request Body schema: application/json
required

cmd

dnbDataSource

string

Default: "DNB"

D&B name of the product to be used in the job.

Enum:	Description
DNB	D&B Master Data
DNB_MASTER_DATA_BASIC	D&B Master Data Basic
DNB_MASTER_DATA_PLUS_MGMT	D&B Master Data Plus Management
DNB_MASTER_DATA_PLUS_LINKAGE	D&B Master Data Plus Linkage
DNB_MASTER_DATA_EXTENDED	D&B Master Data Extended
DNB_LINKAGE_LNKELI	D&B Linkage LNKELI

Example: "DNB_MASTER_DATA_EXTENDED"

dnbPassword

string

Optional if credentials are available in user or organization settings.

Example: "myDnbPassword"

dnbUser

string

Optional if credentials are available in user or organization settings.

Example: "myDnbUser"

featuresOff

Array of strings (DnbLookupJobFeature)

List of features to be deactivated in the lookup.

Items Enum:	Description
INCREMENT	Continue processing after the last processed result with a goal to run on newly created business partners from a storage.
ENABLE_PARTIAL_QUOTA_CONSUMPTION	Enables to run import job on a remaining quota when full quota not available.
ACTIVATE_MASTER_DATA_EXTENDED	Enables to use data blocks instead of cmplek when fetching data from DNB.
SKIP_DNB_IMPORT	If it is not used, all DUNS will be fetched from DNB. Should be used in combination with ENRICH_COMMERCIAL_ULTIMATE to only load what is needed for commercial ultimate calculation.
ENRICH_COMMERCIAL_ULTIMATE	Calculate commercial ultimate for each business partner in storage.

Example: ["INCREMENT"]

featuresOn

Array of strings (DnbLookupJobFeature)

List of features to be activated in the lookup.

Items Enum:	Description
INCREMENT	Continue processing after the last processed result with a goal to run on newly created business partners from a storage.
ENABLE_PARTIAL_QUOTA_CONSUMPTION	Enables to run import job on a remaining quota when full quota not available.
ACTIVATE_MASTER_DATA_EXTENDED	Enables to use data blocks instead of cmplek when fetching data from DNB.
SKIP_DNB_IMPORT	If it is not used, all DUNS will be fetched from DNB. Should be used in combination with ENRICH_COMMERCIAL_ULTIMATE to only load what is needed for commercial ultimate calculation.
ENRICH_COMMERCIAL_ULTIMATE	Calculate commercial ultimate for each business partner in storage.

Example: ["INCREMENT"]

mode

string

MATCH contains just the match results while EXTENDED_MATCH also includes D&B products (attention increased costs)

Enum: "EXTENDED_MATCH" "MATCH"

Example: "EXTENDED_MATCH"

storageId

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"

Responses

200

201

Created

400

The sent request is malformed.

401

Unauthorized

403

Forbidden

404

Not Found

post/dnb/lookupjobs

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"dnbUser": "myDnbUser",
"dnbPassword": "myDnbPassword",
"mode": "EXTENDED_MATCH",
"featuresOn": ["INCREMENT"
],
"featuresOff": ["INCREMENT"
],
"dnbDataSource": "DNB_MASTER_DATA_EXTENDED"
}

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"status": "RUNNING",
"createdAt": "2024-04-25T08:59:32Z",
"createdBy": "76248934691294444",
"progress": "77",
"result": {"statistics": {"numberOfRecords": "10",
"numberOfFailed": "0",
"numberOfInserts": "10",
"numberOfQuotaExceeded": "10",
"numberOfUnknown": "0"
}
},
"modifiedAt": "2024-04-25T08:59:32Z",
"statusMessage": "The job failed because storage is empty."
}

Start DNB Report Lookup JobWSDL

Generates a DNB report lookup job. The job will be executed asynchronously. The response contains the job ID which can be used to poll for the status of the job.

SecurityapiKey

Request

path Parameters

required

string

ID of the DNB report lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957

Responses

200

get/dnb/lookupreportjobs/{id}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"batchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"progress": "77",
"status": "RUNNING",
"optionCountriesFilter": ["CH"
],
"attachments": [{"name": "filename.xlsx",
"url": "cdl-runtime-data/folder/filename.xlsx"
}
]
}

Start DNB Report Lookup JobWSDL

Endpoint is deprecated. Should not be used anymore. For report generation use POST /public/referencedatareports

SecurityapiKey

Request

Request Body schema: application/json
required

cmd

batchLookupJobId required	string (JobId) Unique identifier of a job. Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
cdqBatchLookupJobId	string (JobId) Unique identifier of a job. Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
optionCountriesFilter	Array of strings (CountryShortName) List of countries to filter. Example: ["CH"]
storageId required	string (BusinessPartnerStorageId) Unique identifier of the Storage. Example: "72d6900fce6b326088f5d9d91049e3e6"

Responses

200

400

The sent request is malformed.

post/dnb/lookupreportjobs

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"batchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
"cdqBatchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"optionCountriesFilter": ["CH"
]
}

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"batchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"progress": "77",
"status": "RUNNING",
"optionCountriesFilter": ["CH"
],
"attachments": [{"name": "filename.xlsx",
"url": "cdl-runtime-data/folder/filename.xlsx"
}
]
}

Start Lookup Job

Initialisation of a lookup job. The job will be executed asynchronously. The response contains the job ID which can be used to poll for the status of the job.

SecurityapiKey

Request

Request Body schema: application/json
required

cmd

configurationId	string Configuration ID used to set up lookup. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged): `dataSource` `dataMatchingDefinitionId` `matchingThreshold` `maxCandidates` `pageSize` `featuresOn` `featuresOff` Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
countryShortNames	Array of strings (CountryShortName) If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (means from all countries) are processed (considering other filters). Example: ["CH"]
dataSourceIds	Array of strings (BusinessPartnerStorageDataSourceId) If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (means from all data sources) are processed (considering other filters). Example: ["648824a691d8d2503d65103e"]
featuresOff	Array of strings The features switched off in the lookup. Example: ["ACTIVATE_DATASOURCE_BVD"]
featuresOn	Array of strings The features with which the lookup should be called. Example: ["ACTIVATE_DATASOURCE_BVD"]
optionBatchLookupJobId	string Provide the ID of batch lookup job which produced the matches. Providing this option make sens with optionSkipLookup set to true. Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
optionCandidates	integer Default: 20 Define number of candidates taken into consideration in the matching process. Example: "15"
optionDataMatchingDefinitionId	string Provide the id of the data matching definition id. When id wrongly set then no matching score will be provided. Example: "6461e6113b1865304b3038b6"
optionDelay	integer Add a delay between next lookup calls in milliseconds (example 3000 = 3s). Example: "3000"
optionMatchingConfiguration	string Default: "DEFAULT" Provide the name of the matching configuration. When not set then the default configuration is used. Example: "DEFAULT"
optionMatchingThreshold	string The matching threshold. When not set then all entries are taken into consideration. Example: "0.8"
optionReportMatchingThreshold	string The matching threshold used to filter out results in report. Example: "0.8"
optionReportName	string The report name. If a report with that name exists in S3 it will be overwritten. If report name is empty the report name will be the storage ID. Example: "MyReport"
optionShowAll	boolean Default: false Display also entries without matches. Example: "true"
optionSkipExcelReport	boolean Deprecated Default: false To generate report use `POST /referencedatareports`. Example: "true"
optionSkipLookup	boolean Default: false Skip Lookup. Example: "false"
storageId	string The storage ID for which the batch lookup should be done. Example: "72d6900fce6b326088f5d9d91049e3e6"
	Array of objects This field allows to filter data mirrors that will be queried. For each data mirror, data sources can also be filtered. Leave empty to include all available data mirrors in query.

Responses

200

201

Created

400

The sent request is malformed.

401

Unauthorized

403

Forbidden

404

Not Found

post/lookupjobs

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"optionReportName": "MyReport",
"optionSkipLookup": "false",
"optionBatchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
"optionSkipExcelReport": "true",
"optionShowAll": "true",
"optionMatchingThreshold": "0.8",
"optionReportMatchingThreshold": "0.8",
"optionCandidates": "15",
"optionMatchingConfiguration": "DEFAULT",
"optionDataMatchingDefinitionId": "6461e6113b1865304b3038b6",
"optionDelay": "3000",
"dataSourceIds": ["648824a691d8d2503d65103e"
],
"countryShortNames": ["CH"
],
"configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"storagesDataSources": [{"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"dataSources": ["648824a691d8d2503d65103e"
]
}
],
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
}

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"status": "RUNNING",
"createdAt": "2024-04-25T08:59:32Z",
"user": "johndoe",
"progress": "77"
}

Batch Lookup

Poll DNB Lookup JobWSDL

path Parameters

Poll Lookup Job

path Parameters

Read DNB Lookup Job resultsWSDL

path Parameters

query Parameters

Start DNB Lookup JobWSDL

Request Body schema: application/jsonrequired

Start DNB Report Lookup JobWSDL

path Parameters

Start DNB Report Lookup JobWSDL

Request Body schema: application/jsonrequired

Start Lookup Job

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required