Skip to content

Data Matching API (2)

This API provides services for maintaining matching definitions used as configuration for matching jobs, as well as services for matching data with a job.

Overview
URL

https://www.cdq.ch/team

Sebastian Kaczmarski

sebastian.kaczmarski@cdq.ch

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/

Production SOAP

https://api.corporate-data-league.ch/data-matching/soap/v2/

Production

https://api.corporate-data-league.ch/data-matching/

Business Partner

Provides functionalities for managing business partners. These endpoints support matching business partners against data matching definitions, ensuring comprehensive analytics for data matching activities.

Operations

Analytics

Provides functionalities for generating and polling data matching reports. These endpoints support creating reports and checking their status, ensuring comprehensive analytics for data matching activities.

Operations

Data Matching

Provides functionalities for managing Data Matching Definitions, which are configurations for matching jobs to identify duplicates or link records across data sources. These endpoints support creating, reading, updating, and deleting these configurations.

Operations

Duplicate Matching

Provides functionalities for managing duplications within a single data source. These endpoints support creating Deduplication Job and checking the Deduplication Job Status.

Operations

Entity Matching

Provides functionalities for matching business partners. These endpoints support matching business partners against data matching definitions, ensuring comprehensive analytics for data matching activities.

Operations

Identity Resolution

Provides functionalities for managing identity resolution configurations and operations.

Operations

Linkage Matching

Provides functionalities for managing linkages across multiple data sources. These endpoints support creating Linkage Job and checking the Linkage Job Status.

Operations

Public

Provides functionalities for polling the Matching Reports.

Operations

User Feedback

Provides functionalities for managing user feedback related to data matching decisions.

Operations

Configurations

Operations

List Identity Resolution Configurations

Request

List all identity resolution 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

Limit search to configurations with provided default flag value. If left empty, all configurations will be returned.

Default null
Example: defaultConfiguration=true
clientIdstring

API Key ID or Client ID. When present returns only configurations assigned to the given API key.

Example: clientId=12345678-1234-5678-1234-567812345678
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/configurations/entityresolution

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": "0",
  "nextStartAfter": "1",
  "total": 2,
  "values": [
    { … },
    { … }
  ]
}

Create Identity Resolution Configuration

Request

Create a new identity resolution 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 ValueDescription
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

The name of the configuration.

Example: "Custom configuration name"
configurationobject(IdentityResolutionConfiguration)

Configuration for Identity Resolution

relatedConfigurationsArray of objects(RelatedConfiguration)<= 10 items
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
copiedFromobject(WorkspaceConfigurationCopiedFrom)

The configuration from which the new configuration is copied.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/configurations/entityresolution \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Demo config",
    "configuration": {
      "candidateSearchConfiguration": {
        "maxCandidates": 10,
        "searchAttributes": [
          {
            "jsonPath": "$.names[0].value"
          },
          {
            "jsonPath": "$.addresses[0].country.shortName"
          },
          {
            "jsonPath": "$.addresses[0].thoroughfares[0].value"
          }
        ]
      },
      "generalMatchingConfiguration": {
        "threshold": 0.85,
        "thresholdMaybe": 0.65,
        "matchingAttributes": [
          {
            "name": "Matching Business Partner attribute - name",
            "jsonPath": "businessPartner.names[0].value",
            "cleaners": [
              {
                "name": "LowerCaseNormalizer"
              },
              {
                "name": "PunctuationsCleaner"
              },
              {
                "name": "LegalFormCleaner",
                "parameters": [
                  {
                    "name": "configProperty",
                    "value": "$.addresses[0].country.shortName"
                  }
                ]
              }
            ],
            "high": 0.8,
            "low": 0.3,
            "comparator": {
              "name": "QGramComparator",
              "parameters": [
                {
                  "name": "tokenizer",
                  "value": "BASIC"
                },
                {
                  "name": "formula",
                  "value": "DICE"
                },
                {
                  "name": "q",
                  "value": "3"
                }
              ]
            }
          },
          {
            "name": "Matching Business Partner attribute - country",
            "jsonPath": "businessPartner.addresses[0].country.shortName",
            "cleaners": [
              {
                "name": "LowerCaseNormalizer"
              }
            ],
            "high": 0.5,
            "low": 0,
            "comparator": {
              "name": "ExactComparator"
            }
          },
          {
            "name": "Matching Business Partner attribute - city",
            "jsonPath": "businessPartner.addresses[0].localities[0].value",
            "cleaners": [
              {
                "name": "LowerCaseNormalizer"
              },
              {
                "name": "PunctuationsCleaner"
              }
            ],
            "high": 0.6,
            "low": 0.2,
            "comparator": {
              "name": "Levenshtein"
            }
          },
          {
            "name": "Matching Business Partner attribute - street",
            "jsonPath": "businessPartner.addresses[0].thoroughfares[0].value",
            "cleaners": [
              {
                "name": "LowerCaseNormalizer"
              },
              {
                "name": "PunctuationsCleaner"
              }
            ],
            "high": 0.7,
            "low": 0.3,
            "comparator": {
              "name": "Levenshtein"
            }
          },
          {
            "name": "Matching Business Partner attribute - postal code",
            "jsonPath": "businessPartner.addresses[0].postCodes[0].value",
            "cleaners": [
              {
                "name": "DigitsOnlyCleaner"
              }
            ],
            "high": 0.6,
            "low": 0.3,
            "comparator": {
              "name": "ExactComparator"
            }
          }
        ]
      }
    }
  }'

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(IdentityResolutionConfiguration)

Configuration for Identity Resolution

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"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
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
{
  "name": "Demo config",
  "configuration": {
    "candidateSearchConfiguration": { … },
    "generalMatchingConfiguration": { … }
  },
  "version": 1,
  "id": "69301d590929bb0d54010cf7",
  "createdAt": "2025-12-03T11:22:01.336866221Z",
  "createdBy": "demo",
  "defaultConfiguration": false,
  "relatedConfigurations": []
}

Read Identity Resolution Configuration

Request

Read an identity resolution 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/data-matching-api/api-v2/configurations/entityresolution/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(IdentityResolutionConfiguration)

Configuration for Identity Resolution

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"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
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
{
  "name": "Demo config",
  "configuration": {
    "candidateSearchConfiguration": { … },
    "generalMatchingConfiguration": { … }
  },
  "version": 1,
  "id": "69301d590929bb0d54010cf7",
  "createdAt": "2025-12-03T11:22:01.336Z",
  "createdBy": "demo",
  "defaultConfiguration": false,
  "relatedConfigurations": []
}

Update Identity Resolution Configuration

Request

Update an identity resolution 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 ValueDescription
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

The name of the configuration.

Example: "Custom configuration name"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
configurationobject(IdentityResolutionConfiguration)

Configuration for Identity Resolution

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/configurations/entityresolution/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Demo config",
    "configuration": {
      "candidateSearchConfiguration": {},
      "generalMatchingConfiguration": {}
    }
  }'

Responses

Configuration identity resolution updated 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(IdentityResolutionConfiguration)

Configuration for Identity Resolution

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"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
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
{
  "name": "Demo config",
  "configuration": {
    "candidateSearchConfiguration": {},
    "generalMatchingConfiguration": {}
  },
  "version": 2,
  "id": "69312c605145ab285033b0cf",
  "createdAt": "2025-12-04T06:38:24.506Z",
  "modifiedAt": "2025-12-04T06:41:36.580443831Z",
  "createdBy": "demo",
  "defaultConfiguration": false,
  "relatedConfigurations": []
}

Delete Identity Resolution Configuration

Request

Delete an identity resolution configuration for the current user.

Security
basicAuth
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X DELETE \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/configurations/entityresolution/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(IdentityResolutionConfiguration)

Configuration for Identity Resolution

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"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
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
{
  "name": "Demo config",
  "configuration": {
    "candidateSearchConfiguration": { … },
    "generalMatchingConfiguration": { … }
  },
  "version": 2,
  "id": "69301d590929bb0d54010cf7",
  "createdAt": "2025-12-03T11:22:01.336Z",
  "modifiedAt": "2025-12-03T11:37:30.980489021Z",
  "createdBy": "demo",
  "defaultConfiguration": false,
  "relatedConfigurations": []
}

Read Identity Resolution Configuration Version

Request

Read a specific version of an identity resolution 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/data-matching-api/api-v2/configurations/entityresolution/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1

Responses

Successful operation.

Bodyapplication/json
idstring

Unique identifier of the identity resolution 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(IdentityResolutionConfiguration)

Configuration for Identity Resolution

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"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
Response
application/json
{
  "id": "6930280e0929bb0d54010cfe",
  "name": "Demo config",
  "configurationId": "693027fa0929bb0d54010cfc",
  "version": 2,
  "configuration": {
    "candidateSearchConfiguration": { … },
    "generalMatchingConfiguration": { … }
  },
  "createdAt": "2025-12-03T12:07:22.383Z",
  "createdBy": "demo",
  "modifiedAt": "2025-12-03T12:07:42.272Z",
  "modifiedBy": "demo",
  "defaultConfiguration": false
}