Business Partners

Everything about Business Partners

Curate Business PartnerWSDL

Curate Business Partner or address. This endpoint supports features and profiles and SOAP.

SecurityapiKey

Request

Request Body schema: application/json
required

CurationRequest

addressCurationLevelThreshold

string (CurationLevel)

Indicator for curation quality. Defines how good curation was.

Additional documentation can be found here.

Enum:	Description
UNKNOWN	No possibility to determine curation level.
LEVEL_1	The address was not found by the CDQ in the employed external data sources.
LEVEL_2	The address was found, but there were significant changes in critical fields.
LEVEL_3	The address was found and there are minor changes in highly important fields.
LEVEL_4	The address was found by the CDQ. There were only changes in less critical fields such as the address/premise or address/thoroughfare/number.
LEVEL_5	The address was found by the CDQ, but no major changes have been made as the address was correct.
LEVEL_6	The address was found in the shared CDQ data pool. This means another company uses the same address which is a very reliable indicator that the address is correct (only in a alpha version)

Example: "LEVEL_1"

object (AddressDataSources)

Preferred data sources for curation. Default PrimaryAddressDataSource is HERE. Default SecondaryAddressDataSource is CDQ.

object

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.

featuresOff

Array of strings (Feature)

List of features to be deactivated.

Items Enum: "ACTIVATE_DATASOURCE_BVD" "ACTIVATE_DATASOURCE_DNB" "ALL_ADDRESS_VERSIONS" "CAPITALIZE_ADDRESS" "CONFIRM_IDENTIFIERS" "DETECT_INDUSTRIAL_ZONE" "ENABLE_FUZZY_ENRICHMENTS" "ENABLE_SETTINGS" "ENABLE_UNALLOWED_NAME_VALUE_VALIDATION" "ENRICH_ADDRESS" "ENRICH_ADDRESS_TYPE" "ENRICH_ADMINISTRATIVE_AREA_ISO" "ENRICH_CATEGORY" "ENRICH_CLASSIFICATIONS" "ENRICH_COMPANY_STATUS" "ENRICH_GEOGRAPHIC_COORDINATES" "ENRICH_GOOGLE_PLACES_INFORMATION" "ENRICH_IDENTIFIERS" "ENRICH_LEGAL_ADDRESS" "ENRICH_LOCAL_ADDRESS" "ENRICH_LEGAL_FORM" "ENRICH_MINORITY_INDICATOR" "ENRICH_POST_CODE" "ENRICH_POST_CODE_TYPE" "ENRICH_REGISTERED_NAME" "ENRICH_VAT_REGISTERED_INFORMATION" "EXTRACT_ADDRESS_CONTEXT" "EXTRACT_CARE_OF" "EXTRACT_DOING_BUSINESS_AS" "HARMONIZE_IDENTIFIERS" "HARMONIZE_NAME" "JOIN_THOROUGHFARE_NUMBER_POSTFIX" "JOIN_THOROUGHFARE_NUMBER_PREFIX" "NORMALIZE_ADDRESS" "NORMALIZE_BUSINESS_PARTNER" "PARSE_ADDRESS" "PARSE_LEGAL_FORM" "PARSE_LEGAL_FORM_WORLDWIDE" "PARSE_NAMES" "PREFER_COUNTY" "PREFER_THOROUGHFARE_NAME" "PREFER_THOROUGHFARE_SHORTNAME" "PREPROCESS_ADDRESS" "PREPROCESS_BUSINESS_PARTNER" "REMOVE_CONTACT_INFORMATION" "REMOVE_INVALID_IDENTIFIERS" "SHARING_PRIMARY" "SHOW_DEBUG_INFO" "SHOW_FORMATTED_ADDRESS" "SHOW_FORMATTED_SAP_RECORD" "SHOW_SETTINGS" "STANDARDIZE_REGISTERED_ADDRESS" "STANDARDIZE_VAT_REGISTERED_ADDRESS" "TRANSLATE_ADDRESS" "TRANSLATE_NAMES" "USE_ADDRESS_INDEX_KR" "LAB_ALLOW_LONG_LOOKUP_CALLS" "LAB_QUERY_CLIENT" "LAB_QUERY_GOOGLE_WITH_COMPANY" "LAB_QUERY_PELIAS_WITH_COMPANY" "LAB_USE_GOOGLE_MAPS" "LAB_USE_LOOKUP_CLASSIFICATION_ONLY" "LAB_USE_PELIAS" "LAB_USE_QUEUES"

Example: ["ENRICH_ADDRESS"]

featuresOn

Array of strings (Feature)

List of features to be activated.

Example: ["ENRICH_ADDRESS"]

inputLanguage

string

ISO 639-1 code of the language of provided data (if known).

Example: "CH"

Array of objects (OutputCharset)

List of requested output charsets of the curation result.

outputLanguage

string

ISO 639-1 code of requested language of the curation result.

Example: "CH"

profile

string (Profile)

Used to configure the curation process. Available wiki documentation for profiles:

Enum: "STANDARD" "ADDRESS_ONLY" "STANDARD_ADDRESS_CURATION_AND_ENRICHMENT" "ADDRESS_STANDARDIZATION" "ADDRESS_TRANSLATION" "BUSINESS_PARTNER_ONLY" "FEATURES_OFF" "NATURAL_PERSON_SCREENING" "PRECURATION" "GOLDEN_RECORD"

Example: "STANDARD"

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/businesspartners/curate

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": "Corporate Data Quality AG",
"type": {"technicalKey": "LOCAL"
}
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": "BVD_ID"
}
}
],
"address": {"country": {"shortname": "CH"
},
"postCode": {"value": "9000"
},
"thoroughfares": [{"value": "Lukasstraße 4",
"number": "4"
}
],
"localities": [{"value": "Sankt Gallen"
}
],
"administrativeAreas": [{"value": "Sankt Gallen"
}
],
"premises": [{"value": "Lukasstraße 4",
"type": {"technicalKey": "BUILDING"
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"type": {"technicalKey": "INTERURBAN_DELIVERY_POINT"
}
}
}
},
"inputLanguage": "CH",
"outputLanguage": "CH",
"outputCharsets": [{"concept": "ADDRESS",
"charset": "INTERNATIONAL"
}
],
"addressDataSources": {"primaryAddressDataSource": {"technicalKey": "HERE",
"threshold": "0.4"
},
"secondaryAddressDataSources": [{"technicalKey": "HERE",
"threshold": "0.4"
}
]
},
"addressCurationLevelThreshold": "LEVEL_1",
"profile": "STANDARD",
"featuresOn": ["ENRICH_ADDRESS"
],
"featuresOff": ["ENRICH_ADDRESS"
]
}

Response samples

application/json

{"businessPartnerCurationResult": {"curatedBusinessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": "Corporate Data Quality AG",
"shortname": "CDQ AG",
"type": {"name": "Local Name",
"url": "https://meta.cdq.com/Business_partner/name/type"
}
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID",
"url": "https://meta.cdq.com/Business_partner/identifier/type"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"provenance": {"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"
},
"technicalKey": "DE_9866",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"shortName": "LLC",
"technicalKey": "LIMITED"
}
]
},
"classifications": [{"code": "20.20Z",
"label": "NAFRev2",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type"
}
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
}
},
"addresses": [{"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"
}
},
"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"additionalPostCodes": [{"value": "9000",
"shortname": "8001",
"type": {"name": null,
"url": null
}
}
],
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": null,
"url": null
}
}
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": null,
"url": null
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"name": "Lukasstraße",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": null,
"url": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
}
],
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"indSector": "NAF",
"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",
"postCode": "9000",
"postCode3": "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",
"poBoxPostCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
}
},
"originalBusinessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": "Corporate Data Quality AG",
"shortname": "CDQ AG",
"type": {"name": "Local Name",
"url": "https://meta.cdq.com/Business_partner/name/type"
}
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID",
"url": "https://meta.cdq.com/Business_partner/identifier/type"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"provenance": {"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"
},
"technicalKey": "DE_9866",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"shortName": "LLC",
"technicalKey": "LIMITED"
}
]
},
"classifications": [{"code": "20.20Z",
"label": "NAFRev2",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type"
}
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
}
},
"addresses": [{"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"
}
},
"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"additionalPostCodes": [{"value": "9000",
"shortname": "8001",
"type": {"name": null,
"url": null
}
}
],
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": null,
"url": null
}
}
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": null,
"url": null
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"name": "Lukasstraße",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": null,
"url": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
}
],
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"indSector": "NAF",
"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",
"postCode": "9000",
"postCode3": "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",
"poBoxPostCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
}
},
"requestSimilarity": {"name": {"value": "0.8"
},
"address": {"value": "0.8"
}
},
"changes": [{"externalIds": [{"externalId": "123",
"dataSourceId": "VIES",
"id": "123",
"concept": {"name": "Address",
"technicalKey": "ADDRESS"
},
"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
}
],
"property": {"parentConcept": {"name": "Address",
"technicalKey": "ADDRESS"
},
"name": "Minority Indicator Value",
"technicalKey": "MINORITY_INDICATOR_VALUE",
"contentSelector": "$.partnerProfile.minorityIndicator.value",
"instanceSelectors": [{"key": "type.technicalKey",
"value": "CH_UID"
}
]
},
"newContent": "AAB",
"previousContent": "AAB",
"provenance": {"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"
},
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"confidenceScore": "0.0",
"maxConfidenceScore": "1.0"
}
]
},
"addressCurationResult": {"curatedAddress": {"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"
}
},
"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"additionalPostCodes": [{"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
}
],
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type"
}
}
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type"
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"name": "Lukasstraße",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type"
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
},
"originalAddress": {"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"
}
},
"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"additionalPostCodes": [{"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
}
],
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type"
}
}
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type"
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"name": "Lukasstraße",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type"
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
},
"additionalAddresses": [{"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"
}
},
"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"additionalPostCodes": [{"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
}
],
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type"
}
}
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type"
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"name": "Lukasstraße",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type"
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
}
],
"curationAnalysis": {"requestSimilarity": {"geoCoordinates": "true",
"locality": "0.85",
"postCode": "0.85",
"thoroughfare": "0.85",
"thoroughfareNumber": "0.85",
"overall": "0.85"
},
"curationLevel": "LEVEL_1",
"accuracyIndicator": "0.9",
"outputLanguage": "CH",
"curationDecision": {"action": "ACCEPT"
},
"geographicCoordinatesAccuracy": "LOCALITY"
}
},
"settings": {"enabled": "true",
"dataCurationRules": [{"context": {"country": {"shortName": "CH",
"value": "Switzerland"
}
},
"addressCurationLevelThreshold": "0.5",
"outputLanguageTechnicalKey": "DE",
"outputCharsets": [{"concept": "ADDRESS",
"charset": "LATIN"
}
],
"profile": "BUSINESS_PARTNER_ONLY",
"featuresOn": ["ENABLE_FUZZY_ENRICHMENTS"
],
"featuresOff": ["ENABLE_FUZZY_ENRICHMENTS"
],
"addressDataSources": {"primaryAddressDataSource": {"technicalKey": "HERE",
"threshold": "0.4"
},
"secondaryAddressDataSources": [{"technicalKey": "HERE",
"threshold": "0.4"
}
]
}
}
]
}
}

Generate Golden Record

Generate a Golden Record from a list of provided Business Partners.

SecurityapiKey

Request

Request Body schema: application/json
required

Array of objects (GoldenRecordCandidate) [ 1 .. 1000 ] items

List of Golden Record Candidates.

configurationId

string

Configuration ID for the Golden Record Generation.

Example: "12ed4bd757f8e162f8aa496f"

countryShortName

string (CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"

featuresOn

Array of strings (GoldenRecordFeatureParam)

List of features to be activated.

Items Enum:	Description
ACTIVATE_DATASOURCE_BVD	Allows to lookup in DVB datasource (e.g. during identifier enrichment).
ACTIVATE_DATASOURCE_DNB	Allows to lookup in DNB datasource (e.g. during identifier enrichment).
SKIP_CANDIDATE_SELECTION	Allows to skip candidate selection step (https://meta.cdq.com/Golden_record_rules). Requires exactly one candidate provided.

Example: ["ACTIVATE_DATASOURCE_BVD"]

profile

string

Provide configurations with varying feature sets to cater to Golden Record Generation needs.

Enum:	Description
STANDARD	Curation process with standard profile is turned on by default. This profile consist of most important API toggle features and because of that it's recommended for most data curation cases. More details here.
QUICK	Works exactly the same as the `STANDARD` profile but with features switched off like `ENRICH_IDENTIFIERS`, `ENRICH_CATEGORY`, `ENRICH_GEOGRAPHIC_COORDINATES`, `HARMONIZE_IDENTIFIERS` and `ENABLE_FUZZY_ENRICHMENTS`.

Example: "QUICK"

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/businesspartners/goldenrecords/generate

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"candidates": [{"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": "Corporate Data Quality AG",
"shortname": "CDQ AG",
"type": {"name": "Local Name",
"url": "https://meta.cdq.com/Business_partner/name/type"
}
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID",
"url": "https://meta.cdq.com/Business_partner/identifier/type"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"provenance": {"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"
},
"technicalKey": "DE_9866",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"shortName": "LLC",
"technicalKey": "LIMITED"
}
]
},
"classifications": [{"code": "20.20Z",
"label": "NAFRev2",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type"
}
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
}
},
"addresses": [{"metadata": {"primaryProvenance": {"name": null,
"url": null,
"technicalKey": null,
"cdqId": null
},
"language": {"name": null,
"technicalKey": null
}
},
"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "8001",
"type": {"name": null,
"url": null
}
},
"additionalPostCodes": [{"value": null,
"shortname": null,
"type": null
}
],
"localities": [{"value": null,
"shortname": null,
"type": null
}
],
"administrativeAreas": [{"value": null,
"shortname": null,
"type": null
}
],
"thoroughfares": [{"value": null,
"name": null,
"shortname": null,
"direction": null,
"number": null,
"type": null
}
],
"premises": [{"value": null,
"shortname": null,
"number": null,
"type": null
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": null,
"url": null
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": null,
"url": null
}
],
"contexts": [{"value": null
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
}
],
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"indSector": "NAF",
"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",
"postCode": "9000",
"postCode3": "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",
"poBoxPostCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
}
},
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
},
"dataSource": {"name": "VIES",
"technicalKey": "VIES"
},
"cdqId": "VIES:PL1132639219",
"inactive": "true"
}
],
"countryShortName": "CH",
"profile": "QUICK",
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"configurationId": "12ed4bd757f8e162f8aa496f"
}

Response samples

application/json

{"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": "Corporate Data Quality AG",
"shortname": "CDQ AG",
"type": {"name": "Local Name",
"url": "https://meta.cdq.com/Business_partner/name/type"
}
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID",
"url": "https://meta.cdq.com/Business_partner/identifier/type"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"provenance": {"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"
},
"technicalKey": "DE_9866",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"shortName": "LLC",
"technicalKey": "LIMITED"
}
]
},
"classifications": [{"code": "20.20Z",
"label": "NAFRev2",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type"
}
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
}
},
"addresses": [{"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"
}
},
"country": {"value": "Switzerland",
"shortname": "CH"
},
"postCode": {"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
},
"additionalPostCodes": [{"value": "9000",
"shortname": "8001",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type"
}
}
],
"localities": [{"value": "Sankt Gallen",
"shortname": "St. Gallen",
"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type"
}
}
],
"administrativeAreas": [{"value": "Sankt Gallen",
"shortname": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type"
}
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"name": "Lukasstraße",
"shortname": "Lukasstr. 4",
"direction": "221-bis Baker Street, North",
"number": "4",
"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortname": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type"
}
}
],
"postalDeliveryPoint": {"value": "Postfach",
"shortname": "St Gallen, Postfach 460",
"number": "460",
"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type"
}
},
"geographicCoordinates": {"longitude": "9.395275",
"latitude": "47.439549"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"postOfficeBox": "Postfach 460"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type"
}
],
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"careOf": {"value": "CDQ GmbH c/o Product Department"
}
}
],
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"indSector": "NAF",
"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",
"postCode": "9000",
"postCode3": "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",
"poBoxPostCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
}
},
"metadata": [{"modifiedAt": "2024-12-04T13:28:22Z",
"modifiedBy": "76248934691294444",
"dataSource": {"name": "VIES",
"technicalKey": "VIES"
},
"cdqId": "VIES:PL1132639219",
"inactive": "true"
}
]
}

Business Partners

Curate Business PartnerWSDL

Request Body schema: application/jsonrequired

Generate Golden Record

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required