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

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

Duplicate Links

Operations

Configurations

Operations

Identity Link Storage

Operations

Initialize Organization's Identity Storage

Request

This internal API is used to initialize the storage and indexes for an organization. It serves as a fallback mechanism in case of failures. The API checks if the user has the required CDQ_ADMINISTRATOR role and proceeds with creating the collection and index as needed.

Security

basicAuth

Bodyapplication/jsonrequired

Payload to initialize storage

organizationIdstringrequired

The ID of the organization to initialize storage for.

Example: "5f1114b8-6cb1-41db-8bb8-95facc7a23f6"

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/entitylinkstorage \
  -H 'Content-Type: application/json' \
  -d '{
    "organizationId": "5f1114b8-6cb1-41db-8bb8-95facc7a23f6"
  }'

Responses

Storage and index successfully created, or already exist.

Bodyapplication/json

statusobject(Status)

Details about status or error of a service

Response

application/json

{
  "status": {
    "code": "200",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2019-08-31T16:47+00:00"
  }
}

Entity Matching Links

Operations

Data Matching API (2)

Business Partner

Analytics

Data Matching

Duplicate Matching

Entity Matching

Identity Resolution

Linkage Matching

Public

User Feedback

Duplicate Links

Configurations

Identity Link Storage

Initialize Organization's Identity Storage

Request

Responses

Share the feedback!

Entity Matching Links