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
OK
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
200
400
application/json
{
"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"status": "RUNNING",
"createdAt": "2025-02-28T12:57:09Z",
"createdBy": "76248934691294444",
"progress": "77",
"result": {
"statistics": {
"numberOfRecords": "10",
"numberOfFailed": "0",
"numberOfInserts": "10",
"numberOfQuotaExceeded": "10",
"numberOfUnknown": "0"
}
},
"modifiedAt": "2025-02-28T12:57:09Z",
"statusMessage": "The job failed because storage is empty."