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

Match Business Partners

Request

Matches the given Business Partners against the given Data Matching definition.

Security

basicAuth

Bodyapplication/jsonrequired

candidatesArray of objects(BusinessPartner)[ 1 .. 1000 ] itemsrequired

List of Business Partners to be matched.

candidates[].idstring(BusinessPartnerId)

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"

candidates[].namesArray of objects(Name)

List of names of the Business Partner.

candidates[].legalFormobject(schemas-LegalForm)

The legal form of a business partner/type/legal entity is the form it takes in the eyes of the law governing it. The legal form of a company is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the company's name (e.g. AG, Inc., LLC, S.A.).

candidates[].identifiersArray of objects(schemas-Identifier)

List of identifiers of the Business Partner.

candidates[].categoriesArray of objects(BusinessPartnerCategory)

List of categories of the Business Partner.

candidates[].statusobject(BusinessPartnerStatus)

Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation).

candidates[].addressesArray of objects(schemas-Address)

List of addresses of the Business Partner.

candidates[].externalIdstring(BusinessPartnerExternalId)

Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.

Example: "The ID managed in the customer's SAP systems."

candidates[].profileobject(PartnerProfile)

A business partner profile contains important information about a company, such as its classification, tags, contact details, or minority indicator.

candidates[].formattedSapRecordobject(FormattedSapRecord)

Provides business partner and address information in a data structure similar to SAP Business Partner table BUT000 and SAP Business Address Services table ADRC. Field names are equal or very similar to SAP field names in order to simplify field mapping. Data for name and street fields is already split into chunks of max. 35 characters.

candidates[].relationsArray of objects(BusinessPartnerRelation)

List of relations of the Business Partner.

candidates[].bankAccountsArray of objects(BankAccount)

List of bank accounts of the Business Partner.

candidates[].typesArray of objects(BusinessPartnerType)

List of types of the Business Partner.

candidates[].dataSourcestring(BusinessPartnerStorageDataSourceName)

Name of a data source of a storage.

Example: "Internal customers"

candidates[].recordstring

Stringified JSON of an individual Business Partner record. Characters: backslash \ and double quote " must be escaped (respectively: \\\\ and \"). Fields containing . are unallowed. Maximum size: 15MB.

Example: "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"

patternobject(BusinessPartner)required

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's Business Partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the Business Partner is the core managed entity. A Business Partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a Business Partner.

pattern.idstring(BusinessPartnerId)

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"

pattern.namesArray of objects(Name)

List of names of the Business Partner.

pattern.legalFormobject(schemas-LegalForm)

pattern.identifiersArray of objects(schemas-Identifier)

List of identifiers of the Business Partner.

pattern.categoriesArray of objects(BusinessPartnerCategory)

List of categories of the Business Partner.

pattern.statusobject(BusinessPartnerStatus)

Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation).

pattern.addressesArray of objects(schemas-Address)

List of addresses of the Business Partner.

pattern.externalIdstring(BusinessPartnerExternalId)

Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.

Example: "The ID managed in the customer's SAP systems."

pattern.profileobject(PartnerProfile)

A business partner profile contains important information about a company, such as its classification, tags, contact details, or minority indicator.

pattern.formattedSapRecordobject(FormattedSapRecord)

pattern.relationsArray of objects(BusinessPartnerRelation)

List of relations of the Business Partner.

pattern.bankAccountsArray of objects(BankAccount)

List of bank accounts of the Business Partner.

pattern.typesArray of objects(BusinessPartnerType)

List of types of the Business Partner.

pattern.dataSourcestring(BusinessPartnerStorageDataSourceName)

Name of a data source of a storage.

Example: "Internal customers"

pattern.recordstring

Example: "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"

dataMatchingDefinitionIdstring(DataMatchingDefinitionId)required

Id of the data matching definition.

Example: "6461e6113b1865304b3038b6"

showMatchingStatusesArray of strings(EntityMatchingStatusEnum)

List of matching statuses to be shown in the result.

Default ["MATCH","MAYBE_MATCH"]

Items Enum"MATCH""NO_MATCH""POSSIBLE_MATCH"

Example: ["MATCH"]

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/businesspartners/match \
  -H 'Content-Type: application/json' \
  -d '{
    "candidates": [
      {
        "id": "63e635235c06b7396330fe40",
        "names": [
          {
            "shortName": "CDQ AG",
            "type": {
              "url": "https://meta.cdq.com/Business_partner/name/type",
              "name": "Local Name",
              "technicalKey": "LOCAL"
            },
            "value": "Corporate Data Quality AG",
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "nameValueClassification": {
              "normalizedName": "skoda auto as",
              "nameWithoutLegalForm": "skoda auto",
              "terms": [
                {}
              ]
            }
          }
        ],
        "legalForm": {
          "name": "Aktiengesellschaft",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          },
          "mainAbbreviation": "AG",
          "cdlElfCode": "AG",
          "categories": [
            {
              "name": "Limited Liability Company",
              "shortName": "LLC",
              "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
              "technicalKey": "LIMITED"
            }
          ],
          "url": "https://meta.cdq.com/Business_partner/legal_form",
          "technicalKey": "DE_9866"
        },
        "identifiers": [
          {
            "value": "CHE-218.608.886 HR/MWST",
            "type": {
              "url": "https://meta.cdq.com/Business_partner/identifier/type",
              "name": "CH_VAT_ID",
              "technicalKey": "CH_VAT_ID"
            },
            "status": {
              "name": "ACTIVE",
              "url": "https://meta.cdq.com/Business_partner/identifier/status",
              "technicalKey": "ACTIVE"
            },
            "issuingBody": {
              "name": "Amtsgericht Aachen",
              "shortName": "Amtsgericht Aachen",
              "names": [
                {}
              ],
              "description": "Amtsgericht Aachen",
              "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
              "technicalKey": "Amtsgericht Aachen",
              "jurisdiction": {
                "country": {},
                "administrativeAreas": [
                  null
                ]
              },
              "gleifCode": "RA000004",
              "localAuthorityCode": "R3101",
              "externalUrl": "https://www.amtsgericht.de/muenchen"
            }
          }
        ],
        "categories": [
          {
            "name": "Hotel",
            "url": "https://meta.cdq.com/Business_partner/category",
            "technicalKey": "HOTEL"
          }
        ],
        "status": {
          "officialDenotation": "Good Standing",
          "validFrom": "2022-02-26",
          "validUntil": "2022-02-26",
          "type": {
            "name": "In Liquidation",
            "url": "https://meta.cdq.com/Business_partner/status/type",
            "technicalKey": "IN_LIQUIDATION"
          }
        },
        "addresses": [
          {
            "version": {
              "characterSet": {
                "name": "International",
                "technicalKey": "INTERNATIONAL"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            },
            "identifyingName": {
              "value": "John Doe"
            },
            "externalId": "1",
            "metadata": {
              "primaryProvenance": {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            },
            "careOf": {
              "value": "CDQ GmbH c/o Product Department"
            },
            "contexts": [
              {
                "value": "Production hall 7, Storage field 8."
              }
            ],
            "country": {
              "shortName": "CH",
              "value": "Switzerland"
            },
            "administrativeAreas": [
              {
                "value": "Sankt Gallen",
                "shortName": "SG",
                "fipsCode": "SZ15",
                "isoCode": "CH-SG",
                "type": {},
                "language": {}
              }
            ],
            "postCodes": [
              "9000"
            ],
            "localities": [
              {
                "type": {},
                "shortName": "St. Gallen",
                "value": "Sankt Gallen",
                "language": {}
              }
            ],
            "thoroughfares": [
              {
                "type": {},
                "shortName": "Lukasstr. 4",
                "number": "4",
                "value": "Lukasstraße 4",
                "name": "Lukasstraße",
                "direction": "221-bis Baker Street, North",
                "language": {}
              }
            ],
            "premises": [
              {
                "value": "Lukasstraße 4",
                "shortName": "Lukasstr. 4",
                "number": "4",
                "type": {},
                "language": {}
              }
            ],
            "postalDeliveryPoints": [
              {
                "type": {},
                "shortName": "St Gallen, Postfach 460",
                "number": "460",
                "value": "Postfach",
                "language": {}
              }
            ],
            "openingHours": [
              {
                "openingHour": "09:00 AM",
                "closingHour": "05:00 PM",
                "weekday": "Monday"
              }
            ],
            "geographicCoordinates": {
              "latitude": "47.439549",
              "longitude": "9.395275"
            },
            "types": [
              {
                "name": "Legal Address",
                "url": "https://meta.cdq.com/Address/type",
                "technicalKey": "LEGAL_ADDRESS"
              }
            ],
            "formattedAddress": {
              "country": "Switzerland",
              "administrativeArea": "Sankt Gallen",
              "region": "Sankt Gallen",
              "regionCode": "9004",
              "locality": "Sankt Gallen",
              "district": "City center",
              "postalCode": "9000",
              "thoroughfare": "Lukassstrasse",
              "premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
              "interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
              "mailbox": "Postfach 460",
              "postOfficeBox": "Postfach 460"
            }
          }
        ],
        "externalId": "The ID managed in the customer'\''s SAP systems.",
        "profile": {
          "classifications": [
            {
              "value": "Manufacture of pesticides and other agrochemical products.",
              "code": "20.20Z",
              "level": "primary",
              "type": {
                "name": "NAF 2003",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
                "technicalKey": "NAF_2003"
              }
            }
          ],
          "contactEmails": [
            {
              "value": "developer-portal@cdq.com"
            }
          ],
          "hcpProfile": {
            "generalLicense": {
              "professionType": {
                "name": "Doctor",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
                "technicalKey": "DOCTOR"
              },
              "licenseStatus": {
                "name": "Granted",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
                "technicalKey": "GRANTED"
              }
            },
            "operationalPermissions": [
              {
                "issuingAuthority": "Swiss Medical Association",
                "permissionStatus": {},
                "activityStatus": {},
                "practiceLocations": [
                  null
                ]
              }
            ]
          },
          "minorityIndicator": {
            "value": "Social enterprise"
          },
          "phoneNumbers": [
            {
              "countryPrefix": "+41",
              "number": "71 571 10 40",
              "type": {
                "name": "FAX",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
                "technicalKey": "FAX"
              },
              "value": "+41 71 571 10 40"
            }
          ],
          "tags": [
            {
              "value": "Warehouse",
              "type": {
                "technicalKey": "WAREHOUSE"
              }
            }
          ],
          "vatPayerStatus": {
            "publicationDate": "2020-07-21T17:32:28Z",
            "status": {
              "name": "RELIABLE",
              "technicalKey": "VAT_PAYER_STATUS"
            },
            "registrationAuthority": {
              "registrationAuthorityId": "RA000009",
              "registrationAuthorityEntityId": "RA000009",
              "otherRegistrationAuthorityId": "RA000009"
            }
          },
          "websites": [
            {
              "url": "https://cdq.com",
              "type": {
                "name": "Corporate Website",
                "url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
                "technicalKey": "WEBSITE_TYPE_CORPORATE"
              }
            }
          ]
        },
        "formattedSapRecord": {
          "name1": "CDQ AG",
          "name2": "CDQ AG",
          "name3": "CDQ AG",
          "name4": "CDQ AG",
          "nameCo": "Aktiengesellschaft",
          "legalEntity": "Aktiengesellschaft",
          "legalForm": "Aktiengesellschaft",
          "indSector": "NAF",
          "indSectorCode": "NAF",
          "emailAddress": "bp@gmail.com",
          "narp": "Friedrich Nietzsche",
          "stceg": "CHE-218.608.88",
          "stcd1": "CHE-218.608.88",
          "stcd2": "CHE-218.608.88",
          "stcd3": "CHE-218.608.88",
          "stcd4": "CHE-218.608.88",
          "stcd5": "CHE-218.608.88",
          "url": "www.cdq.com",
          "telNumber": "+41 71 571 10 40",
          "country": "Switzerland",
          "countryCode": "CH",
          "region": "Sankt Gallen",
          "regionCodeSap": "9004",
          "regionCode": "9004",
          "county": "Sankt Gallen",
          "countyCode": "9004",
          "township": "Sankt Gallen",
          "townshipCode": "9004",
          "city": "Sankt Gallen",
          "district": "St. Georgen",
          "postalCode": "9000",
          "postalCode3": "9000",
          "street1": "Lukasstraße 4",
          "street2": "Lukasstraße 4",
          "street5": "Lukasstraße 4",
          "houseNum": "4",
          "houseNum2": "4",
          "building": "Office 2",
          "floor": "2",
          "roomnumber": "123",
          "poBoxCountry": "9000",
          "poBoxCity": "9000",
          "poBoxPostalCode": "9000",
          "poBox": "9000",
          "latitude": "47.439549",
          "longitude": "9.395275"
        },
        "relations": [
          {
            "startedAt": "2019-08-31T16:47+00:00",
            "endedAt": "2019-08-31T16:47+00:00",
            "type": {
              "name": "Commercial ultimate",
              "url": "https://meta.cdq.com/Business_partner/relation/type",
              "technicalKey": "COMMERCIAL_ULTIMATE"
            },
            "class": {
              "name": "CDQ Hierarchy",
              "url": "https://meta.cdq.com/Business_partner/relation/class",
              "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
            },
            "startNode": "FR.RC:5664645",
            "endNode": "FR.RC:5664645"
          }
        ],
        "bankAccounts": [
          {
            "internationalBankAccountIdentifier": "CH8800781619278412000",
            "internationalBankIdentifier": "KBSGCH22XXX",
            "nationalBankAccountIdentifier": "619278412000",
            "nationalBankIdentifier": "00781",
            "bank": {
              "name": "Sparda Bank",
              "branch": "Filiale München",
              "address": {
                "localities": [
                  null
                ],
                "country": {},
                "administrativeAreas": [
                  null
                ],
                "postCodes": [
                  null
                ],
                "thoroughfares": [
                  null
                ]
              }
            }
          }
        ],
        "types": [
          {
            "name": "Legal Entity",
            "url": "https://meta.cdq.com/Business_partner/type",
            "technicalKey": "LEGAL_ENTITY"
          }
        ],
        "dataSource": "Internal customers",
        "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"
      }
    ],
    "pattern": {
      "id": "63e635235c06b7396330fe40",
      "names": [
        {
          "shortName": "CDQ AG",
          "type": {
            "url": "https://meta.cdq.com/Business_partner/name/type",
            "name": "Local Name",
            "technicalKey": "LOCAL"
          },
          "value": "Corporate Data Quality AG",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          },
          "nameValueClassification": {
            "normalizedName": "skoda auto as",
            "nameWithoutLegalForm": "skoda auto",
            "terms": [
              {
                "value": "Legal Form",
                "type": "LEGAL_FORM"
              }
            ]
          }
        }
      ],
      "legalForm": {
        "name": "Aktiengesellschaft",
        "language": {
          "name": "German",
          "technicalKey": "DE"
        },
        "mainAbbreviation": "AG",
        "cdlElfCode": "AG",
        "categories": [
          {
            "name": "Limited Liability Company",
            "shortName": "LLC",
            "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
            "technicalKey": "LIMITED"
          }
        ],
        "url": "https://meta.cdq.com/Business_partner/legal_form",
        "technicalKey": "DE_9866"
      },
      "identifiers": [
        {
          "value": "CHE-218.608.886 HR/MWST",
          "type": {
            "url": "https://meta.cdq.com/Business_partner/identifier/type",
            "name": "CH_VAT_ID",
            "technicalKey": "CH_VAT_ID"
          },
          "status": {
            "name": "ACTIVE",
            "url": "https://meta.cdq.com/Business_partner/identifier/status",
            "technicalKey": "ACTIVE"
          },
          "issuingBody": {
            "name": "Amtsgericht Aachen",
            "shortName": "Amtsgericht Aachen",
            "names": [
              {
                "shortName": "CDQ AG",
                "type": {},
                "value": "Corporate Data Quality AG",
                "language": {}
              }
            ],
            "description": "Amtsgericht Aachen",
            "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
            "technicalKey": "Amtsgericht Aachen",
            "jurisdiction": {
              "country": {
                "shortName": "CH",
                "value": "Switzerland"
              },
              "administrativeAreas": [
                {}
              ]
            },
            "gleifCode": "RA000004",
            "localAuthorityCode": "R3101",
            "externalUrl": "https://www.amtsgericht.de/muenchen"
          }
        }
      ],
      "categories": [
        {
          "name": "Hotel",
          "url": "https://meta.cdq.com/Business_partner/category",
          "technicalKey": "HOTEL"
        }
      ],
      "status": {
        "officialDenotation": "Good Standing",
        "validFrom": "2022-02-26",
        "validUntil": "2022-02-26",
        "type": {
          "name": "In Liquidation",
          "url": "https://meta.cdq.com/Business_partner/status/type",
          "technicalKey": "IN_LIQUIDATION"
        }
      },
      "addresses": [
        {
          "version": {
            "characterSet": {
              "name": "International",
              "technicalKey": "INTERNATIONAL"
            },
            "language": {
              "name": "German",
              "technicalKey": "DE"
            }
          },
          "identifyingName": {
            "value": "John Doe"
          },
          "externalId": "1",
          "metadata": {
            "primaryProvenance": {
              "name": "VIES",
              "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
              "technicalKey": "VIES",
              "cdqId": "VIES:PL8660001429"
            },
            "language": {
              "name": "German",
              "technicalKey": "DE"
            }
          },
          "careOf": {
            "value": "CDQ GmbH c/o Product Department"
          },
          "contexts": [
            {
              "value": "Production hall 7, Storage field 8."
            }
          ],
          "country": {
            "shortName": "CH",
            "value": "Switzerland"
          },
          "administrativeAreas": [
            {
              "value": "Sankt Gallen",
              "shortName": "SG",
              "fipsCode": "SZ15",
              "isoCode": "CH-SG",
              "type": {
                "name": "COUNTY",
                "url": "https://meta.cdq.com/Address/administrative_area/type",
                "technicalKey": "COUNTY"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "postCodes": [
            "9000"
          ],
          "localities": [
            {
              "type": {
                "name": "City",
                "url": "https://meta.cdq.com/Address/locality/type",
                "technicalKey": "CITY"
              },
              "shortName": "St. Gallen",
              "value": "Sankt Gallen",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "thoroughfares": [
            {
              "type": {
                "name": "Industrial zone",
                "url": "https://meta.cdq.com/Address/thoroughfare/type",
                "technicalKey": "INDUSTRIAL_ZONE"
              },
              "shortName": "Lukasstr. 4",
              "number": "4",
              "value": "Lukasstraße 4",
              "name": "Lukasstraße",
              "direction": "221-bis Baker Street, North",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "premises": [
            {
              "value": "Lukasstraße 4",
              "shortName": "Lukasstr. 4",
              "number": "4",
              "type": {
                "name": "Factory",
                "url": "https://meta.cdq.com/Address/premise/type",
                "technicalKey": "FACTORY"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "postalDeliveryPoints": [
            {
              "type": {
                "name": "Mailbox",
                "url": "https://meta.cdq.com/Address/postal_delivery_point/type",
                "technicalKey": "MAILBOX"
              },
              "shortName": "St Gallen, Postfach 460",
              "number": "460",
              "value": "Postfach",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "openingHours": [
            {
              "openingHour": "09:00 AM",
              "closingHour": "05:00 PM",
              "weekday": "Monday"
            }
          ],
          "geographicCoordinates": {
            "latitude": "47.439549",
            "longitude": "9.395275"
          },
          "types": [
            {
              "name": "Legal Address",
              "url": "https://meta.cdq.com/Address/type",
              "technicalKey": "LEGAL_ADDRESS"
            }
          ],
          "formattedAddress": {
            "country": "Switzerland",
            "administrativeArea": "Sankt Gallen",
            "region": "Sankt Gallen",
            "regionCode": "9004",
            "locality": "Sankt Gallen",
            "district": "City center",
            "postalCode": "9000",
            "thoroughfare": "Lukassstrasse",
            "premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
            "interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
            "mailbox": "Postfach 460",
            "postOfficeBox": "Postfach 460"
          }
        }
      ],
      "externalId": "The ID managed in the customer'\''s SAP systems.",
      "profile": {
        "classifications": [
          {
            "value": "Manufacture of pesticides and other agrochemical products.",
            "code": "20.20Z",
            "level": "primary",
            "type": {
              "name": "NAF 2003",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
              "technicalKey": "NAF_2003"
            }
          }
        ],
        "contactEmails": [
          {
            "value": "developer-portal@cdq.com"
          }
        ],
        "hcpProfile": {
          "generalLicense": {
            "professionType": {
              "name": "Doctor",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
              "technicalKey": "DOCTOR"
            },
            "licenseStatus": {
              "name": "Granted",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
              "technicalKey": "GRANTED"
            }
          },
          "operationalPermissions": [
            {
              "issuingAuthority": "Swiss Medical Association",
              "permissionStatus": {
                "name": "Granted",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/permission_status/url",
                "technicalKey": "GRANTED"
              },
              "activityStatus": {
                "name": "Inactive",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/activity_status/url",
                "technicalKey": "INACTIVE"
              },
              "practiceLocations": [
                {}
              ]
            }
          ]
        },
        "minorityIndicator": {
          "value": "Social enterprise"
        },
        "phoneNumbers": [
          {
            "countryPrefix": "+41",
            "number": "71 571 10 40",
            "type": {
              "name": "FAX",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
              "technicalKey": "FAX"
            },
            "value": "+41 71 571 10 40"
          }
        ],
        "tags": [
          {
            "value": "Warehouse",
            "type": {
              "technicalKey": "WAREHOUSE"
            }
          }
        ],
        "vatPayerStatus": {
          "publicationDate": "2020-07-21T17:32:28Z",
          "status": {
            "name": "RELIABLE",
            "technicalKey": "VAT_PAYER_STATUS"
          },
          "registrationAuthority": {
            "registrationAuthorityId": "RA000009",
            "registrationAuthorityEntityId": "RA000009",
            "otherRegistrationAuthorityId": "RA000009"
          }
        },
        "websites": [
          {
            "url": "https://cdq.com",
            "type": {
              "name": "Corporate Website",
              "url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
              "technicalKey": "WEBSITE_TYPE_CORPORATE"
            }
          }
        ]
      },
      "formattedSapRecord": {
        "name1": "CDQ AG",
        "name2": "CDQ AG",
        "name3": "CDQ AG",
        "name4": "CDQ AG",
        "nameCo": "Aktiengesellschaft",
        "legalEntity": "Aktiengesellschaft",
        "legalForm": "Aktiengesellschaft",
        "indSector": "NAF",
        "indSectorCode": "NAF",
        "emailAddress": "bp@gmail.com",
        "narp": "Friedrich Nietzsche",
        "stceg": "CHE-218.608.88",
        "stcd1": "CHE-218.608.88",
        "stcd2": "CHE-218.608.88",
        "stcd3": "CHE-218.608.88",
        "stcd4": "CHE-218.608.88",
        "stcd5": "CHE-218.608.88",
        "url": "www.cdq.com",
        "telNumber": "+41 71 571 10 40",
        "country": "Switzerland",
        "countryCode": "CH",
        "region": "Sankt Gallen",
        "regionCodeSap": "9004",
        "regionCode": "9004",
        "county": "Sankt Gallen",
        "countyCode": "9004",
        "township": "Sankt Gallen",
        "townshipCode": "9004",
        "city": "Sankt Gallen",
        "district": "St. Georgen",
        "postalCode": "9000",
        "postalCode3": "9000",
        "street1": "Lukasstraße 4",
        "street2": "Lukasstraße 4",
        "street5": "Lukasstraße 4",
        "houseNum": "4",
        "houseNum2": "4",
        "building": "Office 2",
        "floor": "2",
        "roomnumber": "123",
        "poBoxCountry": "9000",
        "poBoxCity": "9000",
        "poBoxPostalCode": "9000",
        "poBox": "9000",
        "latitude": "47.439549",
        "longitude": "9.395275"
      },
      "relations": [
        {
          "startedAt": "2019-08-31T16:47+00:00",
          "endedAt": "2019-08-31T16:47+00:00",
          "type": {
            "name": "Commercial ultimate",
            "url": "https://meta.cdq.com/Business_partner/relation/type",
            "technicalKey": "COMMERCIAL_ULTIMATE"
          },
          "class": {
            "name": "CDQ Hierarchy",
            "url": "https://meta.cdq.com/Business_partner/relation/class",
            "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
          },
          "startNode": "FR.RC:5664645",
          "endNode": "FR.RC:5664645"
        }
      ],
      "bankAccounts": [
        {
          "internationalBankAccountIdentifier": "CH8800781619278412000",
          "internationalBankIdentifier": "KBSGCH22XXX",
          "nationalBankAccountIdentifier": "619278412000",
          "nationalBankIdentifier": "00781",
          "bank": {
            "name": "Sparda Bank",
            "branch": "Filiale München",
            "address": {
              "localities": [
                {}
              ],
              "country": {
                "shortName": "CH",
                "value": "Switzerland"
              },
              "administrativeAreas": [
                {}
              ],
              "postCodes": [
                "9000"
              ],
              "thoroughfares": [
                {}
              ]
            }
          }
        }
      ],
      "types": [
        {
          "name": "Legal Entity",
          "url": "https://meta.cdq.com/Business_partner/type",
          "technicalKey": "LEGAL_ENTITY"
        }
      ],
      "dataSource": "Internal customers",
      "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"
    },
    "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
    "showMatchingStatuses": [
      "MATCH",
      "MAYBE_MATCH"
    ]
  }'

Responses

Bodyapplication/json

identityLinksArray of objects(EntityMatchingLink)

List of Identity Links resulting from the deduplication process.

Response

application/json

{
  "identityLinks": [
    { … }
  ]
}

Match Business Partners

Request

Matches the given Business Partners against the given Data Matching definition.

Security

basicAuth

Bodyapplication/jsonrequired

cleanersArray of objects(MatchingAttributeCleaner)

List of cleaners to use with both values.

comparatorsArray of objects(MatchingAttributeComparator)

List of cleaners to use for comparing values.

valueAstring

Base value to which comparison is made.

Example: "CDQ AG"

valueBstring

Value compared to the base.

Example: "CDQ AG"

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/compare \
  -H 'Content-Type: application/json' \
  -d '{
    "cleaners": [
      {
        "name": "LowerCaseNormalizeCleaner",
        "parameters": "JACCARD"
      }
    ],
    "comparators": [
      {
        "name": "QGramComparator",
        "parameters": "JACCARD"
      }
    ],
    "valueA": "CDQ AG",
    "valueB": "CDQ AG"
  }'

Responses

Bodyapplication/json

comparisonResultsArray of objects(BusinessPartnersEntityResolutionComparisonResult)

List of returned comparison results.

Response

application/json

{
  "comparisonResults": [
    { … }
  ]
}

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

Entity Matching Links

Operations

Data Matching API (2)

Business Partner

Analytics

Data Matching

Duplicate Matching

Entity Matching

Match Business Partners

Request

Responses

Share the feedback!

Match Business Partners

Request

Responses

Share the feedback!

Identity Resolution

Linkage Matching

Public

User Feedback

Duplicate Links

Configurations

Identity Link Storage

Entity Matching Links

Data Matching API (2)

Business Partner

Analytics

Data Matching

Duplicate Matching

Entity Matching

Match Business Partners

RequestExpand all

Responses

Share the feedback!

Match Business Partners

RequestExpand all

Responses

Share the feedback!

Identity Resolution

Linkage Matching

Public

User Feedback

Duplicate Links

Configurations

Identity Link Storage

Entity Matching Links

Request

Request