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.

Download OpenAPI description
api-v2.json
api-v2.yaml
Languages
Servers
Mock server

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

Production

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

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.

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

Identity Resolution

Operations

Get BusinessPartner's Attribute Paths

Request

<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Get all attribute paths of BusinessPartner.

Security
apiKey
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/attributepaths \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

A list of attribute paths

Bodyapplication/json
pathsArray of strings

List of attribute paths.

Example: ["businessPartner.addresses[].country.shortName"]
statusobject(Status)

Details about status or error of a service

Response
application/json
{
  "paths": [
    "businessPartner.addresses[].country.shortName"
  ],
  "status": {
    "code": "400",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2025-08-29T09:46:53Z"
  }
}

List Available Cleaners

Request

<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>List all available cleaners for identity resolution.

Security
apiKey
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/cleaners \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
cleanersArray of objects(Cleaner)

List of cleaners.

statusobject(Status)

Details about status or error of a service

Response
application/json
{
  "cleaners": [
    { … },
    { … }
  ],
  "status": {
    "code": 200,
    "technicalkey": "ok",
    "details": [ … ]
  }
}

List Available Comparators

Request

<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>List all available comparators for identity resolution.

Security
apiKey
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/comparators \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
comparatorsArray of objects(Comparator)

List of comparators.

statusobject(Status)

Details about status or error of a service

Response
application/json
{
  "comparators": [
    { … }
  ],
  "status": {
    "code": "400",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2025-08-29T09:46:53Z"
  }
}

Get Available Paths

Request

<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Get all available paths for search in index-api.

Security
apiKey
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/searchattributepaths \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

A list of search attributes

Bodyapplication/json
searchAttributesArray of strings

List of search attributes.

Example: ["$.names[].type.technicalKey"]
statusobject(Status)

Details about status or error of a service

Response
application/json
{
  "searchAttributes": [
    "$.names[].type.technicalKey"
  ],
  "status": {
    "code": "400",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2025-08-29T09:46:53Z"
  }
}