Business Partners

Everything about Business Partners

Curate Business PartnerBETA

BETA
Analyze and improve the quality of data through a curation process.

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

SecurityapiKey

Request

Request Body schema: application/json
required

addressCurationLevelThreshold

string (CurationLevelParam)

Indicator for curation quality. Defines how good curation was.

Determines curationDecision based on curationLevel of the result. 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 an alpha version)

Example: "LEVEL_1"

object (AddressDataSourcesParam)

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

required

object (BusinessPartnerParam)

Additional documentation can be found here.

configurationId

string (DataCurationConfigurationId)

Configuration ID used to set up curation. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):

outputLanguageTechnicalKey
addressDataSources
profile
featuresOn
featuresOff
outputCharsets
addressCurationLevelThreshold
numberSeparator
inputAddressConceptsIgnored

Example: "5c5356588c72a028c448adbd"

featuresOff

Array of strings (CurationFeatureParam)

List of feature to be deactivated.

Items Enum:	Description
ACTIVATE_DATASOURCE_BVD	Allows to lookup in BVD datasource (e.g. during identifier enrichment).
ACTIVATE_DATASOURCE_DNB	Allows to lookup in DNB datasource (e.g. during identifier enrichment).
ALL_ADDRESS_VERSIONS	Description will be provided.
CAPITALIZE_ADDRESS	Converts all values in the address data to upper case.
CONFIRM_IDENTIFIERS	Checks if provided identifiers exist in external data sources and belong to provided business partner.
DETECT_INDUSTRIAL_ZONE	Detects and moves industrial zone from address fields to the last thoroughfare of type industrial zone. This data is also added to District for the SAP format record. The Zone is detected during the precuration process from the administrative area, locality, thoroughfare and premise. This feature works only for few countries with special terms. The cleansing process doesn’t perform industrial zone enrichment. If this information is not provided in input data, the outputs won’t contain it. Google or here curation can remove the information about the industrial zone, but there are implemented special rules, which keep that data and after the curation paste it to the last thoroughfare.
ENABLE_FUZZY_ENRICHMENTS	Enriches identifiers with search using identifiers, name local or international address data.
ENABLE_SETTINGS	Allows to use organization settings. Each organization can choose which profile should be turned on, default features, weather the transliteration is enabled, etc.
ENABLE_UNALLOWED_NAME_VALUE_VALIDATION	Validates input business partner names against unallowed patterns and returns Bad Request in case of invalid name match.
ENRICH_ADDRESS	Enriches address information. Geocodes, administrative areas, country name and code. Cleanse address using external data sources. Remove thoroughfare value and sub thoroughfares when there are more than 3 locality levels.
ENRICH_ADDRESS_TYPE	Identifies the address type of given address and enrich the legal address.
ENRICH_ADMINISTRATIVE_AREA_ISO	Enriches administrative area shortname with ISO value using managed administrative areas. Standardizes administrative area into target language.
ENRICH_CATEGORY	Enrich a CDL community standardized business partner category for a given entity.
ENRICH_CLASSIFICATIONS	Enriches classification field in businessPartner via lookup using identifiers.
ENRICH_COMPANY_STATUS	Enriches status field in businessPartner via lookup using identifiers.
ENRICH_GEOGRAPHIC_COORDINATES	Enriches only geographic coordinates. When turned on with `ENRICH_ADDRESS` then if geographic coordinates were enriched during cleansing, then this element is not executed.
ENRICH_GOOGLE_PLACES_INFORMATION	Enriches name local and legal address from Google Places via ReferenceData lookup.
ENRICH_IDENTIFIERS	Enriches identifiers using ReferenceData lookup via strict and/or fuzzy (on-demand, when `ENABLE_FUZZY_ENRICHMENTS` used). Cross-links with external data sources and authorities, company as well as address identifiers.
ENRICH_LEGAL_ADDRESS	Enriches `legalAddress` field in `businessPartner` via lookup using identifiers.
ENRICH_LOCAL_ADDRESS	Enriches local address in curated Business Partner.
ENRICH_LEGAL_FORM	Identify and enriches the legal form of a company. Looks for legal form in name and sets it in the appropriate field. When `HARMONIZE_NAME` turned on Normalizes name local by harmonizing its legal form.
ENRICH_MINORITY_INDICATOR	Enriches minority indicator value from supplier gateway.
ENRICH_POST_CODE_TYPE	Sets type `REGULAR` to post code type if empty.
ENRICH_POST_CODE	Enriches the post code based on a selection from identified reference addresses. For some special cases such as France additional strategies are applied, e.g. to identify whether a post code is a `CEDEX` post code and use dedicated reference data for the city name and post office city.
ENRICH_REGISTERED_NAME	Enriches name of type registered name via lookup using identifiers.
ENRICH_VAT_REGISTERED_INFORMATION	Enriches the name and address of the business partner as it is provided in official data sources.
EXTRACT_ADDRESS_CONTEXT	Identifies and enriches address context. Moves name part after legal form to address context.
EXTRACT_CARE_OF	Extracts care of from name and sets it in address. Moves care of information from name local to careOf. Removes care of information from name international.
EXTRACT_DOING_BUSINESS_AS	Extracts doing business as from name local and international and adds to names list. Removes duplicates of DBAs. Trims spaces.
HARMONIZE_IDENTIFIERS	Normalizes identifiers by applying formatting rules
HARMONIZE_NAME	Normalizes name local by harmonizing its legal form
JOIN_THOROUGHFARE_NUMBER_POSTFIX	Thoroughfare number in curation result is added to thoroughfare value as a postfix.
JOIN_THOROUGHFARE_NUMBER_PREFIX	Thoroughfare number in curation result is added to thoroughfare value as a prefix.
NORMALIZE_ADDRESS	Capitalize locality, thoroughfare and premise. Normalize first level of the locality to CDQ standards.
NORMALIZE_BUSINESS_PARTNER	Normalizes hyphens to `-` in identifiers. Removes redundant identifies. Removes all identifiers from the given set that do not have a valid identifier value.
PARSE_ADDRESS	Harmonize address data by parsing thoroughfare numbers, etc. Tries to detect country if data invalid. Ensure that country shortname and value are set and existent. Extracts Postal Delivery Point value and number from PostCode. Removes or changes local elements in thoroughfare like esquina (Spanish), mieszkania (Polish), etc. Extracts building number from thoroughfare. Identify and extract premise information, see also Premise Enrichment and Harmonization for details Identify special patterns and extract accordingly such as: a) Ensure that kilometre patterns are identified and extracted, b) Detects and moves industrial zone from address fields to a premise of type industrial zone.
PARSE_LEGAL_FORM	Tries to detect a valid legalform from a businesspartner's localName with respect to its countrycode and writes the detected legalform to the `legalForm` field in the businesspartner. If no valid `legalForm` is found, the legalform field is untouched.
PARSE_LEGAL_FORM_WORLDWIDE	Tries to detect a valid legalform from a businesspartner's localName without respect to its countrycode and writes the detected legalform to the `legalForm` field in the businesspartner. If no valid `legalForm` is found, the legalform field is untouched.
PARSE_NAMES	Removes parts from a given entity's name that are not part of the name. Copies name international to local if local is empty. Normalizes name international to look like name local without accents and specific characters. Abbreviates names and sets calculated values to short names. Detects and sets categories. Removes or changes double spaces, special or local characters, etc.
PERSIST_LOOKUP_RESULTS	Add all lookup requests to curation result.
PREFER_COUNTY	County will be used as a Region in Administrative Area if found.
PREFER_THOROUGHFARE_NAME	Thoroughfare value in curation result is replaced by thoroughfare name.
PREFER_THOROUGHFARE_SHORTNAME	Thoroughfare value in curation result is replaced by thoroughfare shortname.
PREPROCESS_ADDRESS	Trims each field of the address. Removes prefix like (D, D-, DE, DE-) from post code. Removes hyphens which are between words and number in thoroughfare value.
PREPROCESS_BUSINESS_PARTNER	Prepare provided business partner data for further processing (i.e. trimming values).
REMOVE_CONTACT_INFORMATION	Removes contact information from names.
REMOVE_INVALID_IDENTIFIERS	Validates Business partner identifier according to specific rules.
SHARING_PRIMARY	Data from sharing pool (CDQ.POOL or CX.POOL if used api key belongs to CX workspace) will be taken first during enrichment, even if it is not set as primary data source. Egz. CDQ Pool(full match) > VIES(full match) > CDQ Pool(maybe match).
SHOW_DEBUG_INFO	Returns a debug info.
SHOW_FORMATTED_ADDRESS	Returns records in a unified way to a SAP standard format.
SHOW_FORMATTED_SAP_RECORD	Format address in a unified way (without nested data).
SHOW_SETTINGS	Returns a list of all turned on curation settings.
TRANSLATE_ADDRESS	Translates locality and administrative area. Works only when country is selected.
TRANSLATE_NAMES	Translates name international when contains any non-latin characters. Cyrillic is transliterated.
USE_ADDRESS_INDEX_KR	Uses South Korean address index for enrichment. Valid only for KR.

Example: ["ENRICH_ADDRESS"]

featuresOn

Array of strings (CurationFeatureParam)

List of feature to be activated.

Items Enum:	Description
ACTIVATE_DATASOURCE_BVD	Allows to lookup in BVD datasource (e.g. during identifier enrichment).
ACTIVATE_DATASOURCE_DNB	Allows to lookup in DNB datasource (e.g. during identifier enrichment).
ALL_ADDRESS_VERSIONS	Description will be provided.
CAPITALIZE_ADDRESS	Converts all values in the address data to upper case.
CONFIRM_IDENTIFIERS	Checks if provided identifiers exist in external data sources and belong to provided business partner.
DETECT_INDUSTRIAL_ZONE	Detects and moves industrial zone from address fields to the last thoroughfare of type industrial zone. This data is also added to District for the SAP format record. The Zone is detected during the precuration process from the administrative area, locality, thoroughfare and premise. This feature works only for few countries with special terms. The cleansing process doesn’t perform industrial zone enrichment. If this information is not provided in input data, the outputs won’t contain it. Google or here curation can remove the information about the industrial zone, but there are implemented special rules, which keep that data and after the curation paste it to the last thoroughfare.
ENABLE_FUZZY_ENRICHMENTS	Enriches identifiers with search using identifiers, name local or international address data.
ENABLE_SETTINGS	Allows to use organization settings. Each organization can choose which profile should be turned on, default features, weather the transliteration is enabled, etc.
ENABLE_UNALLOWED_NAME_VALUE_VALIDATION	Validates input business partner names against unallowed patterns and returns Bad Request in case of invalid name match.
ENRICH_ADDRESS	Enriches address information. Geocodes, administrative areas, country name and code. Cleanse address using external data sources. Remove thoroughfare value and sub thoroughfares when there are more than 3 locality levels.
ENRICH_ADDRESS_TYPE	Identifies the address type of given address and enrich the legal address.
ENRICH_ADMINISTRATIVE_AREA_ISO	Enriches administrative area shortname with ISO value using managed administrative areas. Standardizes administrative area into target language.
ENRICH_CATEGORY	Enrich a CDL community standardized business partner category for a given entity.
ENRICH_CLASSIFICATIONS	Enriches classification field in businessPartner via lookup using identifiers.
ENRICH_COMPANY_STATUS	Enriches status field in businessPartner via lookup using identifiers.
ENRICH_GEOGRAPHIC_COORDINATES	Enriches only geographic coordinates. When turned on with `ENRICH_ADDRESS` then if geographic coordinates were enriched during cleansing, then this element is not executed.
ENRICH_GOOGLE_PLACES_INFORMATION	Enriches name local and legal address from Google Places via ReferenceData lookup.
ENRICH_IDENTIFIERS	Enriches identifiers using ReferenceData lookup via strict and/or fuzzy (on-demand, when `ENABLE_FUZZY_ENRICHMENTS` used). Cross-links with external data sources and authorities, company as well as address identifiers.
ENRICH_LEGAL_ADDRESS	Enriches `legalAddress` field in `businessPartner` via lookup using identifiers.
ENRICH_LOCAL_ADDRESS	Enriches local address in curated Business Partner.
ENRICH_LEGAL_FORM	Identify and enriches the legal form of a company. Looks for legal form in name and sets it in the appropriate field. When `HARMONIZE_NAME` turned on Normalizes name local by harmonizing its legal form.
ENRICH_MINORITY_INDICATOR	Enriches minority indicator value from supplier gateway.
ENRICH_POST_CODE_TYPE	Sets type `REGULAR` to post code type if empty.
ENRICH_POST_CODE	Enriches the post code based on a selection from identified reference addresses. For some special cases such as France additional strategies are applied, e.g. to identify whether a post code is a `CEDEX` post code and use dedicated reference data for the city name and post office city.
ENRICH_REGISTERED_NAME	Enriches name of type registered name via lookup using identifiers.
ENRICH_VAT_REGISTERED_INFORMATION	Enriches the name and address of the business partner as it is provided in official data sources.
EXTRACT_ADDRESS_CONTEXT	Identifies and enriches address context. Moves name part after legal form to address context.
EXTRACT_CARE_OF	Extracts care of from name and sets it in address. Moves care of information from name local to careOf. Removes care of information from name international.
EXTRACT_DOING_BUSINESS_AS	Extracts doing business as from name local and international and adds to names list. Removes duplicates of DBAs. Trims spaces.
HARMONIZE_IDENTIFIERS	Normalizes identifiers by applying formatting rules
HARMONIZE_NAME	Normalizes name local by harmonizing its legal form
JOIN_THOROUGHFARE_NUMBER_POSTFIX	Thoroughfare number in curation result is added to thoroughfare value as a postfix.
JOIN_THOROUGHFARE_NUMBER_PREFIX	Thoroughfare number in curation result is added to thoroughfare value as a prefix.
NORMALIZE_ADDRESS	Capitalize locality, thoroughfare and premise. Normalize first level of the locality to CDQ standards.
NORMALIZE_BUSINESS_PARTNER	Normalizes hyphens to `-` in identifiers. Removes redundant identifies. Removes all identifiers from the given set that do not have a valid identifier value.
PARSE_ADDRESS	Harmonize address data by parsing thoroughfare numbers, etc. Tries to detect country if data invalid. Ensure that country shortname and value are set and existent. Extracts Postal Delivery Point value and number from PostCode. Removes or changes local elements in thoroughfare like esquina (Spanish), mieszkania (Polish), etc. Extracts building number from thoroughfare. Identify and extract premise information, see also Premise Enrichment and Harmonization for details Identify special patterns and extract accordingly such as: a) Ensure that kilometre patterns are identified and extracted, b) Detects and moves industrial zone from address fields to a premise of type industrial zone.
PARSE_LEGAL_FORM	Tries to detect a valid legalform from a businesspartner's localName with respect to its countrycode and writes the detected legalform to the `legalForm` field in the businesspartner. If no valid `legalForm` is found, the legalform field is untouched.
PARSE_LEGAL_FORM_WORLDWIDE	Tries to detect a valid legalform from a businesspartner's localName without respect to its countrycode and writes the detected legalform to the `legalForm` field in the businesspartner. If no valid `legalForm` is found, the legalform field is untouched.
PARSE_NAMES	Removes parts from a given entity's name that are not part of the name. Copies name international to local if local is empty. Normalizes name international to look like name local without accents and specific characters. Abbreviates names and sets calculated values to short names. Detects and sets categories. Removes or changes double spaces, special or local characters, etc.
PERSIST_LOOKUP_RESULTS	Add all lookup requests to curation result.
PREFER_COUNTY	County will be used as a Region in Administrative Area if found.
PREFER_THOROUGHFARE_NAME	Thoroughfare value in curation result is replaced by thoroughfare name.
PREFER_THOROUGHFARE_SHORTNAME	Thoroughfare value in curation result is replaced by thoroughfare shortname.
PREPROCESS_ADDRESS	Trims each field of the address. Removes prefix like (D, D-, DE, DE-) from post code. Removes hyphens which are between words and number in thoroughfare value.
PREPROCESS_BUSINESS_PARTNER	Prepare provided business partner data for further processing (i.e. trimming values).
REMOVE_CONTACT_INFORMATION	Removes contact information from names.
REMOVE_INVALID_IDENTIFIERS	Validates Business partner identifier according to specific rules.
SHARING_PRIMARY	Data from sharing pool (CDQ.POOL or CX.POOL if used api key belongs to CX workspace) will be taken first during enrichment, even if it is not set as primary data source. Egz. CDQ Pool(full match) > VIES(full match) > CDQ Pool(maybe match).
SHOW_DEBUG_INFO	Returns a debug info.
SHOW_FORMATTED_ADDRESS	Returns records in a unified way to a SAP standard format.
SHOW_FORMATTED_SAP_RECORD	Format address in a unified way (without nested data).
SHOW_SETTINGS	Returns a list of all turned on curation settings.
TRANSLATE_ADDRESS	Translates locality and administrative area. Works only when country is selected.
TRANSLATE_NAMES	Translates name international when contains any non-latin characters. Cyrillic is transliterated.
USE_ADDRESS_INDEX_KR	Uses South Korean address index for enrichment. Valid only for KR.

Example: ["ENRICH_ADDRESS"]

inputAddressConceptsIgnored

Array of strings (InputAddressConceptsIgnored)

A list of technical keys of concepts. Selected concepts will be ignored during curation process. This feature is mainly used in configurations, if i.e. for certain countries selected inputs should be ignored without changing the current technical integration. Please note that ignored concepts will be taken over to the curation result without any change.

Items Enum:	Description
BUILDING	Structure (such as a house, hospital, school, etc.) with a roof and walls that is used as a place for people to live, work, do activities, store things, etc.
CITY	Large and permanent human settlement.
COUNTY	Level 2 subdivision of a country, subdivision of a region.
DISTRICT	Subdivision of larger cities, mostly providing administrative services to the district residents.
LEVEL	Floor/story of the building.
POST_CODE	Numerical code used to identify specific geographic areas for mail sorting and delivery.
REGION	Top level subdivision of a country.
ROOM	Distinct room in a building.
THOROUGHFARE_NUMBER	A numerical identifier assigned to a specific building or property along a thoroughfare.

Example: ["BUILDING"]

object (NumberSeparator)

Number separator for features JOIN_THOROUGHFARE_NUMBER_PREFIX, JOIN_THOROUGHFARE_NUMBER_POSTFIX. Default ","

Array of objects (OutputCharsetParam)

List of Output Character Sets.

object (LanguageRequest)

Expected language of curation result, compliant to ISO 639-1.

profile

string (CurationProfileParam)

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

400

Bad Request

401

Unauthorized

403

Forbidden

post/v3/businesspartners/curate

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartner": {"names": [{"value": "CDQ Poland Sp. z o.o.",
"type": {"technicalKey": "INTERNATIONAL"
}
}
],
"addresses": [{"country": {"shortName": "PL"
}
}
]
}
}

Response samples

application/json

{"updatedBusinessPartner": {"summary": {"tags": ["IDENTIFIER_ADDED"
],
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
}
},
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
},
"updateAssessment": {"action": {"technicalKey": "ADDED"
},
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
},
"provenances": [{"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",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"lastSyncAt": "2024-11-30T23:38:47Z"
}
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": ["IDENTIFIER_ADDED"
],
"before": {"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
},
"requestSimilarity": {"value": "0.8"
}
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"shortName": "LLC",
"technicalKey": "LIMITED"
}
],
"updateAssessment": {"action": {"technicalKey": "ADDED"
},
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
},
"provenances": [{"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",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"lastSyncAt": "2024-11-30T23:38:47Z"
}
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": ["IDENTIFIER_ADDED"
],
"before": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"shortName": "LLC",
"technicalKey": "LIMITED"
}
]
}
}
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"fipsCode": null,
"shortName": null,
"type": null,
"language": null
}
]
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
},
"updateAssessment": {"action": {"technicalKey": "ADDED"
},
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
},
"provenances": [{"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",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"lastSyncAt": "2024-11-30T23:38:47Z"
}
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": ["IDENTIFIER_ADDED"
],
"before": {"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": null,
"administrativeAreas": [ ]
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL",
"score": "0.95",
"updateAssessment": {"action": {"technicalKey": "ADDED"
},
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
},
"provenances": [{"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",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"lastSyncAt": "2024-11-30T23:38:47Z"
}
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": ["IDENTIFIER_ADDED"
],
"before": {"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL",
"score": "0.95"
}
}
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-11-30T23:38:47Z",
"validUntil": "2024-11-30T23:38:47Z",
"updateAssessment": {"action": {"technicalKey": "ADDED"
},
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
},
"provenances": [{"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",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"lastSyncAt": "2024-11-30T23:38:47Z"
}
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": ["IDENTIFIER_ADDED"
],
"before": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-11-30T23:38:47Z",
"validUntil": "2024-11-30T23:38:47Z"
}
}
},
"addresses": [{"updateAssessment": {"provenances": [{"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",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"lastSyncAt": "2024-11-30T23:38:47Z"
}
],
"curationAssessment": {"curationLevel": "LEVEL_1",
"accuracyIndicator": "0.9",
"outputLanguage": {"name": "German",
"technicalKey": "DE"
},
"curationDecision": {"action": "ACCEPT"
},
"geographicCoordinatesAccuracy": "LOCALITY",
"inputAddressType": "INPUT_LOCAL_ADDRESS"
},
"requestSimilarity": {"value": "0.8"
}
},
"version": {"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland",
"updateAssessment": {"action": {"technicalKey": "ADDED"
},
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
},
"provenances": [{"name": null,
"url": null,
"technicalKey": null,
"cdqId": null,
"subscribers": null,
"subscribed": null,
"lastUpdatedAt": null,
"lastSyncAt": null
}
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": ["IDENTIFIER_ADDED"
],
"before": {"shortName": "CH",
"value": "Switzerland"
}
}
},
"administrativeAreas": [{"value": "Sankt Gallen",
"fipsCode": "SZ15",
"shortName": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
},
"language": {"name": "German",
"technicalKey": "DE"
},
"updateAssessment": {"action": {"technicalKey": null
},
"classification": {"technicalKey": null,
"reason": null
},
"provenances": [null
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": [null
],
"before": {"value": null,
"fipsCode": null,
"shortName": null,
"type": null,
"language": null
}
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
},
"updateAssessment": {"action": {"technicalKey": null
},
"classification": {"technicalKey": null,
"reason": null
},
"provenances": [null
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": [null
],
"before": {"value": null,
"type": null
}
}
}
],
"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"
},
"updateAssessment": {"action": {"technicalKey": null
},
"classification": {"technicalKey": null,
"reason": null
},
"provenances": [null
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": [null
],
"before": {"type": null,
"shortName": null,
"value": null,
"language": null
}
}
}
],
"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"
},
"updateAssessment": {"action": {"technicalKey": null
},
"classification": {"technicalKey": null,
"reason": null
},
"provenances": [null
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": [null
],
"before": {"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
}
}
],
"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"
},
"updateAssessment": {"action": {"technicalKey": null
},
"classification": {"technicalKey": null,
"reason": null
},
"provenances": [null
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": [null
],
"before": {"value": null,
"shortName": null,
"number": null,
"type": null,
"language": null
}
}
}
],
"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"
},
"updateAssessment": {"action": {"technicalKey": null
},
"classification": {"technicalKey": null,
"reason": null
},
"provenances": [null
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": [null
],
"before": {"type": null,
"shortName": null,
"number": null,
"value": null,
"language": null
}
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275",
"updateAssessment": {"action": {"technicalKey": "ADDED"
},
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
},
"provenances": [{"name": null,
"url": null,
"technicalKey": null,
"cdqId": null,
"subscribers": null,
"subscribed": null,
"lastUpdatedAt": null,
"lastSyncAt": null
}
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": ["IDENTIFIER_ADDED"
],
"before": {"latitude": "47.439549",
"longitude": "9.395275"
}
}
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
]
},
"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"
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY",
"updateAssessment": {"action": {"technicalKey": "ADDED"
},
"classification": {"technicalKey": "MAJOR",
"reason": "The modified post code has deprecated format."
},
"provenances": [{"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",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"lastSyncAt": "2024-11-30T23:38:47Z"
}
],
"modifiedAt": "2024-11-30T23:38:47Z",
"tags": ["IDENTIFIER_ADDED"
],
"before": {"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
}
}
]
},
"originalBusinessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"shortName": "LLC",
"technicalKey": "LIMITED"
}
]
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"fipsCode": null,
"shortName": null,
"type": null,
"language": null
}
]
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL",
"score": "0.95"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-11-30T23:38:47Z",
"validUntil": "2024-11-30T23:38:47Z"
},
"addresses": [{"version": {"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"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",
"fipsCode": "SZ15",
"shortName": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
},
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
}
],
"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"
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
]
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
]
},
"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"
}
]
}
}
]
},
"debugInfo": {"externalServiceResponses": [{"timestamp": "2024-11-30T23:38:47Z",
"httpStatus": "400",
"httpPath": "/v2/businesspartners/lookup",
"status": "OK",
"message": "VIES_NOT_AVAILABLE - Vies is currently not available",
"source": "CHUID",
"additionalInformations": [{"key": "KEY",
"value": "1"
}
]
}
],
"lookupServiceResponses": [{"request": {"businessPartner": {"names": [{"type": null,
"value": null,
"shortName": null,
"language": null
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": null,
"technicalKey": null
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [null
]
},
"identifiers": [{"type": null,
"value": null,
"issuingBody": null,
"status": null
}
],
"categories": [{"name": null,
"url": null,
"technicalKey": null,
"score": null
}
],
"status": {"type": {"name": null,
"url": null,
"technicalKey": null
},
"officialDenotation": "Good Standing",
"validFrom": "2024-11-30T23:38:47Z",
"validUntil": "2024-11-30T23:38:47Z"
},
"addresses": [{"version": null,
"identifyingName": null,
"externalId": null,
"careOf": null,
"contexts": [ ],
"country": null,
"administrativeAreas": [ ],
"postCodes": [ ],
"localities": [ ],
"thoroughfares": [ ],
"premises": [ ],
"postalDeliveryPoints": [ ],
"geographicCoordinates": null,
"types": [ ]
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"classifications": [null
],
"phoneNumbers": [null
],
"websites": [null
],
"contactEmails": [null
]
},
"types": [{"name": null,
"url": null,
"technicalKey": null
}
]
},
"dataSources": ["VIES"
],
"matchingThreshold": "0.8",
"maxCandidates": "20",
"pageSize": "100",
"page": "1",
"limit": "100",
"startAfter": "5712566172571652",
"featuresOn": ["ACTIVATE_DATASOURCE_BVD"
],
"featuresOff": ["ACTIVATE_DATASOURCE_BVD"
]
},
"result": {"pageSize": "100",
"totals": "67",
"page": "1",
"limit": "100",
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"values": [{"cdqId": "VIES:PL8660001429",
"dataSource": "648824a691d8d2503d65103e",
"lastSyncAt": "2024-11-30T23:38:47Z",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"dataSourceName": "Internal customers",
"storageDataSource": "648824a691d8d2503d65103e",
"matchingProfile": {"matchingScores": null
},
"businessPartner": {"names": [ ],
"legalForm": null,
"identifiers": [ ],
"categories": [ ],
"status": null,
"addresses": [ ],
"externalId": null,
"profile": null,
"types": [ ]
}
}
]
}
}
]
}
}

Generate Golden Record

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

SecurityapiKey

Request

Request Body schema: application/json
required

required

Array of objects (GoldenRecordCandidate) non-empty

List of Golden Records Candidates.

configurationId

string

Configuration ID for the Golden Record Generation.

Example: "12ed4bd757f8e162f8aa496f"

countryShortName

string (CountryShortName)

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

Example: "CH"

dataSources

Array of strings (DataSourceTechnicalKeyEnum)

Data sources enabled for identifiers enrichment in golden record

Items Enum: {"AR_NRC":"Argentina National Registry of Companies"} {"AT_CR":"Austria Company Register"} {"AT_FON":"FinanzOnline Austria"} {"AU_BR":"Australian Business Register"} {"BE_CCD":"Central Belgium Company Database"} {"BR_RF":"Receita Federal Brazil"} {"BZST":"Bundeszentralamt für Steuern"} {"CA_CR":"Corporations Register Canada"} {"CZ_REE":"Register of Economic Entities"} {"CDL":"CDQ Data Sharing Community Data Lake"} {"CDQ_POOL":"CDQ Data Sharing Community Data Pool"} {"CDQ_CRAWLED":null} {"CH_CR":"Swiss commercial register"} {"CH_UIDR":"UID-Register"} {"DATAMIRROR":"CDQ Data Mirror"} {"DE_RC":"German Commercial Register"} {"DNB":"D&B CMPELK Records"} {"DNB_LNKELI":"D&B Extended Linkages"} {"DNB_MASTER_DATA_BASIC":"DNB Master Data Basic Records"} {"DNB_MASTER_DATA_EXTENDED":"DNB Master Data Extended Records"} {"EE_CR":"Estonian Commercial Register"} {"FR_RC":"French Company Register"} {"GB_EAW_CR":"Companies House England and Wales Company Register"} {"GOOGLEPLACES":"Google Places"} {"IE_CR":"Irish Company Register"} {"IL_CR":"Israeli Company Register"} {"JP_CR":"Japanese Company Register"} {"LEI":"Legal Entity Identifier Records"} {"MX_SBI":"Mexican Digital Business Information System"} {"NL_BR":"Netherlands Company Register"} {"PL_NOBR":"Polish National Official Business Register"} {"US_SEC":"US Securities and Exchange Commission EDGAR Company Filings"} {"US_AK_BER":"Alaska Business Entity Register"} {"US_FL_BER":"Florida Business Entity Register"} {"US_LA_BER":"Listing of Active Businesses - Los Angeles"} {"US_SF_BER":"Registered Business Locations - San Francisco"} {"US_NY_BER":"New York Business Entity Register"} {"US_IO_BER":"Iowa Business Entity Register"} {"US_OR_BER":"Oregon Business Entity Register"} {"US_WA_BER":"Washington Business Entity Register"} {"US_WY_BER":"Wyoming Business Entity Register"} {"US_CO_BER":"Colorado Business Entity Register"} {"SG_BR":"Unique Entity Number Register"} {"VIES":"VIES VAT number validation"} {"DK_CR":"Denmark Central Business Register"} {"NO_RBE":"Norway, The Brønnøysund Register Centre"} {"LV_CR":"Registered companies from Latvia"} {"NZ_CR":"New Zealand Business Number Register"} {"SPOR_OMS":"Data source that offers business partner and location information about healthcare organisations and manufacturers"} {"UK_VAT":"HM Revenue and Customs VAT Check"}

Example: ["BR_RF"]

featuresOn

Array of strings (GoldenRecordFeatureParam)

List of Golden Record Features.

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

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

400

Bad Request

401

Unauthorized

403

Forbidden

post/v2/businesspartners/goldenrecords/generate

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"countryShortName": "AT",
"profile": "STANDARD",
"candidates": [{"businessPartner": {"status": {"type": {"name": "inactive",
"url": "url92",
"technicalKey": "technicalKey92"
}
},
"identifiers": [{"value": "078038M",
"type": {"technicalKey": "BR_ID_AT"
}
}
],
"names": [{"value": "ENGEL AUSTRIA GmbH"
}
],
"addresses": [{"country": {"value": "AT"
},
"localities": [{"value": "Schwertberg"
}
],
"thoroughfares": [{"value": "Ludwig-Engel-Str. 1"
}
]
}
]
},
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "FULL_MATCH",
"name": "Full Match"
},
"value": 99.0869848239641,
"explanation": "explanation23"
},
"businessPartner": {"classification": {"technicalKey": "technicalKey23",
"name": "name23"
},
"value": 44.0869848239641,
"explanation": "explanation23"
},
"address": {"classification": {"technicalKey": "technicalKey23",
"name": "name23"
},
"value": 44.0869848239641,
"explanation": "explanation23"
}
}
},
"dataSource": {"name": "name23",
"technicalKey": "AT.CR"
}
}
]
}

Response samples

application/json

{"businessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"cdlElfCode": "AG",
"categories": [{"name": "Limited Liability Company",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"shortName": "LLC",
"technicalKey": "LIMITED"
}
]
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"fipsCode": null,
"shortName": null,
"type": null,
"language": null
}
]
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL",
"score": "0.95"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-11-30T23:38:47Z",
"validUntil": "2024-11-30T23:38:47Z"
},
"addresses": [{"version": {"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"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",
"fipsCode": "SZ15",
"shortName": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
},
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
}
],
"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"
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
]
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
]
},
"metadata": [{"modifiedAt": "2024-11-30T23:38:47Z",
"modifiedBy": "76248934691294444",
"dataSource": {"name": "VIES",
"technicalKey": "VIES"
},
"cdqId": "VIES:PL1132639219",
"inactive": "true"
}
],
"businessPartnerChanges": [{"externalIds": [{"externalId": "123",
"dataSourceId": "VIES",
"id": "123",
"concept": {"name": "Address",
"technicalKey": "ADDRESS"
},
"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
},
"type": {"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
}
],
"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",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "2024-11-30T23:38:47Z",
"lastSyncAt": "2024-11-30T23:38:47Z"
},
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"confidenceScore": "0.0",
"maxConfidenceScore": "1.0",
"matchingScores": {"overall": "0.9",
"businessPartner": "0.9",
"address": "0.9"
}
}
],
"goldenRecordUses": [{"cdqId": "VIES:PL1132639219",
"use": "PRIMARY"
}
]
}

Business Partners

Curate Business PartnerBETA

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