Data Curation API (2)

This API provides services to curate and enrich Business Partner and address data.

Address Curation

Download OpenAPI description

api-v2.json

api-v2.yaml

Servers

Production

https://api.cdq.com/data-curation/rest/

Batch Curation

Everything about Batch Curation

Operations

List Business Partner Curation Results

Request

Retrieves curation results for particular job.

Security

apiKey

Path

idstring(JobId)required

ID of the Data Curation job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de

Query

businessPartnerIdArray of strings(BusinessPartnerId)

Business Partner IDs which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40

startAfterstring(StartAfter)

Used to retrieve the next page of results.

Example: startAfter=5712566172571652

limitinteger(int32)[ 1 .. 100 ]

Number of results that should be fetched. Maximum 100 results can be returned in one page.

Default 100

Example: limit=50

curl -i -X GET \
  https://api.cdq.com/data-curation/rest/v2/curationjobs/35f23c03-1c22-45fe-9484-3ffe769325de/results \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

limitinteger(Limit)

Number of items per page.

Example: "100"

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"

valuesArray of objects(CurationJobResult)

List of Curation Job Results.

nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"

Response

application/json

{
  "startAfter": "5712566172571652",
  "limit": "100",
  "total": "67",
  "values": [
    { … }
  ],
  "nextStartAfter": "5712566172571652"
}

Start Curation Job

Request

Start a batch curation job on a given storage.

Security

apiKey

Bodyapplication/jsonrequired

namestring<= 50 characters

Name of a Job.

Example: "Process vendor data."

descriptionstring<= 200 characters

Detailed description of a Job.

Example: "I started this job to improve quality of our data."

storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"

dataSourceIdsArray 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"]

countryShortNamesArray 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"]

workersinteger[ 1 .. 8 ]

Number of workers to be used for the job. By default, the number of workers is 1.

Default 1

Example: "3"

profilestring(Profile)

Used to configure the curation process. Available wiki documentation for profiles:

Enum"STANDARD""ADDRESS_ONLY""STANDARD_ADDRESS_CURATION_AND_ENRICHMENT""ADDRESS_STANDARDIZATION""ADDRESS_TRANSLATION""BUSINESS_PARTNER_ONLY""FEATURES_OFF""NATURAL_PERSON_SCREENING""PRECURATION""GOLDEN_RECORD"

Example: "STANDARD"

languagestring(LanguageTechnicalKey)

ISO 639-1 two-letter code of languages.

Example: "DE"

outputCharsetsArray of objects(OutputCharset)

List of Output Character Sets.

addressDataSourcesobject(AddressDataSources)

Preferred data sources for curation. Default PrimaryAddressDataSource is HERE. Default SecondaryAddressDataSource is CDQ.

addressCurationLevelThresholdstring(CurationLevel)

Indicator for curation quality. Defines how good curation was.

Additional documentation can be found here.

Enum Value	Description
UNKNOWN	No possibility to determine curation level.
LEVEL_1	The address was not found by the CDQ in the employed external data sources.
LEVEL_2	The address was found, but there were significant changes in critical fields.
LEVEL_3	The address was found and there are minor changes in highly important fields.
LEVEL_4	The address was found by the CDQ. There were only changes in less critical fields such as the address/premise or address/thoroughfare/number.
LEVEL_5	The address was found by the CDQ, but no major changes have been made as the address was correct.
LEVEL_6	The address was found in the shared CDQ data pool. This means another company uses the same address which is a very reliable indicator that the address is correct (only in a alpha version)

Example: "LEVEL_1"

fieldsArray of strings

Fields are deprecated.

Items Enum"formattedAddress""legalAddress""companyStatus""classifications"

Example: ["formattedAddress"]

featuresOnArray of strings(Feature)

List of features to be activated.

Items Enum"ACTIVATE_DATASOURCE_BVD""ACTIVATE_DATASOURCE_DNB""ALL_ADDRESS_VERSIONS""CAPITALIZE_ADDRESS""CONFIRM_IDENTIFIERS""DETECT_INDUSTRIAL_ZONE""ENABLE_FUZZY_ENRICHMENTS""ENABLE_SETTINGS""ENABLE_UNALLOWED_NAME_VALUE_VALIDATION""ENRICH_ADDRESS"

Example: ["ENRICH_ADDRESS"]

featuresOffArray of strings(Feature)

List of features to be deactivated.

Example: ["ENRICH_ADDRESS"]

configurationIdstring(DataCurationConfigurationId)

Configuration ID used to set up curation. 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):

outputLanguageTechnicalKey
addressDataSources
profile
featuresOn
featuresOff
outputCharsets
addressCurationLevelThreshold
numberSeparator
inputAddressConceptsIgnored

Example: "5c5356588c72a028c448adbd"

optionSkipReportbooleanDeprecated

Deprecated and not usable. For a report creation, use reportsRequest.

Default true

Example: "true"

reportsRequestobject(DataCurationReportsRequest)Deprecated

Deprecated. Reports are available in Data Clinic app.

curl -i -X POST \
  https://api.cdq.com/data-curation/rest/curationjobs \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Process vendor data.",
    "description": "I started this job to improve quality of our data.",
    "storageId": "72d6900fce6b326088f5d9d91049e3e6",
    "dataSourceIds": [
      "648824a691d8d2503d65103e"
    ],
    "countryShortNames": [
      "CH"
    ],
    "workers": "3",
    "profile": "STANDARD",
    "language": "DE",
    "outputCharsets": [
      {
        "concept": "ADDRESS",
        "charset": "LATIN"
      }
    ],
    "addressDataSources": {
      "primaryAddressDataSource": {
        "technicalKey": "HERE",
        "threshold": "0.4"
      },
      "secondaryAddressDataSources": [
        {
          "technicalKey": "HERE",
          "threshold": "0.4"
        }
      ]
    },
    "addressCurationLevelThreshold": "LEVEL_1",
    "fields": [
      "formattedAddress"
    ],
    "featuresOn": [
      "ENRICH_ADDRESS"
    ],
    "featuresOff": [
      "ENRICH_ADDRESS"
    ],
    "optionSkipReport": "true",
    "reportsRequest": {
      "dataCurationJobId": "a34fb367-85aa-400f-b369-53863432050c",
      "name": "Data Curation Reports Job",
      "description": "The report will be generated for the Data Curation Job with ID: a34fb367-85aa-400f-b369-53863432050c.",
      "reportsConfiguration": {
        "addressCuration": {
          "build": "true"
        },
        "legalEntityCuration": {
          "build": "true"
        },
        "naturalPersonScreening": {
          "build": "true"
        },
        "vatRegistrationData": {
          "build": "true"
        }
      }
    },
    "configurationId": "5c5356588c72a028c448adbd"
  }'

Responses

Bodyapplication/json

idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"

namestring

Name of a Job.

Example: "Process vendor data"

descriptionstring

Detailed description of a Job.

Example: "I started this job to improve quality of our data."

storageIdstring(BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"

dataSourceIdsArray of strings(BusinessPartnerStorageDataSourceId)

List of Data Source IDs.

Example: ["648824a691d8d2503d65103e"]

countryShortNamesArray of strings(CountryShortName)

List of country short names.

Example: ["CH"]

statusstring(JobStatus)

Curation Job execution status.

Enum"UNKNOWN""CREATED""PERSISTED""SCHEDULED""WAITING""RUNNING""FINISHED""DIED""CANCELED""FAILED"

Example: "RUNNING"

statusMessagestring(JobStatusMessage)

Additional information to explain the status.

Example: "The job failed because storage is empty."

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-19T06:23:10Z"

userstring(JobUser)

ID of (human) user or API key.

Example: "742429-234242-4343-232323"

progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"

attachmentsArray of objects(FileResource)

List of attachments.

reportsJobIdstring

Unique identifier of a Reports Job.

Example: "6be92567-4327-4463-813f-a8c990410d79"

reportsConfigurationobject(DataCurationReportsConfiguration)

Configures if and how Data Curation reports are generated.

Response

application/json

{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "name": "Process vendor data",
  "description": "I started this job to improve quality of our data.",
  "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  "dataSourceIds": [
    "648824a691d8d2503d65103e"
  ],
  "countryShortNames": [
    "CH"
  ],
  "status": "RUNNING",
  "statusMessage": "The job failed because storage is empty.",
  "createdAt": "2025-08-19T06:23:10Z",
  "user": "742429-234242-4343-232323",
  "progress": "77",
  "attachments": [
    { … }
  ],
  "reportsJobId": "6be92567-4327-4463-813f-a8c990410d79",
  "reportsConfiguration": {
    "addressCuration": { … },
    "legalEntityCuration": { … },
    "naturalPersonScreening": { … },
    "vatRegistrationData": { … }
  }
}

Poll Curation Job

Request

After you have started a curation job, you will receive a job id in the response. { 'id' : '<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.

Security

apiKey

Path

idstring(JobId)required

ID of the Data Curation job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de

curl -i -X GET \
  https://api.cdq.com/data-curation/rest/curationjobs/35f23c03-1c22-45fe-9484-3ffe769325de \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"

namestring

Name of a Job.

Example: "Process vendor data"

descriptionstring

Detailed description of a Job.

Example: "I started this job to improve quality of our data."

storageIdstring(BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"

dataSourceIdsArray of strings(BusinessPartnerStorageDataSourceId)

List of Data Source IDs.

Example: ["648824a691d8d2503d65103e"]

countryShortNamesArray of strings(CountryShortName)

List of country short names.

Example: ["CH"]

statusstring(JobStatus)

Curation Job execution status.

Enum"UNKNOWN""CREATED""PERSISTED""SCHEDULED""WAITING""RUNNING""FINISHED""DIED""CANCELED""FAILED"

Example: "RUNNING"

statusMessagestring(JobStatusMessage)

Additional information to explain the status.

Example: "The job failed because storage is empty."

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-19T06:23:10Z"

userstring(JobUser)

ID of (human) user or API key.

Example: "742429-234242-4343-232323"

progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"

attachmentsArray of objects(FileResource)

List of attachments.

reportsJobIdstring

Unique identifier of a Reports Job.

Example: "6be92567-4327-4463-813f-a8c990410d79"

reportsConfigurationobject(DataCurationReportsConfiguration)

Configures if and how Data Curation reports are generated.

Response

application/json

{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "name": "Process vendor data",
  "description": "I started this job to improve quality of our data.",
  "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  "dataSourceIds": [
    "648824a691d8d2503d65103e"
  ],
  "countryShortNames": [
    "CH"
  ],
  "status": "RUNNING",
  "statusMessage": "The job failed because storage is empty.",
  "createdAt": "2025-08-19T06:23:10Z",
  "user": "742429-234242-4343-232323",
  "progress": "77",
  "attachments": [
    { … }
  ],
  "reportsJobId": "6be92567-4327-4463-813f-a8c990410d79",
  "reportsConfiguration": {
    "addressCuration": { … },
    "legalEntityCuration": { … },
    "naturalPersonScreening": { … },
    "vatRegistrationData": { … }
  }
}

Business Partners

Everything about Business Partners

Operations

Processing Logs

Operations

Configuration

Operations

Data Curation API (2)

Batch Curation

List Business Partner Curation Results

Request

Responses

Share the feedback!

Start Curation Job

Request

Responses

Share the feedback!

Poll Curation Job

Request

Responses

Share the feedback!

Business Partners

Processing Logs

Configuration

Data Curation API (2)

Batch Curation

List Business Partner Curation Results

Request

Responses

Share the feedback!

Start Curation Job

RequestExpand all

Responses

Share the feedback!

Poll Curation Job

Request

Responses

Share the feedback!

Business Partners

Processing Logs

Configuration

Request