# Create Augmentation Configuration

Endpoint to create a new augmentation configuration.

Endpoint: POST /configurations/augmentation
Version: 2
Security: apiKey

## Request fields (application/json):

  - `transactionId` (string)
    Id of the transaction, pass it in subsequent requests to make them part of the transaction
    Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

  - `featuresOn` (array)
    Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.
    Enum: "CREATE_TRANSACTION", "COMMIT_TRANSACTION"

  - `workspaceId` (string)
    Uniquely identifying ID of the workspace.
    Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

  - `name` (string)
    Display name for a configuration.
    Example: "Client configuration."

  - `configuration` (object)
    The effective settings for the augmentation.

  - `configuration.lookupConfiguration` (object)
    Describes the lookup configuration.

  - `configuration.lookupConfiguration.featureSettings` (object)
    Feature settings for lookup.

  - `configuration.lookupConfiguration.featureSettings.featuresOn` (array)
    Lookup Feature Settings featuresOn.
    Example: ["CURATE_REQUEST"]

  - `configuration.lookupConfiguration.featureSettings.featuresOff` (array)
    Lookup Feature Settings featuresOff.
    Example: ["CURATE_REQUEST"]

  - `configuration.lookupConfiguration.outputSettings` (object)
    Settings used for the response.

  - `configuration.lookupConfiguration.outputSettings.matchingClassifications` (array)

  - `configuration.lookupConfiguration.outputSettings.matchingClassifications.countryScope` (object, required)
    Matching classification countries scope.

  - `configuration.lookupConfiguration.outputSettings.matchingClassifications.countryScope.shortNames` (array, required)
    Example: ["CH"]

  - `configuration.lookupConfiguration.outputSettings.matchingClassifications.businessPartnerThreshold` (object, required)
    Matching classification thresholds.

  - `configuration.lookupConfiguration.outputSettings.matchingClassifications.businessPartnerThreshold.fullMatch` (number, required)
    Matching classification threshold.
    Example: 0.75

  - `configuration.lookupConfiguration.outputSettings.matchingClassifications.businessPartnerThreshold.maybeMatch` (number, required)
    Matching classification threshold.
    Example: 0.75

  - `configuration.lookupConfiguration.outputSettings.matchingClassifications.addressThreshold` (object, required)
    Matching classification thresholds.

  - `configuration.lookupConfiguration.outputSettings.matchingThreshold` (number)
    LookupOutputSettings matchingThreshold.
    Example: 0.75

  - `configuration.lookupConfiguration.outputSettings.maxCandidates` (integer)
    LookupOutputSettings maxCandidates.
    Example: 50

  - `configuration.lookupConfiguration.outputSettings.limit` (integer)
    Limit
    Example: 100

  - `configuration.lookupConfiguration.outputSettings.tags` (array)
    List of tags.
    Example: ["Reporting"]

  - `configuration.fetchConfiguration` (object)
    Describes the fetch configuration.

  - `configuration.fetchConfiguration.featuresOn` (array)
    Fetch Feature Settings featuresOn.
    Example: ["FORCE_EXTERNAL_CALL"]

  - `configuration.fetchConfiguration.featuresOff` (array)
    Fetch Feature Settings featuresOff.
    Example: ["FORCE_EXTERNAL_CALL"]

  - `configuration.fetchConfiguration.screeningMatchingThreshold` (number)
    ScreenMatchingThreshold.
    Example: 0.75

  - `configuration.curationConfiguration` (object)
    Data structure representing a curation configuration.

  - `configuration.curationConfiguration.curationSettings` (array)
    List of curation settings.

  - `configuration.curationConfiguration.curationSettings.countryScope` (object, required)
    (Optionally) Describes for which country the settings are for.

  - `configuration.curationConfiguration.curationSettings.countryScope.shortName` (string, required)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `configuration.curationConfiguration.curationSettings.featureSettings` (object)
    Feature settings for curation.

  - `configuration.curationConfiguration.curationSettings.featureSettings.profile` (string)
    The profile for curation. List of available curation profiles is available under (List curation profiles)[https://developer.cdq.com/reference-docs/data-clinic/tag/Configuration/#tag/Configuration/paths/~1configurations~1augmentation~1curation~1profiles/get].
    Example: "STANDARD"

  - `configuration.curationConfiguration.curationSettings.featureSettings.featuresOn` (array)
    List of features to be activated.
    Example: ["ENRICH_IDENTIFIERS"]

  - `configuration.curationConfiguration.curationSettings.featureSettings.featuresOff` (array)
    List of features to be deactivated.
    Example: ["ENRICH_IDENTIFIERS"]

  - `configuration.curationConfiguration.curationSettings.featureSettings.scopedFeaturesOn` (array)
    List of features to be activated.

  - `configuration.curationConfiguration.curationSettings.featureSettings.scopedFeaturesOn.feature` (string)
    A feature for curation. List of available curation features is available under (List curation features)[https://developer.cdq.com/reference-docs/data-clinic/tag/Configuration/#tag/Configuration/paths/~1configurations~1augmentation~1curation~1features/get].
    Example: "ENRICH_IDENTIFIERS"

  - `configuration.curationConfiguration.curationSettings.featureSettings.scopedFeaturesOn.jsonPaths` (array)
    Selectors of the Business Partner fields the feature is applied to.
    Example: ["$.businessPartner.names[?(@.type.technicalKey=='LEGAL')].value"]

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings` (object)
    Settings for address curation.

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.curationLevelThreshold` (string)
    Defines threshold for address found in external source like HERE above which it is consider as good. Range 0..1.
    Example: "0.75"

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.dataSourcePriority` (object)
    Preferred data sources for curation. Default PrimaryAddressDataSource is HERE. Default SecondaryAddressDataSource is CDQ.

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.dataSourcePriority.primaryAddressDataSource` (object)
    Object representing the data source for addresses, containing technical keys and thresholds.

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.dataSourcePriority.primaryAddressDataSource.technicalKey` (string)
    Technical key for Address Data Source.
    Example: "HERE"

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.dataSourcePriority.primaryAddressDataSource.threshold` (number)
    Threshold for the address data source. The threshold is a value between 0.0 and 1.0.
    Example: "0.4"

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.dataSourcePriority.secondaryAddressDataSources` (array)
    List of secondary address data sources.

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.numberSeparator` (object)
    Number separator for features JOIN_THOROUGHFARE_NUMBER_PREFIX, JOIN_THOROUGHFARE_NUMBER_POSTFIX.

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.numberSeparator.value` (string)
    The value of the separator.
    Example: ","

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.inputAddressConceptsIgnored` (array)

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.inputAddressConceptsIgnored.technicalKey` (string)
    Address concept technical key for address curation.
    Example: "THOROUGHFARE_VALUE"

  - `configuration.curationConfiguration.curationSettings.addressCurationSettings.ignoreAddressConcepts` (array)
    deprecated, please use inputAddressConceptsIgnored instead

  - `configuration.curationConfiguration.curationSettings.outputSettings` (object)
    Output settings for curation.

  - `configuration.curationConfiguration.curationSettings.outputSettings.outputLanguage` (object)
    The language used for the curation output.

  - `configuration.curationConfiguration.curationSettings.outputSettings.outputLanguage.technicalKey` (string)
    Technical key of the language used for the curation output.
    Example: "en"

  - `configuration.curationConfiguration.curationSettings.outputSettings.outputCharsets` (array)

  - `configuration.curationConfiguration.curationSettings.outputSettings.outputCharsets.concept` (string)
    Defines concept for output charset.
    Example: "ADDRESS"

  - `configuration.curationConfiguration.curationSettings.outputSettings.outputCharsets.charset` (string)
    Defines type for output charset.
    Example: "LATIN"

  - `configuration.curationConfiguration.goldenRecordSettings` (object)
    Golden Record settings for a specific configuration.

  - `configuration.curationConfiguration.goldenRecordSettings.dataSources` (array, required)

  - `configuration.curationConfiguration.goldenRecordSettings.dataSources.countryScope` (object, required)
    (Optionally) Describes for which country the settings are for.

  - `configuration.curationConfiguration.goldenRecordSettings.dataSources.primaryDataSource` (object, required)
    Golden Record settings for a single data source.

  - `configuration.curationConfiguration.goldenRecordSettings.dataSources.primaryDataSource.technicalKey` (string, required)
    Technical key of the data source.
    Example: "BR_RF"

  - `configuration.curationConfiguration.goldenRecordSettings.dataSources.secondaryDataSources` (array)

  - `configuration.curationConfiguration.goldenRecordSettings.dataSources.otherDataSources` (array)

  - `configuration.curationConfiguration.goldenRecordSettings.dataSources.unallowedDataSources` (array)

  - `configuration.updateClassificationConfiguration` (object)
    Model that allows customization of update classification rules.

  - `configuration.updateClassificationConfiguration.updateClassificationRules` (array)
    List of update classification rules, each linked to customer-provided classification keys.

  - `configuration.updateClassificationConfiguration.updateClassificationRules.technicalKey` (string)
    Unique identifier for the update classification rule.
    Example: "RULE123"

  - `configuration.updateClassificationConfiguration.updateClassificationRules.classification` (object)
    Container for classification details. Overwrites the default classification of the rule.

  - `configuration.updateClassificationConfiguration.updateClassificationRules.classification.technicalKey` (string)
    Technical key of an update classification.
    Example: "MAJOR"

  - `configuration.referenceDataSourceUsages` (array)
    At least 1 element required when updating configuration for prevention of removal.

  - `configuration.referenceDataSourceUsages.referenceDataSource` (object, required)
    Data Source of the Data Pool.

  - `configuration.referenceDataSourceUsages.referenceDataSource.technicalKey` (string, required)
    Technical key of the data source.
    Example: "BR_RF"

  - `configuration.referenceDataSourceUsages.lookup` (object)
    Lookup for ReferenceDataSourceUsageSettings.
    Example: true

  - `configuration.referenceDataSourceUsages.lookup.enabled` (boolean, required)
    Boolean indicates that lookup is enabled.
    Example: true

  - `configuration.referenceDataSourceUsages.lookup.quality` (object)
    Quality settings for data source usage.

  - `configuration.referenceDataSourceUsages.lookup.quality.threshold` (object)
    Quality threshold configuration.

  - `configuration.referenceDataSourceUsages.lookup.quality.threshold.technicalKey` (string)
    Defines the minimum acceptable quality level, this can be used only for the CDQ_POOL.
Selecting a level includes the selected level and all higher-quality levels.
Quality hierarchy: OK > INFO > WARNING > ERROR.
    Enum: "INFO", "WARNING", "ERROR"

  - `configuration.referenceDataSourceUsages.updates` (object)
    Settings for update monitoring.

  - `configuration.referenceDataSourceUsages.updates.enabled` (boolean, required)
    Indicates whether the monitoring is enabled or not.
    Example: true

  - `configuration.referenceDataSourceUsages.updates.quality` (object)
    Quality settings for data source usage.

  - `configuration.referenceDataSourceUsages.updates.quality.threshold` (object)
    Quality threshold configuration.

  - `configuration.referenceDataSourceUsages.updates.quality.threshold.technicalKey` (string)
    Defines the minimum acceptable quality level, this can be used only for the CDQ_POOL.
Selecting a level includes the selected level and all higher-quality levels.
Quality hierarchy: OK > INFO > WARNING > ERROR.
    Example: "WARNING"

  - `configuration.storageDataSourceUsages` (array)
    At least 1 element required when updating configuration for prevention of removal.

  - `configuration.storageDataSourceUsages.storageDataSource` (object, required)
    Describes a storage data source.

  - `configuration.storageDataSourceUsages.storageDataSource.id` (string, required)
    Unique identifier for a Data Source of the Storage.
    Example: "648824a691d8d2503d65103e"

  - `configuration.storageDataSourceUsages.lookup` (object)
    Lookup for StorageDataSourceUsageSettings.
    Example: true

  - `configuration.storageDataSourceUsages.lookup.enabled` (boolean, required)
    Boolean indicates that lookup is enabled.
    Example: true

  - `configuration.storageDataSourceUsages.updates` (object)
    Settings for update monitoring.

  - `configuration.storageDataSourceUsages.updates.enabled` (boolean, required)
    Indicates whether the monitoring is enabled or not.
    Example: true

  - `configuration.storageDataSourceUsages.updates.linkageStrategy` (object)
    Linkage strategy.

  - `configuration.storageDataSourceUsages.updates.linkageStrategy.externalContext` (object)
    The strategy context for external linkage with an array of identifiers.

  - `configuration.storageDataSourceUsages.updates.linkageStrategy.externalContext.identifiers` (array)

  - `configuration.storageDataSourceUsages.updates.linkageStrategy.externalContext.identifiers.type` (object)
    LinkageStrategyExternalContextIdentifierType.

  - `relatedConfigurations` (array)
    List of related configurations.

  - `relatedConfigurations.id` (string)
    Id of the related configuration.
    Example: "a0200062daa56952a8640005"

  - `relatedConfigurations.owner` (object)
    Configuration which relates to the root configuration.

  - `relatedConfigurations.owner.service` (string)
    Name of the service which is the owner of the configuration.
    Example: "reference-data-api"

  - `relatedConfigurations.owner.path` (string)
    Endpoint used to read the related configuration.
    Example: "/configurations/businesspartnerlookup"

  - `copiedFrom` (object)
    The configuration from which the new configuration is copied.

  - `copiedFrom.configurationId` (string, required)
    Uniquely identifies a configuration.
    Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

  - `copiedFrom.workspaceId` (string, required)
    Uniquely identifying ID of the workspace.
    Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

## Response 200 fields (application/json):

  - `id` (string)
    Uniquely identifies a configuration.
    Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

  - `name` (string)
    Display name for a configuration.
    Example: "Client configuration."

  - `version` (integer)
    Version number of the configuration.
    Example: 1

  - `createdAt` (string)
    Date of creation (ISO 8601-compliant).
    Example: "2026-08-20T10:05:20Z"

  - `createdBy` (string)
    Creator of a resource.
    Example: "76248934691294444"

  - `modifiedAt` (string)
    Date of modification (ISO 8601-compliant).
    Example: "2026-08-20T10:05:20Z"

  - `defaultConfiguration` (boolean)
    Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.
    Example: true

  - `configuration` (object)
    The effective settings for the augmentation.

  - `configuration.lookupConfiguration` (object)
    Describes the lookup configuration.

  - `configuration.fetchConfiguration` (object)
    Describes the fetch configuration.

  - `configuration.curationConfiguration` (object)
    Data structure representing a curation configuration.

  - `configuration.updateClassificationConfiguration` (object)
    Model that allows customization of update classification rules.

  - `configuration.referenceDataSourceUsages` (array)
    At least 1 element required when updating configuration for prevention of removal.

  - `configuration.referenceDataSourceUsages.referenceDataSource` (object, required)
    Data Source of the Data Pool.

  - `configuration.referenceDataSourceUsages.lookup` (object)
    Lookup for ReferenceDataSourceUsageSettings.
    Example: true

  - `configuration.referenceDataSourceUsages.lookup.enabled` (boolean, required)
    Boolean indicates that lookup is enabled.
    Example: true

  - `configuration.referenceDataSourceUsages.lookup.quality` (object)
    Quality settings for data source usage.

  - `configuration.referenceDataSourceUsages.updates` (object)
    Settings for update monitoring.

  - `configuration.storageDataSourceUsages` (array)
    At least 1 element required when updating configuration for prevention of removal.

  - `relatedConfigurations` (array)
    List of related configurations.

  - `transactionId` (string)
    Id of the transaction, pass it in subsequent requests to make them part of the transaction
    Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"


## Response 400 fields