Configurations

Business Partners

Everything about Business Partners

Operations

Analytics

Everything about reference data analytics

Registrations

Operations

Addresses

Everything about Addresses

Operations

Bulk Fetch

Operations

Bulk Lookup

Operations

Cancel Bulk

Operations

CEDEX Lookup

Operations

Batch Lookup

Operations

Batch Lookup Result

Operations

Administrative Area Index

Operations

DNB

Operations

Configurations

Operations

List Lookup Features

Request

Retrieve List of Available Lookup Features.

Security

basicAuth

Query

pageinteger(schemas-Page)>= 0

Current page number.

Default 0

Example: page=1

pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Example: pageSize=10

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/configurations/businesspartnerlookup/features

Responses

Successful operation

Bodyapplication/json

pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "10"

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"

pageinteger(schemas-Page)>= 0

Current page number.

Default 0

Example: "1"

valuesArray of objects(LookupFeatureSearchResult)

List of lookup features.

Response

application/json

{
  "pageSize": "10",
  "total": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

List Fetch Features

Request

Retrieve List of Available Fetch Features.

Security

basicAuth

Query

pageinteger(schemas-Page)>= 0

Current page number.

Default 0

Example: page=1

pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Example: pageSize=10

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/configurations/businesspartnerfetch/features

Responses

Successful operation

Bodyapplication/json

pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "10"

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"

pageinteger(schemas-Page)>= 0

Current page number.

Default 0

Example: "1"

valuesArray of objects(FetchFeatureSearchResult)

List of fetch features.

Response

application/json

{
  "pageSize": "10",
  "total": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

List Fetch Configurations

Request

List all fetch configurations of the current user.

Security

basicAuth

Query

startAfterstring(StartAfter)

ID of the last configuration returned in the previous request. Used for pagination.

Example: startAfter=5712566172571652

limitinteger(Limit)

Maximum number of configurations to return. Used for pagination.

Example: limit=100

defaultConfigurationboolean

Is default workspace configuration of given type.

Example: defaultConfiguration=true

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerfetch

Responses

Successful operation

Bodyapplication/json

startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

nextStartAfterstring(NextStartAfter)

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

Example: "5712566172571652"

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"

valuesArray of objects(WorkspaceConfigurationSearchResult)

List of workspace configurations.

Response

application/json

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

Create Fetch Configuration

Request

Create a new fetch configuration for the current user.

Security

basicAuth

Bodyapplication/json

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

featuresOnArray of strings(TransactionFeaturesOn)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, turned off.
COMMIT_TRANSACTION	Commit transaction. By default, turned off.

Example: ["CREATE_TRANSACTION"]

workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)required

Display name for a configuration.

Example: "Client configuration."

configurationobject(FetchConfigurationModel)required

The configuration for the Business Partner fetch.

configuration.featuresOnArray of strings(BusinessPartnerFetchFeatureEnum)

List of features to be activated.

Items Enum Value	Description
ENABLE_SETTINGS	Apply rules stored in organizational settings during curation.
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
SHOW_RAW_DATA	Show raw data returned by external service.
SHOW_RAW_DATA_JSON	Show raw data returned by external service in JSON format.
FORCE_EXTERNAL_CALL	Call external service even when results from data mirrors are available.
SCREEN_BUSINESS_NAMES	Add `screeningResult` to the Business Partner.
SHOW_COMMERCIAL_ULTIMATE	Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE	Fetch Domestic Commercial Ultimate from DNB. `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
DETECT_LEGAL_ENTITY	Finds out whether requested DUNS is a branch or headquarter.
ACTIVATE_DATASOURCE_BVD	Allows to use DVB datasource in golden record.

Example: ["SHOW_RAW_DATA"]

configuration.featuresOffArray of strings(BusinessPartnerFetchFeatureEnum)

List of features to be deactivated.

Items Enum Value	Description
ENABLE_SETTINGS	Apply rules stored in organizational settings during curation.
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
SHOW_RAW_DATA	Show raw data returned by external service.
SHOW_RAW_DATA_JSON	Show raw data returned by external service in JSON format.
FORCE_EXTERNAL_CALL	Call external service even when results from data mirrors are available.
SCREEN_BUSINESS_NAMES	Add `screeningResult` to the Business Partner.
SHOW_COMMERCIAL_ULTIMATE	Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE	Fetch Domestic Commercial Ultimate from DNB. `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
DETECT_LEGAL_ENTITY	Finds out whether requested DUNS is a branch or headquarter.
ACTIVATE_DATASOURCE_BVD	Allows to use DVB datasource in golden record.

Example: ["SHOW_RAW_DATA"]

configuration.screeningMatchingThresholdnumber

The matching threshold. When not set then all entries are taken into consideration.

Example: "0.8"

relatedConfigurationsArray of objects(RelatedConfiguration)<= 10 items

copiedFromobject(WorkspaceConfigurationCopiedFrom)

The configuration from which the new configuration is copied.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerfetch \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "Client configuration.",
    "configuration": {
      "featuresOn": [
        "SHOW_RAW_DATA"
      ],
      "featuresOff": [
        "SHOW_RAW_DATA"
      ],
      "screeningMatchingThreshold": "0.8"
    },
    "relatedConfigurations": [
      {
        "id": "a0200062daa56952a8640005",
        "owner": {
          "service": "reference-data-api",
          "path": "/public/configurations/businesspartnerlookup"
        }
      }
    ],
    "copiedFrom": {
      "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
      "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
    }
  }'

Responses

Configuration created successfully

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Read Fetch Configuration

Request

Read a fetch configuration of the current user.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

Successful operation

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Update Fetch Configuration

Request

Update a fetch configuration of the current user.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Bodyapplication/json

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

featuresOnArray of strings(TransactionFeaturesOn)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, turned off.
COMMIT_TRANSACTION	Commit transaction. By default, turned off.

Example: ["CREATE_TRANSACTION"]

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "Client configuration.",
    "configuration": {
      "featuresOn": [
        "SHOW_RAW_DATA"
      ],
      "featuresOff": [
        "SHOW_RAW_DATA"
      ],
      "screeningMatchingThreshold": "0.8"
    }
  }'

Responses

Configuration updated successful

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Delete Fetch Configuration

Request

Delete a fetch configuration of the current user.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Query

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: transactionId=8e37da1e-ee9d-4ee0-b03d-24a1f89988f2

featuresOnArray of strings(TransactionFeatureParam)

Features to be activated. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, turned off.
COMMIT_TRANSACTION	Commit transaction. By default, turned off.

Example: featuresOn=CREATE_TRANSACTION

curl -i -X DELETE \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

OK.

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Read Business Partner Fetch Configuration Version

Request

Read a specific version of a business partner fetch configuration by id and version number.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

versionintegerrequired

Version number of the configuration.

Example: 1

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1

Responses

Successful operation.

Bodyapplication/json

idstring

Unique identifier of the business partner fetch configuration version. Not to be confused with the configuration ID.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring

The name of the configuration

Example: "Configuration Name"

configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-22T13:45+00:00"

createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"

modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Configuration Name",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-22T13:45+00:00",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

List Lookup Configurations

Request

List all lookup configurations of the current user.

Security

basicAuth

Query

limitinteger(Limit)

Maximum number of configurations to return. Used for pagination.

Example: limit=100

startAfterstring(StartAfter)

ID of the last configuration returned in the previous request. Used for pagination.

Example: startAfter=5712566172571652

defaultConfigurationboolean

Is default workspace configuration of given type.

Example: defaultConfiguration=true

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerlookup

Responses

Successful operation

Bodyapplication/json

startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

nextStartAfterstring(NextStartAfter)

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

Example: "5712566172571652"

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"

valuesArray of objects(WorkspaceConfigurationSearchResult)

List of workspace configurations.

Response

application/json

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

Create Lookup Configuration

Request

Create a new lookup configuration for the current user.

Security

basicAuth

Bodyapplication/json

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

featuresOnArray of strings(TransactionFeaturesOn)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, turned off.
COMMIT_TRANSACTION	Commit transaction. By default, turned off.

Example: ["CREATE_TRANSACTION"]

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

relatedConfigurationsArray of objects(RelatedConfiguration)<= 10 items

copiedFromobject(WorkspaceConfigurationCopiedFrom)

The configuration from which the new configuration is copied.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerlookup \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "Client configuration.",
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "configuration": {
      "limit": "10",
      "startAfter": "5712566172571652",
      "dataSources": [
        "VIES"
      ],
      "matchingThreshold": "0.5",
      "matchingClassifications": [
        {
          "countryScope": {
            "shortNames": [
              "CH"
            ]
          },
          "businessPartnerThreshold": {
            "fullMatch": 0.75,
            "maybeMatch": 0.75
          },
          "addressThreshold": {
            "fullMatch": 0.75,
            "maybeMatch": 0.75
          }
        }
      ],
      "maxCandidates": "50",
      "storagesDataSources": [
        {
          "storageId": "6479fd136811f0361e083211",
          "dataSources": [
            {
              "id": "6479fd136811f0361e083211"
            }
          ]
        }
      ],
      "featuresOn": [
        "ACTIVATE_DATASOURCE_BVD"
      ],
      "featuresOff": [
        "ACTIVATE_DATASOURCE_BVD"
      ],
      "tags": [
        "Warehouse"
      ]
    },
    "relatedConfigurations": [
      {
        "id": "a0200062daa56952a8640005",
        "owner": {
          "service": "reference-data-api",
          "path": "/public/configurations/businesspartnerlookup"
        }
      }
    ],
    "copiedFrom": {
      "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
      "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
    }
  }'

Responses

Configuration created successfully

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

relatedConfigurationsArray of objects(RelatedConfiguration)

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "limit": "10",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "matchingClassifications": [ … ],
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ]
}

Read Lookup Configuration

Request

Read a lookup configuration of the current user.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

Successful operation

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

relatedConfigurationsArray of objects(RelatedConfiguration)

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "limit": "10",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "matchingClassifications": [ … ],
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ]
}

Update Lookup Configuration

Request

Update a lookup configuration of the current user.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Bodyapplication/json

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

featuresOnArray of strings(TransactionFeaturesOn)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, turned off.
COMMIT_TRANSACTION	Commit transaction. By default, turned off.

Example: ["CREATE_TRANSACTION"]

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "Client configuration.",
    "configuration": {
      "limit": "10",
      "startAfter": "5712566172571652",
      "dataSources": [
        "VIES"
      ],
      "matchingThreshold": "0.5",
      "matchingClassifications": [
        {
          "countryScope": {
            "shortNames": [
              "CH"
            ]
          },
          "businessPartnerThreshold": {
            "fullMatch": 0.75,
            "maybeMatch": 0.75
          },
          "addressThreshold": {
            "fullMatch": 0.75,
            "maybeMatch": 0.75
          }
        }
      ],
      "maxCandidates": "50",
      "storagesDataSources": [
        {
          "storageId": "6479fd136811f0361e083211",
          "dataSources": [
            {
              "id": "6479fd136811f0361e083211"
            }
          ]
        }
      ],
      "featuresOn": [
        "ACTIVATE_DATASOURCE_BVD"
      ],
      "featuresOff": [
        "ACTIVATE_DATASOURCE_BVD"
      ],
      "tags": [
        "Warehouse"
      ]
    }
  }'

Responses

Configuration updated successful

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

relatedConfigurationsArray of objects(RelatedConfiguration)

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "limit": "10",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "matchingClassifications": [ … ],
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ]
}

Delete Lookup Configuration

Request

Delete a lookup configuration of the current user.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Query

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: transactionId=8e37da1e-ee9d-4ee0-b03d-24a1f89988f2

featuresOnArray of strings(TransactionFeatureParam)

Features to be activated. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, turned off.
COMMIT_TRANSACTION	Commit transaction. By default, turned off.

Example: featuresOn=CREATE_TRANSACTION

curl -i -X DELETE \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

OK.

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

relatedConfigurationsArray of objects(RelatedConfiguration)

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "limit": "10",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "matchingClassifications": [ … ],
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
  "relatedConfigurations": [
    { … }
  ]
}

Read Business partner Lookup Configuration Version

Request

Read a specific version of a business partner lookup configuration by id and version number.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

versionintegerrequired

Version number of the configuration.

Example: 1

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/referencedata-api/api-v4/public/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1

Responses

Successful operation.

Bodyapplication/json

idstring

Unique identifier of the business partner lookup configuration version. Not to be confused with the configuration ID.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

namestring

The name of the configuration

Example: "Configuration Name"

configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-22T13:45+00:00"

createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"

modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Configuration Name",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "configuration": {
    "limit": "10",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "matchingClassifications": [ … ],
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-22T13:45+00:00",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Processing Logs

Operations

Referencedata API (4)

Business Partners

Analytics

Registrations

Addresses

Bulk Fetch

Bulk Lookup

Cancel Bulk

CEDEX Lookup

Batch Lookup

Batch Lookup Result

Administrative Area Index

DNB

Configurations

List Lookup Features

Request

Responses

Share the feedback!

List Fetch Features

Request

Responses

Share the feedback!

List Fetch Configurations

Request

Responses

Share the feedback!

Create Fetch Configuration

RequestExpand all

Responses

Share the feedback!

Read Fetch Configuration

Request

Responses

Share the feedback!

Update Fetch Configuration

RequestExpand all

Responses

Share the feedback!

Delete Fetch Configuration

Request

Responses

Share the feedback!

Read Business Partner Fetch Configuration Version

Request

Responses

Share the feedback!

List Lookup Configurations

Request

Responses

Share the feedback!

Create Lookup Configuration

RequestExpand all

Responses

Share the feedback!

Read Lookup Configuration

Request

Responses

Share the feedback!

Update Lookup Configuration

RequestExpand all

Responses

Share the feedback!

Delete Lookup Configuration

Request

Responses

Share the feedback!

Read Business partner Lookup Configuration Version

Request

Responses

Share the feedback!

Processing Logs

Request

Request

Request

Request