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.
OK
Unauthorized
Forbidden
Not Found
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "status": "RUNNING",
- "createdAt": "2024-11-09T17:00:57Z",
- "createdBy": "76248934691294444",
- "progress": "77",
- "result": {
- "statistics": {
- "numberOfRecords": "10",
- "numberOfFailed": "0",
- "numberOfInserts": "10",
- "numberOfQuotaExceeded": "10",
- "numberOfUnknown": "0"
}
}, - "modifiedAt": "2024-11-09T17:00:57Z",
- "statusMessage": "The job failed because storage is empty."
}
Reads the results of a DNB lookup job by job ID.
OK
Not Found
{- "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
}
}
}
}
]
}
]
}
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.
cmd
OK
Created
The sent request is malformed.
Unauthorized
Forbidden
Not Found
{- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dnbUser": "myDnbUser",
- "dnbPassword": "myDnbPassword",
- "mode": "EXTENDED_MATCH",
- "featuresOn": [
- "INCREMENT"
], - "featuresOff": [
- "INCREMENT"
], - "dnbDataSource": "DNB_MASTER_DATA_EXTENDED"
}
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "status": "RUNNING",
- "createdAt": "2024-11-09T17:00:57Z",
- "createdBy": "76248934691294444",
- "progress": "77",
- "result": {
- "statistics": {
- "numberOfRecords": "10",
- "numberOfFailed": "0",
- "numberOfInserts": "10",
- "numberOfQuotaExceeded": "10",
- "numberOfUnknown": "0"
}
}, - "modifiedAt": "2024-11-09T17:00:57Z",
- "statusMessage": "The job failed because storage is empty."
}
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.
OK
{- "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"
}
]
}
Endpoint is deprecated. Should not be used anymore. For report generation use POST /public/referencedatareports
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" |
OK
The sent request is malformed.
{- "batchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "cdqBatchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "optionCountriesFilter": [
- "CH"
]
}
{- "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"
}
]
}